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_flags
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. By default
3894 this 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.
3899 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3900 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3901 I<may> be skipped. (i.e. the buffer is actually at least 1 byte longer than
3902 C<len>, and already meets the requirements for storing in C<SvPVX>)
3908 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3912 SV_CHECK_THINKFIRST_COW_DROP(sv);
3913 SvUPGRADE(sv, SVt_PV);
3916 if (flags & SV_SMAGIC)
3920 if (SvPVX_const(sv))
3923 allocate = (flags & SV_HAS_TRAILING_NUL)
3924 ? len : PERL_STRLEN_ROUNDUP(len + 1);
3927 /* Force a move to shake out bugs in callers. */
3928 char *new_ptr = safemalloc(allocate);
3929 Copy(ptr, new_ptr, len, char);
3930 PoisonFree(ptr,len,char);
3935 if (!(flags & SV_HAS_TRAILING_NUL)) {
3936 ptr = saferealloc (ptr, allocate);
3941 SvLEN_set(sv, allocate);
3942 if (!(flags & SV_HAS_TRAILING_NUL)) {
3945 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3947 if (flags & SV_SMAGIC)
3951 #ifdef PERL_OLD_COPY_ON_WRITE
3952 /* Need to do this *after* making the SV normal, as we need the buffer
3953 pointer to remain valid until after we've copied it. If we let go too early,
3954 another thread could invalidate it by unsharing last of the same hash key
3955 (which it can do by means other than releasing copy-on-write Svs)
3956 or by changing the other copy-on-write SVs in the loop. */
3958 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3960 if (len) { /* this SV was SvIsCOW_normal(sv) */
3961 /* we need to find the SV pointing to us. */
3962 SV *current = SV_COW_NEXT_SV(after);
3964 if (current == sv) {
3965 /* The SV we point to points back to us (there were only two of us
3967 Hence other SV is no longer copy on write either. */
3969 SvREADONLY_off(after);
3971 /* We need to follow the pointers around the loop. */
3973 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3976 /* don't loop forever if the structure is bust, and we have
3977 a pointer into a closed loop. */
3978 assert (current != after);
3979 assert (SvPVX_const(current) == pvx);
3981 /* Make the SV before us point to the SV after us. */
3982 SV_COW_NEXT_SV_SET(current, after);
3985 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3990 Perl_sv_release_IVX(pTHX_ register SV *sv)
3993 sv_force_normal_flags(sv, 0);
3999 =for apidoc sv_force_normal_flags
4001 Undo various types of fakery on an SV: if the PV is a shared string, make
4002 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4003 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4004 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4005 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4006 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4007 set to some other value.) In addition, the C<flags> parameter gets passed to
4008 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4009 with flags set to 0.
4015 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4018 #ifdef PERL_OLD_COPY_ON_WRITE
4019 if (SvREADONLY(sv)) {
4020 /* At this point I believe I should acquire a global SV mutex. */
4022 const char * const pvx = SvPVX_const(sv);
4023 const STRLEN len = SvLEN(sv);
4024 const STRLEN cur = SvCUR(sv);
4025 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4027 PerlIO_printf(Perl_debug_log,
4028 "Copy on write: Force normal %ld\n",
4034 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4037 if (flags & SV_COW_DROP_PV) {
4038 /* OK, so we don't need to copy our buffer. */
4041 SvGROW(sv, cur + 1);
4042 Move(pvx,SvPVX(sv),cur,char);
4046 sv_release_COW(sv, pvx, len, next);
4051 else if (IN_PERL_RUNTIME)
4052 Perl_croak(aTHX_ PL_no_modify);
4053 /* At this point I believe that I can drop the global SV mutex. */
4056 if (SvREADONLY(sv)) {
4058 const char * const pvx = SvPVX_const(sv);
4059 const STRLEN len = SvCUR(sv);
4064 SvGROW(sv, len + 1);
4065 Move(pvx,SvPVX(sv),len,char);
4067 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4069 else if (IN_PERL_RUNTIME)
4070 Perl_croak(aTHX_ PL_no_modify);
4074 sv_unref_flags(sv, flags);
4075 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4082 Efficient removal of characters from the beginning of the string buffer.
4083 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4084 the string buffer. The C<ptr> becomes the first character of the adjusted
4085 string. Uses the "OOK hack".
4086 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4087 refer to the same chunk of data.
4093 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4095 register STRLEN delta;
4096 if (!ptr || !SvPOKp(sv))
4098 delta = ptr - SvPVX_const(sv);
4099 SV_CHECK_THINKFIRST(sv);
4100 if (SvTYPE(sv) < SVt_PVIV)
4101 sv_upgrade(sv,SVt_PVIV);
4104 if (!SvLEN(sv)) { /* make copy of shared string */
4105 const char *pvx = SvPVX_const(sv);
4106 const STRLEN len = SvCUR(sv);
4107 SvGROW(sv, len + 1);
4108 Move(pvx,SvPVX(sv),len,char);
4112 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4113 and we do that anyway inside the SvNIOK_off
4115 SvFLAGS(sv) |= SVf_OOK;
4118 SvLEN_set(sv, SvLEN(sv) - delta);
4119 SvCUR_set(sv, SvCUR(sv) - delta);
4120 SvPV_set(sv, SvPVX(sv) + delta);
4121 SvIV_set(sv, SvIVX(sv) + delta);
4125 =for apidoc sv_catpvn
4127 Concatenates the string onto the end of the string which is in the SV. The
4128 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4129 status set, then the bytes appended should be valid UTF-8.
4130 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4132 =for apidoc sv_catpvn_flags
4134 Concatenates the string onto the end of the string which is in the SV. The
4135 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4136 status set, then the bytes appended should be valid UTF-8.
4137 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4138 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4139 in terms of this function.
4145 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4149 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4151 SvGROW(dsv, dlen + slen + 1);
4153 sstr = SvPVX_const(dsv);
4154 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4155 SvCUR_set(dsv, SvCUR(dsv) + slen);
4157 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4159 if (flags & SV_SMAGIC)
4164 =for apidoc sv_catsv
4166 Concatenates the string from SV C<ssv> onto the end of the string in
4167 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4168 not 'set' magic. See C<sv_catsv_mg>.
4170 =for apidoc sv_catsv_flags
4172 Concatenates the string from SV C<ssv> onto the end of the string in
4173 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4174 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4175 and C<sv_catsv_nomg> are implemented in terms of this function.
4180 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4185 const char *spv = SvPV_const(ssv, slen);
4187 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4188 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4189 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4190 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4191 dsv->sv_flags doesn't have that bit set.
4192 Andy Dougherty 12 Oct 2001
4194 const I32 sutf8 = DO_UTF8(ssv);
4197 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4199 dutf8 = DO_UTF8(dsv);
4201 if (dutf8 != sutf8) {
4203 /* Not modifying source SV, so taking a temporary copy. */
4204 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4206 sv_utf8_upgrade(csv);
4207 spv = SvPV_const(csv, slen);
4210 sv_utf8_upgrade_nomg(dsv);
4212 sv_catpvn_nomg(dsv, spv, slen);
4215 if (flags & SV_SMAGIC)
4220 =for apidoc sv_catpv
4222 Concatenates the string onto the end of the string which is in the SV.
4223 If the SV has the UTF-8 status set, then the bytes appended should be
4224 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4229 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4232 register STRLEN len;
4238 junk = SvPV_force(sv, tlen);
4240 SvGROW(sv, tlen + len + 1);
4242 ptr = SvPVX_const(sv);
4243 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4244 SvCUR_set(sv, SvCUR(sv) + len);
4245 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4250 =for apidoc sv_catpv_mg
4252 Like C<sv_catpv>, but also handles 'set' magic.
4258 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4267 Creates a new SV. A non-zero C<len> parameter indicates the number of
4268 bytes of preallocated string space the SV should have. An extra byte for a
4269 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4270 space is allocated.) The reference count for the new SV is set to 1.
4272 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4273 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4274 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4275 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4276 modules supporting older perls.
4282 Perl_newSV(pTHX_ STRLEN len)
4289 sv_upgrade(sv, SVt_PV);
4290 SvGROW(sv, len + 1);
4295 =for apidoc sv_magicext
4297 Adds magic to an SV, upgrading it if necessary. Applies the
4298 supplied vtable and returns a pointer to the magic added.
4300 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4301 In particular, you can add magic to SvREADONLY SVs, and add more than
4302 one instance of the same 'how'.
4304 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4305 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4306 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4307 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4309 (This is now used as a subroutine by C<sv_magic>.)
4314 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4315 const char* name, I32 namlen)
4320 if (SvTYPE(sv) < SVt_PVMG) {
4321 SvUPGRADE(sv, SVt_PVMG);
4323 Newxz(mg, 1, MAGIC);
4324 mg->mg_moremagic = SvMAGIC(sv);
4325 SvMAGIC_set(sv, mg);
4327 /* Sometimes a magic contains a reference loop, where the sv and
4328 object refer to each other. To prevent a reference loop that
4329 would prevent such objects being freed, we look for such loops
4330 and if we find one we avoid incrementing the object refcount.
4332 Note we cannot do this to avoid self-tie loops as intervening RV must
4333 have its REFCNT incremented to keep it in existence.
4336 if (!obj || obj == sv ||
4337 how == PERL_MAGIC_arylen ||
4338 how == PERL_MAGIC_qr ||
4339 how == PERL_MAGIC_symtab ||
4340 (SvTYPE(obj) == SVt_PVGV &&
4341 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4342 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4343 GvFORM(obj) == (CV*)sv)))
4348 mg->mg_obj = SvREFCNT_inc_simple(obj);
4349 mg->mg_flags |= MGf_REFCOUNTED;
4352 /* Normal self-ties simply pass a null object, and instead of
4353 using mg_obj directly, use the SvTIED_obj macro to produce a
4354 new RV as needed. For glob "self-ties", we are tieing the PVIO
4355 with an RV obj pointing to the glob containing the PVIO. In
4356 this case, to avoid a reference loop, we need to weaken the
4360 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4361 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4367 mg->mg_len = namlen;
4370 mg->mg_ptr = savepvn(name, namlen);
4371 else if (namlen == HEf_SVKEY)
4372 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4374 mg->mg_ptr = (char *) name;
4376 mg->mg_virtual = vtable;
4380 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4385 =for apidoc sv_magic
4387 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4388 then adds a new magic item of type C<how> to the head of the magic list.
4390 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4391 handling of the C<name> and C<namlen> arguments.
4393 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4394 to add more than one instance of the same 'how'.
4400 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4406 #ifdef PERL_OLD_COPY_ON_WRITE
4408 sv_force_normal_flags(sv, 0);
4410 if (SvREADONLY(sv)) {
4412 /* its okay to attach magic to shared strings; the subsequent
4413 * upgrade to PVMG will unshare the string */
4414 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4417 && how != PERL_MAGIC_regex_global
4418 && how != PERL_MAGIC_bm
4419 && how != PERL_MAGIC_fm
4420 && how != PERL_MAGIC_sv
4421 && how != PERL_MAGIC_backref
4424 Perl_croak(aTHX_ PL_no_modify);
4427 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4428 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4429 /* sv_magic() refuses to add a magic of the same 'how' as an
4432 if (how == PERL_MAGIC_taint) {
4434 /* Any scalar which already had taint magic on which someone
4435 (erroneously?) did SvIOK_on() or similar will now be
4436 incorrectly sporting public "OK" flags. */
4437 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4445 vtable = &PL_vtbl_sv;
4447 case PERL_MAGIC_overload:
4448 vtable = &PL_vtbl_amagic;
4450 case PERL_MAGIC_overload_elem:
4451 vtable = &PL_vtbl_amagicelem;
4453 case PERL_MAGIC_overload_table:
4454 vtable = &PL_vtbl_ovrld;
4457 vtable = &PL_vtbl_bm;
4459 case PERL_MAGIC_regdata:
4460 vtable = &PL_vtbl_regdata;
4462 case PERL_MAGIC_regdatum:
4463 vtable = &PL_vtbl_regdatum;
4465 case PERL_MAGIC_env:
4466 vtable = &PL_vtbl_env;
4469 vtable = &PL_vtbl_fm;
4471 case PERL_MAGIC_envelem:
4472 vtable = &PL_vtbl_envelem;
4474 case PERL_MAGIC_regex_global:
4475 vtable = &PL_vtbl_mglob;
4477 case PERL_MAGIC_isa:
4478 vtable = &PL_vtbl_isa;
4480 case PERL_MAGIC_isaelem:
4481 vtable = &PL_vtbl_isaelem;
4483 case PERL_MAGIC_nkeys:
4484 vtable = &PL_vtbl_nkeys;
4486 case PERL_MAGIC_dbfile:
4489 case PERL_MAGIC_dbline:
4490 vtable = &PL_vtbl_dbline;
4492 #ifdef USE_LOCALE_COLLATE
4493 case PERL_MAGIC_collxfrm:
4494 vtable = &PL_vtbl_collxfrm;
4496 #endif /* USE_LOCALE_COLLATE */
4497 case PERL_MAGIC_tied:
4498 vtable = &PL_vtbl_pack;
4500 case PERL_MAGIC_tiedelem:
4501 case PERL_MAGIC_tiedscalar:
4502 vtable = &PL_vtbl_packelem;
4505 vtable = &PL_vtbl_regexp;
4507 case PERL_MAGIC_hints:
4508 /* As this vtable is all NULL, we can reuse it. */
4509 case PERL_MAGIC_sig:
4510 vtable = &PL_vtbl_sig;
4512 case PERL_MAGIC_sigelem:
4513 vtable = &PL_vtbl_sigelem;
4515 case PERL_MAGIC_taint:
4516 vtable = &PL_vtbl_taint;
4518 case PERL_MAGIC_uvar:
4519 vtable = &PL_vtbl_uvar;
4521 case PERL_MAGIC_vec:
4522 vtable = &PL_vtbl_vec;
4524 case PERL_MAGIC_arylen_p:
4525 case PERL_MAGIC_rhash:
4526 case PERL_MAGIC_symtab:
4527 case PERL_MAGIC_vstring:
4530 case PERL_MAGIC_utf8:
4531 vtable = &PL_vtbl_utf8;
4533 case PERL_MAGIC_substr:
4534 vtable = &PL_vtbl_substr;
4536 case PERL_MAGIC_defelem:
4537 vtable = &PL_vtbl_defelem;
4539 case PERL_MAGIC_arylen:
4540 vtable = &PL_vtbl_arylen;
4542 case PERL_MAGIC_pos:
4543 vtable = &PL_vtbl_pos;
4545 case PERL_MAGIC_backref:
4546 vtable = &PL_vtbl_backref;
4548 case PERL_MAGIC_hintselem:
4549 vtable = &PL_vtbl_hintselem;
4551 case PERL_MAGIC_ext:
4552 /* Reserved for use by extensions not perl internals. */
4553 /* Useful for attaching extension internal data to perl vars. */
4554 /* Note that multiple extensions may clash if magical scalars */
4555 /* etc holding private data from one are passed to another. */
4559 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4562 /* Rest of work is done else where */
4563 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4566 case PERL_MAGIC_taint:
4569 case PERL_MAGIC_ext:
4570 case PERL_MAGIC_dbfile:
4577 =for apidoc sv_unmagic
4579 Removes all magic of type C<type> from an SV.
4585 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4589 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4591 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4592 for (mg = *mgp; mg; mg = *mgp) {
4593 if (mg->mg_type == type) {
4594 const MGVTBL* const vtbl = mg->mg_virtual;
4595 *mgp = mg->mg_moremagic;
4596 if (vtbl && vtbl->svt_free)
4597 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4598 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4600 Safefree(mg->mg_ptr);
4601 else if (mg->mg_len == HEf_SVKEY)
4602 SvREFCNT_dec((SV*)mg->mg_ptr);
4603 else if (mg->mg_type == PERL_MAGIC_utf8)
4604 Safefree(mg->mg_ptr);
4606 if (mg->mg_flags & MGf_REFCOUNTED)
4607 SvREFCNT_dec(mg->mg_obj);
4611 mgp = &mg->mg_moremagic;
4615 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4616 SvMAGIC_set(sv, NULL);
4623 =for apidoc sv_rvweaken
4625 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4626 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4627 push a back-reference to this RV onto the array of backreferences
4628 associated with that magic.
4634 Perl_sv_rvweaken(pTHX_ SV *sv)
4637 if (!SvOK(sv)) /* let undefs pass */
4640 Perl_croak(aTHX_ "Can't weaken a nonreference");
4641 else if (SvWEAKREF(sv)) {
4642 if (ckWARN(WARN_MISC))
4643 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4647 Perl_sv_add_backref(aTHX_ tsv, sv);
4653 /* Give tsv backref magic if it hasn't already got it, then push a
4654 * back-reference to sv onto the array associated with the backref magic.
4658 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4663 if (SvTYPE(tsv) == SVt_PVHV) {
4664 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4668 /* There is no AV in the offical place - try a fixup. */
4669 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4672 /* Aha. They've got it stowed in magic. Bring it back. */
4673 av = (AV*)mg->mg_obj;
4674 /* Stop mg_free decreasing the refernce count. */
4676 /* Stop mg_free even calling the destructor, given that
4677 there's no AV to free up. */
4679 sv_unmagic(tsv, PERL_MAGIC_backref);
4683 SvREFCNT_inc_simple_void(av);
4688 const MAGIC *const mg
4689 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4691 av = (AV*)mg->mg_obj;
4695 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4696 /* av now has a refcnt of 2, which avoids it getting freed
4697 * before us during global cleanup. The extra ref is removed
4698 * by magic_killbackrefs() when tsv is being freed */
4701 if (AvFILLp(av) >= AvMAX(av)) {
4702 av_extend(av, AvFILLp(av)+1);
4704 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4707 /* delete a back-reference to ourselves from the backref magic associated
4708 * with the SV we point to.
4712 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4719 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4720 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4721 /* We mustn't attempt to "fix up" the hash here by moving the
4722 backreference array back to the hv_aux structure, as that is stored
4723 in the main HvARRAY(), and hfreentries assumes that no-one
4724 reallocates HvARRAY() while it is running. */
4727 const MAGIC *const mg
4728 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4730 av = (AV *)mg->mg_obj;
4733 if (PL_in_clean_all)
4735 Perl_croak(aTHX_ "panic: del_backref");
4742 /* We shouldn't be in here more than once, but for paranoia reasons lets
4744 for (i = AvFILLp(av); i >= 0; i--) {
4746 const SSize_t fill = AvFILLp(av);
4748 /* We weren't the last entry.
4749 An unordered list has this property that you can take the
4750 last element off the end to fill the hole, and it's still
4751 an unordered list :-)
4756 AvFILLp(av) = fill - 1;
4762 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4764 SV **svp = AvARRAY(av);
4766 PERL_UNUSED_ARG(sv);
4768 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4769 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4770 if (svp && !SvIS_FREED(av)) {
4771 SV *const *const last = svp + AvFILLp(av);
4773 while (svp <= last) {
4775 SV *const referrer = *svp;
4776 if (SvWEAKREF(referrer)) {
4777 /* XXX Should we check that it hasn't changed? */
4778 SvRV_set(referrer, 0);
4780 SvWEAKREF_off(referrer);
4781 } else if (SvTYPE(referrer) == SVt_PVGV ||
4782 SvTYPE(referrer) == SVt_PVLV) {
4783 /* You lookin' at me? */
4784 assert(GvSTASH(referrer));
4785 assert(GvSTASH(referrer) == (HV*)sv);
4786 GvSTASH(referrer) = 0;
4789 "panic: magic_killbackrefs (flags=%"UVxf")",
4790 (UV)SvFLAGS(referrer));
4798 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4803 =for apidoc sv_insert
4805 Inserts a string at the specified offset/length within the SV. Similar to
4806 the Perl substr() function.
4812 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4817 register char *midend;
4818 register char *bigend;
4824 Perl_croak(aTHX_ "Can't modify non-existent substring");
4825 SvPV_force(bigstr, curlen);
4826 (void)SvPOK_only_UTF8(bigstr);
4827 if (offset + len > curlen) {
4828 SvGROW(bigstr, offset+len+1);
4829 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4830 SvCUR_set(bigstr, offset+len);
4834 i = littlelen - len;
4835 if (i > 0) { /* string might grow */
4836 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4837 mid = big + offset + len;
4838 midend = bigend = big + SvCUR(bigstr);
4841 while (midend > mid) /* shove everything down */
4842 *--bigend = *--midend;
4843 Move(little,big+offset,littlelen,char);
4844 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4849 Move(little,SvPVX(bigstr)+offset,len,char);
4854 big = SvPVX(bigstr);
4857 bigend = big + SvCUR(bigstr);
4859 if (midend > bigend)
4860 Perl_croak(aTHX_ "panic: sv_insert");
4862 if (mid - big > bigend - midend) { /* faster to shorten from end */
4864 Move(little, mid, littlelen,char);
4867 i = bigend - midend;
4869 Move(midend, mid, i,char);
4873 SvCUR_set(bigstr, mid - big);
4875 else if ((i = mid - big)) { /* faster from front */
4876 midend -= littlelen;
4878 sv_chop(bigstr,midend-i);
4883 Move(little, mid, littlelen,char);
4885 else if (littlelen) {
4886 midend -= littlelen;
4887 sv_chop(bigstr,midend);
4888 Move(little,midend,littlelen,char);
4891 sv_chop(bigstr,midend);
4897 =for apidoc sv_replace
4899 Make the first argument a copy of the second, then delete the original.
4900 The target SV physically takes over ownership of the body of the source SV
4901 and inherits its flags; however, the target keeps any magic it owns,
4902 and any magic in the source is discarded.
4903 Note that this is a rather specialist SV copying operation; most of the
4904 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4910 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4913 const U32 refcnt = SvREFCNT(sv);
4914 SV_CHECK_THINKFIRST_COW_DROP(sv);
4915 if (SvREFCNT(nsv) != 1) {
4916 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4917 UVuf " != 1)", (UV) SvREFCNT(nsv));
4919 if (SvMAGICAL(sv)) {
4923 sv_upgrade(nsv, SVt_PVMG);
4924 SvMAGIC_set(nsv, SvMAGIC(sv));
4925 SvFLAGS(nsv) |= SvMAGICAL(sv);
4927 SvMAGIC_set(sv, NULL);
4931 assert(!SvREFCNT(sv));
4932 #ifdef DEBUG_LEAKING_SCALARS
4933 sv->sv_flags = nsv->sv_flags;
4934 sv->sv_any = nsv->sv_any;
4935 sv->sv_refcnt = nsv->sv_refcnt;
4936 sv->sv_u = nsv->sv_u;
4938 StructCopy(nsv,sv,SV);
4940 /* Currently could join these into one piece of pointer arithmetic, but
4941 it would be unclear. */
4942 if(SvTYPE(sv) == SVt_IV)
4944 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4945 else if (SvTYPE(sv) == SVt_RV) {
4946 SvANY(sv) = &sv->sv_u.svu_rv;
4950 #ifdef PERL_OLD_COPY_ON_WRITE
4951 if (SvIsCOW_normal(nsv)) {
4952 /* We need to follow the pointers around the loop to make the
4953 previous SV point to sv, rather than nsv. */
4956 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4959 assert(SvPVX_const(current) == SvPVX_const(nsv));
4961 /* Make the SV before us point to the SV after us. */
4963 PerlIO_printf(Perl_debug_log, "previous is\n");
4965 PerlIO_printf(Perl_debug_log,
4966 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4967 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4969 SV_COW_NEXT_SV_SET(current, sv);
4972 SvREFCNT(sv) = refcnt;
4973 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4979 =for apidoc sv_clear
4981 Clear an SV: call any destructors, free up any memory used by the body,
4982 and free the body itself. The SV's head is I<not> freed, although
4983 its type is set to all 1's so that it won't inadvertently be assumed
4984 to be live during global destruction etc.
4985 This function should only be called when REFCNT is zero. Most of the time
4986 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4993 Perl_sv_clear(pTHX_ register SV *sv)
4996 const U32 type = SvTYPE(sv);
4997 const struct body_details *const sv_type_details
4998 = bodies_by_type + type;
5001 assert(SvREFCNT(sv) == 0);
5003 if (type <= SVt_IV) {
5004 /* See the comment in sv.h about the collusion between this early
5005 return and the overloading of the NULL and IV slots in the size
5011 if (PL_defstash) { /* Still have a symbol table? */
5016 stash = SvSTASH(sv);
5017 destructor = StashHANDLER(stash,DESTROY);
5019 SV* const tmpref = newRV(sv);
5020 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5022 PUSHSTACKi(PERLSI_DESTROY);
5027 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5033 if(SvREFCNT(tmpref) < 2) {
5034 /* tmpref is not kept alive! */
5036 SvRV_set(tmpref, NULL);
5039 SvREFCNT_dec(tmpref);
5041 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5045 if (PL_in_clean_objs)
5046 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5048 /* DESTROY gave object new lease on life */
5054 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5055 SvOBJECT_off(sv); /* Curse the object. */
5056 if (type != SVt_PVIO)
5057 --PL_sv_objcount; /* XXX Might want something more general */
5060 if (type >= SVt_PVMG) {
5062 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5063 (ourstash = OURSTASH(sv))) {
5064 SvREFCNT_dec(ourstash);
5065 } else if (SvMAGIC(sv))
5067 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5068 SvREFCNT_dec(SvSTASH(sv));
5073 IoIFP(sv) != PerlIO_stdin() &&
5074 IoIFP(sv) != PerlIO_stdout() &&
5075 IoIFP(sv) != PerlIO_stderr())
5077 io_close((IO*)sv, FALSE);
5079 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5080 PerlDir_close(IoDIRP(sv));
5081 IoDIRP(sv) = (DIR*)NULL;
5082 Safefree(IoTOP_NAME(sv));
5083 Safefree(IoFMT_NAME(sv));
5084 Safefree(IoBOTTOM_NAME(sv));
5093 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5100 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5101 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5102 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5103 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5105 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5106 SvREFCNT_dec(LvTARG(sv));
5110 if (GvNAME_HEK(sv)) {
5111 unshare_hek(GvNAME_HEK(sv));
5113 /* If we're in a stash, we don't own a reference to it. However it does
5114 have a back reference to us, which needs to be cleared. */
5116 sv_del_backref((SV*)GvSTASH(sv), sv);
5121 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5123 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5124 /* Don't even bother with turning off the OOK flag. */
5129 SV * const target = SvRV(sv);
5131 sv_del_backref(target, sv);
5133 SvREFCNT_dec(target);
5135 #ifdef PERL_OLD_COPY_ON_WRITE
5136 else if (SvPVX_const(sv)) {
5138 /* I believe I need to grab the global SV mutex here and
5139 then recheck the COW status. */
5141 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5144 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5145 SV_COW_NEXT_SV(sv));
5146 /* And drop it here. */
5148 } else if (SvLEN(sv)) {
5149 Safefree(SvPVX_const(sv));
5153 else if (SvPVX_const(sv) && SvLEN(sv))
5154 Safefree(SvPVX_mutable(sv));
5155 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5156 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5165 SvFLAGS(sv) &= SVf_BREAK;
5166 SvFLAGS(sv) |= SVTYPEMASK;
5168 if (sv_type_details->arena) {
5169 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5170 &PL_body_roots[type]);
5172 else if (sv_type_details->body_size) {
5173 my_safefree(SvANY(sv));
5178 =for apidoc sv_newref
5180 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5187 Perl_sv_newref(pTHX_ SV *sv)
5189 PERL_UNUSED_CONTEXT;
5198 Decrement an SV's reference count, and if it drops to zero, call
5199 C<sv_clear> to invoke destructors and free up any memory used by
5200 the body; finally, deallocate the SV's head itself.
5201 Normally called via a wrapper macro C<SvREFCNT_dec>.
5207 Perl_sv_free(pTHX_ SV *sv)
5212 if (SvREFCNT(sv) == 0) {
5213 if (SvFLAGS(sv) & SVf_BREAK)
5214 /* this SV's refcnt has been artificially decremented to
5215 * trigger cleanup */
5217 if (PL_in_clean_all) /* All is fair */
5219 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5220 /* make sure SvREFCNT(sv)==0 happens very seldom */
5221 SvREFCNT(sv) = (~(U32)0)/2;
5224 if (ckWARN_d(WARN_INTERNAL)) {
5225 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5226 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5227 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5228 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5229 Perl_dump_sv_child(aTHX_ sv);
5234 if (--(SvREFCNT(sv)) > 0)
5236 Perl_sv_free2(aTHX_ sv);
5240 Perl_sv_free2(pTHX_ SV *sv)
5245 if (ckWARN_d(WARN_DEBUGGING))
5246 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5247 "Attempt to free temp prematurely: SV 0x%"UVxf
5248 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5252 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5253 /* make sure SvREFCNT(sv)==0 happens very seldom */
5254 SvREFCNT(sv) = (~(U32)0)/2;
5265 Returns the length of the string in the SV. Handles magic and type
5266 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5272 Perl_sv_len(pTHX_ register SV *sv)
5280 len = mg_length(sv);
5282 (void)SvPV_const(sv, len);
5287 =for apidoc sv_len_utf8
5289 Returns the number of characters in the string in an SV, counting wide
5290 UTF-8 bytes as a single character. Handles magic and type coercion.
5296 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5297 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5298 * (Note that the mg_len is not the length of the mg_ptr field.
5299 * This allows the cache to store the character length of the string without
5300 * needing to malloc() extra storage to attach to the mg_ptr.)
5305 Perl_sv_len_utf8(pTHX_ register SV *sv)
5311 return mg_length(sv);
5315 const U8 *s = (U8*)SvPV_const(sv, len);
5319 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5321 if (mg && mg->mg_len != -1) {
5323 if (PL_utf8cache < 0) {
5324 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5326 /* Need to turn the assertions off otherwise we may
5327 recurse infinitely while printing error messages.
5329 SAVEI8(PL_utf8cache);
5331 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5332 " real %"UVf" for %"SVf,
5333 (UV) ulen, (UV) real, sv);
5338 ulen = Perl_utf8_length(aTHX_ s, s + len);
5339 if (!SvREADONLY(sv)) {
5341 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5342 &PL_vtbl_utf8, 0, 0);
5350 return Perl_utf8_length(aTHX_ s, s + len);
5354 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5357 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5360 const U8 *s = start;
5362 PERL_UNUSED_CONTEXT;
5364 while (s < send && uoffset--)
5367 /* This is the existing behaviour. Possibly it should be a croak, as
5368 it's actually a bounds error */
5374 /* Given the length of the string in both bytes and UTF-8 characters, decide
5375 whether to walk forwards or backwards to find the byte corresponding to
5376 the passed in UTF-8 offset. */
5378 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5379 STRLEN uoffset, STRLEN uend)
5381 STRLEN backw = uend - uoffset;
5382 if (uoffset < 2 * backw) {
5383 /* The assumption is that going forwards is twice the speed of going
5384 forward (that's where the 2 * backw comes from).
5385 (The real figure of course depends on the UTF-8 data.) */
5386 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5391 while (UTF8_IS_CONTINUATION(*send))
5394 return send - start;
5397 /* For the string representation of the given scalar, find the byte
5398 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5399 give another position in the string, *before* the sought offset, which
5400 (which is always true, as 0, 0 is a valid pair of positions), which should
5401 help reduce the amount of linear searching.
5402 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5403 will be used to reduce the amount of linear searching. The cache will be
5404 created if necessary, and the found value offered to it for update. */
5406 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5407 const U8 *const send, STRLEN uoffset,
5408 STRLEN uoffset0, STRLEN boffset0) {
5409 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5412 assert (uoffset >= uoffset0);
5414 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5415 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5416 if ((*mgp)->mg_ptr) {
5417 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5418 if (cache[0] == uoffset) {
5419 /* An exact match. */
5422 if (cache[2] == uoffset) {
5423 /* An exact match. */
5427 if (cache[0] < uoffset) {
5428 /* The cache already knows part of the way. */
5429 if (cache[0] > uoffset0) {
5430 /* The cache knows more than the passed in pair */
5431 uoffset0 = cache[0];
5432 boffset0 = cache[1];
5434 if ((*mgp)->mg_len != -1) {
5435 /* And we know the end too. */
5437 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5439 (*mgp)->mg_len - uoffset0);
5442 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5443 send, uoffset - uoffset0);
5446 else if (cache[2] < uoffset) {
5447 /* We're between the two cache entries. */
5448 if (cache[2] > uoffset0) {
5449 /* and the cache knows more than the passed in pair */
5450 uoffset0 = cache[2];
5451 boffset0 = cache[3];
5455 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5458 cache[0] - uoffset0);
5461 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5464 cache[2] - uoffset0);
5468 else if ((*mgp)->mg_len != -1) {
5469 /* If we can take advantage of a passed in offset, do so. */
5470 /* In fact, offset0 is either 0, or less than offset, so don't
5471 need to worry about the other possibility. */
5473 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5475 (*mgp)->mg_len - uoffset0);
5480 if (!found || PL_utf8cache < 0) {
5481 const STRLEN real_boffset
5482 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5483 send, uoffset - uoffset0);
5485 if (found && PL_utf8cache < 0) {
5486 if (real_boffset != boffset) {
5487 /* Need to turn the assertions off otherwise we may recurse
5488 infinitely while printing error messages. */
5489 SAVEI8(PL_utf8cache);
5491 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5492 " real %"UVf" for %"SVf,
5493 (UV) boffset, (UV) real_boffset, sv);
5496 boffset = real_boffset;
5499 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5505 =for apidoc sv_pos_u2b
5507 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5508 the start of the string, to a count of the equivalent number of bytes; if
5509 lenp is non-zero, it does the same to lenp, but this time starting from
5510 the offset, rather than from the start of the string. Handles magic and
5517 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5518 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5519 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5524 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5532 start = (U8*)SvPV_const(sv, len);
5534 STRLEN uoffset = (STRLEN) *offsetp;
5535 const U8 * const send = start + len;
5537 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5540 *offsetp = (I32) boffset;
5543 /* Convert the relative offset to absolute. */
5544 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5546 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5547 uoffset, boffset) - boffset;
5561 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5562 byte length pairing. The (byte) length of the total SV is passed in too,
5563 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5564 may not have updated SvCUR, so we can't rely on reading it directly.
5566 The proffered utf8/byte length pairing isn't used if the cache already has
5567 two pairs, and swapping either for the proffered pair would increase the
5568 RMS of the intervals between known byte offsets.
5570 The cache itself consists of 4 STRLEN values
5571 0: larger UTF-8 offset
5572 1: corresponding byte offset
5573 2: smaller UTF-8 offset
5574 3: corresponding byte offset
5576 Unused cache pairs have the value 0, 0.
5577 Keeping the cache "backwards" means that the invariant of
5578 cache[0] >= cache[2] is maintained even with empty slots, which means that
5579 the code that uses it doesn't need to worry if only 1 entry has actually
5580 been set to non-zero. It also makes the "position beyond the end of the
5581 cache" logic much simpler, as the first slot is always the one to start
5585 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5593 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5595 (*mgp)->mg_len = -1;
5599 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5600 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5601 (*mgp)->mg_ptr = (char *) cache;
5605 if (PL_utf8cache < 0) {
5606 const U8 *start = (const U8 *) SvPVX_const(sv);
5607 const U8 *const end = start + byte;
5608 STRLEN realutf8 = 0;
5610 while (start < end) {
5611 start += UTF8SKIP(start);
5615 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5616 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5617 doesn't? I don't know whether this difference was introduced with
5618 the caching code in 5.8.1. */
5620 if (realutf8 != utf8) {
5621 /* Need to turn the assertions off otherwise we may recurse
5622 infinitely while printing error messages. */
5623 SAVEI8(PL_utf8cache);
5625 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5626 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5630 /* Cache is held with the later position first, to simplify the code
5631 that deals with unbounded ends. */
5633 ASSERT_UTF8_CACHE(cache);
5634 if (cache[1] == 0) {
5635 /* Cache is totally empty */
5638 } else if (cache[3] == 0) {
5639 if (byte > cache[1]) {
5640 /* New one is larger, so goes first. */
5641 cache[2] = cache[0];
5642 cache[3] = cache[1];
5650 #define THREEWAY_SQUARE(a,b,c,d) \
5651 ((float)((d) - (c))) * ((float)((d) - (c))) \
5652 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5653 + ((float)((b) - (a))) * ((float)((b) - (a)))
5655 /* Cache has 2 slots in use, and we know three potential pairs.
5656 Keep the two that give the lowest RMS distance. Do the
5657 calcualation in bytes simply because we always know the byte
5658 length. squareroot has the same ordering as the positive value,
5659 so don't bother with the actual square root. */
5660 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5661 if (byte > cache[1]) {
5662 /* New position is after the existing pair of pairs. */
5663 const float keep_earlier
5664 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5665 const float keep_later
5666 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5668 if (keep_later < keep_earlier) {
5669 if (keep_later < existing) {
5670 cache[2] = cache[0];
5671 cache[3] = cache[1];
5677 if (keep_earlier < existing) {
5683 else if (byte > cache[3]) {
5684 /* New position is between the existing pair of pairs. */
5685 const float keep_earlier
5686 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5687 const float keep_later
5688 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5690 if (keep_later < keep_earlier) {
5691 if (keep_later < existing) {
5697 if (keep_earlier < existing) {
5704 /* New position is before the existing pair of pairs. */
5705 const float keep_earlier
5706 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5707 const float keep_later
5708 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5710 if (keep_later < keep_earlier) {
5711 if (keep_later < existing) {
5717 if (keep_earlier < existing) {
5718 cache[0] = cache[2];
5719 cache[1] = cache[3];
5726 ASSERT_UTF8_CACHE(cache);
5729 /* If we don't know the character offset of the end of a region, our only
5730 option is to walk forwards to the target byte offset. */
5732 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5735 while (s < target) {
5738 /* Call utf8n_to_uvchr() to validate the sequence
5739 * (unless a simple non-UTF character) */
5740 if (!UTF8_IS_INVARIANT(*s))
5741 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5752 /* We already know all of the way, now we may be able to walk back. The same
5753 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5754 backward is half the speed of walking forward. */
5756 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5759 const STRLEN forw = target - s;
5760 STRLEN backw = end - target;
5762 if (forw < 2 * backw) {
5763 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5766 while (end > target) {
5768 while (UTF8_IS_CONTINUATION(*end)) {
5777 =for apidoc sv_pos_b2u
5779 Converts the value pointed to by offsetp from a count of bytes from the
5780 start of the string, to a count of the equivalent number of UTF-8 chars.
5781 Handles magic and type coercion.
5787 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5788 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5793 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5796 const STRLEN byte = *offsetp;
5797 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5806 s = (const U8*)SvPV_const(sv, blen);
5809 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5813 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5814 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5816 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5817 if (cache[1] == byte) {
5818 /* An exact match. */
5819 *offsetp = cache[0];
5822 if (cache[3] == byte) {
5823 /* An exact match. */
5824 *offsetp = cache[2];
5828 if (cache[1] < byte) {
5829 /* We already know part of the way. */
5830 if (mg->mg_len != -1) {
5831 /* Actually, we know the end too. */
5833 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5834 s + blen, mg->mg_len - cache[0]);
5837 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5840 else if (cache[3] < byte) {
5841 /* We're between the two cached pairs, so we do the calculation
5842 offset by the byte/utf-8 positions for the earlier pair,
5843 then add the utf-8 characters from the string start to
5845 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5846 s + cache[1], cache[0] - cache[2])
5850 else { /* cache[3] > byte */
5851 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5855 ASSERT_UTF8_CACHE(cache);
5857 } else if (mg->mg_len != -1) {
5858 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5862 if (!found || PL_utf8cache < 0) {
5863 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5865 if (found && PL_utf8cache < 0) {
5866 if (len != real_len) {
5867 /* Need to turn the assertions off otherwise we may recurse
5868 infinitely while printing error messages. */
5869 SAVEI8(PL_utf8cache);
5871 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5872 " real %"UVf" for %"SVf,
5873 (UV) len, (UV) real_len, sv);
5880 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5886 Returns a boolean indicating whether the strings in the two SVs are
5887 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5888 coerce its args to strings if necessary.
5894 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5903 SV* svrecode = NULL;
5910 pv1 = SvPV_const(sv1, cur1);
5917 pv2 = SvPV_const(sv2, cur2);
5919 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5920 /* Differing utf8ness.
5921 * Do not UTF8size the comparands as a side-effect. */
5924 svrecode = newSVpvn(pv2, cur2);
5925 sv_recode_to_utf8(svrecode, PL_encoding);
5926 pv2 = SvPV_const(svrecode, cur2);
5929 svrecode = newSVpvn(pv1, cur1);
5930 sv_recode_to_utf8(svrecode, PL_encoding);
5931 pv1 = SvPV_const(svrecode, cur1);
5933 /* Now both are in UTF-8. */
5935 SvREFCNT_dec(svrecode);
5940 bool is_utf8 = TRUE;
5943 /* sv1 is the UTF-8 one,
5944 * if is equal it must be downgrade-able */
5945 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5951 /* sv2 is the UTF-8 one,
5952 * if is equal it must be downgrade-able */
5953 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5959 /* Downgrade not possible - cannot be eq */
5967 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5969 SvREFCNT_dec(svrecode);
5979 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5980 string in C<sv1> is less than, equal to, or greater than the string in
5981 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5982 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5988 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5992 const char *pv1, *pv2;
5995 SV *svrecode = NULL;
6002 pv1 = SvPV_const(sv1, cur1);
6009 pv2 = SvPV_const(sv2, cur2);
6011 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6012 /* Differing utf8ness.
6013 * Do not UTF8size the comparands as a side-effect. */
6016 svrecode = newSVpvn(pv2, cur2);
6017 sv_recode_to_utf8(svrecode, PL_encoding);
6018 pv2 = SvPV_const(svrecode, cur2);
6021 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6026 svrecode = newSVpvn(pv1, cur1);
6027 sv_recode_to_utf8(svrecode, PL_encoding);
6028 pv1 = SvPV_const(svrecode, cur1);
6031 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6037 cmp = cur2 ? -1 : 0;
6041 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6044 cmp = retval < 0 ? -1 : 1;
6045 } else if (cur1 == cur2) {
6048 cmp = cur1 < cur2 ? -1 : 1;
6052 SvREFCNT_dec(svrecode);
6060 =for apidoc sv_cmp_locale
6062 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6063 'use bytes' aware, handles get magic, and will coerce its args to strings
6064 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6070 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6073 #ifdef USE_LOCALE_COLLATE
6079 if (PL_collation_standard)
6083 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6085 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6087 if (!pv1 || !len1) {
6098 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6101 return retval < 0 ? -1 : 1;
6104 * When the result of collation is equality, that doesn't mean
6105 * that there are no differences -- some locales exclude some
6106 * characters from consideration. So to avoid false equalities,
6107 * we use the raw string as a tiebreaker.
6113 #endif /* USE_LOCALE_COLLATE */
6115 return sv_cmp(sv1, sv2);
6119 #ifdef USE_LOCALE_COLLATE
6122 =for apidoc sv_collxfrm
6124 Add Collate Transform magic to an SV if it doesn't already have it.
6126 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6127 scalar data of the variable, but transformed to such a format that a normal
6128 memory comparison can be used to compare the data according to the locale
6135 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6140 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6141 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6147 Safefree(mg->mg_ptr);
6148 s = SvPV_const(sv, len);
6149 if ((xf = mem_collxfrm(s, len, &xlen))) {
6150 if (SvREADONLY(sv)) {
6153 return xf + sizeof(PL_collation_ix);
6156 #ifdef PERL_OLD_COPY_ON_WRITE
6158 sv_force_normal_flags(sv, 0);
6160 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6174 if (mg && mg->mg_ptr) {
6176 return mg->mg_ptr + sizeof(PL_collation_ix);
6184 #endif /* USE_LOCALE_COLLATE */
6189 Get a line from the filehandle and store it into the SV, optionally
6190 appending to the currently-stored string.
6196 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6201 register STDCHAR rslast;
6202 register STDCHAR *bp;
6207 if (SvTHINKFIRST(sv))
6208 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6209 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6211 However, perlbench says it's slower, because the existing swipe code
6212 is faster than copy on write.
6213 Swings and roundabouts. */
6214 SvUPGRADE(sv, SVt_PV);
6219 if (PerlIO_isutf8(fp)) {
6221 sv_utf8_upgrade_nomg(sv);
6222 sv_pos_u2b(sv,&append,0);
6224 } else if (SvUTF8(sv)) {
6225 SV * const tsv = newSV(0);
6226 sv_gets(tsv, fp, 0);
6227 sv_utf8_upgrade_nomg(tsv);
6228 SvCUR_set(sv,append);
6231 goto return_string_or_null;
6236 if (PerlIO_isutf8(fp))
6239 if (IN_PERL_COMPILETIME) {
6240 /* we always read code in line mode */
6244 else if (RsSNARF(PL_rs)) {
6245 /* If it is a regular disk file use size from stat() as estimate
6246 of amount we are going to read -- may result in mallocing
6247 more memory than we really need if the layers below reduce
6248 the size we read (e.g. CRLF or a gzip layer).
6251 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6252 const Off_t offset = PerlIO_tell(fp);
6253 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6254 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6260 else if (RsRECORD(PL_rs)) {
6265 /* Grab the size of the record we're getting */
6266 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6267 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6270 /* VMS wants read instead of fread, because fread doesn't respect */
6271 /* RMS record boundaries. This is not necessarily a good thing to be */
6272 /* doing, but we've got no other real choice - except avoid stdio
6273 as implementation - perhaps write a :vms layer ?
6275 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6277 bytesread = PerlIO_read(fp, buffer, recsize);
6281 SvCUR_set(sv, bytesread += append);
6282 buffer[bytesread] = '\0';
6283 goto return_string_or_null;
6285 else if (RsPARA(PL_rs)) {
6291 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6292 if (PerlIO_isutf8(fp)) {
6293 rsptr = SvPVutf8(PL_rs, rslen);
6296 if (SvUTF8(PL_rs)) {
6297 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6298 Perl_croak(aTHX_ "Wide character in $/");
6301 rsptr = SvPV_const(PL_rs, rslen);
6305 rslast = rslen ? rsptr[rslen - 1] : '\0';
6307 if (rspara) { /* have to do this both before and after */
6308 do { /* to make sure file boundaries work right */
6311 i = PerlIO_getc(fp);
6315 PerlIO_ungetc(fp,i);
6321 /* See if we know enough about I/O mechanism to cheat it ! */
6323 /* This used to be #ifdef test - it is made run-time test for ease
6324 of abstracting out stdio interface. One call should be cheap
6325 enough here - and may even be a macro allowing compile
6329 if (PerlIO_fast_gets(fp)) {
6332 * We're going to steal some values from the stdio struct
6333 * and put EVERYTHING in the innermost loop into registers.
6335 register STDCHAR *ptr;
6339 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6340 /* An ungetc()d char is handled separately from the regular
6341 * buffer, so we getc() it back out and stuff it in the buffer.
6343 i = PerlIO_getc(fp);
6344 if (i == EOF) return 0;
6345 *(--((*fp)->_ptr)) = (unsigned char) i;
6349 /* Here is some breathtakingly efficient cheating */
6351 cnt = PerlIO_get_cnt(fp); /* get count into register */
6352 /* make sure we have the room */
6353 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6354 /* Not room for all of it
6355 if we are looking for a separator and room for some
6357 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6358 /* just process what we have room for */
6359 shortbuffered = cnt - SvLEN(sv) + append + 1;
6360 cnt -= shortbuffered;
6364 /* remember that cnt can be negative */
6365 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6370 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6371 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6372 DEBUG_P(PerlIO_printf(Perl_debug_log,
6373 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6374 DEBUG_P(PerlIO_printf(Perl_debug_log,
6375 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6376 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6377 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6382 while (cnt > 0) { /* this | eat */
6384 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6385 goto thats_all_folks; /* screams | sed :-) */
6389 Copy(ptr, bp, cnt, char); /* this | eat */
6390 bp += cnt; /* screams | dust */
6391 ptr += cnt; /* louder | sed :-) */
6396 if (shortbuffered) { /* oh well, must extend */
6397 cnt = shortbuffered;
6399 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6401 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6402 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6406 DEBUG_P(PerlIO_printf(Perl_debug_log,
6407 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6408 PTR2UV(ptr),(long)cnt));
6409 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6411 DEBUG_P(PerlIO_printf(Perl_debug_log,
6412 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6413 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6414 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6416 /* This used to call 'filbuf' in stdio form, but as that behaves like
6417 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6418 another abstraction. */
6419 i = PerlIO_getc(fp); /* get more characters */
6421 DEBUG_P(PerlIO_printf(Perl_debug_log,
6422 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6423 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6424 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6426 cnt = PerlIO_get_cnt(fp);
6427 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6428 DEBUG_P(PerlIO_printf(Perl_debug_log,
6429 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6431 if (i == EOF) /* all done for ever? */
6432 goto thats_really_all_folks;
6434 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6436 SvGROW(sv, bpx + cnt + 2);
6437 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6439 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6441 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6442 goto thats_all_folks;
6446 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6447 memNE((char*)bp - rslen, rsptr, rslen))
6448 goto screamer; /* go back to the fray */
6449 thats_really_all_folks:
6451 cnt += shortbuffered;
6452 DEBUG_P(PerlIO_printf(Perl_debug_log,
6453 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6454 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6455 DEBUG_P(PerlIO_printf(Perl_debug_log,
6456 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6457 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6458 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6460 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6461 DEBUG_P(PerlIO_printf(Perl_debug_log,
6462 "Screamer: done, len=%ld, string=|%.*s|\n",
6463 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6467 /*The big, slow, and stupid way. */
6468 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6469 STDCHAR *buf = NULL;
6470 Newx(buf, 8192, STDCHAR);
6478 register const STDCHAR * const bpe = buf + sizeof(buf);
6480 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6481 ; /* keep reading */
6485 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6486 /* Accomodate broken VAXC compiler, which applies U8 cast to
6487 * both args of ?: operator, causing EOF to change into 255
6490 i = (U8)buf[cnt - 1];
6496 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6498 sv_catpvn(sv, (char *) buf, cnt);
6500 sv_setpvn(sv, (char *) buf, cnt);
6502 if (i != EOF && /* joy */
6504 SvCUR(sv) < rslen ||
6505 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6509 * If we're reading from a TTY and we get a short read,
6510 * indicating that the user hit his EOF character, we need
6511 * to notice it now, because if we try to read from the TTY
6512 * again, the EOF condition will disappear.
6514 * The comparison of cnt to sizeof(buf) is an optimization
6515 * that prevents unnecessary calls to feof().
6519 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6523 #ifdef USE_HEAP_INSTEAD_OF_STACK
6528 if (rspara) { /* have to do this both before and after */
6529 while (i != EOF) { /* to make sure file boundaries work right */
6530 i = PerlIO_getc(fp);
6532 PerlIO_ungetc(fp,i);
6538 return_string_or_null:
6539 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6545 Auto-increment of the value in the SV, doing string to numeric conversion
6546 if necessary. Handles 'get' magic.
6552 Perl_sv_inc(pTHX_ register SV *sv)
6561 if (SvTHINKFIRST(sv)) {
6563 sv_force_normal_flags(sv, 0);
6564 if (SvREADONLY(sv)) {
6565 if (IN_PERL_RUNTIME)
6566 Perl_croak(aTHX_ PL_no_modify);
6570 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6572 i = PTR2IV(SvRV(sv));
6577 flags = SvFLAGS(sv);
6578 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6579 /* It's (privately or publicly) a float, but not tested as an
6580 integer, so test it to see. */
6582 flags = SvFLAGS(sv);
6584 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6585 /* It's publicly an integer, or privately an integer-not-float */
6586 #ifdef PERL_PRESERVE_IVUV
6590 if (SvUVX(sv) == UV_MAX)
6591 sv_setnv(sv, UV_MAX_P1);
6593 (void)SvIOK_only_UV(sv);
6594 SvUV_set(sv, SvUVX(sv) + 1);
6596 if (SvIVX(sv) == IV_MAX)
6597 sv_setuv(sv, (UV)IV_MAX + 1);
6599 (void)SvIOK_only(sv);
6600 SvIV_set(sv, SvIVX(sv) + 1);
6605 if (flags & SVp_NOK) {
6606 (void)SvNOK_only(sv);
6607 SvNV_set(sv, SvNVX(sv) + 1.0);
6611 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6612 if ((flags & SVTYPEMASK) < SVt_PVIV)
6613 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6614 (void)SvIOK_only(sv);
6619 while (isALPHA(*d)) d++;
6620 while (isDIGIT(*d)) d++;
6622 #ifdef PERL_PRESERVE_IVUV
6623 /* Got to punt this as an integer if needs be, but we don't issue
6624 warnings. Probably ought to make the sv_iv_please() that does
6625 the conversion if possible, and silently. */
6626 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6627 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6628 /* Need to try really hard to see if it's an integer.
6629 9.22337203685478e+18 is an integer.
6630 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6631 so $a="9.22337203685478e+18"; $a+0; $a++
6632 needs to be the same as $a="9.22337203685478e+18"; $a++
6639 /* sv_2iv *should* have made this an NV */
6640 if (flags & SVp_NOK) {
6641 (void)SvNOK_only(sv);
6642 SvNV_set(sv, SvNVX(sv) + 1.0);
6645 /* I don't think we can get here. Maybe I should assert this
6646 And if we do get here I suspect that sv_setnv will croak. NWC
6648 #if defined(USE_LONG_DOUBLE)
6649 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",
6650 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6652 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6653 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6656 #endif /* PERL_PRESERVE_IVUV */
6657 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6661 while (d >= SvPVX_const(sv)) {
6669 /* MKS: The original code here died if letters weren't consecutive.
6670 * at least it didn't have to worry about non-C locales. The
6671 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6672 * arranged in order (although not consecutively) and that only
6673 * [A-Za-z] are accepted by isALPHA in the C locale.
6675 if (*d != 'z' && *d != 'Z') {
6676 do { ++*d; } while (!isALPHA(*d));
6679 *(d--) -= 'z' - 'a';
6684 *(d--) -= 'z' - 'a' + 1;
6688 /* oh,oh, the number grew */
6689 SvGROW(sv, SvCUR(sv) + 2);
6690 SvCUR_set(sv, SvCUR(sv) + 1);
6691 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6702 Auto-decrement of the value in the SV, doing string to numeric conversion
6703 if necessary. Handles 'get' magic.
6709 Perl_sv_dec(pTHX_ register SV *sv)
6717 if (SvTHINKFIRST(sv)) {
6719 sv_force_normal_flags(sv, 0);
6720 if (SvREADONLY(sv)) {
6721 if (IN_PERL_RUNTIME)
6722 Perl_croak(aTHX_ PL_no_modify);
6726 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6728 i = PTR2IV(SvRV(sv));
6733 /* Unlike sv_inc we don't have to worry about string-never-numbers
6734 and keeping them magic. But we mustn't warn on punting */
6735 flags = SvFLAGS(sv);
6736 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6737 /* It's publicly an integer, or privately an integer-not-float */
6738 #ifdef PERL_PRESERVE_IVUV
6742 if (SvUVX(sv) == 0) {
6743 (void)SvIOK_only(sv);
6747 (void)SvIOK_only_UV(sv);
6748 SvUV_set(sv, SvUVX(sv) - 1);
6751 if (SvIVX(sv) == IV_MIN)
6752 sv_setnv(sv, (NV)IV_MIN - 1.0);
6754 (void)SvIOK_only(sv);
6755 SvIV_set(sv, SvIVX(sv) - 1);
6760 if (flags & SVp_NOK) {
6761 SvNV_set(sv, SvNVX(sv) - 1.0);
6762 (void)SvNOK_only(sv);
6765 if (!(flags & SVp_POK)) {
6766 if ((flags & SVTYPEMASK) < SVt_PVIV)
6767 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6769 (void)SvIOK_only(sv);
6772 #ifdef PERL_PRESERVE_IVUV
6774 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6775 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6776 /* Need to try really hard to see if it's an integer.
6777 9.22337203685478e+18 is an integer.
6778 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6779 so $a="9.22337203685478e+18"; $a+0; $a--
6780 needs to be the same as $a="9.22337203685478e+18"; $a--
6787 /* sv_2iv *should* have made this an NV */
6788 if (flags & SVp_NOK) {
6789 (void)SvNOK_only(sv);
6790 SvNV_set(sv, SvNVX(sv) - 1.0);
6793 /* I don't think we can get here. Maybe I should assert this
6794 And if we do get here I suspect that sv_setnv will croak. NWC
6796 #if defined(USE_LONG_DOUBLE)
6797 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",
6798 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6800 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6801 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6805 #endif /* PERL_PRESERVE_IVUV */
6806 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6810 =for apidoc sv_mortalcopy
6812 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6813 The new SV is marked as mortal. It will be destroyed "soon", either by an
6814 explicit call to FREETMPS, or by an implicit call at places such as
6815 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6820 /* Make a string that will exist for the duration of the expression
6821 * evaluation. Actually, it may have to last longer than that, but
6822 * hopefully we won't free it until it has been assigned to a
6823 * permanent location. */
6826 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6832 sv_setsv(sv,oldstr);
6834 PL_tmps_stack[++PL_tmps_ix] = sv;
6840 =for apidoc sv_newmortal
6842 Creates a new null SV which is mortal. The reference count of the SV is
6843 set to 1. It will be destroyed "soon", either by an explicit call to
6844 FREETMPS, or by an implicit call at places such as statement boundaries.
6845 See also C<sv_mortalcopy> and C<sv_2mortal>.
6851 Perl_sv_newmortal(pTHX)
6857 SvFLAGS(sv) = SVs_TEMP;
6859 PL_tmps_stack[++PL_tmps_ix] = sv;
6864 =for apidoc sv_2mortal
6866 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6867 by an explicit call to FREETMPS, or by an implicit call at places such as
6868 statement boundaries. SvTEMP() is turned on which means that the SV's
6869 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6870 and C<sv_mortalcopy>.
6876 Perl_sv_2mortal(pTHX_ register SV *sv)
6881 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6884 PL_tmps_stack[++PL_tmps_ix] = sv;
6892 Creates a new SV and copies a string into it. The reference count for the
6893 SV is set to 1. If C<len> is zero, Perl will compute the length using
6894 strlen(). For efficiency, consider using C<newSVpvn> instead.
6900 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6906 sv_setpvn(sv,s,len ? len : strlen(s));
6911 =for apidoc newSVpvn
6913 Creates a new SV and copies a string into it. The reference count for the
6914 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6915 string. You are responsible for ensuring that the source string is at least
6916 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6922 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6928 sv_setpvn(sv,s,len);
6934 =for apidoc newSVhek
6936 Creates a new SV from the hash key structure. It will generate scalars that
6937 point to the shared string table where possible. Returns a new (undefined)
6938 SV if the hek is NULL.
6944 Perl_newSVhek(pTHX_ const HEK *hek)
6954 if (HEK_LEN(hek) == HEf_SVKEY) {
6955 return newSVsv(*(SV**)HEK_KEY(hek));
6957 const int flags = HEK_FLAGS(hek);
6958 if (flags & HVhek_WASUTF8) {
6960 Andreas would like keys he put in as utf8 to come back as utf8
6962 STRLEN utf8_len = HEK_LEN(hek);
6963 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6964 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6967 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6969 } else if (flags & HVhek_REHASH) {
6970 /* We don't have a pointer to the hv, so we have to replicate the
6971 flag into every HEK. This hv is using custom a hasing
6972 algorithm. Hence we can't return a shared string scalar, as
6973 that would contain the (wrong) hash value, and might get passed
6974 into an hv routine with a regular hash */
6976 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6981 /* This will be overwhelminly the most common case. */
6983 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6984 more efficient than sharepvn(). */
6988 sv_upgrade(sv, SVt_PV);
6989 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
6990 SvCUR_set(sv, HEK_LEN(hek));
7003 =for apidoc newSVpvn_share
7005 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7006 table. If the string does not already exist in the table, it is created
7007 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7008 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7009 otherwise the hash is computed. The idea here is that as the string table
7010 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7011 hash lookup will avoid string compare.
7017 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7021 bool is_utf8 = FALSE;
7022 const char *const orig_src = src;
7025 STRLEN tmplen = -len;
7027 /* See the note in hv.c:hv_fetch() --jhi */
7028 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7032 PERL_HASH(hash, src, len);
7034 sv_upgrade(sv, SVt_PV);
7035 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7043 if (src != orig_src)
7049 #if defined(PERL_IMPLICIT_CONTEXT)
7051 /* pTHX_ magic can't cope with varargs, so this is a no-context
7052 * version of the main function, (which may itself be aliased to us).
7053 * Don't access this version directly.
7057 Perl_newSVpvf_nocontext(const char* pat, ...)
7062 va_start(args, pat);
7063 sv = vnewSVpvf(pat, &args);
7070 =for apidoc newSVpvf
7072 Creates a new SV and initializes it with the string formatted like
7079 Perl_newSVpvf(pTHX_ const char* pat, ...)
7083 va_start(args, pat);
7084 sv = vnewSVpvf(pat, &args);
7089 /* backend for newSVpvf() and newSVpvf_nocontext() */
7092 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7097 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7104 Creates a new SV and copies a floating point value into it.
7105 The reference count for the SV is set to 1.
7111 Perl_newSVnv(pTHX_ NV n)
7124 Creates a new SV and copies an integer into it. The reference count for the
7131 Perl_newSViv(pTHX_ IV i)
7144 Creates a new SV and copies an unsigned integer into it.
7145 The reference count for the SV is set to 1.
7151 Perl_newSVuv(pTHX_ UV u)
7162 =for apidoc newRV_noinc
7164 Creates an RV wrapper for an SV. The reference count for the original
7165 SV is B<not> incremented.
7171 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7177 sv_upgrade(sv, SVt_RV);
7179 SvRV_set(sv, tmpRef);
7184 /* newRV_inc is the official function name to use now.
7185 * newRV_inc is in fact #defined to newRV in sv.h
7189 Perl_newRV(pTHX_ SV *sv)
7192 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7198 Creates a new SV which is an exact duplicate of the original SV.
7205 Perl_newSVsv(pTHX_ register SV *old)
7212 if (SvTYPE(old) == SVTYPEMASK) {
7213 if (ckWARN_d(WARN_INTERNAL))
7214 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7218 /* SV_GMAGIC is the default for sv_setv()
7219 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7220 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7221 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7226 =for apidoc sv_reset
7228 Underlying implementation for the C<reset> Perl function.
7229 Note that the perl-level function is vaguely deprecated.
7235 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7238 char todo[PERL_UCHAR_MAX+1];
7243 if (!*s) { /* reset ?? searches */
7244 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7246 PMOP *pm = (PMOP *) mg->mg_obj;
7248 pm->op_pmdynflags &= ~PMdf_USED;
7255 /* reset variables */
7257 if (!HvARRAY(stash))
7260 Zero(todo, 256, char);
7263 I32 i = (unsigned char)*s;
7267 max = (unsigned char)*s++;
7268 for ( ; i <= max; i++) {
7271 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7273 for (entry = HvARRAY(stash)[i];
7275 entry = HeNEXT(entry))
7280 if (!todo[(U8)*HeKEY(entry)])
7282 gv = (GV*)HeVAL(entry);
7285 if (SvTHINKFIRST(sv)) {
7286 if (!SvREADONLY(sv) && SvROK(sv))
7288 /* XXX Is this continue a bug? Why should THINKFIRST
7289 exempt us from resetting arrays and hashes? */
7293 if (SvTYPE(sv) >= SVt_PV) {
7295 if (SvPVX_const(sv) != NULL)
7303 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7305 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7308 # if defined(USE_ENVIRON_ARRAY)
7311 # endif /* USE_ENVIRON_ARRAY */
7322 Using various gambits, try to get an IO from an SV: the IO slot if its a
7323 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7324 named after the PV if we're a string.
7330 Perl_sv_2io(pTHX_ SV *sv)
7335 switch (SvTYPE(sv)) {
7343 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7347 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7349 return sv_2io(SvRV(sv));
7350 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7356 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7365 Using various gambits, try to get a CV from an SV; in addition, try if
7366 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7367 The flags in C<lref> are passed to sv_fetchsv.
7373 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7384 switch (SvTYPE(sv)) {
7403 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7404 tryAMAGICunDEREF(to_cv);
7407 if (SvTYPE(sv) == SVt_PVCV) {
7416 Perl_croak(aTHX_ "Not a subroutine reference");
7421 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7427 /* Some flags to gv_fetchsv mean don't really create the GV */
7428 if (SvTYPE(gv) != SVt_PVGV) {
7434 if (lref && !GvCVu(gv)) {
7438 gv_efullname3(tmpsv, gv, NULL);
7439 /* XXX this is probably not what they think they're getting.
7440 * It has the same effect as "sub name;", i.e. just a forward
7442 newSUB(start_subparse(FALSE, 0),
7443 newSVOP(OP_CONST, 0, tmpsv),
7447 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7457 Returns true if the SV has a true value by Perl's rules.
7458 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7459 instead use an in-line version.
7465 Perl_sv_true(pTHX_ register SV *sv)
7470 register const XPV* const tXpv = (XPV*)SvANY(sv);
7472 (tXpv->xpv_cur > 1 ||
7473 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7480 return SvIVX(sv) != 0;
7483 return SvNVX(sv) != 0.0;
7485 return sv_2bool(sv);
7491 =for apidoc sv_pvn_force
7493 Get a sensible string out of the SV somehow.
7494 A private implementation of the C<SvPV_force> macro for compilers which
7495 can't cope with complex macro expressions. Always use the macro instead.
7497 =for apidoc sv_pvn_force_flags
7499 Get a sensible string out of the SV somehow.
7500 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7501 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7502 implemented in terms of this function.
7503 You normally want to use the various wrapper macros instead: see
7504 C<SvPV_force> and C<SvPV_force_nomg>
7510 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7513 if (SvTHINKFIRST(sv) && !SvROK(sv))
7514 sv_force_normal_flags(sv, 0);
7524 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7525 const char * const ref = sv_reftype(sv,0);
7527 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7528 ref, OP_NAME(PL_op));
7530 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7532 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7533 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7535 s = sv_2pv_flags(sv, &len, flags);
7539 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7542 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7543 SvGROW(sv, len + 1);
7544 Move(s,SvPVX(sv),len,char);
7549 SvPOK_on(sv); /* validate pointer */
7551 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7552 PTR2UV(sv),SvPVX_const(sv)));
7555 return SvPVX_mutable(sv);
7559 =for apidoc sv_pvbyten_force
7561 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7567 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7569 sv_pvn_force(sv,lp);
7570 sv_utf8_downgrade(sv,0);
7576 =for apidoc sv_pvutf8n_force
7578 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7584 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7586 sv_pvn_force(sv,lp);
7587 sv_utf8_upgrade(sv);
7593 =for apidoc sv_reftype
7595 Returns a string describing what the SV is a reference to.
7601 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7603 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7604 inside return suggests a const propagation bug in g++. */
7605 if (ob && SvOBJECT(sv)) {
7606 char * const name = HvNAME_get(SvSTASH(sv));
7607 return name ? name : (char *) "__ANON__";
7610 switch (SvTYPE(sv)) {
7627 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7628 /* tied lvalues should appear to be
7629 * scalars for backwards compatitbility */
7630 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7631 ? "SCALAR" : "LVALUE");
7632 case SVt_PVAV: return "ARRAY";
7633 case SVt_PVHV: return "HASH";
7634 case SVt_PVCV: return "CODE";
7635 case SVt_PVGV: return "GLOB";
7636 case SVt_PVFM: return "FORMAT";
7637 case SVt_PVIO: return "IO";
7638 default: return "UNKNOWN";
7644 =for apidoc sv_isobject
7646 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7647 object. If the SV is not an RV, or if the object is not blessed, then this
7654 Perl_sv_isobject(pTHX_ SV *sv)
7670 Returns a boolean indicating whether the SV is blessed into the specified
7671 class. This does not check for subtypes; use C<sv_derived_from> to verify
7672 an inheritance relationship.
7678 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7689 hvname = HvNAME_get(SvSTASH(sv));
7693 return strEQ(hvname, name);
7699 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7700 it will be upgraded to one. If C<classname> is non-null then the new SV will
7701 be blessed in the specified package. The new SV is returned and its
7702 reference count is 1.
7708 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7715 SV_CHECK_THINKFIRST_COW_DROP(rv);
7718 if (SvTYPE(rv) >= SVt_PVMG) {
7719 const U32 refcnt = SvREFCNT(rv);
7723 SvREFCNT(rv) = refcnt;
7725 sv_upgrade(rv, SVt_RV);
7726 } else if (SvROK(rv)) {
7727 SvREFCNT_dec(SvRV(rv));
7728 } else if (SvTYPE(rv) < SVt_RV)
7729 sv_upgrade(rv, SVt_RV);
7730 else if (SvTYPE(rv) > SVt_RV) {
7741 HV* const stash = gv_stashpv(classname, TRUE);
7742 (void)sv_bless(rv, stash);
7748 =for apidoc sv_setref_pv
7750 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7751 argument will be upgraded to an RV. That RV will be modified to point to
7752 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7753 into the SV. The C<classname> argument indicates the package for the
7754 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7755 will have a reference count of 1, and the RV will be returned.
7757 Do not use with other Perl types such as HV, AV, SV, CV, because those
7758 objects will become corrupted by the pointer copy process.
7760 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7766 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7770 sv_setsv(rv, &PL_sv_undef);
7774 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7779 =for apidoc sv_setref_iv
7781 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7782 argument will be upgraded to an RV. That RV will be modified to point to
7783 the new SV. The C<classname> argument indicates the package for the
7784 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7785 will have a reference count of 1, and the RV will be returned.
7791 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7793 sv_setiv(newSVrv(rv,classname), iv);
7798 =for apidoc sv_setref_uv
7800 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7801 argument will be upgraded to an RV. That RV will be modified to point to
7802 the new SV. The C<classname> argument indicates the package for the
7803 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7804 will have a reference count of 1, and the RV will be returned.
7810 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7812 sv_setuv(newSVrv(rv,classname), uv);
7817 =for apidoc sv_setref_nv
7819 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7820 argument will be upgraded to an RV. That RV will be modified to point to
7821 the new SV. The C<classname> argument indicates the package for the
7822 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7823 will have a reference count of 1, and the RV will be returned.
7829 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7831 sv_setnv(newSVrv(rv,classname), nv);
7836 =for apidoc sv_setref_pvn
7838 Copies a string into a new SV, optionally blessing the SV. The length of the
7839 string must be specified with C<n>. The C<rv> argument will be upgraded to
7840 an RV. That RV will be modified to point to the new SV. The C<classname>
7841 argument indicates the package for the blessing. Set C<classname> to
7842 C<NULL> to avoid the blessing. The new SV will have a reference count
7843 of 1, and the RV will be returned.
7845 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7851 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7853 sv_setpvn(newSVrv(rv,classname), pv, n);
7858 =for apidoc sv_bless
7860 Blesses an SV into a specified package. The SV must be an RV. The package
7861 must be designated by its stash (see C<gv_stashpv()>). The reference count
7862 of the SV is unaffected.
7868 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7873 Perl_croak(aTHX_ "Can't bless non-reference value");
7875 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7876 if (SvREADONLY(tmpRef))
7877 Perl_croak(aTHX_ PL_no_modify);
7878 if (SvOBJECT(tmpRef)) {
7879 if (SvTYPE(tmpRef) != SVt_PVIO)
7881 SvREFCNT_dec(SvSTASH(tmpRef));
7884 SvOBJECT_on(tmpRef);
7885 if (SvTYPE(tmpRef) != SVt_PVIO)
7887 SvUPGRADE(tmpRef, SVt_PVMG);
7888 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7895 if(SvSMAGICAL(tmpRef))
7896 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7904 /* Downgrades a PVGV to a PVMG.
7908 S_sv_unglob(pTHX_ SV *sv)
7912 SV * const temp = sv_newmortal();
7914 assert(SvTYPE(sv) == SVt_PVGV);
7916 gv_efullname3(temp, (GV *) sv, "*");
7922 sv_del_backref((SV*)GvSTASH(sv), sv);
7926 if (GvNAME_HEK(sv)) {
7927 unshare_hek(GvNAME_HEK(sv));
7931 /* need to keep SvANY(sv) in the right arena */
7932 xpvmg = new_XPVMG();
7933 StructCopy(SvANY(sv), xpvmg, XPVMG);
7934 del_XPVGV(SvANY(sv));
7937 SvFLAGS(sv) &= ~SVTYPEMASK;
7938 SvFLAGS(sv) |= SVt_PVMG;
7940 /* Intentionally not calling any local SET magic, as this isn't so much a
7941 set operation as merely an internal storage change. */
7942 sv_setsv_flags(sv, temp, 0);
7946 =for apidoc sv_unref_flags
7948 Unsets the RV status of the SV, and decrements the reference count of
7949 whatever was being referenced by the RV. This can almost be thought of
7950 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7951 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7952 (otherwise the decrementing is conditional on the reference count being
7953 different from one or the reference being a readonly SV).
7960 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7962 SV* const target = SvRV(ref);
7964 if (SvWEAKREF(ref)) {
7965 sv_del_backref(target, ref);
7967 SvRV_set(ref, NULL);
7970 SvRV_set(ref, NULL);
7972 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7973 assigned to as BEGIN {$a = \"Foo"} will fail. */
7974 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7975 SvREFCNT_dec(target);
7976 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7977 sv_2mortal(target); /* Schedule for freeing later */
7981 =for apidoc sv_untaint
7983 Untaint an SV. Use C<SvTAINTED_off> instead.
7988 Perl_sv_untaint(pTHX_ SV *sv)
7990 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7991 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7998 =for apidoc sv_tainted
8000 Test an SV for taintedness. Use C<SvTAINTED> instead.
8005 Perl_sv_tainted(pTHX_ SV *sv)
8007 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8008 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8009 if (mg && (mg->mg_len & 1) )
8016 =for apidoc sv_setpviv
8018 Copies an integer into the given SV, also updating its string value.
8019 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8025 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8027 char buf[TYPE_CHARS(UV)];
8029 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8031 sv_setpvn(sv, ptr, ebuf - ptr);
8035 =for apidoc sv_setpviv_mg
8037 Like C<sv_setpviv>, but also handles 'set' magic.
8043 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8049 #if defined(PERL_IMPLICIT_CONTEXT)
8051 /* pTHX_ magic can't cope with varargs, so this is a no-context
8052 * version of the main function, (which may itself be aliased to us).
8053 * Don't access this version directly.
8057 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8061 va_start(args, pat);
8062 sv_vsetpvf(sv, pat, &args);
8066 /* pTHX_ magic can't cope with varargs, so this is a no-context
8067 * version of the main function, (which may itself be aliased to us).
8068 * Don't access this version directly.
8072 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8076 va_start(args, pat);
8077 sv_vsetpvf_mg(sv, pat, &args);
8083 =for apidoc sv_setpvf
8085 Works like C<sv_catpvf> but copies the text into the SV instead of
8086 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8092 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8095 va_start(args, pat);
8096 sv_vsetpvf(sv, pat, &args);
8101 =for apidoc sv_vsetpvf
8103 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8104 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8106 Usually used via its frontend C<sv_setpvf>.
8112 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8114 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8118 =for apidoc sv_setpvf_mg
8120 Like C<sv_setpvf>, but also handles 'set' magic.
8126 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8129 va_start(args, pat);
8130 sv_vsetpvf_mg(sv, pat, &args);
8135 =for apidoc sv_vsetpvf_mg
8137 Like C<sv_vsetpvf>, but also handles 'set' magic.
8139 Usually used via its frontend C<sv_setpvf_mg>.
8145 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8147 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8151 #if defined(PERL_IMPLICIT_CONTEXT)
8153 /* pTHX_ magic can't cope with varargs, so this is a no-context
8154 * version of the main function, (which may itself be aliased to us).
8155 * Don't access this version directly.
8159 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8163 va_start(args, pat);
8164 sv_vcatpvf(sv, pat, &args);
8168 /* pTHX_ magic can't cope with varargs, so this is a no-context
8169 * version of the main function, (which may itself be aliased to us).
8170 * Don't access this version directly.
8174 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8178 va_start(args, pat);
8179 sv_vcatpvf_mg(sv, pat, &args);
8185 =for apidoc sv_catpvf
8187 Processes its arguments like C<sprintf> and appends the formatted
8188 output to an SV. If the appended data contains "wide" characters
8189 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8190 and characters >255 formatted with %c), the original SV might get
8191 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8192 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8193 valid UTF-8; if the original SV was bytes, the pattern should be too.
8198 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8201 va_start(args, pat);
8202 sv_vcatpvf(sv, pat, &args);
8207 =for apidoc sv_vcatpvf
8209 Processes its arguments like C<vsprintf> and appends the formatted output
8210 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8212 Usually used via its frontend C<sv_catpvf>.
8218 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8220 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8224 =for apidoc sv_catpvf_mg
8226 Like C<sv_catpvf>, but also handles 'set' magic.
8232 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8235 va_start(args, pat);
8236 sv_vcatpvf_mg(sv, pat, &args);
8241 =for apidoc sv_vcatpvf_mg
8243 Like C<sv_vcatpvf>, but also handles 'set' magic.
8245 Usually used via its frontend C<sv_catpvf_mg>.
8251 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8253 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8258 =for apidoc sv_vsetpvfn
8260 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8263 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8269 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8271 sv_setpvn(sv, "", 0);
8272 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8276 S_expect_number(pTHX_ char** pattern)
8280 switch (**pattern) {
8281 case '1': case '2': case '3':
8282 case '4': case '5': case '6':
8283 case '7': case '8': case '9':
8284 var = *(*pattern)++ - '0';
8285 while (isDIGIT(**pattern)) {
8286 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8288 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8296 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8298 const int neg = nv < 0;
8307 if (uv & 1 && uv == nv)
8308 uv--; /* Round to even */
8310 const unsigned dig = uv % 10;
8323 =for apidoc sv_vcatpvfn
8325 Processes its arguments like C<vsprintf> and appends the formatted output
8326 to an SV. Uses an array of SVs if the C style variable argument list is
8327 missing (NULL). When running with taint checks enabled, indicates via
8328 C<maybe_tainted> if results are untrustworthy (often due to the use of
8331 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8337 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8338 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8339 vec_utf8 = DO_UTF8(vecsv);
8341 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8344 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8352 static const char nullstr[] = "(null)";
8354 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8355 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8357 /* Times 4: a decimal digit takes more than 3 binary digits.
8358 * NV_DIG: mantissa takes than many decimal digits.
8359 * Plus 32: Playing safe. */
8360 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8361 /* large enough for "%#.#f" --chip */
8362 /* what about long double NVs? --jhi */
8364 PERL_UNUSED_ARG(maybe_tainted);
8366 /* no matter what, this is a string now */
8367 (void)SvPV_force(sv, origlen);
8369 /* special-case "", "%s", and "%-p" (SVf - see below) */
8372 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8374 const char * const s = va_arg(*args, char*);
8375 sv_catpv(sv, s ? s : nullstr);
8377 else if (svix < svmax) {
8378 sv_catsv(sv, *svargs);
8382 if (args && patlen == 3 && pat[0] == '%' &&
8383 pat[1] == '-' && pat[2] == 'p') {
8384 argsv = va_arg(*args, SV*);
8385 sv_catsv(sv, argsv);
8389 #ifndef USE_LONG_DOUBLE
8390 /* special-case "%.<number>[gf]" */
8391 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8392 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8393 unsigned digits = 0;
8397 while (*pp >= '0' && *pp <= '9')
8398 digits = 10 * digits + (*pp++ - '0');
8399 if (pp - pat == (int)patlen - 1) {
8407 /* Add check for digits != 0 because it seems that some
8408 gconverts are buggy in this case, and we don't yet have
8409 a Configure test for this. */
8410 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8411 /* 0, point, slack */
8412 Gconvert(nv, (int)digits, 0, ebuf);
8414 if (*ebuf) /* May return an empty string for digits==0 */
8417 } else if (!digits) {
8420 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8421 sv_catpvn(sv, p, l);
8427 #endif /* !USE_LONG_DOUBLE */
8429 if (!args && svix < svmax && DO_UTF8(*svargs))
8432 patend = (char*)pat + patlen;
8433 for (p = (char*)pat; p < patend; p = q) {
8436 bool vectorize = FALSE;
8437 bool vectorarg = FALSE;
8438 bool vec_utf8 = FALSE;
8444 bool has_precis = FALSE;
8446 const I32 osvix = svix;
8447 bool is_utf8 = FALSE; /* is this item utf8? */
8448 #ifdef HAS_LDBL_SPRINTF_BUG
8449 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8450 with sfio - Allen <allens@cpan.org> */
8451 bool fix_ldbl_sprintf_bug = FALSE;
8455 U8 utf8buf[UTF8_MAXBYTES+1];
8456 STRLEN esignlen = 0;
8458 const char *eptr = NULL;
8461 const U8 *vecstr = NULL;
8468 /* we need a long double target in case HAS_LONG_DOUBLE but
8471 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8479 const char *dotstr = ".";
8480 STRLEN dotstrlen = 1;
8481 I32 efix = 0; /* explicit format parameter index */
8482 I32 ewix = 0; /* explicit width index */
8483 I32 epix = 0; /* explicit precision index */
8484 I32 evix = 0; /* explicit vector index */
8485 bool asterisk = FALSE;
8487 /* echo everything up to the next format specification */
8488 for (q = p; q < patend && *q != '%'; ++q) ;
8490 if (has_utf8 && !pat_utf8)
8491 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8493 sv_catpvn(sv, p, q - p);
8500 We allow format specification elements in this order:
8501 \d+\$ explicit format parameter index
8503 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8504 0 flag (as above): repeated to allow "v02"
8505 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8506 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8508 [%bcdefginopsuxDFOUX] format (mandatory)
8513 As of perl5.9.3, printf format checking is on by default.
8514 Internally, perl uses %p formats to provide an escape to
8515 some extended formatting. This block deals with those
8516 extensions: if it does not match, (char*)q is reset and
8517 the normal format processing code is used.
8519 Currently defined extensions are:
8520 %p include pointer address (standard)
8521 %-p (SVf) include an SV (previously %_)
8522 %-<num>p include an SV with precision <num>
8523 %1p (VDf) include a v-string (as %vd)
8524 %<num>p reserved for future extensions
8526 Robin Barker 2005-07-14
8533 n = expect_number(&q);
8540 argsv = va_arg(*args, SV*);
8541 eptr = SvPVx_const(argsv, elen);
8547 else if (n == vdNUMBER) { /* VDf */
8554 if (ckWARN_d(WARN_INTERNAL))
8555 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8556 "internal %%<num>p might conflict with future printf extensions");
8562 if ( (width = expect_number(&q)) ) {
8603 if ( (ewix = expect_number(&q)) )
8612 if ((vectorarg = asterisk)) {
8625 width = expect_number(&q);
8631 vecsv = va_arg(*args, SV*);
8633 vecsv = (evix > 0 && evix <= svmax)
8634 ? svargs[evix-1] : &PL_sv_undef;
8636 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8638 dotstr = SvPV_const(vecsv, dotstrlen);
8639 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8640 bad with tied or overloaded values that return UTF8. */
8643 else if (has_utf8) {
8644 vecsv = sv_mortalcopy(vecsv);
8645 sv_utf8_upgrade(vecsv);
8646 dotstr = SvPV_const(vecsv, dotstrlen);
8653 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8654 vecsv = svargs[efix ? efix-1 : svix++];
8655 vecstr = (U8*)SvPV_const(vecsv,veclen);
8656 vec_utf8 = DO_UTF8(vecsv);
8658 /* if this is a version object, we need to convert
8659 * back into v-string notation and then let the
8660 * vectorize happen normally
8662 if (sv_derived_from(vecsv, "version")) {
8663 char *version = savesvpv(vecsv);
8664 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8665 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8666 "vector argument not supported with alpha versions");
8669 vecsv = sv_newmortal();
8670 /* scan_vstring is expected to be called during
8671 * tokenization, so we need to fake up the end
8672 * of the buffer for it
8674 PL_bufend = version + veclen;
8675 scan_vstring(version, vecsv);
8676 vecstr = (U8*)SvPV_const(vecsv, veclen);
8677 vec_utf8 = DO_UTF8(vecsv);
8689 i = va_arg(*args, int);
8691 i = (ewix ? ewix <= svmax : svix < svmax) ?
8692 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8694 width = (i < 0) ? -i : i;
8704 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8706 /* XXX: todo, support specified precision parameter */
8710 i = va_arg(*args, int);
8712 i = (ewix ? ewix <= svmax : svix < svmax)
8713 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8714 precis = (i < 0) ? 0 : i;
8719 precis = precis * 10 + (*q++ - '0');
8728 case 'I': /* Ix, I32x, and I64x */
8730 if (q[1] == '6' && q[2] == '4') {
8736 if (q[1] == '3' && q[2] == '2') {
8746 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8757 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8758 if (*(q + 1) == 'l') { /* lld, llf */
8784 if (!vectorize && !args) {
8786 const I32 i = efix-1;
8787 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8789 argsv = (svix >= 0 && svix < svmax)
8790 ? svargs[svix++] : &PL_sv_undef;
8801 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8803 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8805 eptr = (char*)utf8buf;
8806 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8820 eptr = va_arg(*args, char*);
8822 #ifdef MACOS_TRADITIONAL
8823 /* On MacOS, %#s format is used for Pascal strings */
8828 elen = strlen(eptr);
8830 eptr = (char *)nullstr;
8831 elen = sizeof nullstr - 1;
8835 eptr = SvPVx_const(argsv, elen);
8836 if (DO_UTF8(argsv)) {
8837 if (has_precis && precis < elen) {
8839 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8842 if (width) { /* fudge width (can't fudge elen) */
8843 width += elen - sv_len_utf8(argsv);
8850 if (has_precis && elen > precis)
8857 if (alt || vectorize)
8859 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8880 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8889 esignbuf[esignlen++] = plus;
8893 case 'h': iv = (short)va_arg(*args, int); break;
8894 case 'l': iv = va_arg(*args, long); break;
8895 case 'V': iv = va_arg(*args, IV); break;
8896 default: iv = va_arg(*args, int); break;
8898 case 'q': iv = va_arg(*args, Quad_t); break;
8903 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8905 case 'h': iv = (short)tiv; break;
8906 case 'l': iv = (long)tiv; break;
8908 default: iv = tiv; break;
8910 case 'q': iv = (Quad_t)tiv; break;
8914 if ( !vectorize ) /* we already set uv above */
8919 esignbuf[esignlen++] = plus;
8923 esignbuf[esignlen++] = '-';
8966 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8977 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8978 case 'l': uv = va_arg(*args, unsigned long); break;
8979 case 'V': uv = va_arg(*args, UV); break;
8980 default: uv = va_arg(*args, unsigned); break;
8982 case 'q': uv = va_arg(*args, Uquad_t); break;
8987 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8989 case 'h': uv = (unsigned short)tuv; break;
8990 case 'l': uv = (unsigned long)tuv; break;
8992 default: uv = tuv; break;
8994 case 'q': uv = (Uquad_t)tuv; break;
9001 char *ptr = ebuf + sizeof ebuf;
9007 p = (char*)((c == 'X')
9008 ? "0123456789ABCDEF" : "0123456789abcdef");
9014 esignbuf[esignlen++] = '0';
9015 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9023 if (alt && *ptr != '0')
9034 esignbuf[esignlen++] = '0';
9035 esignbuf[esignlen++] = 'b';
9038 default: /* it had better be ten or less */
9042 } while (uv /= base);
9045 elen = (ebuf + sizeof ebuf) - ptr;
9049 zeros = precis - elen;
9050 else if (precis == 0 && elen == 1 && *eptr == '0')
9056 /* FLOATING POINT */
9059 c = 'f'; /* maybe %F isn't supported here */
9067 /* This is evil, but floating point is even more evil */
9069 /* for SV-style calling, we can only get NV
9070 for C-style calling, we assume %f is double;
9071 for simplicity we allow any of %Lf, %llf, %qf for long double
9075 #if defined(USE_LONG_DOUBLE)
9079 /* [perl #20339] - we should accept and ignore %lf rather than die */
9083 #if defined(USE_LONG_DOUBLE)
9084 intsize = args ? 0 : 'q';
9088 #if defined(HAS_LONG_DOUBLE)
9097 /* now we need (long double) if intsize == 'q', else (double) */
9099 #if LONG_DOUBLESIZE > DOUBLESIZE
9101 va_arg(*args, long double) :
9102 va_arg(*args, double)
9104 va_arg(*args, double)
9109 if (c != 'e' && c != 'E') {
9111 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9112 will cast our (long double) to (double) */
9113 (void)Perl_frexp(nv, &i);
9114 if (i == PERL_INT_MIN)
9115 Perl_die(aTHX_ "panic: frexp");
9117 need = BIT_DIGITS(i);
9119 need += has_precis ? precis : 6; /* known default */
9124 #ifdef HAS_LDBL_SPRINTF_BUG
9125 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9126 with sfio - Allen <allens@cpan.org> */
9129 # define MY_DBL_MAX DBL_MAX
9130 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9131 # if DOUBLESIZE >= 8
9132 # define MY_DBL_MAX 1.7976931348623157E+308L
9134 # define MY_DBL_MAX 3.40282347E+38L
9138 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9139 # define MY_DBL_MAX_BUG 1L
9141 # define MY_DBL_MAX_BUG MY_DBL_MAX
9145 # define MY_DBL_MIN DBL_MIN
9146 # else /* XXX guessing! -Allen */
9147 # if DOUBLESIZE >= 8
9148 # define MY_DBL_MIN 2.2250738585072014E-308L
9150 # define MY_DBL_MIN 1.17549435E-38L
9154 if ((intsize == 'q') && (c == 'f') &&
9155 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9157 /* it's going to be short enough that
9158 * long double precision is not needed */
9160 if ((nv <= 0L) && (nv >= -0L))
9161 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9163 /* would use Perl_fp_class as a double-check but not
9164 * functional on IRIX - see perl.h comments */
9166 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9167 /* It's within the range that a double can represent */
9168 #if defined(DBL_MAX) && !defined(DBL_MIN)
9169 if ((nv >= ((long double)1/DBL_MAX)) ||
9170 (nv <= (-(long double)1/DBL_MAX)))
9172 fix_ldbl_sprintf_bug = TRUE;
9175 if (fix_ldbl_sprintf_bug == TRUE) {
9185 # undef MY_DBL_MAX_BUG
9188 #endif /* HAS_LDBL_SPRINTF_BUG */
9190 need += 20; /* fudge factor */
9191 if (PL_efloatsize < need) {
9192 Safefree(PL_efloatbuf);
9193 PL_efloatsize = need + 20; /* more fudge */
9194 Newx(PL_efloatbuf, PL_efloatsize, char);
9195 PL_efloatbuf[0] = '\0';
9198 if ( !(width || left || plus || alt) && fill != '0'
9199 && has_precis && intsize != 'q' ) { /* Shortcuts */
9200 /* See earlier comment about buggy Gconvert when digits,
9202 if ( c == 'g' && precis) {
9203 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9204 /* May return an empty string for digits==0 */
9205 if (*PL_efloatbuf) {
9206 elen = strlen(PL_efloatbuf);
9207 goto float_converted;
9209 } else if ( c == 'f' && !precis) {
9210 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9215 char *ptr = ebuf + sizeof ebuf;
9218 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9219 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9220 if (intsize == 'q') {
9221 /* Copy the one or more characters in a long double
9222 * format before the 'base' ([efgEFG]) character to
9223 * the format string. */
9224 static char const prifldbl[] = PERL_PRIfldbl;
9225 char const *p = prifldbl + sizeof(prifldbl) - 3;
9226 while (p >= prifldbl) { *--ptr = *p--; }
9231 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9236 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9248 /* No taint. Otherwise we are in the strange situation
9249 * where printf() taints but print($float) doesn't.
9251 #if defined(HAS_LONG_DOUBLE)
9252 elen = ((intsize == 'q')
9253 ? my_sprintf(PL_efloatbuf, ptr, nv)
9254 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9256 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9260 eptr = PL_efloatbuf;
9268 i = SvCUR(sv) - origlen;
9271 case 'h': *(va_arg(*args, short*)) = i; break;
9272 default: *(va_arg(*args, int*)) = i; break;
9273 case 'l': *(va_arg(*args, long*)) = i; break;
9274 case 'V': *(va_arg(*args, IV*)) = i; break;
9276 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9281 sv_setuv_mg(argsv, (UV)i);
9282 continue; /* not "break" */
9289 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9290 && ckWARN(WARN_PRINTF))
9292 SV * const msg = sv_newmortal();
9293 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9294 (PL_op->op_type == OP_PRTF) ? "" : "s");
9297 Perl_sv_catpvf(aTHX_ msg,
9298 "\"%%%c\"", c & 0xFF);
9300 Perl_sv_catpvf(aTHX_ msg,
9301 "\"%%\\%03"UVof"\"",
9304 sv_catpvs(msg, "end of string");
9305 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9308 /* output mangled stuff ... */
9314 /* ... right here, because formatting flags should not apply */
9315 SvGROW(sv, SvCUR(sv) + elen + 1);
9317 Copy(eptr, p, elen, char);
9320 SvCUR_set(sv, p - SvPVX_const(sv));
9322 continue; /* not "break" */
9325 /* calculate width before utf8_upgrade changes it */
9326 have = esignlen + zeros + elen;
9328 Perl_croak_nocontext(PL_memory_wrap);
9330 if (is_utf8 != has_utf8) {
9333 sv_utf8_upgrade(sv);
9336 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9337 sv_utf8_upgrade(nsv);
9338 eptr = SvPVX_const(nsv);
9341 SvGROW(sv, SvCUR(sv) + elen + 1);
9346 need = (have > width ? have : width);
9349 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9350 Perl_croak_nocontext(PL_memory_wrap);
9351 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9353 if (esignlen && fill == '0') {
9355 for (i = 0; i < (int)esignlen; i++)
9359 memset(p, fill, gap);
9362 if (esignlen && fill != '0') {
9364 for (i = 0; i < (int)esignlen; i++)
9369 for (i = zeros; i; i--)
9373 Copy(eptr, p, elen, char);
9377 memset(p, ' ', gap);
9382 Copy(dotstr, p, dotstrlen, char);
9386 vectorize = FALSE; /* done iterating over vecstr */
9393 SvCUR_set(sv, p - SvPVX_const(sv));
9401 /* =========================================================================
9403 =head1 Cloning an interpreter
9405 All the macros and functions in this section are for the private use of
9406 the main function, perl_clone().
9408 The foo_dup() functions make an exact copy of an existing foo thinngy.
9409 During the course of a cloning, a hash table is used to map old addresses
9410 to new addresses. The table is created and manipulated with the
9411 ptr_table_* functions.
9415 ============================================================================*/
9418 #if defined(USE_ITHREADS)
9420 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9421 #ifndef GpREFCNT_inc
9422 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9426 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9427 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9428 please unmerge ss_dup. */
9429 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9430 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9431 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9432 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9433 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9434 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9435 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9436 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9437 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9438 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9439 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9440 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9441 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9442 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9445 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9446 regcomp.c. AMS 20010712 */
9449 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9454 struct reg_substr_datum *s;
9457 return (REGEXP *)NULL;
9459 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9462 len = r->offsets[0];
9463 npar = r->nparens+1;
9465 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9466 Copy(r->program, ret->program, len+1, regnode);
9468 Newx(ret->startp, npar, I32);
9469 Copy(r->startp, ret->startp, npar, I32);
9470 Newx(ret->endp, npar, I32);
9471 Copy(r->startp, ret->startp, npar, I32);
9473 Newx(ret->substrs, 1, struct reg_substr_data);
9474 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9475 s->min_offset = r->substrs->data[i].min_offset;
9476 s->max_offset = r->substrs->data[i].max_offset;
9477 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9478 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9481 ret->regstclass = NULL;
9484 const int count = r->data->count;
9487 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9488 char, struct reg_data);
9489 Newx(d->what, count, U8);
9492 for (i = 0; i < count; i++) {
9493 d->what[i] = r->data->what[i];
9494 switch (d->what[i]) {
9495 /* legal options are one of: sfpont
9496 see also regcomp.h and pregfree() */
9498 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9501 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9504 /* This is cheating. */
9505 Newx(d->data[i], 1, struct regnode_charclass_class);
9506 StructCopy(r->data->data[i], d->data[i],
9507 struct regnode_charclass_class);
9508 ret->regstclass = (regnode*)d->data[i];
9511 /* Compiled op trees are readonly, and can thus be
9512 shared without duplication. */
9514 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9518 d->data[i] = r->data->data[i];
9521 d->data[i] = r->data->data[i];
9523 ((reg_trie_data*)d->data[i])->refcount++;
9527 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9536 Newx(ret->offsets, 2*len+1, U32);
9537 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9539 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9540 ret->refcnt = r->refcnt;
9541 ret->minlen = r->minlen;
9542 ret->prelen = r->prelen;
9543 ret->nparens = r->nparens;
9544 ret->lastparen = r->lastparen;
9545 ret->lastcloseparen = r->lastcloseparen;
9546 ret->reganch = r->reganch;
9548 ret->sublen = r->sublen;
9550 if (RX_MATCH_COPIED(ret))
9551 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9554 #ifdef PERL_OLD_COPY_ON_WRITE
9555 ret->saved_copy = NULL;
9558 ptr_table_store(PL_ptr_table, r, ret);
9562 /* duplicate a file handle */
9565 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9569 PERL_UNUSED_ARG(type);
9572 return (PerlIO*)NULL;
9574 /* look for it in the table first */
9575 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9579 /* create anew and remember what it is */
9580 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9581 ptr_table_store(PL_ptr_table, fp, ret);
9585 /* duplicate a directory handle */
9588 Perl_dirp_dup(pTHX_ DIR *dp)
9590 PERL_UNUSED_CONTEXT;
9597 /* duplicate a typeglob */
9600 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9606 /* look for it in the table first */
9607 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9611 /* create anew and remember what it is */
9613 ptr_table_store(PL_ptr_table, gp, ret);
9616 ret->gp_refcnt = 0; /* must be before any other dups! */
9617 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9618 ret->gp_io = io_dup_inc(gp->gp_io, param);
9619 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9620 ret->gp_av = av_dup_inc(gp->gp_av, param);
9621 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9622 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9623 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9624 ret->gp_cvgen = gp->gp_cvgen;
9625 ret->gp_line = gp->gp_line;
9626 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9630 /* duplicate a chain of magic */
9633 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9635 MAGIC *mgprev = (MAGIC*)NULL;
9638 return (MAGIC*)NULL;
9639 /* look for it in the table first */
9640 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9644 for (; mg; mg = mg->mg_moremagic) {
9646 Newxz(nmg, 1, MAGIC);
9648 mgprev->mg_moremagic = nmg;
9651 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9652 nmg->mg_private = mg->mg_private;
9653 nmg->mg_type = mg->mg_type;
9654 nmg->mg_flags = mg->mg_flags;
9655 if (mg->mg_type == PERL_MAGIC_qr) {
9656 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9658 else if(mg->mg_type == PERL_MAGIC_backref) {
9659 /* The backref AV has its reference count deliberately bumped by
9661 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9663 else if (mg->mg_type == PERL_MAGIC_symtab) {
9664 nmg->mg_obj = mg->mg_obj;
9667 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9668 ? sv_dup_inc(mg->mg_obj, param)
9669 : sv_dup(mg->mg_obj, param);
9671 nmg->mg_len = mg->mg_len;
9672 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9673 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9674 if (mg->mg_len > 0) {
9675 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9676 if (mg->mg_type == PERL_MAGIC_overload_table &&
9677 AMT_AMAGIC((AMT*)mg->mg_ptr))
9679 const AMT * const amtp = (AMT*)mg->mg_ptr;
9680 AMT * const namtp = (AMT*)nmg->mg_ptr;
9682 for (i = 1; i < NofAMmeth; i++) {
9683 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9687 else if (mg->mg_len == HEf_SVKEY)
9688 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9690 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9691 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9698 /* create a new pointer-mapping table */
9701 Perl_ptr_table_new(pTHX)
9704 PERL_UNUSED_CONTEXT;
9706 Newxz(tbl, 1, PTR_TBL_t);
9709 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9713 #define PTR_TABLE_HASH(ptr) \
9714 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9717 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9718 following define) and at call to new_body_inline made below in
9719 Perl_ptr_table_store()
9722 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9724 /* map an existing pointer using a table */
9726 STATIC PTR_TBL_ENT_t *
9727 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9728 PTR_TBL_ENT_t *tblent;
9729 const UV hash = PTR_TABLE_HASH(sv);
9731 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9732 for (; tblent; tblent = tblent->next) {
9733 if (tblent->oldval == sv)
9740 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9742 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9743 PERL_UNUSED_CONTEXT;
9744 return tblent ? tblent->newval : NULL;
9747 /* add a new entry to a pointer-mapping table */
9750 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9752 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9753 PERL_UNUSED_CONTEXT;
9756 tblent->newval = newsv;
9758 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9760 new_body_inline(tblent, PTE_SVSLOT);
9762 tblent->oldval = oldsv;
9763 tblent->newval = newsv;
9764 tblent->next = tbl->tbl_ary[entry];
9765 tbl->tbl_ary[entry] = tblent;
9767 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9768 ptr_table_split(tbl);
9772 /* double the hash bucket size of an existing ptr table */
9775 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9777 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9778 const UV oldsize = tbl->tbl_max + 1;
9779 UV newsize = oldsize * 2;
9781 PERL_UNUSED_CONTEXT;
9783 Renew(ary, newsize, PTR_TBL_ENT_t*);
9784 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9785 tbl->tbl_max = --newsize;
9787 for (i=0; i < oldsize; i++, ary++) {
9788 PTR_TBL_ENT_t **curentp, **entp, *ent;
9791 curentp = ary + oldsize;
9792 for (entp = ary, ent = *ary; ent; ent = *entp) {
9793 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9795 ent->next = *curentp;
9805 /* remove all the entries from a ptr table */
9808 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9810 if (tbl && tbl->tbl_items) {
9811 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9812 UV riter = tbl->tbl_max;
9815 PTR_TBL_ENT_t *entry = array[riter];
9818 PTR_TBL_ENT_t * const oentry = entry;
9819 entry = entry->next;
9828 /* clear and free a ptr table */
9831 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9836 ptr_table_clear(tbl);
9837 Safefree(tbl->tbl_ary);
9843 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9846 SvRV_set(dstr, SvWEAKREF(sstr)
9847 ? sv_dup(SvRV(sstr), param)
9848 : sv_dup_inc(SvRV(sstr), param));
9851 else if (SvPVX_const(sstr)) {
9852 /* Has something there */
9854 /* Normal PV - clone whole allocated space */
9855 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9856 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9857 /* Not that normal - actually sstr is copy on write.
9858 But we are a true, independant SV, so: */
9859 SvREADONLY_off(dstr);
9864 /* Special case - not normally malloced for some reason */
9865 if (isGV_with_GP(sstr)) {
9866 /* Don't need to do anything here. */
9868 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9869 /* A "shared" PV - clone it as "shared" PV */
9871 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9875 /* Some other special case - random pointer */
9876 SvPV_set(dstr, SvPVX(sstr));
9882 if (SvTYPE(dstr) == SVt_RV)
9883 SvRV_set(dstr, NULL);
9885 SvPV_set(dstr, NULL);
9889 /* duplicate an SV of any type (including AV, HV etc) */
9892 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9897 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9899 /* look for it in the table first */
9900 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9904 if(param->flags & CLONEf_JOIN_IN) {
9905 /** We are joining here so we don't want do clone
9906 something that is bad **/
9907 if (SvTYPE(sstr) == SVt_PVHV) {
9908 const char * const hvname = HvNAME_get(sstr);
9910 /** don't clone stashes if they already exist **/
9911 return (SV*)gv_stashpv(hvname,0);
9915 /* create anew and remember what it is */
9918 #ifdef DEBUG_LEAKING_SCALARS
9919 dstr->sv_debug_optype = sstr->sv_debug_optype;
9920 dstr->sv_debug_line = sstr->sv_debug_line;
9921 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9922 dstr->sv_debug_cloned = 1;
9923 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9926 ptr_table_store(PL_ptr_table, sstr, dstr);
9929 SvFLAGS(dstr) = SvFLAGS(sstr);
9930 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9931 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9934 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9935 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9936 PL_watch_pvx, SvPVX_const(sstr));
9939 /* don't clone objects whose class has asked us not to */
9940 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9941 SvFLAGS(dstr) &= ~SVTYPEMASK;
9946 switch (SvTYPE(sstr)) {
9951 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9952 SvIV_set(dstr, SvIVX(sstr));
9955 SvANY(dstr) = new_XNV();
9956 SvNV_set(dstr, SvNVX(sstr));
9959 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9960 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9964 /* These are all the types that need complex bodies allocating. */
9966 const svtype sv_type = SvTYPE(sstr);
9967 const struct body_details *const sv_type_details
9968 = bodies_by_type + sv_type;
9972 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9976 if (GvUNIQUE((GV*)sstr)) {
9977 /*EMPTY*/; /* Do sharing here, and fall through */
9990 assert(sv_type_details->body_size);
9991 if (sv_type_details->arena) {
9992 new_body_inline(new_body, sv_type);
9994 = (void*)((char*)new_body - sv_type_details->offset);
9996 new_body = new_NOARENA(sv_type_details);
10000 SvANY(dstr) = new_body;
10003 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10004 ((char*)SvANY(dstr)) + sv_type_details->offset,
10005 sv_type_details->copy, char);
10007 Copy(((char*)SvANY(sstr)),
10008 ((char*)SvANY(dstr)),
10009 sv_type_details->body_size + sv_type_details->offset, char);
10012 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10013 && !isGV_with_GP(dstr))
10014 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10016 /* The Copy above means that all the source (unduplicated) pointers
10017 are now in the destination. We can check the flags and the
10018 pointers in either, but it's possible that there's less cache
10019 missing by always going for the destination.
10020 FIXME - instrument and check that assumption */
10021 if (sv_type >= SVt_PVMG) {
10023 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
10024 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
10025 } else if (SvMAGIC(dstr))
10026 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10028 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10031 /* The cast silences a GCC warning about unhandled types. */
10032 switch ((int)sv_type) {
10044 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10045 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10046 LvTARG(dstr) = dstr;
10047 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10048 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10050 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10053 if (GvNAME_HEK(dstr))
10054 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10056 /* Don't call sv_add_backref here as it's going to be created
10057 as part of the magic cloning of the symbol table. */
10058 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10059 if(isGV_with_GP(sstr)) {
10060 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10061 at the point of this comment. */
10062 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10063 (void)GpREFCNT_inc(GvGP(dstr));
10065 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10068 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10069 if (IoOFP(dstr) == IoIFP(sstr))
10070 IoOFP(dstr) = IoIFP(dstr);
10072 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10073 /* PL_rsfp_filters entries have fake IoDIRP() */
10074 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10075 /* I have no idea why fake dirp (rsfps)
10076 should be treated differently but otherwise
10077 we end up with leaks -- sky*/
10078 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10079 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10080 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10082 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10083 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10084 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10085 if (IoDIRP(dstr)) {
10086 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10089 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10092 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10093 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10094 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10097 if (AvARRAY((AV*)sstr)) {
10098 SV **dst_ary, **src_ary;
10099 SSize_t items = AvFILLp((AV*)sstr) + 1;
10101 src_ary = AvARRAY((AV*)sstr);
10102 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10103 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10104 SvPV_set(dstr, (char*)dst_ary);
10105 AvALLOC((AV*)dstr) = dst_ary;
10106 if (AvREAL((AV*)sstr)) {
10107 while (items-- > 0)
10108 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10111 while (items-- > 0)
10112 *dst_ary++ = sv_dup(*src_ary++, param);
10114 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10115 while (items-- > 0) {
10116 *dst_ary++ = &PL_sv_undef;
10120 SvPV_set(dstr, NULL);
10121 AvALLOC((AV*)dstr) = (SV**)NULL;
10126 HEK *hvname = NULL;
10128 if (HvARRAY((HV*)sstr)) {
10130 const bool sharekeys = !!HvSHAREKEYS(sstr);
10131 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10132 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10134 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10135 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10137 HvARRAY(dstr) = (HE**)darray;
10138 while (i <= sxhv->xhv_max) {
10139 const HE *source = HvARRAY(sstr)[i];
10140 HvARRAY(dstr)[i] = source
10141 ? he_dup(source, sharekeys, param) : 0;
10145 struct xpvhv_aux * const saux = HvAUX(sstr);
10146 struct xpvhv_aux * const daux = HvAUX(dstr);
10147 /* This flag isn't copied. */
10148 /* SvOOK_on(hv) attacks the IV flags. */
10149 SvFLAGS(dstr) |= SVf_OOK;
10151 hvname = saux->xhv_name;
10153 = hvname ? hek_dup(hvname, param) : hvname;
10155 daux->xhv_riter = saux->xhv_riter;
10156 daux->xhv_eiter = saux->xhv_eiter
10157 ? he_dup(saux->xhv_eiter,
10158 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10159 daux->xhv_backreferences = saux->xhv_backreferences
10160 ? (AV*) SvREFCNT_inc(
10162 xhv_backreferences,
10168 SvPV_set(dstr, NULL);
10170 /* Record stashes for possible cloning in Perl_clone(). */
10172 av_push(param->stashes, dstr);
10176 if (!(param->flags & CLONEf_COPY_STACKS)) {
10180 /* NOTE: not refcounted */
10181 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10183 if (!CvISXSUB(dstr))
10184 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10186 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10187 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10188 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10189 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10191 /* don't dup if copying back - CvGV isn't refcounted, so the
10192 * duped GV may never be freed. A bit of a hack! DAPM */
10193 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10194 NULL : gv_dup(CvGV(dstr), param) ;
10195 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10197 CvWEAKOUTSIDE(sstr)
10198 ? cv_dup( CvOUTSIDE(dstr), param)
10199 : cv_dup_inc(CvOUTSIDE(dstr), param);
10200 if (!CvISXSUB(dstr))
10201 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10207 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10213 /* duplicate a context */
10216 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10218 PERL_CONTEXT *ncxs;
10221 return (PERL_CONTEXT*)NULL;
10223 /* look for it in the table first */
10224 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10228 /* create anew and remember what it is */
10229 Newxz(ncxs, max + 1, PERL_CONTEXT);
10230 ptr_table_store(PL_ptr_table, cxs, ncxs);
10233 PERL_CONTEXT * const cx = &cxs[ix];
10234 PERL_CONTEXT * const ncx = &ncxs[ix];
10235 ncx->cx_type = cx->cx_type;
10236 if (CxTYPE(cx) == CXt_SUBST) {
10237 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10240 ncx->blk_oldsp = cx->blk_oldsp;
10241 ncx->blk_oldcop = cx->blk_oldcop;
10242 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10243 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10244 ncx->blk_oldpm = cx->blk_oldpm;
10245 ncx->blk_gimme = cx->blk_gimme;
10246 switch (CxTYPE(cx)) {
10248 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10249 ? cv_dup_inc(cx->blk_sub.cv, param)
10250 : cv_dup(cx->blk_sub.cv,param));
10251 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10252 ? av_dup_inc(cx->blk_sub.argarray, param)
10254 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10255 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10256 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10257 ncx->blk_sub.lval = cx->blk_sub.lval;
10258 ncx->blk_sub.retop = cx->blk_sub.retop;
10261 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10262 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10263 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10264 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10265 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10266 ncx->blk_eval.retop = cx->blk_eval.retop;
10269 ncx->blk_loop.label = cx->blk_loop.label;
10270 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10271 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10272 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10273 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10274 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10275 ? cx->blk_loop.iterdata
10276 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10277 ncx->blk_loop.oldcomppad
10278 = (PAD*)ptr_table_fetch(PL_ptr_table,
10279 cx->blk_loop.oldcomppad);
10280 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10281 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10282 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10283 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10284 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10287 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10288 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10289 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10290 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10291 ncx->blk_sub.retop = cx->blk_sub.retop;
10303 /* duplicate a stack info structure */
10306 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10311 return (PERL_SI*)NULL;
10313 /* look for it in the table first */
10314 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10318 /* create anew and remember what it is */
10319 Newxz(nsi, 1, PERL_SI);
10320 ptr_table_store(PL_ptr_table, si, nsi);
10322 nsi->si_stack = av_dup_inc(si->si_stack, param);
10323 nsi->si_cxix = si->si_cxix;
10324 nsi->si_cxmax = si->si_cxmax;
10325 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10326 nsi->si_type = si->si_type;
10327 nsi->si_prev = si_dup(si->si_prev, param);
10328 nsi->si_next = si_dup(si->si_next, param);
10329 nsi->si_markoff = si->si_markoff;
10334 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10335 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10336 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10337 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10338 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10339 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10340 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10341 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10342 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10343 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10344 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10345 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10346 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10347 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10350 #define pv_dup_inc(p) SAVEPV(p)
10351 #define pv_dup(p) SAVEPV(p)
10352 #define svp_dup_inc(p,pp) any_dup(p,pp)
10354 /* map any object to the new equivent - either something in the
10355 * ptr table, or something in the interpreter structure
10359 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10364 return (void*)NULL;
10366 /* look for it in the table first */
10367 ret = ptr_table_fetch(PL_ptr_table, v);
10371 /* see if it is part of the interpreter structure */
10372 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10373 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10381 /* duplicate the save stack */
10384 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10386 ANY * const ss = proto_perl->Tsavestack;
10387 const I32 max = proto_perl->Tsavestack_max;
10388 I32 ix = proto_perl->Tsavestack_ix;
10400 void (*dptr) (void*);
10401 void (*dxptr) (pTHX_ void*);
10403 Newxz(nss, max, ANY);
10406 I32 i = POPINT(ss,ix);
10407 TOPINT(nss,ix) = i;
10409 case SAVEt_ITEM: /* normal string */
10410 case SAVEt_SV: /* scalar reference */
10411 sv = (SV*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10413 sv = (SV*)POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10416 case SAVEt_SHARED_PVREF: /* char* in shared space */
10417 c = (char*)POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = savesharedpv(c);
10419 ptr = POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10422 case SAVEt_GENERIC_SVREF: /* generic sv */
10423 case SAVEt_SVREF: /* scalar reference */
10424 sv = (SV*)POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10426 ptr = POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10429 case SAVEt_HV: /* hash reference */
10430 case SAVEt_AV: /* array reference */
10431 sv = POPPTR(ss,ix);
10432 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10433 gv = (GV*)POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = gv_dup(gv, param);
10436 case SAVEt_INT: /* int reference */
10437 ptr = POPPTR(ss,ix);
10438 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10439 intval = (int)POPINT(ss,ix);
10440 TOPINT(nss,ix) = intval;
10442 case SAVEt_LONG: /* long reference */
10443 ptr = POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10445 longval = (long)POPLONG(ss,ix);
10446 TOPLONG(nss,ix) = longval;
10448 case SAVEt_I32: /* I32 reference */
10449 case SAVEt_I16: /* I16 reference */
10450 case SAVEt_I8: /* I8 reference */
10451 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10452 ptr = POPPTR(ss,ix);
10453 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10455 TOPINT(nss,ix) = i;
10457 case SAVEt_IV: /* IV reference */
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 TOPIV(nss,ix) = iv;
10463 case SAVEt_HPTR: /* HV* reference */
10464 case SAVEt_APTR: /* AV* reference */
10465 case SAVEt_SPTR: /* SV* reference */
10466 ptr = POPPTR(ss,ix);
10467 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10468 sv = (SV*)POPPTR(ss,ix);
10469 TOPPTR(nss,ix) = sv_dup(sv, param);
10471 case SAVEt_VPTR: /* random* reference */
10472 ptr = POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10474 ptr = POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 case SAVEt_GENERIC_PVREF: /* generic char* */
10478 case SAVEt_PPTR: /* char* reference */
10479 ptr = POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10481 c = (char*)POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = pv_dup(c);
10485 gv = (GV*)POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = gv_dup(gv, param);
10488 case SAVEt_GP: /* scalar reference */
10489 gp = (GP*)POPPTR(ss,ix);
10490 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10491 (void)GpREFCNT_inc(gp);
10492 gv = (GV*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10494 c = (char*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = pv_dup(c);
10497 TOPIV(nss,ix) = iv;
10499 TOPIV(nss,ix) = iv;
10502 case SAVEt_MORTALIZESV:
10503 sv = (SV*)POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10507 ptr = POPPTR(ss,ix);
10508 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10509 /* these are assumed to be refcounted properly */
10511 switch (((OP*)ptr)->op_type) {
10513 case OP_LEAVESUBLV:
10517 case OP_LEAVEWRITE:
10518 TOPPTR(nss,ix) = ptr;
10523 TOPPTR(nss,ix) = NULL;
10528 TOPPTR(nss,ix) = NULL;
10531 c = (char*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = pv_dup_inc(c);
10534 case SAVEt_CLEARSV:
10535 longval = POPLONG(ss,ix);
10536 TOPLONG(nss,ix) = longval;
10539 hv = (HV*)POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10541 c = (char*)POPPTR(ss,ix);
10542 TOPPTR(nss,ix) = pv_dup_inc(c);
10544 TOPINT(nss,ix) = i;
10546 case SAVEt_DESTRUCTOR:
10547 ptr = POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10549 dptr = POPDPTR(ss,ix);
10550 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10551 any_dup(FPTR2DPTR(void *, dptr),
10554 case SAVEt_DESTRUCTOR_X:
10555 ptr = POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10557 dxptr = POPDXPTR(ss,ix);
10558 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10559 any_dup(FPTR2DPTR(void *, dxptr),
10562 case SAVEt_REGCONTEXT:
10565 TOPINT(nss,ix) = i;
10568 case SAVEt_STACK_POS: /* Position on Perl stack */
10570 TOPINT(nss,ix) = i;
10572 case SAVEt_AELEM: /* array element */
10573 sv = (SV*)POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10576 TOPINT(nss,ix) = i;
10577 av = (AV*)POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = av_dup_inc(av, param);
10580 case SAVEt_HELEM: /* hash element */
10581 sv = (SV*)POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10583 sv = (SV*)POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10585 hv = (HV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10589 ptr = POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = ptr;
10594 TOPINT(nss,ix) = i;
10595 ptr = POPPTR(ss,ix);
10598 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10599 HINTS_REFCNT_UNLOCK;
10601 TOPPTR(nss,ix) = ptr;
10602 if (i & HINT_LOCALIZE_HH) {
10603 hv = (HV*)POPPTR(ss,ix);
10604 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10607 case SAVEt_COMPPAD:
10608 av = (AV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = av_dup(av, param);
10612 longval = (long)POPLONG(ss,ix);
10613 TOPLONG(nss,ix) = longval;
10614 ptr = POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10616 sv = (SV*)POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = sv_dup(sv, param);
10620 ptr = POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10622 longval = (long)POPBOOL(ss,ix);
10623 TOPBOOL(nss,ix) = (bool)longval;
10625 case SAVEt_SET_SVFLAGS:
10627 TOPINT(nss,ix) = i;
10629 TOPINT(nss,ix) = i;
10630 sv = (SV*)POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = sv_dup(sv, param);
10633 case SAVEt_RE_STATE:
10635 const struct re_save_state *const old_state
10636 = (struct re_save_state *)
10637 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10638 struct re_save_state *const new_state
10639 = (struct re_save_state *)
10640 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10642 Copy(old_state, new_state, 1, struct re_save_state);
10643 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10645 new_state->re_state_bostr
10646 = pv_dup(old_state->re_state_bostr);
10647 new_state->re_state_reginput
10648 = pv_dup(old_state->re_state_reginput);
10649 new_state->re_state_regeol
10650 = pv_dup(old_state->re_state_regeol);
10651 new_state->re_state_regstartp
10652 = any_dup(old_state->re_state_regstartp, proto_perl);
10653 new_state->re_state_regendp
10654 = any_dup(old_state->re_state_regendp, proto_perl);
10655 new_state->re_state_reglastparen
10656 = any_dup(old_state->re_state_reglastparen, proto_perl);
10657 new_state->re_state_reglastcloseparen
10658 = any_dup(old_state->re_state_reglastcloseparen,
10660 /* XXX This just has to be broken. The old save_re_context
10661 code did SAVEGENERICPV(PL_reg_start_tmp);
10662 PL_reg_start_tmp is char **.
10663 Look above to what the dup code does for
10664 SAVEt_GENERIC_PVREF
10665 It can never have worked.
10666 So this is merely a faithful copy of the exiting bug: */
10667 new_state->re_state_reg_start_tmp
10668 = (char **) pv_dup((char *)
10669 old_state->re_state_reg_start_tmp);
10670 /* I assume that it only ever "worked" because no-one called
10671 (pseudo)fork while the regexp engine had re-entered itself.
10673 #ifdef PERL_OLD_COPY_ON_WRITE
10674 new_state->re_state_nrs
10675 = sv_dup(old_state->re_state_nrs, param);
10677 new_state->re_state_reg_magic
10678 = any_dup(old_state->re_state_reg_magic, proto_perl);
10679 new_state->re_state_reg_oldcurpm
10680 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10681 new_state->re_state_reg_curpm
10682 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10683 new_state->re_state_reg_oldsaved
10684 = pv_dup(old_state->re_state_reg_oldsaved);
10685 new_state->re_state_reg_poscache
10686 = pv_dup(old_state->re_state_reg_poscache);
10688 new_state->re_state_reg_starttry
10689 = pv_dup(old_state->re_state_reg_starttry);
10693 case SAVEt_COMPILE_WARNINGS:
10694 ptr = POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10698 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10706 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10707 * flag to the result. This is done for each stash before cloning starts,
10708 * so we know which stashes want their objects cloned */
10711 do_mark_cloneable_stash(pTHX_ SV *sv)
10713 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10715 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10716 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10717 if (cloner && GvCV(cloner)) {
10724 XPUSHs(sv_2mortal(newSVhek(hvname)));
10726 call_sv((SV*)GvCV(cloner), G_SCALAR);
10733 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10741 =for apidoc perl_clone
10743 Create and return a new interpreter by cloning the current one.
10745 perl_clone takes these flags as parameters:
10747 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10748 without it we only clone the data and zero the stacks,
10749 with it we copy the stacks and the new perl interpreter is
10750 ready to run at the exact same point as the previous one.
10751 The pseudo-fork code uses COPY_STACKS while the
10752 threads->new doesn't.
10754 CLONEf_KEEP_PTR_TABLE
10755 perl_clone keeps a ptr_table with the pointer of the old
10756 variable as a key and the new variable as a value,
10757 this allows it to check if something has been cloned and not
10758 clone it again but rather just use the value and increase the
10759 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10760 the ptr_table using the function
10761 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10762 reason to keep it around is if you want to dup some of your own
10763 variable who are outside the graph perl scans, example of this
10764 code is in threads.xs create
10767 This is a win32 thing, it is ignored on unix, it tells perls
10768 win32host code (which is c++) to clone itself, this is needed on
10769 win32 if you want to run two threads at the same time,
10770 if you just want to do some stuff in a separate perl interpreter
10771 and then throw it away and return to the original one,
10772 you don't need to do anything.
10777 /* XXX the above needs expanding by someone who actually understands it ! */
10778 EXTERN_C PerlInterpreter *
10779 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10782 perl_clone(PerlInterpreter *proto_perl, UV flags)
10785 #ifdef PERL_IMPLICIT_SYS
10787 /* perlhost.h so we need to call into it
10788 to clone the host, CPerlHost should have a c interface, sky */
10790 if (flags & CLONEf_CLONE_HOST) {
10791 return perl_clone_host(proto_perl,flags);
10793 return perl_clone_using(proto_perl, flags,
10795 proto_perl->IMemShared,
10796 proto_perl->IMemParse,
10798 proto_perl->IStdIO,
10802 proto_perl->IProc);
10806 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10807 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10808 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10809 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10810 struct IPerlDir* ipD, struct IPerlSock* ipS,
10811 struct IPerlProc* ipP)
10813 /* XXX many of the string copies here can be optimized if they're
10814 * constants; they need to be allocated as common memory and just
10815 * their pointers copied. */
10818 CLONE_PARAMS clone_params;
10819 CLONE_PARAMS* const param = &clone_params;
10821 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10822 /* for each stash, determine whether its objects should be cloned */
10823 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10824 PERL_SET_THX(my_perl);
10827 PoisonNew(my_perl, 1, PerlInterpreter);
10833 PL_savestack_ix = 0;
10834 PL_savestack_max = -1;
10835 PL_sig_pending = 0;
10836 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10837 # else /* !DEBUGGING */
10838 Zero(my_perl, 1, PerlInterpreter);
10839 # endif /* DEBUGGING */
10841 /* host pointers */
10843 PL_MemShared = ipMS;
10844 PL_MemParse = ipMP;
10851 #else /* !PERL_IMPLICIT_SYS */
10853 CLONE_PARAMS clone_params;
10854 CLONE_PARAMS* param = &clone_params;
10855 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10856 /* for each stash, determine whether its objects should be cloned */
10857 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10858 PERL_SET_THX(my_perl);
10861 PoisonNew(my_perl, 1, PerlInterpreter);
10867 PL_savestack_ix = 0;
10868 PL_savestack_max = -1;
10869 PL_sig_pending = 0;
10870 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10871 # else /* !DEBUGGING */
10872 Zero(my_perl, 1, PerlInterpreter);
10873 # endif /* DEBUGGING */
10874 #endif /* PERL_IMPLICIT_SYS */
10875 param->flags = flags;
10876 param->proto_perl = proto_perl;
10878 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10880 PL_body_arenas = NULL;
10881 Zero(&PL_body_roots, 1, PL_body_roots);
10883 PL_nice_chunk = NULL;
10884 PL_nice_chunk_size = 0;
10886 PL_sv_objcount = 0;
10888 PL_sv_arenaroot = NULL;
10890 PL_debug = proto_perl->Idebug;
10892 PL_hash_seed = proto_perl->Ihash_seed;
10893 PL_rehash_seed = proto_perl->Irehash_seed;
10895 #ifdef USE_REENTRANT_API
10896 /* XXX: things like -Dm will segfault here in perlio, but doing
10897 * PERL_SET_CONTEXT(proto_perl);
10898 * breaks too many other things
10900 Perl_reentrant_init(aTHX);
10903 /* create SV map for pointer relocation */
10904 PL_ptr_table = ptr_table_new();
10906 /* initialize these special pointers as early as possible */
10907 SvANY(&PL_sv_undef) = NULL;
10908 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10909 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10910 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10912 SvANY(&PL_sv_no) = new_XPVNV();
10913 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10914 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10915 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10916 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10917 SvCUR_set(&PL_sv_no, 0);
10918 SvLEN_set(&PL_sv_no, 1);
10919 SvIV_set(&PL_sv_no, 0);
10920 SvNV_set(&PL_sv_no, 0);
10921 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10923 SvANY(&PL_sv_yes) = new_XPVNV();
10924 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10925 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10926 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10927 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10928 SvCUR_set(&PL_sv_yes, 1);
10929 SvLEN_set(&PL_sv_yes, 2);
10930 SvIV_set(&PL_sv_yes, 1);
10931 SvNV_set(&PL_sv_yes, 1);
10932 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10934 /* create (a non-shared!) shared string table */
10935 PL_strtab = newHV();
10936 HvSHAREKEYS_off(PL_strtab);
10937 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10938 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10940 PL_compiling = proto_perl->Icompiling;
10942 /* These two PVs will be free'd special way so must set them same way op.c does */
10943 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10944 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10946 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10947 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10949 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10950 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10951 if (!specialCopIO(PL_compiling.cop_io))
10952 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10953 if (PL_compiling.cop_hints) {
10955 PL_compiling.cop_hints->refcounted_he_refcnt++;
10956 HINTS_REFCNT_UNLOCK;
10958 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10960 /* pseudo environmental stuff */
10961 PL_origargc = proto_perl->Iorigargc;
10962 PL_origargv = proto_perl->Iorigargv;
10964 param->stashes = newAV(); /* Setup array of objects to call clone on */
10966 /* Set tainting stuff before PerlIO_debug can possibly get called */
10967 PL_tainting = proto_perl->Itainting;
10968 PL_taint_warn = proto_perl->Itaint_warn;
10970 #ifdef PERLIO_LAYERS
10971 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10972 PerlIO_clone(aTHX_ proto_perl, param);
10975 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10976 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10977 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10978 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10979 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10980 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10983 PL_minus_c = proto_perl->Iminus_c;
10984 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10985 PL_localpatches = proto_perl->Ilocalpatches;
10986 PL_splitstr = proto_perl->Isplitstr;
10987 PL_preprocess = proto_perl->Ipreprocess;
10988 PL_minus_n = proto_perl->Iminus_n;
10989 PL_minus_p = proto_perl->Iminus_p;
10990 PL_minus_l = proto_perl->Iminus_l;
10991 PL_minus_a = proto_perl->Iminus_a;
10992 PL_minus_E = proto_perl->Iminus_E;
10993 PL_minus_F = proto_perl->Iminus_F;
10994 PL_doswitches = proto_perl->Idoswitches;
10995 PL_dowarn = proto_perl->Idowarn;
10996 PL_doextract = proto_perl->Idoextract;
10997 PL_sawampersand = proto_perl->Isawampersand;
10998 PL_unsafe = proto_perl->Iunsafe;
10999 PL_inplace = SAVEPV(proto_perl->Iinplace);
11000 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11001 PL_perldb = proto_perl->Iperldb;
11002 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11003 PL_exit_flags = proto_perl->Iexit_flags;
11005 /* magical thingies */
11006 /* XXX time(&PL_basetime) when asked for? */
11007 PL_basetime = proto_perl->Ibasetime;
11008 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11010 PL_maxsysfd = proto_perl->Imaxsysfd;
11011 PL_statusvalue = proto_perl->Istatusvalue;
11013 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11015 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11017 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11019 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11020 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11021 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11023 /* Clone the regex array */
11024 PL_regex_padav = newAV();
11026 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11027 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11029 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11030 for(i = 1; i <= len; i++) {
11031 const SV * const regex = regexen[i];
11034 ? sv_dup_inc(regex, param)
11036 newSViv(PTR2IV(re_dup(
11037 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11039 av_push(PL_regex_padav, sv);
11042 PL_regex_pad = AvARRAY(PL_regex_padav);
11044 /* shortcuts to various I/O objects */
11045 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11046 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11047 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11048 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11049 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11050 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11052 /* shortcuts to regexp stuff */
11053 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11055 /* shortcuts to misc objects */
11056 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11058 /* shortcuts to debugging objects */
11059 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11060 PL_DBline = gv_dup(proto_perl->IDBline, param);
11061 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11062 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11063 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11064 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11065 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11066 PL_lineary = av_dup(proto_perl->Ilineary, param);
11067 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11069 /* symbol tables */
11070 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11071 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11072 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11073 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11074 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11076 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11077 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11078 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11079 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11080 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11081 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11083 PL_sub_generation = proto_perl->Isub_generation;
11085 /* funky return mechanisms */
11086 PL_forkprocess = proto_perl->Iforkprocess;
11088 /* subprocess state */
11089 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11091 /* internal state */
11092 PL_maxo = proto_perl->Imaxo;
11093 if (proto_perl->Iop_mask)
11094 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11097 /* PL_asserting = proto_perl->Iasserting; */
11099 /* current interpreter roots */
11100 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11101 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11102 PL_main_start = proto_perl->Imain_start;
11103 PL_eval_root = proto_perl->Ieval_root;
11104 PL_eval_start = proto_perl->Ieval_start;
11106 /* runtime control stuff */
11107 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11108 PL_copline = proto_perl->Icopline;
11110 PL_filemode = proto_perl->Ifilemode;
11111 PL_lastfd = proto_perl->Ilastfd;
11112 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11115 PL_gensym = proto_perl->Igensym;
11116 PL_preambled = proto_perl->Ipreambled;
11117 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11118 PL_laststatval = proto_perl->Ilaststatval;
11119 PL_laststype = proto_perl->Ilaststype;
11122 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11124 /* interpreter atexit processing */
11125 PL_exitlistlen = proto_perl->Iexitlistlen;
11126 if (PL_exitlistlen) {
11127 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11128 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11131 PL_exitlist = (PerlExitListEntry*)NULL;
11133 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11134 if (PL_my_cxt_size) {
11135 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11136 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11139 PL_my_cxt_list = (void**)NULL;
11140 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11141 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11142 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11144 PL_profiledata = NULL;
11145 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11146 /* PL_rsfp_filters entries have fake IoDIRP() */
11147 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11149 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11151 PAD_CLONE_VARS(proto_perl, param);
11153 #ifdef HAVE_INTERP_INTERN
11154 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11157 /* more statics moved here */
11158 PL_generation = proto_perl->Igeneration;
11159 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11161 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11162 PL_in_clean_all = proto_perl->Iin_clean_all;
11164 PL_uid = proto_perl->Iuid;
11165 PL_euid = proto_perl->Ieuid;
11166 PL_gid = proto_perl->Igid;
11167 PL_egid = proto_perl->Iegid;
11168 PL_nomemok = proto_perl->Inomemok;
11169 PL_an = proto_perl->Ian;
11170 PL_evalseq = proto_perl->Ievalseq;
11171 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11172 PL_origalen = proto_perl->Iorigalen;
11173 #ifdef PERL_USES_PL_PIDSTATUS
11174 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11176 PL_osname = SAVEPV(proto_perl->Iosname);
11177 PL_sighandlerp = proto_perl->Isighandlerp;
11179 PL_runops = proto_perl->Irunops;
11181 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11184 PL_cshlen = proto_perl->Icshlen;
11185 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11188 PL_lex_state = proto_perl->Ilex_state;
11189 PL_lex_defer = proto_perl->Ilex_defer;
11190 PL_lex_expect = proto_perl->Ilex_expect;
11191 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11192 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11193 PL_lex_starts = proto_perl->Ilex_starts;
11194 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11195 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11196 PL_lex_op = proto_perl->Ilex_op;
11197 PL_lex_inpat = proto_perl->Ilex_inpat;
11198 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11199 PL_lex_brackets = proto_perl->Ilex_brackets;
11200 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11201 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11202 PL_lex_casemods = proto_perl->Ilex_casemods;
11203 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11204 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11207 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11208 PL_lasttoke = proto_perl->Ilasttoke;
11209 PL_realtokenstart = proto_perl->Irealtokenstart;
11210 PL_faketokens = proto_perl->Ifaketokens;
11211 PL_thismad = proto_perl->Ithismad;
11212 PL_thistoken = proto_perl->Ithistoken;
11213 PL_thisopen = proto_perl->Ithisopen;
11214 PL_thisstuff = proto_perl->Ithisstuff;
11215 PL_thisclose = proto_perl->Ithisclose;
11216 PL_thiswhite = proto_perl->Ithiswhite;
11217 PL_nextwhite = proto_perl->Inextwhite;
11218 PL_skipwhite = proto_perl->Iskipwhite;
11219 PL_endwhite = proto_perl->Iendwhite;
11220 PL_curforce = proto_perl->Icurforce;
11222 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11223 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11224 PL_nexttoke = proto_perl->Inexttoke;
11227 /* XXX This is probably masking the deeper issue of why
11228 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11229 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11230 * (A little debugging with a watchpoint on it may help.)
11232 if (SvANY(proto_perl->Ilinestr)) {
11233 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11234 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11235 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11236 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11237 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11238 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11239 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11240 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11241 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11244 PL_linestr = newSV(79);
11245 sv_upgrade(PL_linestr,SVt_PVIV);
11246 sv_setpvn(PL_linestr,"",0);
11247 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11249 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11250 PL_pending_ident = proto_perl->Ipending_ident;
11251 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11253 PL_expect = proto_perl->Iexpect;
11255 PL_multi_start = proto_perl->Imulti_start;
11256 PL_multi_end = proto_perl->Imulti_end;
11257 PL_multi_open = proto_perl->Imulti_open;
11258 PL_multi_close = proto_perl->Imulti_close;
11260 PL_error_count = proto_perl->Ierror_count;
11261 PL_subline = proto_perl->Isubline;
11262 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11264 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11265 if (SvANY(proto_perl->Ilinestr)) {
11266 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11267 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11268 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11269 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11270 PL_last_lop_op = proto_perl->Ilast_lop_op;
11273 PL_last_uni = SvPVX(PL_linestr);
11274 PL_last_lop = SvPVX(PL_linestr);
11275 PL_last_lop_op = 0;
11277 PL_in_my = proto_perl->Iin_my;
11278 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11280 PL_cryptseen = proto_perl->Icryptseen;
11283 PL_hints = proto_perl->Ihints;
11285 PL_amagic_generation = proto_perl->Iamagic_generation;
11287 #ifdef USE_LOCALE_COLLATE
11288 PL_collation_ix = proto_perl->Icollation_ix;
11289 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11290 PL_collation_standard = proto_perl->Icollation_standard;
11291 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11292 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11293 #endif /* USE_LOCALE_COLLATE */
11295 #ifdef USE_LOCALE_NUMERIC
11296 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11297 PL_numeric_standard = proto_perl->Inumeric_standard;
11298 PL_numeric_local = proto_perl->Inumeric_local;
11299 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11300 #endif /* !USE_LOCALE_NUMERIC */
11302 /* utf8 character classes */
11303 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11304 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11305 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11306 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11307 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11308 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11309 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11310 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11311 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11312 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11313 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11314 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11315 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11316 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11317 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11318 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11319 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11320 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11321 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11322 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11324 /* Did the locale setup indicate UTF-8? */
11325 PL_utf8locale = proto_perl->Iutf8locale;
11326 /* Unicode features (see perlrun/-C) */
11327 PL_unicode = proto_perl->Iunicode;
11329 /* Pre-5.8 signals control */
11330 PL_signals = proto_perl->Isignals;
11332 /* times() ticks per second */
11333 PL_clocktick = proto_perl->Iclocktick;
11335 /* Recursion stopper for PerlIO_find_layer */
11336 PL_in_load_module = proto_perl->Iin_load_module;
11338 /* sort() routine */
11339 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11341 /* Not really needed/useful since the reenrant_retint is "volatile",
11342 * but do it for consistency's sake. */
11343 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11345 /* Hooks to shared SVs and locks. */
11346 PL_sharehook = proto_perl->Isharehook;
11347 PL_lockhook = proto_perl->Ilockhook;
11348 PL_unlockhook = proto_perl->Iunlockhook;
11349 PL_threadhook = proto_perl->Ithreadhook;
11351 PL_runops_std = proto_perl->Irunops_std;
11352 PL_runops_dbg = proto_perl->Irunops_dbg;
11354 #ifdef THREADS_HAVE_PIDS
11355 PL_ppid = proto_perl->Ippid;
11359 PL_last_swash_hv = NULL; /* reinits on demand */
11360 PL_last_swash_klen = 0;
11361 PL_last_swash_key[0]= '\0';
11362 PL_last_swash_tmps = (U8*)NULL;
11363 PL_last_swash_slen = 0;
11365 PL_glob_index = proto_perl->Iglob_index;
11366 PL_srand_called = proto_perl->Isrand_called;
11367 PL_uudmap['M'] = 0; /* reinits on demand */
11368 PL_bitcount = NULL; /* reinits on demand */
11370 if (proto_perl->Ipsig_pend) {
11371 Newxz(PL_psig_pend, SIG_SIZE, int);
11374 PL_psig_pend = (int*)NULL;
11377 if (proto_perl->Ipsig_ptr) {
11378 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11379 Newxz(PL_psig_name, SIG_SIZE, SV*);
11380 for (i = 1; i < SIG_SIZE; i++) {
11381 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11382 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11386 PL_psig_ptr = (SV**)NULL;
11387 PL_psig_name = (SV**)NULL;
11390 /* thrdvar.h stuff */
11392 if (flags & CLONEf_COPY_STACKS) {
11393 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11394 PL_tmps_ix = proto_perl->Ttmps_ix;
11395 PL_tmps_max = proto_perl->Ttmps_max;
11396 PL_tmps_floor = proto_perl->Ttmps_floor;
11397 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11399 while (i <= PL_tmps_ix) {
11400 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11404 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11405 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11406 Newxz(PL_markstack, i, I32);
11407 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11408 - proto_perl->Tmarkstack);
11409 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11410 - proto_perl->Tmarkstack);
11411 Copy(proto_perl->Tmarkstack, PL_markstack,
11412 PL_markstack_ptr - PL_markstack + 1, I32);
11414 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11415 * NOTE: unlike the others! */
11416 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11417 PL_scopestack_max = proto_perl->Tscopestack_max;
11418 Newxz(PL_scopestack, PL_scopestack_max, I32);
11419 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11421 /* NOTE: si_dup() looks at PL_markstack */
11422 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11424 /* PL_curstack = PL_curstackinfo->si_stack; */
11425 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11426 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11428 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11429 PL_stack_base = AvARRAY(PL_curstack);
11430 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11431 - proto_perl->Tstack_base);
11432 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11434 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11435 * NOTE: unlike the others! */
11436 PL_savestack_ix = proto_perl->Tsavestack_ix;
11437 PL_savestack_max = proto_perl->Tsavestack_max;
11438 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11439 PL_savestack = ss_dup(proto_perl, param);
11443 ENTER; /* perl_destruct() wants to LEAVE; */
11445 /* although we're not duplicating the tmps stack, we should still
11446 * add entries for any SVs on the tmps stack that got cloned by a
11447 * non-refcount means (eg a temp in @_); otherwise they will be
11450 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11451 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11452 proto_perl->Ttmps_stack[i]);
11453 if (nsv && !SvREFCNT(nsv)) {
11455 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11460 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11461 PL_top_env = &PL_start_env;
11463 PL_op = proto_perl->Top;
11466 PL_Xpv = (XPV*)NULL;
11467 PL_na = proto_perl->Tna;
11469 PL_statbuf = proto_perl->Tstatbuf;
11470 PL_statcache = proto_perl->Tstatcache;
11471 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11472 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11474 PL_timesbuf = proto_perl->Ttimesbuf;
11477 PL_tainted = proto_perl->Ttainted;
11478 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11479 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11480 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11481 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11482 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11483 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11484 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11485 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11486 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11488 PL_restartop = proto_perl->Trestartop;
11489 PL_in_eval = proto_perl->Tin_eval;
11490 PL_delaymagic = proto_perl->Tdelaymagic;
11491 PL_dirty = proto_perl->Tdirty;
11492 PL_localizing = proto_perl->Tlocalizing;
11494 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11495 PL_hv_fetch_ent_mh = NULL;
11496 PL_modcount = proto_perl->Tmodcount;
11497 PL_lastgotoprobe = NULL;
11498 PL_dumpindent = proto_perl->Tdumpindent;
11500 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11501 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11502 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11503 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11504 PL_efloatbuf = NULL; /* reinits on demand */
11505 PL_efloatsize = 0; /* reinits on demand */
11509 PL_screamfirst = NULL;
11510 PL_screamnext = NULL;
11511 PL_maxscream = -1; /* reinits on demand */
11512 PL_lastscream = NULL;
11514 PL_watchaddr = NULL;
11517 PL_regdummy = proto_perl->Tregdummy;
11518 PL_colorset = 0; /* reinits PL_colors[] */
11519 /*PL_colors[6] = {0,0,0,0,0,0};*/
11521 /* RE engine - function pointers */
11522 PL_regcompp = proto_perl->Tregcompp;
11523 PL_regexecp = proto_perl->Tregexecp;
11524 PL_regint_start = proto_perl->Tregint_start;
11525 PL_regint_string = proto_perl->Tregint_string;
11526 PL_regfree = proto_perl->Tregfree;
11527 Zero(&PL_reg_state, 1, struct re_save_state);
11528 PL_reginterp_cnt = 0;
11529 PL_regmatch_slab = NULL;
11531 /* Pluggable optimizer */
11532 PL_peepp = proto_perl->Tpeepp;
11534 PL_stashcache = newHV();
11536 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11537 ptr_table_free(PL_ptr_table);
11538 PL_ptr_table = NULL;
11541 /* Call the ->CLONE method, if it exists, for each of the stashes
11542 identified by sv_dup() above.
11544 while(av_len(param->stashes) != -1) {
11545 HV* const stash = (HV*) av_shift(param->stashes);
11546 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11547 if (cloner && GvCV(cloner)) {
11552 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11554 call_sv((SV*)GvCV(cloner), G_DISCARD);
11560 SvREFCNT_dec(param->stashes);
11562 /* orphaned? eg threads->new inside BEGIN or use */
11563 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11564 SvREFCNT_inc_simple_void(PL_compcv);
11565 SAVEFREESV(PL_compcv);
11571 #endif /* USE_ITHREADS */
11574 =head1 Unicode Support
11576 =for apidoc sv_recode_to_utf8
11578 The encoding is assumed to be an Encode object, on entry the PV
11579 of the sv is assumed to be octets in that encoding, and the sv
11580 will be converted into Unicode (and UTF-8).
11582 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11583 is not a reference, nothing is done to the sv. If the encoding is not
11584 an C<Encode::XS> Encoding object, bad things will happen.
11585 (See F<lib/encoding.pm> and L<Encode>).
11587 The PV of the sv is returned.
11592 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11595 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11609 Passing sv_yes is wrong - it needs to be or'ed set of constants
11610 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11611 remove converted chars from source.
11613 Both will default the value - let them.
11615 XPUSHs(&PL_sv_yes);
11618 call_method("decode", G_SCALAR);
11622 s = SvPV_const(uni, len);
11623 if (s != SvPVX_const(sv)) {
11624 SvGROW(sv, len + 1);
11625 Move(s, SvPVX(sv), len + 1, char);
11626 SvCUR_set(sv, len);
11633 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11637 =for apidoc sv_cat_decode
11639 The encoding is assumed to be an Encode object, the PV of the ssv is
11640 assumed to be octets in that encoding and decoding the input starts
11641 from the position which (PV + *offset) pointed to. The dsv will be
11642 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11643 when the string tstr appears in decoding output or the input ends on
11644 the PV of the ssv. The value which the offset points will be modified
11645 to the last input position on the ssv.
11647 Returns TRUE if the terminator was found, else returns FALSE.
11652 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11653 SV *ssv, int *offset, char *tstr, int tlen)
11657 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11668 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11669 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11671 call_method("cat_decode", G_SCALAR);
11673 ret = SvTRUE(TOPs);
11674 *offset = SvIV(offsv);
11680 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11685 /* ---------------------------------------------------------------------
11687 * support functions for report_uninit()
11690 /* the maxiumum size of array or hash where we will scan looking
11691 * for the undefined element that triggered the warning */
11693 #define FUV_MAX_SEARCH_SIZE 1000
11695 /* Look for an entry in the hash whose value has the same SV as val;
11696 * If so, return a mortal copy of the key. */
11699 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11702 register HE **array;
11705 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11706 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11709 array = HvARRAY(hv);
11711 for (i=HvMAX(hv); i>0; i--) {
11712 register HE *entry;
11713 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11714 if (HeVAL(entry) != val)
11716 if ( HeVAL(entry) == &PL_sv_undef ||
11717 HeVAL(entry) == &PL_sv_placeholder)
11721 if (HeKLEN(entry) == HEf_SVKEY)
11722 return sv_mortalcopy(HeKEY_sv(entry));
11723 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11729 /* Look for an entry in the array whose value has the same SV as val;
11730 * If so, return the index, otherwise return -1. */
11733 S_find_array_subscript(pTHX_ AV *av, SV* val)
11738 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11739 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11743 for (i=AvFILLp(av); i>=0; i--) {
11744 if (svp[i] == val && svp[i] != &PL_sv_undef)
11750 /* S_varname(): return the name of a variable, optionally with a subscript.
11751 * If gv is non-zero, use the name of that global, along with gvtype (one
11752 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11753 * targ. Depending on the value of the subscript_type flag, return:
11756 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11757 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11758 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11759 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11762 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11763 SV* keyname, I32 aindex, int subscript_type)
11766 SV * const name = sv_newmortal();
11769 buffer[0] = gvtype;
11772 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11774 gv_fullname4(name, gv, buffer, 0);
11776 if ((unsigned int)SvPVX(name)[1] <= 26) {
11778 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11780 /* Swap the 1 unprintable control character for the 2 byte pretty
11781 version - ie substr($name, 1, 1) = $buffer; */
11782 sv_insert(name, 1, 1, buffer, 2);
11787 CV * const cv = find_runcv(&unused);
11791 if (!cv || !CvPADLIST(cv))
11793 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11794 sv = *av_fetch(av, targ, FALSE);
11795 /* SvLEN in a pad name is not to be trusted */
11796 sv_setpv(name, SvPV_nolen_const(sv));
11799 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11800 SV * const sv = newSV(0);
11801 *SvPVX(name) = '$';
11802 Perl_sv_catpvf(aTHX_ name, "{%s}",
11803 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11806 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11807 *SvPVX(name) = '$';
11808 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11810 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11811 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11818 =for apidoc find_uninit_var
11820 Find the name of the undefined variable (if any) that caused the operator o
11821 to issue a "Use of uninitialized value" warning.
11822 If match is true, only return a name if it's value matches uninit_sv.
11823 So roughly speaking, if a unary operator (such as OP_COS) generates a
11824 warning, then following the direct child of the op may yield an
11825 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11826 other hand, with OP_ADD there are two branches to follow, so we only print
11827 the variable name if we get an exact match.
11829 The name is returned as a mortal SV.
11831 Assumes that PL_op is the op that originally triggered the error, and that
11832 PL_comppad/PL_curpad points to the currently executing pad.
11838 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11846 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11847 uninit_sv == &PL_sv_placeholder)))
11850 switch (obase->op_type) {
11857 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11858 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11861 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11863 if (pad) { /* @lex, %lex */
11864 sv = PAD_SVl(obase->op_targ);
11868 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11869 /* @global, %global */
11870 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11873 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11875 else /* @{expr}, %{expr} */
11876 return find_uninit_var(cUNOPx(obase)->op_first,
11880 /* attempt to find a match within the aggregate */
11882 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11884 subscript_type = FUV_SUBSCRIPT_HASH;
11887 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11889 subscript_type = FUV_SUBSCRIPT_ARRAY;
11892 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11895 return varname(gv, hash ? '%' : '@', obase->op_targ,
11896 keysv, index, subscript_type);
11900 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11902 return varname(NULL, '$', obase->op_targ,
11903 NULL, 0, FUV_SUBSCRIPT_NONE);
11906 gv = cGVOPx_gv(obase);
11907 if (!gv || (match && GvSV(gv) != uninit_sv))
11909 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11912 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11915 av = (AV*)PAD_SV(obase->op_targ);
11916 if (!av || SvRMAGICAL(av))
11918 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11919 if (!svp || *svp != uninit_sv)
11922 return varname(NULL, '$', obase->op_targ,
11923 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11926 gv = cGVOPx_gv(obase);
11932 if (!av || SvRMAGICAL(av))
11934 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11935 if (!svp || *svp != uninit_sv)
11938 return varname(gv, '$', 0,
11939 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11944 o = cUNOPx(obase)->op_first;
11945 if (!o || o->op_type != OP_NULL ||
11946 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11948 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11952 if (PL_op == obase)
11953 /* $a[uninit_expr] or $h{uninit_expr} */
11954 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11957 o = cBINOPx(obase)->op_first;
11958 kid = cBINOPx(obase)->op_last;
11960 /* get the av or hv, and optionally the gv */
11962 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11963 sv = PAD_SV(o->op_targ);
11965 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11966 && cUNOPo->op_first->op_type == OP_GV)
11968 gv = cGVOPx_gv(cUNOPo->op_first);
11971 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11976 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11977 /* index is constant */
11981 if (obase->op_type == OP_HELEM) {
11982 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11983 if (!he || HeVAL(he) != uninit_sv)
11987 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11988 if (!svp || *svp != uninit_sv)
11992 if (obase->op_type == OP_HELEM)
11993 return varname(gv, '%', o->op_targ,
11994 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11996 return varname(gv, '@', o->op_targ, NULL,
11997 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12000 /* index is an expression;
12001 * attempt to find a match within the aggregate */
12002 if (obase->op_type == OP_HELEM) {
12003 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12005 return varname(gv, '%', o->op_targ,
12006 keysv, 0, FUV_SUBSCRIPT_HASH);
12009 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12011 return varname(gv, '@', o->op_targ,
12012 NULL, index, FUV_SUBSCRIPT_ARRAY);
12017 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12019 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12024 /* only examine RHS */
12025 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12028 o = cUNOPx(obase)->op_first;
12029 if (o->op_type == OP_PUSHMARK)
12032 if (!o->op_sibling) {
12033 /* one-arg version of open is highly magical */
12035 if (o->op_type == OP_GV) { /* open FOO; */
12037 if (match && GvSV(gv) != uninit_sv)
12039 return varname(gv, '$', 0,
12040 NULL, 0, FUV_SUBSCRIPT_NONE);
12042 /* other possibilities not handled are:
12043 * open $x; or open my $x; should return '${*$x}'
12044 * open expr; should return '$'.expr ideally
12050 /* ops where $_ may be an implicit arg */
12054 if ( !(obase->op_flags & OPf_STACKED)) {
12055 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12056 ? PAD_SVl(obase->op_targ)
12059 sv = sv_newmortal();
12060 sv_setpvn(sv, "$_", 2);
12068 /* skip filehandle as it can't produce 'undef' warning */
12069 o = cUNOPx(obase)->op_first;
12070 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12071 o = o->op_sibling->op_sibling;
12078 match = 1; /* XS or custom code could trigger random warnings */
12083 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12084 return sv_2mortal(newSVpvs("${$/}"));
12089 if (!(obase->op_flags & OPf_KIDS))
12091 o = cUNOPx(obase)->op_first;
12097 /* if all except one arg are constant, or have no side-effects,
12098 * or are optimized away, then it's unambiguous */
12100 for (kid=o; kid; kid = kid->op_sibling) {
12103 ( (kid->op_type == OP_CONST && (sv = cSVOPx_sv(kid))
12105 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12106 || (kid->op_type == OP_PUSHMARK)
12110 if (o2) { /* more than one found */
12117 return find_uninit_var(o2, uninit_sv, match);
12119 /* scan all args */
12121 sv = find_uninit_var(o, uninit_sv, 1);
12133 =for apidoc report_uninit
12135 Print appropriate "Use of uninitialized variable" warning
12141 Perl_report_uninit(pTHX_ SV* uninit_sv)
12145 SV* varname = NULL;
12147 varname = find_uninit_var(PL_op, uninit_sv,0);
12149 sv_insert(varname, 0, 0, " ", 1);
12151 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12152 varname ? SvPV_nolen_const(varname) : "",
12153 " in ", OP_DESC(PL_op));
12156 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12162 * c-indentation-style: bsd
12163 * c-basic-offset: 4
12164 * indent-tabs-mode: t
12167 * ex: set ts=8 sts=4 sw=4 noet: