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)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
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);
1284 sv->sv_u.svu_array = NULL; /* or svu_hash */
1290 /* XXX Is this still needed? Was it ever needed? Surely as there is
1291 no route from NV to PVIV, NOK can never be true */
1292 assert(!SvNOKp(sv));
1304 assert(new_type_details->body_size);
1305 /* We always allocated the full length item with PURIFY. To do this
1306 we fake things so that arena is false for all 16 types.. */
1307 if(new_type_details->arena) {
1308 /* This points to the start of the allocated area. */
1309 new_body_inline(new_body, new_type);
1310 Zero(new_body, new_type_details->body_size, char);
1311 new_body = ((char *)new_body) - new_type_details->offset;
1313 new_body = new_NOARENAZ(new_type_details);
1315 SvANY(sv) = new_body;
1317 if (old_type_details->copy) {
1318 /* There is now the potential for an upgrade from something without
1319 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1320 int offset = old_type_details->offset;
1321 int length = old_type_details->copy;
1323 if (new_type_details->offset > old_type_details->offset) {
1324 const int difference
1325 = new_type_details->offset - old_type_details->offset;
1326 offset += difference;
1327 length -= difference;
1329 assert (length >= 0);
1331 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1335 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1336 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1337 * correct 0.0 for us. Otherwise, if the old body didn't have an
1338 * NV slot, but the new one does, then we need to initialise the
1339 * freshly created NV slot with whatever the correct bit pattern is
1341 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1345 if (new_type == SVt_PVIO)
1346 IoPAGE_LEN(sv) = 60;
1347 if (old_type < SVt_RV)
1351 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1352 (unsigned long)new_type);
1355 if (old_type_details->arena) {
1356 /* If there was an old body, then we need to free it.
1357 Note that there is an assumption that all bodies of types that
1358 can be upgraded came from arenas. Only the more complex non-
1359 upgradable types are allowed to be directly malloc()ed. */
1361 my_safefree(old_body);
1363 del_body((void*)((char*)old_body + old_type_details->offset),
1364 &PL_body_roots[old_type]);
1370 =for apidoc sv_backoff
1372 Remove any string offset. You should normally use the C<SvOOK_off> macro
1379 Perl_sv_backoff(pTHX_ register SV *sv)
1381 PERL_UNUSED_CONTEXT;
1383 assert(SvTYPE(sv) != SVt_PVHV);
1384 assert(SvTYPE(sv) != SVt_PVAV);
1386 const char * const s = SvPVX_const(sv);
1387 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1388 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1390 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1392 SvFLAGS(sv) &= ~SVf_OOK;
1399 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1400 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1401 Use the C<SvGROW> wrapper instead.
1407 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1411 if (PL_madskills && newlen >= 0x100000) {
1412 PerlIO_printf(Perl_debug_log,
1413 "Allocation too large: %"UVxf"\n", (UV)newlen);
1415 #ifdef HAS_64K_LIMIT
1416 if (newlen >= 0x10000) {
1417 PerlIO_printf(Perl_debug_log,
1418 "Allocation too large: %"UVxf"\n", (UV)newlen);
1421 #endif /* HAS_64K_LIMIT */
1424 if (SvTYPE(sv) < SVt_PV) {
1425 sv_upgrade(sv, SVt_PV);
1426 s = SvPVX_mutable(sv);
1428 else if (SvOOK(sv)) { /* pv is offset? */
1430 s = SvPVX_mutable(sv);
1431 if (newlen > SvLEN(sv))
1432 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1433 #ifdef HAS_64K_LIMIT
1434 if (newlen >= 0x10000)
1439 s = SvPVX_mutable(sv);
1441 if (newlen > SvLEN(sv)) { /* need more room? */
1442 newlen = PERL_STRLEN_ROUNDUP(newlen);
1443 if (SvLEN(sv) && s) {
1445 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1451 s = (char*)saferealloc(s, newlen);
1454 s = (char*)safemalloc(newlen);
1455 if (SvPVX_const(sv) && SvCUR(sv)) {
1456 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1460 SvLEN_set(sv, newlen);
1466 =for apidoc sv_setiv
1468 Copies an integer into the given SV, upgrading first if necessary.
1469 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1475 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1478 SV_CHECK_THINKFIRST_COW_DROP(sv);
1479 switch (SvTYPE(sv)) {
1481 sv_upgrade(sv, SVt_IV);
1484 sv_upgrade(sv, SVt_PVNV);
1488 sv_upgrade(sv, SVt_PVIV);
1497 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1603 (void)SvNOK_only(sv); /* validate number */
1608 =for apidoc sv_setnv_mg
1610 Like C<sv_setnv>, but also handles 'set' magic.
1616 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1622 /* Print an "isn't numeric" warning, using a cleaned-up,
1623 * printable version of the offending string
1627 S_not_a_number(pTHX_ SV *sv)
1635 dsv = sv_2mortal(newSVpvs(""));
1636 pv = sv_uni_display(dsv, sv, 10, 0);
1639 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1640 /* each *s can expand to 4 chars + "...\0",
1641 i.e. need room for 8 chars */
1643 const char *s = SvPVX_const(sv);
1644 const char * const end = s + SvCUR(sv);
1645 for ( ; s < end && d < limit; s++ ) {
1647 if (ch & 128 && !isPRINT_LC(ch)) {
1656 else if (ch == '\r') {
1660 else if (ch == '\f') {
1664 else if (ch == '\\') {
1668 else if (ch == '\0') {
1672 else if (isPRINT_LC(ch))
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric in %s", pv,
1693 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1694 "Argument \"%s\" isn't numeric", pv);
1698 =for apidoc looks_like_number
1700 Test if the content of an SV looks like a number (or is a number).
1701 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1702 non-numeric warning), even if your atof() doesn't grok them.
1708 Perl_looks_like_number(pTHX_ SV *sv)
1710 register const char *sbegin;
1714 sbegin = SvPVX_const(sv);
1717 else if (SvPOKp(sv))
1718 sbegin = SvPV_const(sv, len);
1720 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1721 return grok_number(sbegin, len, NULL);
1725 S_glob_2number(pTHX_ GV * const gv)
1727 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1728 SV *const buffer = sv_newmortal();
1730 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1733 gv_efullname3(buffer, gv, "*");
1734 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1746 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1748 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1749 SV *const buffer = sv_newmortal();
1751 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1754 gv_efullname3(buffer, gv, "*");
1755 SvFLAGS(gv) |= wasfake;
1757 assert(SvPOK(buffer));
1759 *len = SvCUR(buffer);
1761 return SvPVX(buffer);
1764 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1765 until proven guilty, assume that things are not that bad... */
1770 As 64 bit platforms often have an NV that doesn't preserve all bits of
1771 an IV (an assumption perl has been based on to date) it becomes necessary
1772 to remove the assumption that the NV always carries enough precision to
1773 recreate the IV whenever needed, and that the NV is the canonical form.
1774 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1775 precision as a side effect of conversion (which would lead to insanity
1776 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1777 1) to distinguish between IV/UV/NV slots that have cached a valid
1778 conversion where precision was lost and IV/UV/NV slots that have a
1779 valid conversion which has lost no precision
1780 2) to ensure that if a numeric conversion to one form is requested that
1781 would lose precision, the precise conversion (or differently
1782 imprecise conversion) is also performed and cached, to prevent
1783 requests for different numeric formats on the same SV causing
1784 lossy conversion chains. (lossless conversion chains are perfectly
1789 SvIOKp is true if the IV slot contains a valid value
1790 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1791 SvNOKp is true if the NV slot contains a valid value
1792 SvNOK is true only if the NV value is accurate
1795 while converting from PV to NV, check to see if converting that NV to an
1796 IV(or UV) would lose accuracy over a direct conversion from PV to
1797 IV(or UV). If it would, cache both conversions, return NV, but mark
1798 SV as IOK NOKp (ie not NOK).
1800 While converting from PV to IV, check to see if converting that IV to an
1801 NV would lose accuracy over a direct conversion from PV to NV. If it
1802 would, cache both conversions, flag similarly.
1804 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1805 correctly because if IV & NV were set NV *always* overruled.
1806 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1807 changes - now IV and NV together means that the two are interchangeable:
1808 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1810 The benefit of this is that operations such as pp_add know that if
1811 SvIOK is true for both left and right operands, then integer addition
1812 can be used instead of floating point (for cases where the result won't
1813 overflow). Before, floating point was always used, which could lead to
1814 loss of precision compared with integer addition.
1816 * making IV and NV equal status should make maths accurate on 64 bit
1818 * may speed up maths somewhat if pp_add and friends start to use
1819 integers when possible instead of fp. (Hopefully the overhead in
1820 looking for SvIOK and checking for overflow will not outweigh the
1821 fp to integer speedup)
1822 * will slow down integer operations (callers of SvIV) on "inaccurate"
1823 values, as the change from SvIOK to SvIOKp will cause a call into
1824 sv_2iv each time rather than a macro access direct to the IV slot
1825 * should speed up number->string conversion on integers as IV is
1826 favoured when IV and NV are equally accurate
1828 ####################################################################
1829 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1830 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1831 On the other hand, SvUOK is true iff UV.
1832 ####################################################################
1834 Your mileage will vary depending your CPU's relative fp to integer
1838 #ifndef NV_PRESERVES_UV
1839 # define IS_NUMBER_UNDERFLOW_IV 1
1840 # define IS_NUMBER_UNDERFLOW_UV 2
1841 # define IS_NUMBER_IV_AND_UV 2
1842 # define IS_NUMBER_OVERFLOW_IV 4
1843 # define IS_NUMBER_OVERFLOW_UV 5
1845 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1847 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1849 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1852 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1853 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));
1854 if (SvNVX(sv) < (NV)IV_MIN) {
1855 (void)SvIOKp_on(sv);
1857 SvIV_set(sv, IV_MIN);
1858 return IS_NUMBER_UNDERFLOW_IV;
1860 if (SvNVX(sv) > (NV)UV_MAX) {
1861 (void)SvIOKp_on(sv);
1864 SvUV_set(sv, UV_MAX);
1865 return IS_NUMBER_OVERFLOW_UV;
1867 (void)SvIOKp_on(sv);
1869 /* Can't use strtol etc to convert this string. (See truth table in
1871 if (SvNVX(sv) <= (UV)IV_MAX) {
1872 SvIV_set(sv, I_V(SvNVX(sv)));
1873 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1874 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1876 /* Integer is imprecise. NOK, IOKp */
1878 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1881 SvUV_set(sv, U_V(SvNVX(sv)));
1882 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1883 if (SvUVX(sv) == UV_MAX) {
1884 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1885 possibly be preserved by NV. Hence, it must be overflow.
1887 return IS_NUMBER_OVERFLOW_UV;
1889 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1891 /* Integer is imprecise. NOK, IOKp */
1893 return IS_NUMBER_OVERFLOW_IV;
1895 #endif /* !NV_PRESERVES_UV*/
1898 S_sv_2iuv_common(pTHX_ SV *sv) {
1901 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1902 * without also getting a cached IV/UV from it at the same time
1903 * (ie PV->NV conversion should detect loss of accuracy and cache
1904 * IV or UV at same time to avoid this. */
1905 /* IV-over-UV optimisation - choose to cache IV if possible */
1907 if (SvTYPE(sv) == SVt_NV)
1908 sv_upgrade(sv, SVt_PVNV);
1910 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1911 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1912 certainly cast into the IV range at IV_MAX, whereas the correct
1913 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1915 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1916 if (Perl_isnan(SvNVX(sv))) {
1922 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1923 SvIV_set(sv, I_V(SvNVX(sv)));
1924 if (SvNVX(sv) == (NV) SvIVX(sv)
1925 #ifndef NV_PRESERVES_UV
1926 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1927 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1928 /* Don't flag it as "accurately an integer" if the number
1929 came from a (by definition imprecise) NV operation, and
1930 we're outside the range of NV integer precision */
1933 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1934 DEBUG_c(PerlIO_printf(Perl_debug_log,
1935 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1941 /* IV not precise. No need to convert from PV, as NV
1942 conversion would already have cached IV if it detected
1943 that PV->IV would be better than PV->NV->IV
1944 flags already correct - don't set public IOK. */
1945 DEBUG_c(PerlIO_printf(Perl_debug_log,
1946 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1951 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1952 but the cast (NV)IV_MIN rounds to a the value less (more
1953 negative) than IV_MIN which happens to be equal to SvNVX ??
1954 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1955 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1956 (NV)UVX == NVX are both true, but the values differ. :-(
1957 Hopefully for 2s complement IV_MIN is something like
1958 0x8000000000000000 which will be exact. NWC */
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1963 (SvNVX(sv) == (NV) SvUVX(sv))
1964 #ifndef NV_PRESERVES_UV
1965 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1966 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1967 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1968 /* Don't flag it as "accurately an integer" if the number
1969 came from a (by definition imprecise) NV operation, and
1970 we're outside the range of NV integer precision */
1975 DEBUG_c(PerlIO_printf(Perl_debug_log,
1976 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1982 else if (SvPOKp(sv) && SvLEN(sv)) {
1984 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1985 /* We want to avoid a possible problem when we cache an IV/ a UV which
1986 may be later translated to an NV, and the resulting NV is not
1987 the same as the direct translation of the initial string
1988 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1989 be careful to ensure that the value with the .456 is around if the
1990 NV value is requested in the future).
1992 This means that if we cache such an IV/a UV, we need to cache the
1993 NV as well. Moreover, we trade speed for space, and do not
1994 cache the NV if we are sure it's not needed.
1997 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1998 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1999 == IS_NUMBER_IN_UV) {
2000 /* It's definitely an integer, only upgrade to PVIV */
2001 if (SvTYPE(sv) < SVt_PVIV)
2002 sv_upgrade(sv, SVt_PVIV);
2004 } else if (SvTYPE(sv) < SVt_PVNV)
2005 sv_upgrade(sv, SVt_PVNV);
2007 /* If NVs preserve UVs then we only use the UV value if we know that
2008 we aren't going to call atof() below. If NVs don't preserve UVs
2009 then the value returned may have more precision than atof() will
2010 return, even though value isn't perfectly accurate. */
2011 if ((numtype & (IS_NUMBER_IN_UV
2012 #ifdef NV_PRESERVES_UV
2015 )) == IS_NUMBER_IN_UV) {
2016 /* This won't turn off the public IOK flag if it was set above */
2017 (void)SvIOKp_on(sv);
2019 if (!(numtype & IS_NUMBER_NEG)) {
2021 if (value <= (UV)IV_MAX) {
2022 SvIV_set(sv, (IV)value);
2024 /* it didn't overflow, and it was positive. */
2025 SvUV_set(sv, value);
2029 /* 2s complement assumption */
2030 if (value <= (UV)IV_MIN) {
2031 SvIV_set(sv, -(IV)value);
2033 /* Too negative for an IV. This is a double upgrade, but
2034 I'm assuming it will be rare. */
2035 if (SvTYPE(sv) < SVt_PVNV)
2036 sv_upgrade(sv, SVt_PVNV);
2040 SvNV_set(sv, -(NV)value);
2041 SvIV_set(sv, IV_MIN);
2045 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2046 will be in the previous block to set the IV slot, and the next
2047 block to set the NV slot. So no else here. */
2049 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2050 != IS_NUMBER_IN_UV) {
2051 /* It wasn't an (integer that doesn't overflow the UV). */
2052 SvNV_set(sv, Atof(SvPVX_const(sv)));
2054 if (! numtype && ckWARN(WARN_NUMERIC))
2057 #if defined(USE_LONG_DOUBLE)
2058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2059 PTR2UV(sv), SvNVX(sv)));
2061 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2062 PTR2UV(sv), SvNVX(sv)));
2065 #ifdef NV_PRESERVES_UV
2066 (void)SvIOKp_on(sv);
2068 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2069 SvIV_set(sv, I_V(SvNVX(sv)));
2070 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2073 NOOP; /* Integer is imprecise. NOK, IOKp */
2075 /* UV will not work better than IV */
2077 if (SvNVX(sv) > (NV)UV_MAX) {
2079 /* Integer is inaccurate. NOK, IOKp, is UV */
2080 SvUV_set(sv, UV_MAX);
2082 SvUV_set(sv, U_V(SvNVX(sv)));
2083 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2084 NV preservse UV so can do correct comparison. */
2085 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2088 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2093 #else /* NV_PRESERVES_UV */
2094 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2095 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2096 /* The IV/UV slot will have been set from value returned by
2097 grok_number above. The NV slot has just been set using
2100 assert (SvIOKp(sv));
2102 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2103 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2104 /* Small enough to preserve all bits. */
2105 (void)SvIOKp_on(sv);
2107 SvIV_set(sv, I_V(SvNVX(sv)));
2108 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2110 /* Assumption: first non-preserved integer is < IV_MAX,
2111 this NV is in the preserved range, therefore: */
2112 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2114 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);
2118 0 0 already failed to read UV.
2119 0 1 already failed to read UV.
2120 1 0 you won't get here in this case. IV/UV
2121 slot set, public IOK, Atof() unneeded.
2122 1 1 already read UV.
2123 so there's no point in sv_2iuv_non_preserve() attempting
2124 to use atol, strtol, strtoul etc. */
2125 sv_2iuv_non_preserve (sv, numtype);
2128 #endif /* NV_PRESERVES_UV */
2132 if (isGV_with_GP(sv))
2133 return glob_2number((GV *)sv);
2135 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2136 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2139 if (SvTYPE(sv) < SVt_IV)
2140 /* Typically the caller expects that sv_any is not NULL now. */
2141 sv_upgrade(sv, SVt_IV);
2142 /* Return 0 from the caller. */
2149 =for apidoc sv_2iv_flags
2151 Return the integer value of an SV, doing any necessary string
2152 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2153 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2159 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2164 if (SvGMAGICAL(sv)) {
2165 if (flags & SV_GMAGIC)
2170 return I_V(SvNVX(sv));
2172 if (SvPOKp(sv) && SvLEN(sv)) {
2175 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2177 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2178 == IS_NUMBER_IN_UV) {
2179 /* It's definitely an integer */
2180 if (numtype & IS_NUMBER_NEG) {
2181 if (value < (UV)IV_MIN)
2184 if (value < (UV)IV_MAX)
2189 if (ckWARN(WARN_NUMERIC))
2192 return I_V(Atof(SvPVX_const(sv)));
2197 assert(SvTYPE(sv) >= SVt_PVMG);
2198 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2199 } else if (SvTHINKFIRST(sv)) {
2203 SV * const tmpstr=AMG_CALLun(sv,numer);
2204 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2205 return SvIV(tmpstr);
2208 return PTR2IV(SvRV(sv));
2211 sv_force_normal_flags(sv, 0);
2213 if (SvREADONLY(sv) && !SvOK(sv)) {
2214 if (ckWARN(WARN_UNINITIALIZED))
2220 if (S_sv_2iuv_common(aTHX_ sv))
2223 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2224 PTR2UV(sv),SvIVX(sv)));
2225 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2229 =for apidoc sv_2uv_flags
2231 Return the unsigned integer value of an SV, doing any necessary string
2232 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2233 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2239 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2244 if (SvGMAGICAL(sv)) {
2245 if (flags & SV_GMAGIC)
2250 return U_V(SvNVX(sv));
2251 if (SvPOKp(sv) && SvLEN(sv)) {
2254 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2256 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2257 == IS_NUMBER_IN_UV) {
2258 /* It's definitely an integer */
2259 if (!(numtype & IS_NUMBER_NEG))
2263 if (ckWARN(WARN_NUMERIC))
2266 return U_V(Atof(SvPVX_const(sv)));
2271 assert(SvTYPE(sv) >= SVt_PVMG);
2272 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2273 } else if (SvTHINKFIRST(sv)) {
2277 SV *const tmpstr = AMG_CALLun(sv,numer);
2278 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2279 return SvUV(tmpstr);
2282 return PTR2UV(SvRV(sv));
2285 sv_force_normal_flags(sv, 0);
2287 if (SvREADONLY(sv) && !SvOK(sv)) {
2288 if (ckWARN(WARN_UNINITIALIZED))
2294 if (S_sv_2iuv_common(aTHX_ sv))
2298 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2299 PTR2UV(sv),SvUVX(sv)));
2300 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2306 Return the num value of an SV, doing any necessary string or integer
2307 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2314 Perl_sv_2nv(pTHX_ register SV *sv)
2319 if (SvGMAGICAL(sv)) {
2323 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2324 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2325 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2327 return Atof(SvPVX_const(sv));
2331 return (NV)SvUVX(sv);
2333 return (NV)SvIVX(sv);
2338 assert(SvTYPE(sv) >= SVt_PVMG);
2339 /* This falls through to the report_uninit near the end of the
2341 } else if (SvTHINKFIRST(sv)) {
2345 SV *const tmpstr = AMG_CALLun(sv,numer);
2346 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2347 return SvNV(tmpstr);
2350 return PTR2NV(SvRV(sv));
2353 sv_force_normal_flags(sv, 0);
2355 if (SvREADONLY(sv) && !SvOK(sv)) {
2356 if (ckWARN(WARN_UNINITIALIZED))
2361 if (SvTYPE(sv) < SVt_NV) {
2362 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2363 sv_upgrade(sv, SVt_NV);
2364 #ifdef USE_LONG_DOUBLE
2366 STORE_NUMERIC_LOCAL_SET_STANDARD();
2367 PerlIO_printf(Perl_debug_log,
2368 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2369 PTR2UV(sv), SvNVX(sv));
2370 RESTORE_NUMERIC_LOCAL();
2374 STORE_NUMERIC_LOCAL_SET_STANDARD();
2375 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2376 PTR2UV(sv), SvNVX(sv));
2377 RESTORE_NUMERIC_LOCAL();
2381 else if (SvTYPE(sv) < SVt_PVNV)
2382 sv_upgrade(sv, SVt_PVNV);
2387 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2388 #ifdef NV_PRESERVES_UV
2391 /* Only set the public NV OK flag if this NV preserves the IV */
2392 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2393 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2394 : (SvIVX(sv) == I_V(SvNVX(sv))))
2400 else if (SvPOKp(sv) && SvLEN(sv)) {
2402 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2403 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2405 #ifdef NV_PRESERVES_UV
2406 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2407 == IS_NUMBER_IN_UV) {
2408 /* It's definitely an integer */
2409 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2411 SvNV_set(sv, Atof(SvPVX_const(sv)));
2414 SvNV_set(sv, Atof(SvPVX_const(sv)));
2415 /* Only set the public NV OK flag if this NV preserves the value in
2416 the PV at least as well as an IV/UV would.
2417 Not sure how to do this 100% reliably. */
2418 /* if that shift count is out of range then Configure's test is
2419 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2421 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2422 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2423 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2424 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2425 /* Can't use strtol etc to convert this string, so don't try.
2426 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2429 /* value has been set. It may not be precise. */
2430 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2431 /* 2s complement assumption for (UV)IV_MIN */
2432 SvNOK_on(sv); /* Integer is too negative. */
2437 if (numtype & IS_NUMBER_NEG) {
2438 SvIV_set(sv, -(IV)value);
2439 } else if (value <= (UV)IV_MAX) {
2440 SvIV_set(sv, (IV)value);
2442 SvUV_set(sv, value);
2446 if (numtype & IS_NUMBER_NOT_INT) {
2447 /* I believe that even if the original PV had decimals,
2448 they are lost beyond the limit of the FP precision.
2449 However, neither is canonical, so both only get p
2450 flags. NWC, 2000/11/25 */
2451 /* Both already have p flags, so do nothing */
2453 const NV nv = SvNVX(sv);
2454 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2455 if (SvIVX(sv) == I_V(nv)) {
2458 /* It had no "." so it must be integer. */
2462 /* between IV_MAX and NV(UV_MAX).
2463 Could be slightly > UV_MAX */
2465 if (numtype & IS_NUMBER_NOT_INT) {
2466 /* UV and NV both imprecise. */
2468 const UV nv_as_uv = U_V(nv);
2470 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2479 #endif /* NV_PRESERVES_UV */
2482 if (isGV_with_GP(sv)) {
2483 glob_2number((GV *)sv);
2487 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2489 assert (SvTYPE(sv) >= SVt_NV);
2490 /* Typically the caller expects that sv_any is not NULL now. */
2491 /* XXX Ilya implies that this is a bug in callers that assume this
2492 and ideally should be fixed. */
2495 #if defined(USE_LONG_DOUBLE)
2497 STORE_NUMERIC_LOCAL_SET_STANDARD();
2498 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2499 PTR2UV(sv), SvNVX(sv));
2500 RESTORE_NUMERIC_LOCAL();
2504 STORE_NUMERIC_LOCAL_SET_STANDARD();
2505 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2506 PTR2UV(sv), SvNVX(sv));
2507 RESTORE_NUMERIC_LOCAL();
2513 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2514 * UV as a string towards the end of buf, and return pointers to start and
2517 * We assume that buf is at least TYPE_CHARS(UV) long.
2521 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2523 char *ptr = buf + TYPE_CHARS(UV);
2524 char * const ebuf = ptr;
2537 *--ptr = '0' + (char)(uv % 10);
2546 =for apidoc sv_2pv_flags
2548 Returns a pointer to the string value of an SV, and sets *lp to its length.
2549 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2551 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2552 usually end up here too.
2558 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2568 if (SvGMAGICAL(sv)) {
2569 if (flags & SV_GMAGIC)
2574 if (flags & SV_MUTABLE_RETURN)
2575 return SvPVX_mutable(sv);
2576 if (flags & SV_CONST_RETURN)
2577 return (char *)SvPVX_const(sv);
2580 if (SvIOKp(sv) || SvNOKp(sv)) {
2581 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2586 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2587 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2589 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2596 #ifdef FIXNEGATIVEZERO
2597 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2603 SvUPGRADE(sv, SVt_PV);
2606 s = SvGROW_mutable(sv, len + 1);
2609 return (char*)memcpy(s, tbuf, len + 1);
2615 assert(SvTYPE(sv) >= SVt_PVMG);
2616 /* This falls through to the report_uninit near the end of the
2618 } else if (SvTHINKFIRST(sv)) {
2622 SV *const tmpstr = AMG_CALLun(sv,string);
2623 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2625 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2629 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2630 if (flags & SV_CONST_RETURN) {
2631 pv = (char *) SvPVX_const(tmpstr);
2633 pv = (flags & SV_MUTABLE_RETURN)
2634 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2637 *lp = SvCUR(tmpstr);
2639 pv = sv_2pv_flags(tmpstr, lp, flags);
2653 const SV *const referent = (SV*)SvRV(sv);
2657 retval = buffer = savepvn("NULLREF", len);
2658 } else if (SvTYPE(referent) == SVt_PVMG
2659 && ((SvFLAGS(referent) &
2660 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2661 == (SVs_OBJECT|SVs_SMG))
2662 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2667 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2672 PL_reginterp_cnt += haseval;
2675 const char *const typestr = sv_reftype(referent, 0);
2676 const STRLEN typelen = strlen(typestr);
2677 UV addr = PTR2UV(referent);
2678 const char *stashname = NULL;
2679 STRLEN stashnamelen = 0; /* hush, gcc */
2680 const char *buffer_end;
2682 if (SvOBJECT(referent)) {
2683 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2686 stashname = HEK_KEY(name);
2687 stashnamelen = HEK_LEN(name);
2689 if (HEK_UTF8(name)) {
2695 stashname = "__ANON__";
2698 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2699 + 2 * sizeof(UV) + 2 /* )\0 */;
2701 len = typelen + 3 /* (0x */
2702 + 2 * sizeof(UV) + 2 /* )\0 */;
2705 Newx(buffer, len, char);
2706 buffer_end = retval = buffer + len;
2708 /* Working backwards */
2712 *--retval = PL_hexdigit[addr & 15];
2713 } while (addr >>= 4);
2719 memcpy(retval, typestr, typelen);
2723 retval -= stashnamelen;
2724 memcpy(retval, stashname, stashnamelen);
2726 /* retval may not neccesarily have reached the start of the
2728 assert (retval >= buffer);
2730 len = buffer_end - retval - 1; /* -1 for that \0 */
2738 if (SvREADONLY(sv) && !SvOK(sv)) {
2739 if (ckWARN(WARN_UNINITIALIZED))
2746 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2747 /* I'm assuming that if both IV and NV are equally valid then
2748 converting the IV is going to be more efficient */
2749 const U32 isIOK = SvIOK(sv);
2750 const U32 isUIOK = SvIsUV(sv);
2751 char buf[TYPE_CHARS(UV)];
2754 if (SvTYPE(sv) < SVt_PVIV)
2755 sv_upgrade(sv, SVt_PVIV);
2756 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2757 /* inlined from sv_setpvn */
2758 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2759 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2760 SvCUR_set(sv, ebuf - ptr);
2770 else if (SvNOKp(sv)) {
2771 const int olderrno = errno;
2772 if (SvTYPE(sv) < SVt_PVNV)
2773 sv_upgrade(sv, SVt_PVNV);
2774 /* The +20 is pure guesswork. Configure test needed. --jhi */
2775 s = SvGROW_mutable(sv, NV_DIG + 20);
2776 /* some Xenix systems wipe out errno here */
2778 if (SvNVX(sv) == 0.0)
2779 my_strlcpy(s, "0", SvLEN(sv));
2783 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2786 #ifdef FIXNEGATIVEZERO
2787 if (*s == '-' && s[1] == '0' && !s[2])
2788 my_strlcpy(s, "0", SvLEN(s));
2797 if (isGV_with_GP(sv))
2798 return glob_2pv((GV *)sv, lp);
2800 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2804 if (SvTYPE(sv) < SVt_PV)
2805 /* Typically the caller expects that sv_any is not NULL now. */
2806 sv_upgrade(sv, SVt_PV);
2810 const STRLEN len = s - SvPVX_const(sv);
2816 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2817 PTR2UV(sv),SvPVX_const(sv)));
2818 if (flags & SV_CONST_RETURN)
2819 return (char *)SvPVX_const(sv);
2820 if (flags & SV_MUTABLE_RETURN)
2821 return SvPVX_mutable(sv);
2826 =for apidoc sv_copypv
2828 Copies a stringified representation of the source SV into the
2829 destination SV. Automatically performs any necessary mg_get and
2830 coercion of numeric values into strings. Guaranteed to preserve
2831 UTF-8 flag even from overloaded objects. Similar in nature to
2832 sv_2pv[_flags] but operates directly on an SV instead of just the
2833 string. Mostly uses sv_2pv_flags to do its work, except when that
2834 would lose the UTF-8'ness of the PV.
2840 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2843 const char * const s = SvPV_const(ssv,len);
2844 sv_setpvn(dsv,s,len);
2852 =for apidoc sv_2pvbyte
2854 Return a pointer to the byte-encoded representation of the SV, and set *lp
2855 to its length. May cause the SV to be downgraded from UTF-8 as a
2858 Usually accessed via the C<SvPVbyte> macro.
2864 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2866 sv_utf8_downgrade(sv,0);
2867 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2871 =for apidoc sv_2pvutf8
2873 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2874 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2876 Usually accessed via the C<SvPVutf8> macro.
2882 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2884 sv_utf8_upgrade(sv);
2885 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2890 =for apidoc sv_2bool
2892 This function is only called on magical items, and is only used by
2893 sv_true() or its macro equivalent.
2899 Perl_sv_2bool(pTHX_ register SV *sv)
2908 SV * const tmpsv = AMG_CALLun(sv,bool_);
2909 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2910 return (bool)SvTRUE(tmpsv);
2912 return SvRV(sv) != 0;
2915 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2917 (*sv->sv_u.svu_pv > '0' ||
2918 Xpvtmp->xpv_cur > 1 ||
2919 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2926 return SvIVX(sv) != 0;
2929 return SvNVX(sv) != 0.0;
2931 if (isGV_with_GP(sv))
2941 =for apidoc sv_utf8_upgrade
2943 Converts the PV of an SV to its UTF-8-encoded form.
2944 Forces the SV to string form if it is not already.
2945 Always sets the SvUTF8 flag to avoid future validity checks even
2946 if all the bytes have hibit clear.
2948 This is not as a general purpose byte encoding to Unicode interface:
2949 use the Encode extension for that.
2951 =for apidoc sv_utf8_upgrade_flags
2953 Converts the PV of an SV to its UTF-8-encoded form.
2954 Forces the SV to string form if it is not already.
2955 Always sets the SvUTF8 flag to avoid future validity checks even
2956 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2957 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2958 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2960 This is not as a general purpose byte encoding to Unicode interface:
2961 use the Encode extension for that.
2967 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2970 if (sv == &PL_sv_undef)
2974 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2975 (void) sv_2pv_flags(sv,&len, flags);
2979 (void) SvPV_force(sv,len);
2988 sv_force_normal_flags(sv, 0);
2991 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2992 sv_recode_to_utf8(sv, PL_encoding);
2993 else { /* Assume Latin-1/EBCDIC */
2994 /* This function could be much more efficient if we
2995 * had a FLAG in SVs to signal if there are any hibit
2996 * chars in the PV. Given that there isn't such a flag
2997 * make the loop as fast as possible. */
2998 const U8 * const s = (U8 *) SvPVX_const(sv);
2999 const U8 * const e = (U8 *) SvEND(sv);
3004 /* Check for hi bit */
3005 if (!NATIVE_IS_INVARIANT(ch)) {
3006 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3007 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3009 SvPV_free(sv); /* No longer using what was there before. */
3010 SvPV_set(sv, (char*)recoded);
3011 SvCUR_set(sv, len - 1);
3012 SvLEN_set(sv, len); /* No longer know the real size. */
3016 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3023 =for apidoc sv_utf8_downgrade
3025 Attempts to convert the PV of an SV from characters to bytes.
3026 If the PV contains a character beyond byte, this conversion will fail;
3027 in this case, either returns false or, if C<fail_ok> is not
3030 This is not as a general purpose Unicode to byte encoding interface:
3031 use the Encode extension for that.
3037 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3040 if (SvPOKp(sv) && SvUTF8(sv)) {
3046 sv_force_normal_flags(sv, 0);
3048 s = (U8 *) SvPV(sv, len);
3049 if (!utf8_to_bytes(s, &len)) {
3054 Perl_croak(aTHX_ "Wide character in %s",
3057 Perl_croak(aTHX_ "Wide character");
3068 =for apidoc sv_utf8_encode
3070 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3071 flag off so that it looks like octets again.
3077 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3080 sv_force_normal_flags(sv, 0);
3082 if (SvREADONLY(sv)) {
3083 Perl_croak(aTHX_ PL_no_modify);
3085 (void) sv_utf8_upgrade(sv);
3090 =for apidoc sv_utf8_decode
3092 If the PV of the SV is an octet sequence in UTF-8
3093 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3094 so that it looks like a character. If the PV contains only single-byte
3095 characters, the C<SvUTF8> flag stays being off.
3096 Scans PV for validity and returns false if the PV is invalid UTF-8.
3102 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3108 /* The octets may have got themselves encoded - get them back as
3111 if (!sv_utf8_downgrade(sv, TRUE))
3114 /* it is actually just a matter of turning the utf8 flag on, but
3115 * we want to make sure everything inside is valid utf8 first.
3117 c = (const U8 *) SvPVX_const(sv);
3118 if (!is_utf8_string(c, SvCUR(sv)+1))
3120 e = (const U8 *) SvEND(sv);
3123 if (!UTF8_IS_INVARIANT(ch)) {
3133 =for apidoc sv_setsv
3135 Copies the contents of the source SV C<ssv> into the destination SV
3136 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3137 function if the source SV needs to be reused. Does not handle 'set' magic.
3138 Loosely speaking, it performs a copy-by-value, obliterating any previous
3139 content of the destination.
3141 You probably want to use one of the assortment of wrappers, such as
3142 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3143 C<SvSetMagicSV_nosteal>.
3145 =for apidoc sv_setsv_flags
3147 Copies the contents of the source SV C<ssv> into the destination SV
3148 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3149 function if the source SV needs to be reused. Does not handle 'set' magic.
3150 Loosely speaking, it performs a copy-by-value, obliterating any previous
3151 content of the destination.
3152 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3153 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3154 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3155 and C<sv_setsv_nomg> are implemented in terms of this function.
3157 You probably want to use one of the assortment of wrappers, such as
3158 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3159 C<SvSetMagicSV_nosteal>.
3161 This is the primary function for copying scalars, and most other
3162 copy-ish functions and macros use this underneath.
3168 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3170 if (dtype != SVt_PVGV) {
3171 const char * const name = GvNAME(sstr);
3172 const STRLEN len = GvNAMELEN(sstr);
3173 /* don't upgrade SVt_PVLV: it can hold a glob */
3174 if (dtype != SVt_PVLV) {
3175 if (dtype >= SVt_PV) {
3181 sv_upgrade(dstr, SVt_PVGV);
3182 (void)SvOK_off(dstr);
3185 GvSTASH(dstr) = GvSTASH(sstr);
3187 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3188 gv_name_set((GV *)dstr, name, len, GV_ADD);
3189 SvFAKE_on(dstr); /* can coerce to non-glob */
3192 #ifdef GV_UNIQUE_CHECK
3193 if (GvUNIQUE((GV*)dstr)) {
3194 Perl_croak(aTHX_ PL_no_modify);
3200 (void)SvOK_off(dstr);
3202 GvINTRO_off(dstr); /* one-shot flag */
3203 GvGP(dstr) = gp_ref(GvGP(sstr));
3204 if (SvTAINTED(sstr))
3206 if (GvIMPORTED(dstr) != GVf_IMPORTED
3207 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3209 GvIMPORTED_on(dstr);
3216 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3217 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3219 const int intro = GvINTRO(dstr);
3222 const U32 stype = SvTYPE(sref);
3225 #ifdef GV_UNIQUE_CHECK
3226 if (GvUNIQUE((GV*)dstr)) {
3227 Perl_croak(aTHX_ PL_no_modify);
3232 GvINTRO_off(dstr); /* one-shot flag */
3233 GvLINE(dstr) = CopLINE(PL_curcop);
3234 GvEGV(dstr) = (GV*)dstr;
3239 location = (SV **) &GvCV(dstr);
3240 import_flag = GVf_IMPORTED_CV;
3243 location = (SV **) &GvHV(dstr);
3244 import_flag = GVf_IMPORTED_HV;
3247 location = (SV **) &GvAV(dstr);
3248 import_flag = GVf_IMPORTED_AV;
3251 location = (SV **) &GvIOp(dstr);
3254 location = (SV **) &GvFORM(dstr);
3256 location = &GvSV(dstr);
3257 import_flag = GVf_IMPORTED_SV;
3260 if (stype == SVt_PVCV) {
3261 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3262 SvREFCNT_dec(GvCV(dstr));
3264 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3265 PL_sub_generation++;
3268 SAVEGENERICSV(*location);
3272 if (stype == SVt_PVCV && *location != sref) {
3273 CV* const cv = (CV*)*location;
3275 if (!GvCVGEN((GV*)dstr) &&
3276 (CvROOT(cv) || CvXSUB(cv)))
3278 /* Redefining a sub - warning is mandatory if
3279 it was a const and its value changed. */
3280 if (CvCONST(cv) && CvCONST((CV*)sref)
3281 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3283 /* They are 2 constant subroutines generated from
3284 the same constant. This probably means that
3285 they are really the "same" proxy subroutine
3286 instantiated in 2 places. Most likely this is
3287 when a constant is exported twice. Don't warn.
3290 else if (ckWARN(WARN_REDEFINE)
3292 && (!CvCONST((CV*)sref)
3293 || sv_cmp(cv_const_sv(cv),
3294 cv_const_sv((CV*)sref))))) {
3295 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3298 ? "Constant subroutine %s::%s redefined"
3299 : "Subroutine %s::%s redefined"),
3300 HvNAME_get(GvSTASH((GV*)dstr)),
3301 GvENAME((GV*)dstr));
3305 cv_ckproto_len(cv, (GV*)dstr,
3306 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3307 SvPOK(sref) ? SvCUR(sref) : 0);
3309 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3310 GvASSUMECV_on(dstr);
3311 PL_sub_generation++;
3314 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3315 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3316 GvFLAGS(dstr) |= import_flag;
3321 if (SvTAINTED(sstr))
3327 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3330 register U32 sflags;
3332 register svtype stype;
3337 if (SvIS_FREED(dstr)) {
3338 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3339 " to a freed scalar %p", sstr, dstr);
3341 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3343 sstr = &PL_sv_undef;
3344 if (SvIS_FREED(sstr)) {
3345 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3348 stype = SvTYPE(sstr);
3349 dtype = SvTYPE(dstr);
3354 /* need to nuke the magic */
3356 SvRMAGICAL_off(dstr);
3359 /* There's a lot of redundancy below but we're going for speed here */
3364 if (dtype != SVt_PVGV) {
3365 (void)SvOK_off(dstr);
3373 sv_upgrade(dstr, SVt_IV);
3378 sv_upgrade(dstr, SVt_PVIV);
3381 (void)SvIOK_only(dstr);
3382 SvIV_set(dstr, SvIVX(sstr));
3385 /* SvTAINTED can only be true if the SV has taint magic, which in
3386 turn means that the SV type is PVMG (or greater). This is the
3387 case statement for SVt_IV, so this cannot be true (whatever gcov
3389 assert(!SvTAINTED(sstr));
3399 sv_upgrade(dstr, SVt_NV);
3404 sv_upgrade(dstr, SVt_PVNV);
3407 SvNV_set(dstr, SvNVX(sstr));
3408 (void)SvNOK_only(dstr);
3409 /* SvTAINTED can only be true if the SV has taint magic, which in
3410 turn means that the SV type is PVMG (or greater). This is the
3411 case statement for SVt_NV, so this cannot be true (whatever gcov
3413 assert(!SvTAINTED(sstr));
3420 sv_upgrade(dstr, SVt_RV);
3423 #ifdef PERL_OLD_COPY_ON_WRITE
3424 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3425 if (dtype < SVt_PVIV)
3426 sv_upgrade(dstr, SVt_PVIV);
3433 sv_upgrade(dstr, SVt_PV);
3436 if (dtype < SVt_PVIV)
3437 sv_upgrade(dstr, SVt_PVIV);
3440 if (dtype < SVt_PVNV)
3441 sv_upgrade(dstr, SVt_PVNV);
3445 const char * const type = sv_reftype(sstr,0);
3447 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3449 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3454 if (dtype <= SVt_PVGV) {
3455 glob_assign_glob(dstr, sstr, dtype);
3463 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3465 if (SvTYPE(sstr) != stype) {
3466 stype = SvTYPE(sstr);
3467 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3468 glob_assign_glob(dstr, sstr, dtype);
3473 if (stype == SVt_PVLV)
3474 SvUPGRADE(dstr, SVt_PVNV);
3476 SvUPGRADE(dstr, (svtype)stype);
3479 /* dstr may have been upgraded. */
3480 dtype = SvTYPE(dstr);
3481 sflags = SvFLAGS(sstr);
3483 if (dtype == SVt_PVCV) {
3484 /* Assigning to a subroutine sets the prototype. */
3487 const char *const ptr = SvPV_const(sstr, len);
3489 SvGROW(dstr, len + 1);
3490 Copy(ptr, SvPVX(dstr), len + 1, char);
3491 SvCUR_set(dstr, len);
3496 } else if (sflags & SVf_ROK) {
3497 if (dtype == SVt_PVGV && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3500 if (GvIMPORTED(dstr) != GVf_IMPORTED
3501 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3503 GvIMPORTED_on(dstr);
3508 glob_assign_glob(dstr, sstr, dtype);
3512 if (dtype >= SVt_PV) {
3513 if (dtype == SVt_PVGV) {
3514 glob_assign_ref(dstr, sstr);
3517 if (SvPVX_const(dstr)) {
3523 (void)SvOK_off(dstr);
3524 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3525 SvFLAGS(dstr) |= sflags & SVf_ROK;
3526 assert(!(sflags & SVp_NOK));
3527 assert(!(sflags & SVp_IOK));
3528 assert(!(sflags & SVf_NOK));
3529 assert(!(sflags & SVf_IOK));
3531 else if (dtype == SVt_PVGV) {
3532 if (!(sflags & SVf_OK)) {
3533 if (ckWARN(WARN_MISC))
3534 Perl_warner(aTHX_ packWARN(WARN_MISC),
3535 "Undefined value assigned to typeglob");
3538 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3539 if (dstr != (SV*)gv) {
3542 GvGP(dstr) = gp_ref(GvGP(gv));
3546 else if (sflags & SVp_POK) {
3550 * Check to see if we can just swipe the string. If so, it's a
3551 * possible small lose on short strings, but a big win on long ones.
3552 * It might even be a win on short strings if SvPVX_const(dstr)
3553 * has to be allocated and SvPVX_const(sstr) has to be freed.
3554 * Likewise if we can set up COW rather than doing an actual copy, we
3555 * drop to the else clause, as the swipe code and the COW setup code
3556 * have much in common.
3559 /* Whichever path we take through the next code, we want this true,
3560 and doing it now facilitates the COW check. */
3561 (void)SvPOK_only(dstr);
3564 /* If we're already COW then this clause is not true, and if COW
3565 is allowed then we drop down to the else and make dest COW
3566 with us. If caller hasn't said that we're allowed to COW
3567 shared hash keys then we don't do the COW setup, even if the
3568 source scalar is a shared hash key scalar. */
3569 (((flags & SV_COW_SHARED_HASH_KEYS)
3570 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3571 : 1 /* If making a COW copy is forbidden then the behaviour we
3572 desire is as if the source SV isn't actually already
3573 COW, even if it is. So we act as if the source flags
3574 are not COW, rather than actually testing them. */
3576 #ifndef PERL_OLD_COPY_ON_WRITE
3577 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3578 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3579 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3580 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3581 but in turn, it's somewhat dead code, never expected to go
3582 live, but more kept as a placeholder on how to do it better
3583 in a newer implementation. */
3584 /* If we are COW and dstr is a suitable target then we drop down
3585 into the else and make dest a COW of us. */
3586 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3591 (sflags & SVs_TEMP) && /* slated for free anyway? */
3592 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3593 (!(flags & SV_NOSTEAL)) &&
3594 /* and we're allowed to steal temps */
3595 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3596 SvLEN(sstr) && /* and really is a string */
3597 /* and won't be needed again, potentially */
3598 !(PL_op && PL_op->op_type == OP_AASSIGN))
3599 #ifdef PERL_OLD_COPY_ON_WRITE
3600 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3601 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3602 && SvTYPE(sstr) >= SVt_PVIV)
3605 /* Failed the swipe test, and it's not a shared hash key either.
3606 Have to copy the string. */
3607 STRLEN len = SvCUR(sstr);
3608 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3609 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3610 SvCUR_set(dstr, len);
3611 *SvEND(dstr) = '\0';
3613 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3615 /* Either it's a shared hash key, or it's suitable for
3616 copy-on-write or we can swipe the string. */
3618 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3622 #ifdef PERL_OLD_COPY_ON_WRITE
3624 /* I believe I should acquire a global SV mutex if
3625 it's a COW sv (not a shared hash key) to stop
3626 it going un copy-on-write.
3627 If the source SV has gone un copy on write between up there
3628 and down here, then (assert() that) it is of the correct
3629 form to make it copy on write again */
3630 if ((sflags & (SVf_FAKE | SVf_READONLY))
3631 != (SVf_FAKE | SVf_READONLY)) {
3632 SvREADONLY_on(sstr);
3634 /* Make the source SV into a loop of 1.
3635 (about to become 2) */
3636 SV_COW_NEXT_SV_SET(sstr, sstr);
3640 /* Initial code is common. */
3641 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3646 /* making another shared SV. */
3647 STRLEN cur = SvCUR(sstr);
3648 STRLEN len = SvLEN(sstr);
3649 #ifdef PERL_OLD_COPY_ON_WRITE
3651 assert (SvTYPE(dstr) >= SVt_PVIV);
3652 /* SvIsCOW_normal */
3653 /* splice us in between source and next-after-source. */
3654 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3655 SV_COW_NEXT_SV_SET(sstr, dstr);
3656 SvPV_set(dstr, SvPVX_mutable(sstr));
3660 /* SvIsCOW_shared_hash */
3661 DEBUG_C(PerlIO_printf(Perl_debug_log,
3662 "Copy on write: Sharing hash\n"));
3664 assert (SvTYPE(dstr) >= SVt_PV);
3666 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3668 SvLEN_set(dstr, len);
3669 SvCUR_set(dstr, cur);
3670 SvREADONLY_on(dstr);
3672 /* Relesase a global SV mutex. */
3675 { /* Passes the swipe test. */
3676 SvPV_set(dstr, SvPVX_mutable(sstr));
3677 SvLEN_set(dstr, SvLEN(sstr));
3678 SvCUR_set(dstr, SvCUR(sstr));
3681 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3682 SvPV_set(sstr, NULL);
3688 if (sflags & SVp_NOK) {
3689 SvNV_set(dstr, SvNVX(sstr));
3691 if (sflags & SVp_IOK) {
3692 SvRELEASE_IVX(dstr);
3693 SvIV_set(dstr, SvIVX(sstr));
3694 /* Must do this otherwise some other overloaded use of 0x80000000
3695 gets confused. I guess SVpbm_VALID */
3696 if (sflags & SVf_IVisUV)
3699 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3701 const MAGIC * const smg = SvVSTRING_mg(sstr);
3703 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3704 smg->mg_ptr, smg->mg_len);
3705 SvRMAGICAL_on(dstr);
3709 else if (sflags & (SVp_IOK|SVp_NOK)) {
3710 (void)SvOK_off(dstr);
3711 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3712 if (sflags & SVp_IOK) {
3713 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3714 SvIV_set(dstr, SvIVX(sstr));
3716 if (sflags & SVp_NOK) {
3717 SvNV_set(dstr, SvNVX(sstr));
3721 if (isGV_with_GP(sstr)) {
3722 /* This stringification rule for globs is spread in 3 places.
3723 This feels bad. FIXME. */
3724 const U32 wasfake = sflags & SVf_FAKE;
3726 /* FAKE globs can get coerced, so need to turn this off
3727 temporarily if it is on. */
3729 gv_efullname3(dstr, (GV *)sstr, "*");
3730 SvFLAGS(sstr) |= wasfake;
3733 (void)SvOK_off(dstr);
3735 if (SvTAINTED(sstr))
3740 =for apidoc sv_setsv_mg
3742 Like C<sv_setsv>, but also handles 'set' magic.
3748 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3750 sv_setsv(dstr,sstr);
3754 #ifdef PERL_OLD_COPY_ON_WRITE
3756 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3758 STRLEN cur = SvCUR(sstr);
3759 STRLEN len = SvLEN(sstr);
3760 register char *new_pv;
3763 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3771 if (SvTHINKFIRST(dstr))
3772 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3773 else if (SvPVX_const(dstr))
3774 Safefree(SvPVX_const(dstr));
3778 SvUPGRADE(dstr, SVt_PVIV);
3780 assert (SvPOK(sstr));
3781 assert (SvPOKp(sstr));
3782 assert (!SvIOK(sstr));
3783 assert (!SvIOKp(sstr));
3784 assert (!SvNOK(sstr));
3785 assert (!SvNOKp(sstr));
3787 if (SvIsCOW(sstr)) {
3789 if (SvLEN(sstr) == 0) {
3790 /* source is a COW shared hash key. */
3791 DEBUG_C(PerlIO_printf(Perl_debug_log,
3792 "Fast copy on write: Sharing hash\n"));
3793 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3796 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3798 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3799 SvUPGRADE(sstr, SVt_PVIV);
3800 SvREADONLY_on(sstr);
3802 DEBUG_C(PerlIO_printf(Perl_debug_log,
3803 "Fast copy on write: Converting sstr to COW\n"));
3804 SV_COW_NEXT_SV_SET(dstr, sstr);
3806 SV_COW_NEXT_SV_SET(sstr, dstr);
3807 new_pv = SvPVX_mutable(sstr);
3810 SvPV_set(dstr, new_pv);
3811 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3814 SvLEN_set(dstr, len);
3815 SvCUR_set(dstr, cur);
3824 =for apidoc sv_setpvn
3826 Copies a string into an SV. The C<len> parameter indicates the number of
3827 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3828 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3834 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3837 register char *dptr;
3839 SV_CHECK_THINKFIRST_COW_DROP(sv);
3845 /* len is STRLEN which is unsigned, need to copy to signed */
3848 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3850 SvUPGRADE(sv, SVt_PV);
3852 dptr = SvGROW(sv, len + 1);
3853 Move(ptr,dptr,len,char);
3856 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3861 =for apidoc sv_setpvn_mg
3863 Like C<sv_setpvn>, but also handles 'set' magic.
3869 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3871 sv_setpvn(sv,ptr,len);
3876 =for apidoc sv_setpv
3878 Copies a string into an SV. The string must be null-terminated. Does not
3879 handle 'set' magic. See C<sv_setpv_mg>.
3885 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3888 register STRLEN len;
3890 SV_CHECK_THINKFIRST_COW_DROP(sv);
3896 SvUPGRADE(sv, SVt_PV);
3898 SvGROW(sv, len + 1);
3899 Move(ptr,SvPVX(sv),len+1,char);
3901 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3906 =for apidoc sv_setpv_mg
3908 Like C<sv_setpv>, but also handles 'set' magic.
3914 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3921 =for apidoc sv_usepvn_flags
3923 Tells an SV to use C<ptr> to find its string value. Normally the
3924 string is stored inside the SV but sv_usepvn allows the SV to use an
3925 outside string. The C<ptr> should point to memory that was allocated
3926 by C<malloc>. The string length, C<len>, must be supplied. By default
3927 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3928 so that pointer should not be freed or used by the programmer after
3929 giving it to sv_usepvn, and neither should any pointers from "behind"
3930 that pointer (e.g. ptr + 1) be used.
3932 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3933 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3934 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3935 C<len>, and already meets the requirements for storing in C<SvPVX>)
3941 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3945 SV_CHECK_THINKFIRST_COW_DROP(sv);
3946 SvUPGRADE(sv, SVt_PV);
3949 if (flags & SV_SMAGIC)
3953 if (SvPVX_const(sv))
3957 if (flags & SV_HAS_TRAILING_NUL)
3958 assert(ptr[len] == '\0');
3961 allocate = (flags & SV_HAS_TRAILING_NUL)
3962 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3963 if (flags & SV_HAS_TRAILING_NUL) {
3964 /* It's long enough - do nothing.
3965 Specfically Perl_newCONSTSUB is relying on this. */
3968 /* Force a move to shake out bugs in callers. */
3969 char *new_ptr = (char*)safemalloc(allocate);
3970 Copy(ptr, new_ptr, len, char);
3971 PoisonFree(ptr,len,char);
3975 ptr = (char*) saferealloc (ptr, allocate);
3980 SvLEN_set(sv, allocate);
3981 if (!(flags & SV_HAS_TRAILING_NUL)) {
3984 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3986 if (flags & SV_SMAGIC)
3990 #ifdef PERL_OLD_COPY_ON_WRITE
3991 /* Need to do this *after* making the SV normal, as we need the buffer
3992 pointer to remain valid until after we've copied it. If we let go too early,
3993 another thread could invalidate it by unsharing last of the same hash key
3994 (which it can do by means other than releasing copy-on-write Svs)
3995 or by changing the other copy-on-write SVs in the loop. */
3997 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3999 if (len) { /* this SV was SvIsCOW_normal(sv) */
4000 /* we need to find the SV pointing to us. */
4001 SV *current = SV_COW_NEXT_SV(after);
4003 if (current == sv) {
4004 /* The SV we point to points back to us (there were only two of us
4006 Hence other SV is no longer copy on write either. */
4008 SvREADONLY_off(after);
4010 /* We need to follow the pointers around the loop. */
4012 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4015 /* don't loop forever if the structure is bust, and we have
4016 a pointer into a closed loop. */
4017 assert (current != after);
4018 assert (SvPVX_const(current) == pvx);
4020 /* Make the SV before us point to the SV after us. */
4021 SV_COW_NEXT_SV_SET(current, after);
4024 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4029 Perl_sv_release_IVX(pTHX_ register SV *sv)
4032 sv_force_normal_flags(sv, 0);
4038 =for apidoc sv_force_normal_flags
4040 Undo various types of fakery on an SV: if the PV is a shared string, make
4041 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4042 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4043 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4044 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4045 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4046 set to some other value.) In addition, the C<flags> parameter gets passed to
4047 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4048 with flags set to 0.
4054 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4057 #ifdef PERL_OLD_COPY_ON_WRITE
4058 if (SvREADONLY(sv)) {
4059 /* At this point I believe I should acquire a global SV mutex. */
4061 const char * const pvx = SvPVX_const(sv);
4062 const STRLEN len = SvLEN(sv);
4063 const STRLEN cur = SvCUR(sv);
4064 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4066 PerlIO_printf(Perl_debug_log,
4067 "Copy on write: Force normal %ld\n",
4073 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4076 if (flags & SV_COW_DROP_PV) {
4077 /* OK, so we don't need to copy our buffer. */
4080 SvGROW(sv, cur + 1);
4081 Move(pvx,SvPVX(sv),cur,char);
4085 sv_release_COW(sv, pvx, len, next);
4090 else if (IN_PERL_RUNTIME)
4091 Perl_croak(aTHX_ PL_no_modify);
4092 /* At this point I believe that I can drop the global SV mutex. */
4095 if (SvREADONLY(sv)) {
4097 const char * const pvx = SvPVX_const(sv);
4098 const STRLEN len = SvCUR(sv);
4103 SvGROW(sv, len + 1);
4104 Move(pvx,SvPVX(sv),len,char);
4106 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4108 else if (IN_PERL_RUNTIME)
4109 Perl_croak(aTHX_ PL_no_modify);
4113 sv_unref_flags(sv, flags);
4114 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4121 Efficient removal of characters from the beginning of the string buffer.
4122 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4123 the string buffer. The C<ptr> becomes the first character of the adjusted
4124 string. Uses the "OOK hack".
4125 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4126 refer to the same chunk of data.
4132 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4134 register STRLEN delta;
4135 if (!ptr || !SvPOKp(sv))
4137 delta = ptr - SvPVX_const(sv);
4138 SV_CHECK_THINKFIRST(sv);
4139 if (SvTYPE(sv) < SVt_PVIV)
4140 sv_upgrade(sv,SVt_PVIV);
4143 if (!SvLEN(sv)) { /* make copy of shared string */
4144 const char *pvx = SvPVX_const(sv);
4145 const STRLEN len = SvCUR(sv);
4146 SvGROW(sv, len + 1);
4147 Move(pvx,SvPVX(sv),len,char);
4151 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4152 and we do that anyway inside the SvNIOK_off
4154 SvFLAGS(sv) |= SVf_OOK;
4157 SvLEN_set(sv, SvLEN(sv) - delta);
4158 SvCUR_set(sv, SvCUR(sv) - delta);
4159 SvPV_set(sv, SvPVX(sv) + delta);
4160 SvIV_set(sv, SvIVX(sv) + delta);
4164 =for apidoc sv_catpvn
4166 Concatenates the string onto the end of the string which is in the SV. The
4167 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4168 status set, then the bytes appended should be valid UTF-8.
4169 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4171 =for apidoc sv_catpvn_flags
4173 Concatenates the string onto the end of the string which is in the SV. The
4174 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4175 status set, then the bytes appended should be valid UTF-8.
4176 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4177 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4178 in terms of this function.
4184 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4188 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4190 SvGROW(dsv, dlen + slen + 1);
4192 sstr = SvPVX_const(dsv);
4193 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4194 SvCUR_set(dsv, SvCUR(dsv) + slen);
4196 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4198 if (flags & SV_SMAGIC)
4203 =for apidoc sv_catsv
4205 Concatenates the string from SV C<ssv> onto the end of the string in
4206 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4207 not 'set' magic. See C<sv_catsv_mg>.
4209 =for apidoc sv_catsv_flags
4211 Concatenates the string from SV C<ssv> onto the end of the string in
4212 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4213 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4214 and C<sv_catsv_nomg> are implemented in terms of this function.
4219 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4224 const char *spv = SvPV_const(ssv, slen);
4226 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4227 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4228 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4229 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4230 dsv->sv_flags doesn't have that bit set.
4231 Andy Dougherty 12 Oct 2001
4233 const I32 sutf8 = DO_UTF8(ssv);
4236 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4238 dutf8 = DO_UTF8(dsv);
4240 if (dutf8 != sutf8) {
4242 /* Not modifying source SV, so taking a temporary copy. */
4243 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4245 sv_utf8_upgrade(csv);
4246 spv = SvPV_const(csv, slen);
4249 sv_utf8_upgrade_nomg(dsv);
4251 sv_catpvn_nomg(dsv, spv, slen);
4254 if (flags & SV_SMAGIC)
4259 =for apidoc sv_catpv
4261 Concatenates the string onto the end of the string which is in the SV.
4262 If the SV has the UTF-8 status set, then the bytes appended should be
4263 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4268 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4271 register STRLEN len;
4277 junk = SvPV_force(sv, tlen);
4279 SvGROW(sv, tlen + len + 1);
4281 ptr = SvPVX_const(sv);
4282 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4283 SvCUR_set(sv, SvCUR(sv) + len);
4284 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4289 =for apidoc sv_catpv_mg
4291 Like C<sv_catpv>, but also handles 'set' magic.
4297 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4306 Creates a new SV. A non-zero C<len> parameter indicates the number of
4307 bytes of preallocated string space the SV should have. An extra byte for a
4308 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4309 space is allocated.) The reference count for the new SV is set to 1.
4311 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4312 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4313 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4314 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4315 modules supporting older perls.
4321 Perl_newSV(pTHX_ STRLEN len)
4328 sv_upgrade(sv, SVt_PV);
4329 SvGROW(sv, len + 1);
4334 =for apidoc sv_magicext
4336 Adds magic to an SV, upgrading it if necessary. Applies the
4337 supplied vtable and returns a pointer to the magic added.
4339 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4340 In particular, you can add magic to SvREADONLY SVs, and add more than
4341 one instance of the same 'how'.
4343 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4344 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4345 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4346 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4348 (This is now used as a subroutine by C<sv_magic>.)
4353 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4354 const char* name, I32 namlen)
4359 if (SvTYPE(sv) < SVt_PVMG) {
4360 SvUPGRADE(sv, SVt_PVMG);
4362 Newxz(mg, 1, MAGIC);
4363 mg->mg_moremagic = SvMAGIC(sv);
4364 SvMAGIC_set(sv, mg);
4366 /* Sometimes a magic contains a reference loop, where the sv and
4367 object refer to each other. To prevent a reference loop that
4368 would prevent such objects being freed, we look for such loops
4369 and if we find one we avoid incrementing the object refcount.
4371 Note we cannot do this to avoid self-tie loops as intervening RV must
4372 have its REFCNT incremented to keep it in existence.
4375 if (!obj || obj == sv ||
4376 how == PERL_MAGIC_arylen ||
4377 how == PERL_MAGIC_qr ||
4378 how == PERL_MAGIC_symtab ||
4379 (SvTYPE(obj) == SVt_PVGV &&
4380 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4381 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4382 GvFORM(obj) == (CV*)sv)))
4387 mg->mg_obj = SvREFCNT_inc_simple(obj);
4388 mg->mg_flags |= MGf_REFCOUNTED;
4391 /* Normal self-ties simply pass a null object, and instead of
4392 using mg_obj directly, use the SvTIED_obj macro to produce a
4393 new RV as needed. For glob "self-ties", we are tieing the PVIO
4394 with an RV obj pointing to the glob containing the PVIO. In
4395 this case, to avoid a reference loop, we need to weaken the
4399 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4400 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4406 mg->mg_len = namlen;
4409 mg->mg_ptr = savepvn(name, namlen);
4410 else if (namlen == HEf_SVKEY)
4411 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4413 mg->mg_ptr = (char *) name;
4415 mg->mg_virtual = vtable;
4419 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4424 =for apidoc sv_magic
4426 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4427 then adds a new magic item of type C<how> to the head of the magic list.
4429 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4430 handling of the C<name> and C<namlen> arguments.
4432 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4433 to add more than one instance of the same 'how'.
4439 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4445 #ifdef PERL_OLD_COPY_ON_WRITE
4447 sv_force_normal_flags(sv, 0);
4449 if (SvREADONLY(sv)) {
4451 /* its okay to attach magic to shared strings; the subsequent
4452 * upgrade to PVMG will unshare the string */
4453 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4456 && how != PERL_MAGIC_regex_global
4457 && how != PERL_MAGIC_bm
4458 && how != PERL_MAGIC_fm
4459 && how != PERL_MAGIC_sv
4460 && how != PERL_MAGIC_backref
4463 Perl_croak(aTHX_ PL_no_modify);
4466 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4467 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4468 /* sv_magic() refuses to add a magic of the same 'how' as an
4471 if (how == PERL_MAGIC_taint) {
4473 /* Any scalar which already had taint magic on which someone
4474 (erroneously?) did SvIOK_on() or similar will now be
4475 incorrectly sporting public "OK" flags. */
4476 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4484 vtable = &PL_vtbl_sv;
4486 case PERL_MAGIC_overload:
4487 vtable = &PL_vtbl_amagic;
4489 case PERL_MAGIC_overload_elem:
4490 vtable = &PL_vtbl_amagicelem;
4492 case PERL_MAGIC_overload_table:
4493 vtable = &PL_vtbl_ovrld;
4496 vtable = &PL_vtbl_bm;
4498 case PERL_MAGIC_regdata:
4499 vtable = &PL_vtbl_regdata;
4501 case PERL_MAGIC_regdata_names:
4502 vtable = &PL_vtbl_regdata_names;
4504 case PERL_MAGIC_regdatum:
4505 vtable = &PL_vtbl_regdatum;
4507 case PERL_MAGIC_env:
4508 vtable = &PL_vtbl_env;
4511 vtable = &PL_vtbl_fm;
4513 case PERL_MAGIC_envelem:
4514 vtable = &PL_vtbl_envelem;
4516 case PERL_MAGIC_regex_global:
4517 vtable = &PL_vtbl_mglob;
4519 case PERL_MAGIC_isa:
4520 vtable = &PL_vtbl_isa;
4522 case PERL_MAGIC_isaelem:
4523 vtable = &PL_vtbl_isaelem;
4525 case PERL_MAGIC_nkeys:
4526 vtable = &PL_vtbl_nkeys;
4528 case PERL_MAGIC_dbfile:
4531 case PERL_MAGIC_dbline:
4532 vtable = &PL_vtbl_dbline;
4534 #ifdef USE_LOCALE_COLLATE
4535 case PERL_MAGIC_collxfrm:
4536 vtable = &PL_vtbl_collxfrm;
4538 #endif /* USE_LOCALE_COLLATE */
4539 case PERL_MAGIC_tied:
4540 vtable = &PL_vtbl_pack;
4542 case PERL_MAGIC_tiedelem:
4543 case PERL_MAGIC_tiedscalar:
4544 vtable = &PL_vtbl_packelem;
4547 vtable = &PL_vtbl_regexp;
4549 case PERL_MAGIC_hints:
4550 /* As this vtable is all NULL, we can reuse it. */
4551 case PERL_MAGIC_sig:
4552 vtable = &PL_vtbl_sig;
4554 case PERL_MAGIC_sigelem:
4555 vtable = &PL_vtbl_sigelem;
4557 case PERL_MAGIC_taint:
4558 vtable = &PL_vtbl_taint;
4560 case PERL_MAGIC_uvar:
4561 vtable = &PL_vtbl_uvar;
4563 case PERL_MAGIC_vec:
4564 vtable = &PL_vtbl_vec;
4566 case PERL_MAGIC_arylen_p:
4567 case PERL_MAGIC_rhash:
4568 case PERL_MAGIC_symtab:
4569 case PERL_MAGIC_vstring:
4572 case PERL_MAGIC_utf8:
4573 vtable = &PL_vtbl_utf8;
4575 case PERL_MAGIC_substr:
4576 vtable = &PL_vtbl_substr;
4578 case PERL_MAGIC_defelem:
4579 vtable = &PL_vtbl_defelem;
4581 case PERL_MAGIC_arylen:
4582 vtable = &PL_vtbl_arylen;
4584 case PERL_MAGIC_pos:
4585 vtable = &PL_vtbl_pos;
4587 case PERL_MAGIC_backref:
4588 vtable = &PL_vtbl_backref;
4590 case PERL_MAGIC_hintselem:
4591 vtable = &PL_vtbl_hintselem;
4593 case PERL_MAGIC_ext:
4594 /* Reserved for use by extensions not perl internals. */
4595 /* Useful for attaching extension internal data to perl vars. */
4596 /* Note that multiple extensions may clash if magical scalars */
4597 /* etc holding private data from one are passed to another. */
4601 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4604 /* Rest of work is done else where */
4605 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4608 case PERL_MAGIC_taint:
4611 case PERL_MAGIC_ext:
4612 case PERL_MAGIC_dbfile:
4619 =for apidoc sv_unmagic
4621 Removes all magic of type C<type> from an SV.
4627 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4631 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4633 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4634 for (mg = *mgp; mg; mg = *mgp) {
4635 if (mg->mg_type == type) {
4636 const MGVTBL* const vtbl = mg->mg_virtual;
4637 *mgp = mg->mg_moremagic;
4638 if (vtbl && vtbl->svt_free)
4639 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4640 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4642 Safefree(mg->mg_ptr);
4643 else if (mg->mg_len == HEf_SVKEY)
4644 SvREFCNT_dec((SV*)mg->mg_ptr);
4645 else if (mg->mg_type == PERL_MAGIC_utf8)
4646 Safefree(mg->mg_ptr);
4648 if (mg->mg_flags & MGf_REFCOUNTED)
4649 SvREFCNT_dec(mg->mg_obj);
4653 mgp = &mg->mg_moremagic;
4657 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4658 SvMAGIC_set(sv, NULL);
4665 =for apidoc sv_rvweaken
4667 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4668 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4669 push a back-reference to this RV onto the array of backreferences
4670 associated with that magic. If the RV is magical, set magic will be
4671 called after the RV is cleared.
4677 Perl_sv_rvweaken(pTHX_ SV *sv)
4680 if (!SvOK(sv)) /* let undefs pass */
4683 Perl_croak(aTHX_ "Can't weaken a nonreference");
4684 else if (SvWEAKREF(sv)) {
4685 if (ckWARN(WARN_MISC))
4686 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4690 Perl_sv_add_backref(aTHX_ tsv, sv);
4696 /* Give tsv backref magic if it hasn't already got it, then push a
4697 * back-reference to sv onto the array associated with the backref magic.
4701 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4706 if (SvTYPE(tsv) == SVt_PVHV) {
4707 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4711 /* There is no AV in the offical place - try a fixup. */
4712 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4715 /* Aha. They've got it stowed in magic. Bring it back. */
4716 av = (AV*)mg->mg_obj;
4717 /* Stop mg_free decreasing the refernce count. */
4719 /* Stop mg_free even calling the destructor, given that
4720 there's no AV to free up. */
4722 sv_unmagic(tsv, PERL_MAGIC_backref);
4726 SvREFCNT_inc_simple_void(av);
4731 const MAGIC *const mg
4732 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4734 av = (AV*)mg->mg_obj;
4738 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4739 /* av now has a refcnt of 2, which avoids it getting freed
4740 * before us during global cleanup. The extra ref is removed
4741 * by magic_killbackrefs() when tsv is being freed */
4744 if (AvFILLp(av) >= AvMAX(av)) {
4745 av_extend(av, AvFILLp(av)+1);
4747 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4750 /* delete a back-reference to ourselves from the backref magic associated
4751 * with the SV we point to.
4755 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4762 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4763 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4764 /* We mustn't attempt to "fix up" the hash here by moving the
4765 backreference array back to the hv_aux structure, as that is stored
4766 in the main HvARRAY(), and hfreentries assumes that no-one
4767 reallocates HvARRAY() while it is running. */
4770 const MAGIC *const mg
4771 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4773 av = (AV *)mg->mg_obj;
4776 if (PL_in_clean_all)
4778 Perl_croak(aTHX_ "panic: del_backref");
4785 /* We shouldn't be in here more than once, but for paranoia reasons lets
4787 for (i = AvFILLp(av); i >= 0; i--) {
4789 const SSize_t fill = AvFILLp(av);
4791 /* We weren't the last entry.
4792 An unordered list has this property that you can take the
4793 last element off the end to fill the hole, and it's still
4794 an unordered list :-)
4799 AvFILLp(av) = fill - 1;
4805 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4807 SV **svp = AvARRAY(av);
4809 PERL_UNUSED_ARG(sv);
4811 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4812 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4813 if (svp && !SvIS_FREED(av)) {
4814 SV *const *const last = svp + AvFILLp(av);
4816 while (svp <= last) {
4818 SV *const referrer = *svp;
4819 if (SvWEAKREF(referrer)) {
4820 /* XXX Should we check that it hasn't changed? */
4821 SvRV_set(referrer, 0);
4823 SvWEAKREF_off(referrer);
4824 SvSETMAGIC(referrer);
4825 } else if (SvTYPE(referrer) == SVt_PVGV ||
4826 SvTYPE(referrer) == SVt_PVLV) {
4827 /* You lookin' at me? */
4828 assert(GvSTASH(referrer));
4829 assert(GvSTASH(referrer) == (HV*)sv);
4830 GvSTASH(referrer) = 0;
4833 "panic: magic_killbackrefs (flags=%"UVxf")",
4834 (UV)SvFLAGS(referrer));
4842 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4847 =for apidoc sv_insert
4849 Inserts a string at the specified offset/length within the SV. Similar to
4850 the Perl substr() function.
4856 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4861 register char *midend;
4862 register char *bigend;
4868 Perl_croak(aTHX_ "Can't modify non-existent substring");
4869 SvPV_force(bigstr, curlen);
4870 (void)SvPOK_only_UTF8(bigstr);
4871 if (offset + len > curlen) {
4872 SvGROW(bigstr, offset+len+1);
4873 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4874 SvCUR_set(bigstr, offset+len);
4878 i = littlelen - len;
4879 if (i > 0) { /* string might grow */
4880 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4881 mid = big + offset + len;
4882 midend = bigend = big + SvCUR(bigstr);
4885 while (midend > mid) /* shove everything down */
4886 *--bigend = *--midend;
4887 Move(little,big+offset,littlelen,char);
4888 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4893 Move(little,SvPVX(bigstr)+offset,len,char);
4898 big = SvPVX(bigstr);
4901 bigend = big + SvCUR(bigstr);
4903 if (midend > bigend)
4904 Perl_croak(aTHX_ "panic: sv_insert");
4906 if (mid - big > bigend - midend) { /* faster to shorten from end */
4908 Move(little, mid, littlelen,char);
4911 i = bigend - midend;
4913 Move(midend, mid, i,char);
4917 SvCUR_set(bigstr, mid - big);
4919 else if ((i = mid - big)) { /* faster from front */
4920 midend -= littlelen;
4922 sv_chop(bigstr,midend-i);
4927 Move(little, mid, littlelen,char);
4929 else if (littlelen) {
4930 midend -= littlelen;
4931 sv_chop(bigstr,midend);
4932 Move(little,midend,littlelen,char);
4935 sv_chop(bigstr,midend);
4941 =for apidoc sv_replace
4943 Make the first argument a copy of the second, then delete the original.
4944 The target SV physically takes over ownership of the body of the source SV
4945 and inherits its flags; however, the target keeps any magic it owns,
4946 and any magic in the source is discarded.
4947 Note that this is a rather specialist SV copying operation; most of the
4948 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4954 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4957 const U32 refcnt = SvREFCNT(sv);
4958 SV_CHECK_THINKFIRST_COW_DROP(sv);
4959 if (SvREFCNT(nsv) != 1) {
4960 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4961 UVuf " != 1)", (UV) SvREFCNT(nsv));
4963 if (SvMAGICAL(sv)) {
4967 sv_upgrade(nsv, SVt_PVMG);
4968 SvMAGIC_set(nsv, SvMAGIC(sv));
4969 SvFLAGS(nsv) |= SvMAGICAL(sv);
4971 SvMAGIC_set(sv, NULL);
4975 assert(!SvREFCNT(sv));
4976 #ifdef DEBUG_LEAKING_SCALARS
4977 sv->sv_flags = nsv->sv_flags;
4978 sv->sv_any = nsv->sv_any;
4979 sv->sv_refcnt = nsv->sv_refcnt;
4980 sv->sv_u = nsv->sv_u;
4982 StructCopy(nsv,sv,SV);
4984 /* Currently could join these into one piece of pointer arithmetic, but
4985 it would be unclear. */
4986 if(SvTYPE(sv) == SVt_IV)
4988 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4989 else if (SvTYPE(sv) == SVt_RV) {
4990 SvANY(sv) = &sv->sv_u.svu_rv;
4994 #ifdef PERL_OLD_COPY_ON_WRITE
4995 if (SvIsCOW_normal(nsv)) {
4996 /* We need to follow the pointers around the loop to make the
4997 previous SV point to sv, rather than nsv. */
5000 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5003 assert(SvPVX_const(current) == SvPVX_const(nsv));
5005 /* Make the SV before us point to the SV after us. */
5007 PerlIO_printf(Perl_debug_log, "previous is\n");
5009 PerlIO_printf(Perl_debug_log,
5010 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5011 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5013 SV_COW_NEXT_SV_SET(current, sv);
5016 SvREFCNT(sv) = refcnt;
5017 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5023 =for apidoc sv_clear
5025 Clear an SV: call any destructors, free up any memory used by the body,
5026 and free the body itself. The SV's head is I<not> freed, although
5027 its type is set to all 1's so that it won't inadvertently be assumed
5028 to be live during global destruction etc.
5029 This function should only be called when REFCNT is zero. Most of the time
5030 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5037 Perl_sv_clear(pTHX_ register SV *sv)
5040 const U32 type = SvTYPE(sv);
5041 const struct body_details *const sv_type_details
5042 = bodies_by_type + type;
5045 assert(SvREFCNT(sv) == 0);
5047 if (type <= SVt_IV) {
5048 /* See the comment in sv.h about the collusion between this early
5049 return and the overloading of the NULL and IV slots in the size
5055 if (PL_defstash) { /* Still have a symbol table? */
5060 stash = SvSTASH(sv);
5061 destructor = StashHANDLER(stash,DESTROY);
5063 SV* const tmpref = newRV(sv);
5064 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5066 PUSHSTACKi(PERLSI_DESTROY);
5071 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5077 if(SvREFCNT(tmpref) < 2) {
5078 /* tmpref is not kept alive! */
5080 SvRV_set(tmpref, NULL);
5083 SvREFCNT_dec(tmpref);
5085 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5089 if (PL_in_clean_objs)
5090 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5092 /* DESTROY gave object new lease on life */
5098 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5099 SvOBJECT_off(sv); /* Curse the object. */
5100 if (type != SVt_PVIO)
5101 --PL_sv_objcount; /* XXX Might want something more general */
5104 if (type >= SVt_PVMG) {
5105 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5106 SvREFCNT_dec(OURSTASH(sv));
5107 } else if (SvMAGIC(sv))
5109 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5110 SvREFCNT_dec(SvSTASH(sv));
5115 IoIFP(sv) != PerlIO_stdin() &&
5116 IoIFP(sv) != PerlIO_stdout() &&
5117 IoIFP(sv) != PerlIO_stderr())
5119 io_close((IO*)sv, FALSE);
5121 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5122 PerlDir_close(IoDIRP(sv));
5123 IoDIRP(sv) = (DIR*)NULL;
5124 Safefree(IoTOP_NAME(sv));
5125 Safefree(IoFMT_NAME(sv));
5126 Safefree(IoBOTTOM_NAME(sv));
5135 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5142 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5143 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5144 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5145 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5147 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5148 SvREFCNT_dec(LvTARG(sv));
5152 if (GvNAME_HEK(sv)) {
5153 unshare_hek(GvNAME_HEK(sv));
5155 /* If we're in a stash, we don't own a reference to it. However it does
5156 have a back reference to us, which needs to be cleared. */
5158 sv_del_backref((SV*)GvSTASH(sv), sv);
5163 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5165 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5166 /* Don't even bother with turning off the OOK flag. */
5171 SV * const target = SvRV(sv);
5173 sv_del_backref(target, sv);
5175 SvREFCNT_dec(target);
5177 #ifdef PERL_OLD_COPY_ON_WRITE
5178 else if (SvPVX_const(sv)) {
5180 /* I believe I need to grab the global SV mutex here and
5181 then recheck the COW status. */
5183 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5186 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5187 SV_COW_NEXT_SV(sv));
5188 /* And drop it here. */
5190 } else if (SvLEN(sv)) {
5191 Safefree(SvPVX_const(sv));
5195 else if (SvPVX_const(sv) && SvLEN(sv))
5196 Safefree(SvPVX_mutable(sv));
5197 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5198 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5207 SvFLAGS(sv) &= SVf_BREAK;
5208 SvFLAGS(sv) |= SVTYPEMASK;
5210 if (sv_type_details->arena) {
5211 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5212 &PL_body_roots[type]);
5214 else if (sv_type_details->body_size) {
5215 my_safefree(SvANY(sv));
5220 =for apidoc sv_newref
5222 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5229 Perl_sv_newref(pTHX_ SV *sv)
5231 PERL_UNUSED_CONTEXT;
5240 Decrement an SV's reference count, and if it drops to zero, call
5241 C<sv_clear> to invoke destructors and free up any memory used by
5242 the body; finally, deallocate the SV's head itself.
5243 Normally called via a wrapper macro C<SvREFCNT_dec>.
5249 Perl_sv_free(pTHX_ SV *sv)
5254 if (SvREFCNT(sv) == 0) {
5255 if (SvFLAGS(sv) & SVf_BREAK)
5256 /* this SV's refcnt has been artificially decremented to
5257 * trigger cleanup */
5259 if (PL_in_clean_all) /* All is fair */
5261 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5262 /* make sure SvREFCNT(sv)==0 happens very seldom */
5263 SvREFCNT(sv) = (~(U32)0)/2;
5266 if (ckWARN_d(WARN_INTERNAL)) {
5267 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5268 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5269 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5270 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5271 Perl_dump_sv_child(aTHX_ sv);
5276 if (--(SvREFCNT(sv)) > 0)
5278 Perl_sv_free2(aTHX_ sv);
5282 Perl_sv_free2(pTHX_ SV *sv)
5287 if (ckWARN_d(WARN_DEBUGGING))
5288 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5289 "Attempt to free temp prematurely: SV 0x%"UVxf
5290 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5294 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5295 /* make sure SvREFCNT(sv)==0 happens very seldom */
5296 SvREFCNT(sv) = (~(U32)0)/2;
5307 Returns the length of the string in the SV. Handles magic and type
5308 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5314 Perl_sv_len(pTHX_ register SV *sv)
5322 len = mg_length(sv);
5324 (void)SvPV_const(sv, len);
5329 =for apidoc sv_len_utf8
5331 Returns the number of characters in the string in an SV, counting wide
5332 UTF-8 bytes as a single character. Handles magic and type coercion.
5338 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5339 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5340 * (Note that the mg_len is not the length of the mg_ptr field.
5341 * This allows the cache to store the character length of the string without
5342 * needing to malloc() extra storage to attach to the mg_ptr.)
5347 Perl_sv_len_utf8(pTHX_ register SV *sv)
5353 return mg_length(sv);
5357 const U8 *s = (U8*)SvPV_const(sv, len);
5361 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5363 if (mg && mg->mg_len != -1) {
5365 if (PL_utf8cache < 0) {
5366 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5368 /* Need to turn the assertions off otherwise we may
5369 recurse infinitely while printing error messages.
5371 SAVEI8(PL_utf8cache);
5373 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5374 " real %"UVuf" for %"SVf,
5375 (UV) ulen, (UV) real, (void*)sv);
5380 ulen = Perl_utf8_length(aTHX_ s, s + len);
5381 if (!SvREADONLY(sv)) {
5383 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5384 &PL_vtbl_utf8, 0, 0);
5392 return Perl_utf8_length(aTHX_ s, s + len);
5396 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5399 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5402 const U8 *s = start;
5404 while (s < send && uoffset--)
5407 /* This is the existing behaviour. Possibly it should be a croak, as
5408 it's actually a bounds error */
5414 /* Given the length of the string in both bytes and UTF-8 characters, decide
5415 whether to walk forwards or backwards to find the byte corresponding to
5416 the passed in UTF-8 offset. */
5418 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5419 STRLEN uoffset, STRLEN uend)
5421 STRLEN backw = uend - uoffset;
5422 if (uoffset < 2 * backw) {
5423 /* The assumption is that going forwards is twice the speed of going
5424 forward (that's where the 2 * backw comes from).
5425 (The real figure of course depends on the UTF-8 data.) */
5426 return sv_pos_u2b_forwards(start, send, uoffset);
5431 while (UTF8_IS_CONTINUATION(*send))
5434 return send - start;
5437 /* For the string representation of the given scalar, find the byte
5438 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5439 give another position in the string, *before* the sought offset, which
5440 (which is always true, as 0, 0 is a valid pair of positions), which should
5441 help reduce the amount of linear searching.
5442 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5443 will be used to reduce the amount of linear searching. The cache will be
5444 created if necessary, and the found value offered to it for update. */
5446 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5447 const U8 *const send, STRLEN uoffset,
5448 STRLEN uoffset0, STRLEN boffset0) {
5449 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5452 assert (uoffset >= uoffset0);
5454 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5455 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5456 if ((*mgp)->mg_ptr) {
5457 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5458 if (cache[0] == uoffset) {
5459 /* An exact match. */
5462 if (cache[2] == uoffset) {
5463 /* An exact match. */
5467 if (cache[0] < uoffset) {
5468 /* The cache already knows part of the way. */
5469 if (cache[0] > uoffset0) {
5470 /* The cache knows more than the passed in pair */
5471 uoffset0 = cache[0];
5472 boffset0 = cache[1];
5474 if ((*mgp)->mg_len != -1) {
5475 /* And we know the end too. */
5477 + sv_pos_u2b_midway(start + boffset0, send,
5479 (*mgp)->mg_len - uoffset0);
5482 + sv_pos_u2b_forwards(start + boffset0,
5483 send, uoffset - uoffset0);
5486 else if (cache[2] < uoffset) {
5487 /* We're between the two cache entries. */
5488 if (cache[2] > uoffset0) {
5489 /* and the cache knows more than the passed in pair */
5490 uoffset0 = cache[2];
5491 boffset0 = cache[3];
5495 + sv_pos_u2b_midway(start + boffset0,
5498 cache[0] - uoffset0);
5501 + sv_pos_u2b_midway(start + boffset0,
5504 cache[2] - uoffset0);
5508 else if ((*mgp)->mg_len != -1) {
5509 /* If we can take advantage of a passed in offset, do so. */
5510 /* In fact, offset0 is either 0, or less than offset, so don't
5511 need to worry about the other possibility. */
5513 + sv_pos_u2b_midway(start + boffset0, send,
5515 (*mgp)->mg_len - uoffset0);
5520 if (!found || PL_utf8cache < 0) {
5521 const STRLEN real_boffset
5522 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5523 send, uoffset - uoffset0);
5525 if (found && PL_utf8cache < 0) {
5526 if (real_boffset != boffset) {
5527 /* Need to turn the assertions off otherwise we may recurse
5528 infinitely while printing error messages. */
5529 SAVEI8(PL_utf8cache);
5531 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5532 " real %"UVuf" for %"SVf,
5533 (UV) boffset, (UV) real_boffset, (void*)sv);
5536 boffset = real_boffset;
5539 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5545 =for apidoc sv_pos_u2b
5547 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5548 the start of the string, to a count of the equivalent number of bytes; if
5549 lenp is non-zero, it does the same to lenp, but this time starting from
5550 the offset, rather than from the start of the string. Handles magic and
5557 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5558 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5559 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5564 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5572 start = (U8*)SvPV_const(sv, len);
5574 STRLEN uoffset = (STRLEN) *offsetp;
5575 const U8 * const send = start + len;
5577 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5580 *offsetp = (I32) boffset;
5583 /* Convert the relative offset to absolute. */
5584 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5585 const STRLEN boffset2
5586 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5587 uoffset, boffset) - boffset;
5601 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5602 byte length pairing. The (byte) length of the total SV is passed in too,
5603 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5604 may not have updated SvCUR, so we can't rely on reading it directly.
5606 The proffered utf8/byte length pairing isn't used if the cache already has
5607 two pairs, and swapping either for the proffered pair would increase the
5608 RMS of the intervals between known byte offsets.
5610 The cache itself consists of 4 STRLEN values
5611 0: larger UTF-8 offset
5612 1: corresponding byte offset
5613 2: smaller UTF-8 offset
5614 3: corresponding byte offset
5616 Unused cache pairs have the value 0, 0.
5617 Keeping the cache "backwards" means that the invariant of
5618 cache[0] >= cache[2] is maintained even with empty slots, which means that
5619 the code that uses it doesn't need to worry if only 1 entry has actually
5620 been set to non-zero. It also makes the "position beyond the end of the
5621 cache" logic much simpler, as the first slot is always the one to start
5625 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5633 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5635 (*mgp)->mg_len = -1;
5639 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5640 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5641 (*mgp)->mg_ptr = (char *) cache;
5645 if (PL_utf8cache < 0) {
5646 const U8 *start = (const U8 *) SvPVX_const(sv);
5647 const STRLEN realutf8 = utf8_length(start, start + byte);
5649 if (realutf8 != utf8) {
5650 /* Need to turn the assertions off otherwise we may recurse
5651 infinitely while printing error messages. */
5652 SAVEI8(PL_utf8cache);
5654 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5655 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5659 /* Cache is held with the later position first, to simplify the code
5660 that deals with unbounded ends. */
5662 ASSERT_UTF8_CACHE(cache);
5663 if (cache[1] == 0) {
5664 /* Cache is totally empty */
5667 } else if (cache[3] == 0) {
5668 if (byte > cache[1]) {
5669 /* New one is larger, so goes first. */
5670 cache[2] = cache[0];
5671 cache[3] = cache[1];
5679 #define THREEWAY_SQUARE(a,b,c,d) \
5680 ((float)((d) - (c))) * ((float)((d) - (c))) \
5681 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5682 + ((float)((b) - (a))) * ((float)((b) - (a)))
5684 /* Cache has 2 slots in use, and we know three potential pairs.
5685 Keep the two that give the lowest RMS distance. Do the
5686 calcualation in bytes simply because we always know the byte
5687 length. squareroot has the same ordering as the positive value,
5688 so don't bother with the actual square root. */
5689 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5690 if (byte > cache[1]) {
5691 /* New position is after the existing pair of pairs. */
5692 const float keep_earlier
5693 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5694 const float keep_later
5695 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5697 if (keep_later < keep_earlier) {
5698 if (keep_later < existing) {
5699 cache[2] = cache[0];
5700 cache[3] = cache[1];
5706 if (keep_earlier < existing) {
5712 else if (byte > cache[3]) {
5713 /* New position is between the existing pair of pairs. */
5714 const float keep_earlier
5715 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5716 const float keep_later
5717 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5719 if (keep_later < keep_earlier) {
5720 if (keep_later < existing) {
5726 if (keep_earlier < existing) {
5733 /* New position is before the existing pair of pairs. */
5734 const float keep_earlier
5735 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5736 const float keep_later
5737 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5739 if (keep_later < keep_earlier) {
5740 if (keep_later < existing) {
5746 if (keep_earlier < existing) {
5747 cache[0] = cache[2];
5748 cache[1] = cache[3];
5755 ASSERT_UTF8_CACHE(cache);
5758 /* We already know all of the way, now we may be able to walk back. The same
5759 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5760 backward is half the speed of walking forward. */
5762 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5765 const STRLEN forw = target - s;
5766 STRLEN backw = end - target;
5768 if (forw < 2 * backw) {
5769 return utf8_length(s, target);
5772 while (end > target) {
5774 while (UTF8_IS_CONTINUATION(*end)) {
5783 =for apidoc sv_pos_b2u
5785 Converts the value pointed to by offsetp from a count of bytes from the
5786 start of the string, to a count of the equivalent number of UTF-8 chars.
5787 Handles magic and type coercion.
5793 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5794 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5799 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5802 const STRLEN byte = *offsetp;
5803 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5812 s = (const U8*)SvPV_const(sv, blen);
5815 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5819 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5820 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5822 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5823 if (cache[1] == byte) {
5824 /* An exact match. */
5825 *offsetp = cache[0];
5828 if (cache[3] == byte) {
5829 /* An exact match. */
5830 *offsetp = cache[2];
5834 if (cache[1] < byte) {
5835 /* We already know part of the way. */
5836 if (mg->mg_len != -1) {
5837 /* Actually, we know the end too. */
5839 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5840 s + blen, mg->mg_len - cache[0]);
5842 len = cache[0] + utf8_length(s + cache[1], send);
5845 else if (cache[3] < byte) {
5846 /* We're between the two cached pairs, so we do the calculation
5847 offset by the byte/utf-8 positions for the earlier pair,
5848 then add the utf-8 characters from the string start to
5850 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5851 s + cache[1], cache[0] - cache[2])
5855 else { /* cache[3] > byte */
5856 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5860 ASSERT_UTF8_CACHE(cache);
5862 } else if (mg->mg_len != -1) {
5863 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5867 if (!found || PL_utf8cache < 0) {
5868 const STRLEN real_len = utf8_length(s, send);
5870 if (found && PL_utf8cache < 0) {
5871 if (len != real_len) {
5872 /* Need to turn the assertions off otherwise we may recurse
5873 infinitely while printing error messages. */
5874 SAVEI8(PL_utf8cache);
5876 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5877 " real %"UVuf" for %"SVf,
5878 (UV) len, (UV) real_len, (void*)sv);
5885 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5891 Returns a boolean indicating whether the strings in the two SVs are
5892 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5893 coerce its args to strings if necessary.
5899 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5908 SV* svrecode = NULL;
5915 /* if pv1 and pv2 are the same, second SvPV_const call may
5916 * invalidate pv1, so we may need to make a copy */
5917 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5918 pv1 = SvPV_const(sv1, cur1);
5919 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5920 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5922 pv1 = SvPV_const(sv1, cur1);
5930 pv2 = SvPV_const(sv2, cur2);
5932 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5933 /* Differing utf8ness.
5934 * Do not UTF8size the comparands as a side-effect. */
5937 svrecode = newSVpvn(pv2, cur2);
5938 sv_recode_to_utf8(svrecode, PL_encoding);
5939 pv2 = SvPV_const(svrecode, cur2);
5942 svrecode = newSVpvn(pv1, cur1);
5943 sv_recode_to_utf8(svrecode, PL_encoding);
5944 pv1 = SvPV_const(svrecode, cur1);
5946 /* Now both are in UTF-8. */
5948 SvREFCNT_dec(svrecode);
5953 bool is_utf8 = TRUE;
5956 /* sv1 is the UTF-8 one,
5957 * if is equal it must be downgrade-able */
5958 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5964 /* sv2 is the UTF-8 one,
5965 * if is equal it must be downgrade-able */
5966 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5972 /* Downgrade not possible - cannot be eq */
5980 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5982 SvREFCNT_dec(svrecode);
5992 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5993 string in C<sv1> is less than, equal to, or greater than the string in
5994 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5995 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6001 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6005 const char *pv1, *pv2;
6008 SV *svrecode = NULL;
6015 pv1 = SvPV_const(sv1, cur1);
6022 pv2 = SvPV_const(sv2, cur2);
6024 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6025 /* Differing utf8ness.
6026 * Do not UTF8size the comparands as a side-effect. */
6029 svrecode = newSVpvn(pv2, cur2);
6030 sv_recode_to_utf8(svrecode, PL_encoding);
6031 pv2 = SvPV_const(svrecode, cur2);
6034 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6039 svrecode = newSVpvn(pv1, cur1);
6040 sv_recode_to_utf8(svrecode, PL_encoding);
6041 pv1 = SvPV_const(svrecode, cur1);
6044 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6050 cmp = cur2 ? -1 : 0;
6054 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6057 cmp = retval < 0 ? -1 : 1;
6058 } else if (cur1 == cur2) {
6061 cmp = cur1 < cur2 ? -1 : 1;
6065 SvREFCNT_dec(svrecode);
6073 =for apidoc sv_cmp_locale
6075 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6076 'use bytes' aware, handles get magic, and will coerce its args to strings
6077 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6083 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6086 #ifdef USE_LOCALE_COLLATE
6092 if (PL_collation_standard)
6096 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6098 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6100 if (!pv1 || !len1) {
6111 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6114 return retval < 0 ? -1 : 1;
6117 * When the result of collation is equality, that doesn't mean
6118 * that there are no differences -- some locales exclude some
6119 * characters from consideration. So to avoid false equalities,
6120 * we use the raw string as a tiebreaker.
6126 #endif /* USE_LOCALE_COLLATE */
6128 return sv_cmp(sv1, sv2);
6132 #ifdef USE_LOCALE_COLLATE
6135 =for apidoc sv_collxfrm
6137 Add Collate Transform magic to an SV if it doesn't already have it.
6139 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6140 scalar data of the variable, but transformed to such a format that a normal
6141 memory comparison can be used to compare the data according to the locale
6148 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6153 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6154 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6160 Safefree(mg->mg_ptr);
6161 s = SvPV_const(sv, len);
6162 if ((xf = mem_collxfrm(s, len, &xlen))) {
6163 if (SvREADONLY(sv)) {
6166 return xf + sizeof(PL_collation_ix);
6169 #ifdef PERL_OLD_COPY_ON_WRITE
6171 sv_force_normal_flags(sv, 0);
6173 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6187 if (mg && mg->mg_ptr) {
6189 return mg->mg_ptr + sizeof(PL_collation_ix);
6197 #endif /* USE_LOCALE_COLLATE */
6202 Get a line from the filehandle and store it into the SV, optionally
6203 appending to the currently-stored string.
6209 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6214 register STDCHAR rslast;
6215 register STDCHAR *bp;
6220 if (SvTHINKFIRST(sv))
6221 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6222 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6224 However, perlbench says it's slower, because the existing swipe code
6225 is faster than copy on write.
6226 Swings and roundabouts. */
6227 SvUPGRADE(sv, SVt_PV);
6232 if (PerlIO_isutf8(fp)) {
6234 sv_utf8_upgrade_nomg(sv);
6235 sv_pos_u2b(sv,&append,0);
6237 } else if (SvUTF8(sv)) {
6238 SV * const tsv = newSV(0);
6239 sv_gets(tsv, fp, 0);
6240 sv_utf8_upgrade_nomg(tsv);
6241 SvCUR_set(sv,append);
6244 goto return_string_or_null;
6249 if (PerlIO_isutf8(fp))
6252 if (IN_PERL_COMPILETIME) {
6253 /* we always read code in line mode */
6257 else if (RsSNARF(PL_rs)) {
6258 /* If it is a regular disk file use size from stat() as estimate
6259 of amount we are going to read -- may result in mallocing
6260 more memory than we really need if the layers below reduce
6261 the size we read (e.g. CRLF or a gzip layer).
6264 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6265 const Off_t offset = PerlIO_tell(fp);
6266 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6267 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6273 else if (RsRECORD(PL_rs)) {
6278 /* Grab the size of the record we're getting */
6279 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6280 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6283 /* VMS wants read instead of fread, because fread doesn't respect */
6284 /* RMS record boundaries. This is not necessarily a good thing to be */
6285 /* doing, but we've got no other real choice - except avoid stdio
6286 as implementation - perhaps write a :vms layer ?
6288 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6290 bytesread = PerlIO_read(fp, buffer, recsize);
6294 SvCUR_set(sv, bytesread += append);
6295 buffer[bytesread] = '\0';
6296 goto return_string_or_null;
6298 else if (RsPARA(PL_rs)) {
6304 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6305 if (PerlIO_isutf8(fp)) {
6306 rsptr = SvPVutf8(PL_rs, rslen);
6309 if (SvUTF8(PL_rs)) {
6310 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6311 Perl_croak(aTHX_ "Wide character in $/");
6314 rsptr = SvPV_const(PL_rs, rslen);
6318 rslast = rslen ? rsptr[rslen - 1] : '\0';
6320 if (rspara) { /* have to do this both before and after */
6321 do { /* to make sure file boundaries work right */
6324 i = PerlIO_getc(fp);
6328 PerlIO_ungetc(fp,i);
6334 /* See if we know enough about I/O mechanism to cheat it ! */
6336 /* This used to be #ifdef test - it is made run-time test for ease
6337 of abstracting out stdio interface. One call should be cheap
6338 enough here - and may even be a macro allowing compile
6342 if (PerlIO_fast_gets(fp)) {
6345 * We're going to steal some values from the stdio struct
6346 * and put EVERYTHING in the innermost loop into registers.
6348 register STDCHAR *ptr;
6352 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6353 /* An ungetc()d char is handled separately from the regular
6354 * buffer, so we getc() it back out and stuff it in the buffer.
6356 i = PerlIO_getc(fp);
6357 if (i == EOF) return 0;
6358 *(--((*fp)->_ptr)) = (unsigned char) i;
6362 /* Here is some breathtakingly efficient cheating */
6364 cnt = PerlIO_get_cnt(fp); /* get count into register */
6365 /* make sure we have the room */
6366 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6367 /* Not room for all of it
6368 if we are looking for a separator and room for some
6370 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6371 /* just process what we have room for */
6372 shortbuffered = cnt - SvLEN(sv) + append + 1;
6373 cnt -= shortbuffered;
6377 /* remember that cnt can be negative */
6378 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6383 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6384 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6385 DEBUG_P(PerlIO_printf(Perl_debug_log,
6386 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6387 DEBUG_P(PerlIO_printf(Perl_debug_log,
6388 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6389 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6390 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6395 while (cnt > 0) { /* this | eat */
6397 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6398 goto thats_all_folks; /* screams | sed :-) */
6402 Copy(ptr, bp, cnt, char); /* this | eat */
6403 bp += cnt; /* screams | dust */
6404 ptr += cnt; /* louder | sed :-) */
6409 if (shortbuffered) { /* oh well, must extend */
6410 cnt = shortbuffered;
6412 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6414 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6415 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6419 DEBUG_P(PerlIO_printf(Perl_debug_log,
6420 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6421 PTR2UV(ptr),(long)cnt));
6422 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6424 DEBUG_P(PerlIO_printf(Perl_debug_log,
6425 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6426 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6427 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6429 /* This used to call 'filbuf' in stdio form, but as that behaves like
6430 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6431 another abstraction. */
6432 i = PerlIO_getc(fp); /* get more characters */
6434 DEBUG_P(PerlIO_printf(Perl_debug_log,
6435 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6436 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6437 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6439 cnt = PerlIO_get_cnt(fp);
6440 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6441 DEBUG_P(PerlIO_printf(Perl_debug_log,
6442 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6444 if (i == EOF) /* all done for ever? */
6445 goto thats_really_all_folks;
6447 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6449 SvGROW(sv, bpx + cnt + 2);
6450 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6452 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6454 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6455 goto thats_all_folks;
6459 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6460 memNE((char*)bp - rslen, rsptr, rslen))
6461 goto screamer; /* go back to the fray */
6462 thats_really_all_folks:
6464 cnt += shortbuffered;
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6467 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6468 DEBUG_P(PerlIO_printf(Perl_debug_log,
6469 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6470 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6471 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6473 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6474 DEBUG_P(PerlIO_printf(Perl_debug_log,
6475 "Screamer: done, len=%ld, string=|%.*s|\n",
6476 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6480 /*The big, slow, and stupid way. */
6481 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6482 STDCHAR *buf = NULL;
6483 Newx(buf, 8192, STDCHAR);
6491 register const STDCHAR * const bpe = buf + sizeof(buf);
6493 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6494 ; /* keep reading */
6498 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6499 /* Accomodate broken VAXC compiler, which applies U8 cast to
6500 * both args of ?: operator, causing EOF to change into 255
6503 i = (U8)buf[cnt - 1];
6509 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6511 sv_catpvn(sv, (char *) buf, cnt);
6513 sv_setpvn(sv, (char *) buf, cnt);
6515 if (i != EOF && /* joy */
6517 SvCUR(sv) < rslen ||
6518 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6522 * If we're reading from a TTY and we get a short read,
6523 * indicating that the user hit his EOF character, we need
6524 * to notice it now, because if we try to read from the TTY
6525 * again, the EOF condition will disappear.
6527 * The comparison of cnt to sizeof(buf) is an optimization
6528 * that prevents unnecessary calls to feof().
6532 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6536 #ifdef USE_HEAP_INSTEAD_OF_STACK
6541 if (rspara) { /* have to do this both before and after */
6542 while (i != EOF) { /* to make sure file boundaries work right */
6543 i = PerlIO_getc(fp);
6545 PerlIO_ungetc(fp,i);
6551 return_string_or_null:
6552 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6558 Auto-increment of the value in the SV, doing string to numeric conversion
6559 if necessary. Handles 'get' magic.
6565 Perl_sv_inc(pTHX_ register SV *sv)
6574 if (SvTHINKFIRST(sv)) {
6576 sv_force_normal_flags(sv, 0);
6577 if (SvREADONLY(sv)) {
6578 if (IN_PERL_RUNTIME)
6579 Perl_croak(aTHX_ PL_no_modify);
6583 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6585 i = PTR2IV(SvRV(sv));
6590 flags = SvFLAGS(sv);
6591 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6592 /* It's (privately or publicly) a float, but not tested as an
6593 integer, so test it to see. */
6595 flags = SvFLAGS(sv);
6597 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6598 /* It's publicly an integer, or privately an integer-not-float */
6599 #ifdef PERL_PRESERVE_IVUV
6603 if (SvUVX(sv) == UV_MAX)
6604 sv_setnv(sv, UV_MAX_P1);
6606 (void)SvIOK_only_UV(sv);
6607 SvUV_set(sv, SvUVX(sv) + 1);
6609 if (SvIVX(sv) == IV_MAX)
6610 sv_setuv(sv, (UV)IV_MAX + 1);
6612 (void)SvIOK_only(sv);
6613 SvIV_set(sv, SvIVX(sv) + 1);
6618 if (flags & SVp_NOK) {
6619 (void)SvNOK_only(sv);
6620 SvNV_set(sv, SvNVX(sv) + 1.0);
6624 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6625 if ((flags & SVTYPEMASK) < SVt_PVIV)
6626 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6627 (void)SvIOK_only(sv);
6632 while (isALPHA(*d)) d++;
6633 while (isDIGIT(*d)) d++;
6635 #ifdef PERL_PRESERVE_IVUV
6636 /* Got to punt this as an integer if needs be, but we don't issue
6637 warnings. Probably ought to make the sv_iv_please() that does
6638 the conversion if possible, and silently. */
6639 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6640 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6641 /* Need to try really hard to see if it's an integer.
6642 9.22337203685478e+18 is an integer.
6643 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6644 so $a="9.22337203685478e+18"; $a+0; $a++
6645 needs to be the same as $a="9.22337203685478e+18"; $a++
6652 /* sv_2iv *should* have made this an NV */
6653 if (flags & SVp_NOK) {
6654 (void)SvNOK_only(sv);
6655 SvNV_set(sv, SvNVX(sv) + 1.0);
6658 /* I don't think we can get here. Maybe I should assert this
6659 And if we do get here I suspect that sv_setnv will croak. NWC
6661 #if defined(USE_LONG_DOUBLE)
6662 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",
6663 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6665 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6666 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6669 #endif /* PERL_PRESERVE_IVUV */
6670 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6674 while (d >= SvPVX_const(sv)) {
6682 /* MKS: The original code here died if letters weren't consecutive.
6683 * at least it didn't have to worry about non-C locales. The
6684 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6685 * arranged in order (although not consecutively) and that only
6686 * [A-Za-z] are accepted by isALPHA in the C locale.
6688 if (*d != 'z' && *d != 'Z') {
6689 do { ++*d; } while (!isALPHA(*d));
6692 *(d--) -= 'z' - 'a';
6697 *(d--) -= 'z' - 'a' + 1;
6701 /* oh,oh, the number grew */
6702 SvGROW(sv, SvCUR(sv) + 2);
6703 SvCUR_set(sv, SvCUR(sv) + 1);
6704 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6715 Auto-decrement of the value in the SV, doing string to numeric conversion
6716 if necessary. Handles 'get' magic.
6722 Perl_sv_dec(pTHX_ register SV *sv)
6730 if (SvTHINKFIRST(sv)) {
6732 sv_force_normal_flags(sv, 0);
6733 if (SvREADONLY(sv)) {
6734 if (IN_PERL_RUNTIME)
6735 Perl_croak(aTHX_ PL_no_modify);
6739 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6741 i = PTR2IV(SvRV(sv));
6746 /* Unlike sv_inc we don't have to worry about string-never-numbers
6747 and keeping them magic. But we mustn't warn on punting */
6748 flags = SvFLAGS(sv);
6749 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6750 /* It's publicly an integer, or privately an integer-not-float */
6751 #ifdef PERL_PRESERVE_IVUV
6755 if (SvUVX(sv) == 0) {
6756 (void)SvIOK_only(sv);
6760 (void)SvIOK_only_UV(sv);
6761 SvUV_set(sv, SvUVX(sv) - 1);
6764 if (SvIVX(sv) == IV_MIN)
6765 sv_setnv(sv, (NV)IV_MIN - 1.0);
6767 (void)SvIOK_only(sv);
6768 SvIV_set(sv, SvIVX(sv) - 1);
6773 if (flags & SVp_NOK) {
6774 SvNV_set(sv, SvNVX(sv) - 1.0);
6775 (void)SvNOK_only(sv);
6778 if (!(flags & SVp_POK)) {
6779 if ((flags & SVTYPEMASK) < SVt_PVIV)
6780 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6782 (void)SvIOK_only(sv);
6785 #ifdef PERL_PRESERVE_IVUV
6787 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6788 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6789 /* Need to try really hard to see if it's an integer.
6790 9.22337203685478e+18 is an integer.
6791 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6792 so $a="9.22337203685478e+18"; $a+0; $a--
6793 needs to be the same as $a="9.22337203685478e+18"; $a--
6800 /* sv_2iv *should* have made this an NV */
6801 if (flags & SVp_NOK) {
6802 (void)SvNOK_only(sv);
6803 SvNV_set(sv, SvNVX(sv) - 1.0);
6806 /* I don't think we can get here. Maybe I should assert this
6807 And if we do get here I suspect that sv_setnv will croak. NWC
6809 #if defined(USE_LONG_DOUBLE)
6810 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",
6811 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6813 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6814 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6818 #endif /* PERL_PRESERVE_IVUV */
6819 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6823 =for apidoc sv_mortalcopy
6825 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6826 The new SV is marked as mortal. It will be destroyed "soon", either by an
6827 explicit call to FREETMPS, or by an implicit call at places such as
6828 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6833 /* Make a string that will exist for the duration of the expression
6834 * evaluation. Actually, it may have to last longer than that, but
6835 * hopefully we won't free it until it has been assigned to a
6836 * permanent location. */
6839 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6845 sv_setsv(sv,oldstr);
6847 PL_tmps_stack[++PL_tmps_ix] = sv;
6853 =for apidoc sv_newmortal
6855 Creates a new null SV which is mortal. The reference count of the SV is
6856 set to 1. It will be destroyed "soon", either by an explicit call to
6857 FREETMPS, or by an implicit call at places such as statement boundaries.
6858 See also C<sv_mortalcopy> and C<sv_2mortal>.
6864 Perl_sv_newmortal(pTHX)
6870 SvFLAGS(sv) = SVs_TEMP;
6872 PL_tmps_stack[++PL_tmps_ix] = sv;
6877 =for apidoc sv_2mortal
6879 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6880 by an explicit call to FREETMPS, or by an implicit call at places such as
6881 statement boundaries. SvTEMP() is turned on which means that the SV's
6882 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6883 and C<sv_mortalcopy>.
6889 Perl_sv_2mortal(pTHX_ register SV *sv)
6894 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6897 PL_tmps_stack[++PL_tmps_ix] = sv;
6905 Creates a new SV and copies a string into it. The reference count for the
6906 SV is set to 1. If C<len> is zero, Perl will compute the length using
6907 strlen(). For efficiency, consider using C<newSVpvn> instead.
6913 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6919 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6924 =for apidoc newSVpvn
6926 Creates a new SV and copies a string into it. The reference count for the
6927 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6928 string. You are responsible for ensuring that the source string is at least
6929 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6935 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6941 sv_setpvn(sv,s,len);
6947 =for apidoc newSVhek
6949 Creates a new SV from the hash key structure. It will generate scalars that
6950 point to the shared string table where possible. Returns a new (undefined)
6951 SV if the hek is NULL.
6957 Perl_newSVhek(pTHX_ const HEK *hek)
6967 if (HEK_LEN(hek) == HEf_SVKEY) {
6968 return newSVsv(*(SV**)HEK_KEY(hek));
6970 const int flags = HEK_FLAGS(hek);
6971 if (flags & HVhek_WASUTF8) {
6973 Andreas would like keys he put in as utf8 to come back as utf8
6975 STRLEN utf8_len = HEK_LEN(hek);
6976 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6977 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6980 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6982 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6983 /* We don't have a pointer to the hv, so we have to replicate the
6984 flag into every HEK. This hv is using custom a hasing
6985 algorithm. Hence we can't return a shared string scalar, as
6986 that would contain the (wrong) hash value, and might get passed
6987 into an hv routine with a regular hash.
6988 Similarly, a hash that isn't using shared hash keys has to have
6989 the flag in every key so that we know not to try to call
6990 share_hek_kek on it. */
6992 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6997 /* This will be overwhelminly the most common case. */
6999 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7000 more efficient than sharepvn(). */
7004 sv_upgrade(sv, SVt_PV);
7005 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7006 SvCUR_set(sv, HEK_LEN(hek));
7019 =for apidoc newSVpvn_share
7021 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7022 table. If the string does not already exist in the table, it is created
7023 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7024 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7025 otherwise the hash is computed. The idea here is that as the string table
7026 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7027 hash lookup will avoid string compare.
7033 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7037 bool is_utf8 = FALSE;
7038 const char *const orig_src = src;
7041 STRLEN tmplen = -len;
7043 /* See the note in hv.c:hv_fetch() --jhi */
7044 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7048 PERL_HASH(hash, src, len);
7050 sv_upgrade(sv, SVt_PV);
7051 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7059 if (src != orig_src)
7065 #if defined(PERL_IMPLICIT_CONTEXT)
7067 /* pTHX_ magic can't cope with varargs, so this is a no-context
7068 * version of the main function, (which may itself be aliased to us).
7069 * Don't access this version directly.
7073 Perl_newSVpvf_nocontext(const char* pat, ...)
7078 va_start(args, pat);
7079 sv = vnewSVpvf(pat, &args);
7086 =for apidoc newSVpvf
7088 Creates a new SV and initializes it with the string formatted like
7095 Perl_newSVpvf(pTHX_ const char* pat, ...)
7099 va_start(args, pat);
7100 sv = vnewSVpvf(pat, &args);
7105 /* backend for newSVpvf() and newSVpvf_nocontext() */
7108 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7113 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7120 Creates a new SV and copies a floating point value into it.
7121 The reference count for the SV is set to 1.
7127 Perl_newSVnv(pTHX_ NV n)
7140 Creates a new SV and copies an integer into it. The reference count for the
7147 Perl_newSViv(pTHX_ IV i)
7160 Creates a new SV and copies an unsigned integer into it.
7161 The reference count for the SV is set to 1.
7167 Perl_newSVuv(pTHX_ UV u)
7178 =for apidoc newRV_noinc
7180 Creates an RV wrapper for an SV. The reference count for the original
7181 SV is B<not> incremented.
7187 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7193 sv_upgrade(sv, SVt_RV);
7195 SvRV_set(sv, tmpRef);
7200 /* newRV_inc is the official function name to use now.
7201 * newRV_inc is in fact #defined to newRV in sv.h
7205 Perl_newRV(pTHX_ SV *sv)
7208 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7214 Creates a new SV which is an exact duplicate of the original SV.
7221 Perl_newSVsv(pTHX_ register SV *old)
7228 if (SvTYPE(old) == SVTYPEMASK) {
7229 if (ckWARN_d(WARN_INTERNAL))
7230 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7234 /* SV_GMAGIC is the default for sv_setv()
7235 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7236 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7237 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7242 =for apidoc sv_reset
7244 Underlying implementation for the C<reset> Perl function.
7245 Note that the perl-level function is vaguely deprecated.
7251 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7254 char todo[PERL_UCHAR_MAX+1];
7259 if (!*s) { /* reset ?? searches */
7260 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7262 PMOP *pm = (PMOP *) mg->mg_obj;
7264 pm->op_pmdynflags &= ~PMdf_USED;
7271 /* reset variables */
7273 if (!HvARRAY(stash))
7276 Zero(todo, 256, char);
7279 I32 i = (unsigned char)*s;
7283 max = (unsigned char)*s++;
7284 for ( ; i <= max; i++) {
7287 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7289 for (entry = HvARRAY(stash)[i];
7291 entry = HeNEXT(entry))
7296 if (!todo[(U8)*HeKEY(entry)])
7298 gv = (GV*)HeVAL(entry);
7301 if (SvTHINKFIRST(sv)) {
7302 if (!SvREADONLY(sv) && SvROK(sv))
7304 /* XXX Is this continue a bug? Why should THINKFIRST
7305 exempt us from resetting arrays and hashes? */
7309 if (SvTYPE(sv) >= SVt_PV) {
7311 if (SvPVX_const(sv) != NULL)
7319 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7321 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7324 # if defined(USE_ENVIRON_ARRAY)
7327 # endif /* USE_ENVIRON_ARRAY */
7338 Using various gambits, try to get an IO from an SV: the IO slot if its a
7339 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7340 named after the PV if we're a string.
7346 Perl_sv_2io(pTHX_ SV *sv)
7351 switch (SvTYPE(sv)) {
7359 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7363 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7365 return sv_2io(SvRV(sv));
7366 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7372 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7381 Using various gambits, try to get a CV from an SV; in addition, try if
7382 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7383 The flags in C<lref> are passed to sv_fetchsv.
7389 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7400 switch (SvTYPE(sv)) {
7419 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7420 tryAMAGICunDEREF(to_cv);
7423 if (SvTYPE(sv) == SVt_PVCV) {
7432 Perl_croak(aTHX_ "Not a subroutine reference");
7437 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7443 /* Some flags to gv_fetchsv mean don't really create the GV */
7444 if (SvTYPE(gv) != SVt_PVGV) {
7450 if (lref && !GvCVu(gv)) {
7454 gv_efullname3(tmpsv, gv, NULL);
7455 /* XXX this is probably not what they think they're getting.
7456 * It has the same effect as "sub name;", i.e. just a forward
7458 newSUB(start_subparse(FALSE, 0),
7459 newSVOP(OP_CONST, 0, tmpsv),
7463 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7473 Returns true if the SV has a true value by Perl's rules.
7474 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7475 instead use an in-line version.
7481 Perl_sv_true(pTHX_ register SV *sv)
7486 register const XPV* const tXpv = (XPV*)SvANY(sv);
7488 (tXpv->xpv_cur > 1 ||
7489 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7496 return SvIVX(sv) != 0;
7499 return SvNVX(sv) != 0.0;
7501 return sv_2bool(sv);
7507 =for apidoc sv_pvn_force
7509 Get a sensible string out of the SV somehow.
7510 A private implementation of the C<SvPV_force> macro for compilers which
7511 can't cope with complex macro expressions. Always use the macro instead.
7513 =for apidoc sv_pvn_force_flags
7515 Get a sensible string out of the SV somehow.
7516 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7517 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7518 implemented in terms of this function.
7519 You normally want to use the various wrapper macros instead: see
7520 C<SvPV_force> and C<SvPV_force_nomg>
7526 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7529 if (SvTHINKFIRST(sv) && !SvROK(sv))
7530 sv_force_normal_flags(sv, 0);
7540 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7541 const char * const ref = sv_reftype(sv,0);
7543 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7544 ref, OP_NAME(PL_op));
7546 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7548 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7549 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7551 s = sv_2pv_flags(sv, &len, flags);
7555 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7558 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7559 SvGROW(sv, len + 1);
7560 Move(s,SvPVX(sv),len,char);
7565 SvPOK_on(sv); /* validate pointer */
7567 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7568 PTR2UV(sv),SvPVX_const(sv)));
7571 return SvPVX_mutable(sv);
7575 =for apidoc sv_pvbyten_force
7577 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7583 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7585 sv_pvn_force(sv,lp);
7586 sv_utf8_downgrade(sv,0);
7592 =for apidoc sv_pvutf8n_force
7594 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7600 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7602 sv_pvn_force(sv,lp);
7603 sv_utf8_upgrade(sv);
7609 =for apidoc sv_reftype
7611 Returns a string describing what the SV is a reference to.
7617 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7619 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7620 inside return suggests a const propagation bug in g++. */
7621 if (ob && SvOBJECT(sv)) {
7622 char * const name = HvNAME_get(SvSTASH(sv));
7623 return name ? name : (char *) "__ANON__";
7626 switch (SvTYPE(sv)) {
7643 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7644 /* tied lvalues should appear to be
7645 * scalars for backwards compatitbility */
7646 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7647 ? "SCALAR" : "LVALUE");
7648 case SVt_PVAV: return "ARRAY";
7649 case SVt_PVHV: return "HASH";
7650 case SVt_PVCV: return "CODE";
7651 case SVt_PVGV: return "GLOB";
7652 case SVt_PVFM: return "FORMAT";
7653 case SVt_PVIO: return "IO";
7654 default: return "UNKNOWN";
7660 =for apidoc sv_isobject
7662 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7663 object. If the SV is not an RV, or if the object is not blessed, then this
7670 Perl_sv_isobject(pTHX_ SV *sv)
7686 Returns a boolean indicating whether the SV is blessed into the specified
7687 class. This does not check for subtypes; use C<sv_derived_from> to verify
7688 an inheritance relationship.
7694 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7705 hvname = HvNAME_get(SvSTASH(sv));
7709 return strEQ(hvname, name);
7715 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7716 it will be upgraded to one. If C<classname> is non-null then the new SV will
7717 be blessed in the specified package. The new SV is returned and its
7718 reference count is 1.
7724 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7731 SV_CHECK_THINKFIRST_COW_DROP(rv);
7734 if (SvTYPE(rv) >= SVt_PVMG) {
7735 const U32 refcnt = SvREFCNT(rv);
7739 SvREFCNT(rv) = refcnt;
7741 sv_upgrade(rv, SVt_RV);
7742 } else if (SvROK(rv)) {
7743 SvREFCNT_dec(SvRV(rv));
7744 } else if (SvTYPE(rv) < SVt_RV)
7745 sv_upgrade(rv, SVt_RV);
7746 else if (SvTYPE(rv) > SVt_RV) {
7757 HV* const stash = gv_stashpv(classname, TRUE);
7758 (void)sv_bless(rv, stash);
7764 =for apidoc sv_setref_pv
7766 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7767 argument will be upgraded to an RV. That RV will be modified to point to
7768 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7769 into the SV. The C<classname> argument indicates the package for the
7770 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7771 will have a reference count of 1, and the RV will be returned.
7773 Do not use with other Perl types such as HV, AV, SV, CV, because those
7774 objects will become corrupted by the pointer copy process.
7776 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7782 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7786 sv_setsv(rv, &PL_sv_undef);
7790 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7795 =for apidoc sv_setref_iv
7797 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7798 argument will be upgraded to an RV. That RV will be modified to point to
7799 the new SV. The C<classname> argument indicates the package for the
7800 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7801 will have a reference count of 1, and the RV will be returned.
7807 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7809 sv_setiv(newSVrv(rv,classname), iv);
7814 =for apidoc sv_setref_uv
7816 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7817 argument will be upgraded to an RV. That RV will be modified to point to
7818 the new SV. The C<classname> argument indicates the package for the
7819 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7820 will have a reference count of 1, and the RV will be returned.
7826 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7828 sv_setuv(newSVrv(rv,classname), uv);
7833 =for apidoc sv_setref_nv
7835 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7836 argument will be upgraded to an RV. That RV will be modified to point to
7837 the new SV. The C<classname> argument indicates the package for the
7838 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7839 will have a reference count of 1, and the RV will be returned.
7845 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7847 sv_setnv(newSVrv(rv,classname), nv);
7852 =for apidoc sv_setref_pvn
7854 Copies a string into a new SV, optionally blessing the SV. The length of the
7855 string must be specified with C<n>. The C<rv> argument will be upgraded to
7856 an RV. That RV will be modified to point to the new SV. The C<classname>
7857 argument indicates the package for the blessing. Set C<classname> to
7858 C<NULL> to avoid the blessing. The new SV will have a reference count
7859 of 1, and the RV will be returned.
7861 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7867 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7869 sv_setpvn(newSVrv(rv,classname), pv, n);
7874 =for apidoc sv_bless
7876 Blesses an SV into a specified package. The SV must be an RV. The package
7877 must be designated by its stash (see C<gv_stashpv()>). The reference count
7878 of the SV is unaffected.
7884 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7889 Perl_croak(aTHX_ "Can't bless non-reference value");
7891 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7892 if (SvREADONLY(tmpRef))
7893 Perl_croak(aTHX_ PL_no_modify);
7894 if (SvOBJECT(tmpRef)) {
7895 if (SvTYPE(tmpRef) != SVt_PVIO)
7897 SvREFCNT_dec(SvSTASH(tmpRef));
7900 SvOBJECT_on(tmpRef);
7901 if (SvTYPE(tmpRef) != SVt_PVIO)
7903 SvUPGRADE(tmpRef, SVt_PVMG);
7904 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7911 if(SvSMAGICAL(tmpRef))
7912 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7920 /* Downgrades a PVGV to a PVMG.
7924 S_sv_unglob(pTHX_ SV *sv)
7928 SV * const temp = sv_newmortal();
7930 assert(SvTYPE(sv) == SVt_PVGV);
7932 gv_efullname3(temp, (GV *) sv, "*");
7938 sv_del_backref((SV*)GvSTASH(sv), sv);
7942 if (GvNAME_HEK(sv)) {
7943 unshare_hek(GvNAME_HEK(sv));
7947 /* need to keep SvANY(sv) in the right arena */
7948 xpvmg = new_XPVMG();
7949 StructCopy(SvANY(sv), xpvmg, XPVMG);
7950 del_XPVGV(SvANY(sv));
7953 SvFLAGS(sv) &= ~SVTYPEMASK;
7954 SvFLAGS(sv) |= SVt_PVMG;
7956 /* Intentionally not calling any local SET magic, as this isn't so much a
7957 set operation as merely an internal storage change. */
7958 sv_setsv_flags(sv, temp, 0);
7962 =for apidoc sv_unref_flags
7964 Unsets the RV status of the SV, and decrements the reference count of
7965 whatever was being referenced by the RV. This can almost be thought of
7966 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7967 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7968 (otherwise the decrementing is conditional on the reference count being
7969 different from one or the reference being a readonly SV).
7976 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7978 SV* const target = SvRV(ref);
7980 if (SvWEAKREF(ref)) {
7981 sv_del_backref(target, ref);
7983 SvRV_set(ref, NULL);
7986 SvRV_set(ref, NULL);
7988 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7989 assigned to as BEGIN {$a = \"Foo"} will fail. */
7990 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7991 SvREFCNT_dec(target);
7992 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7993 sv_2mortal(target); /* Schedule for freeing later */
7997 =for apidoc sv_untaint
7999 Untaint an SV. Use C<SvTAINTED_off> instead.
8004 Perl_sv_untaint(pTHX_ SV *sv)
8006 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8007 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8014 =for apidoc sv_tainted
8016 Test an SV for taintedness. Use C<SvTAINTED> instead.
8021 Perl_sv_tainted(pTHX_ SV *sv)
8023 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8024 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8025 if (mg && (mg->mg_len & 1) )
8032 =for apidoc sv_setpviv
8034 Copies an integer into the given SV, also updating its string value.
8035 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8041 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8043 char buf[TYPE_CHARS(UV)];
8045 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8047 sv_setpvn(sv, ptr, ebuf - ptr);
8051 =for apidoc sv_setpviv_mg
8053 Like C<sv_setpviv>, but also handles 'set' magic.
8059 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8065 #if defined(PERL_IMPLICIT_CONTEXT)
8067 /* pTHX_ magic can't cope with varargs, so this is a no-context
8068 * version of the main function, (which may itself be aliased to us).
8069 * Don't access this version directly.
8073 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8077 va_start(args, pat);
8078 sv_vsetpvf(sv, pat, &args);
8082 /* pTHX_ magic can't cope with varargs, so this is a no-context
8083 * version of the main function, (which may itself be aliased to us).
8084 * Don't access this version directly.
8088 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8092 va_start(args, pat);
8093 sv_vsetpvf_mg(sv, pat, &args);
8099 =for apidoc sv_setpvf
8101 Works like C<sv_catpvf> but copies the text into the SV instead of
8102 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8108 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8111 va_start(args, pat);
8112 sv_vsetpvf(sv, pat, &args);
8117 =for apidoc sv_vsetpvf
8119 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8120 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8122 Usually used via its frontend C<sv_setpvf>.
8128 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8130 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8134 =for apidoc sv_setpvf_mg
8136 Like C<sv_setpvf>, but also handles 'set' magic.
8142 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8145 va_start(args, pat);
8146 sv_vsetpvf_mg(sv, pat, &args);
8151 =for apidoc sv_vsetpvf_mg
8153 Like C<sv_vsetpvf>, but also handles 'set' magic.
8155 Usually used via its frontend C<sv_setpvf_mg>.
8161 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8163 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8167 #if defined(PERL_IMPLICIT_CONTEXT)
8169 /* pTHX_ magic can't cope with varargs, so this is a no-context
8170 * version of the main function, (which may itself be aliased to us).
8171 * Don't access this version directly.
8175 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8179 va_start(args, pat);
8180 sv_vcatpvf(sv, pat, &args);
8184 /* pTHX_ magic can't cope with varargs, so this is a no-context
8185 * version of the main function, (which may itself be aliased to us).
8186 * Don't access this version directly.
8190 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8194 va_start(args, pat);
8195 sv_vcatpvf_mg(sv, pat, &args);
8201 =for apidoc sv_catpvf
8203 Processes its arguments like C<sprintf> and appends the formatted
8204 output to an SV. If the appended data contains "wide" characters
8205 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8206 and characters >255 formatted with %c), the original SV might get
8207 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8208 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8209 valid UTF-8; if the original SV was bytes, the pattern should be too.
8214 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8217 va_start(args, pat);
8218 sv_vcatpvf(sv, pat, &args);
8223 =for apidoc sv_vcatpvf
8225 Processes its arguments like C<vsprintf> and appends the formatted output
8226 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8228 Usually used via its frontend C<sv_catpvf>.
8234 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8236 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8240 =for apidoc sv_catpvf_mg
8242 Like C<sv_catpvf>, but also handles 'set' magic.
8248 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8251 va_start(args, pat);
8252 sv_vcatpvf_mg(sv, pat, &args);
8257 =for apidoc sv_vcatpvf_mg
8259 Like C<sv_vcatpvf>, but also handles 'set' magic.
8261 Usually used via its frontend C<sv_catpvf_mg>.
8267 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8269 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8274 =for apidoc sv_vsetpvfn
8276 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8279 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8285 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8287 sv_setpvn(sv, "", 0);
8288 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8292 S_expect_number(pTHX_ char** pattern)
8296 switch (**pattern) {
8297 case '1': case '2': case '3':
8298 case '4': case '5': case '6':
8299 case '7': case '8': case '9':
8300 var = *(*pattern)++ - '0';
8301 while (isDIGIT(**pattern)) {
8302 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8304 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8312 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8314 const int neg = nv < 0;
8323 if (uv & 1 && uv == nv)
8324 uv--; /* Round to even */
8326 const unsigned dig = uv % 10;
8339 =for apidoc sv_vcatpvfn
8341 Processes its arguments like C<vsprintf> and appends the formatted output
8342 to an SV. Uses an array of SVs if the C style variable argument list is
8343 missing (NULL). When running with taint checks enabled, indicates via
8344 C<maybe_tainted> if results are untrustworthy (often due to the use of
8347 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8353 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8354 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8355 vec_utf8 = DO_UTF8(vecsv);
8357 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8360 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8368 static const char nullstr[] = "(null)";
8370 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8371 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8373 /* Times 4: a decimal digit takes more than 3 binary digits.
8374 * NV_DIG: mantissa takes than many decimal digits.
8375 * Plus 32: Playing safe. */
8376 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8377 /* large enough for "%#.#f" --chip */
8378 /* what about long double NVs? --jhi */
8380 PERL_UNUSED_ARG(maybe_tainted);
8382 /* no matter what, this is a string now */
8383 (void)SvPV_force(sv, origlen);
8385 /* special-case "", "%s", and "%-p" (SVf - see below) */
8388 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8390 const char * const s = va_arg(*args, char*);
8391 sv_catpv(sv, s ? s : nullstr);
8393 else if (svix < svmax) {
8394 sv_catsv(sv, *svargs);
8398 if (args && patlen == 3 && pat[0] == '%' &&
8399 pat[1] == '-' && pat[2] == 'p') {
8400 argsv = va_arg(*args, SV*);
8401 sv_catsv(sv, argsv);
8405 #ifndef USE_LONG_DOUBLE
8406 /* special-case "%.<number>[gf]" */
8407 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8408 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8409 unsigned digits = 0;
8413 while (*pp >= '0' && *pp <= '9')
8414 digits = 10 * digits + (*pp++ - '0');
8415 if (pp - pat == (int)patlen - 1) {
8423 /* Add check for digits != 0 because it seems that some
8424 gconverts are buggy in this case, and we don't yet have
8425 a Configure test for this. */
8426 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8427 /* 0, point, slack */
8428 Gconvert(nv, (int)digits, 0, ebuf);
8430 if (*ebuf) /* May return an empty string for digits==0 */
8433 } else if (!digits) {
8436 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8437 sv_catpvn(sv, p, l);
8443 #endif /* !USE_LONG_DOUBLE */
8445 if (!args && svix < svmax && DO_UTF8(*svargs))
8448 patend = (char*)pat + patlen;
8449 for (p = (char*)pat; p < patend; p = q) {
8452 bool vectorize = FALSE;
8453 bool vectorarg = FALSE;
8454 bool vec_utf8 = FALSE;
8460 bool has_precis = FALSE;
8462 const I32 osvix = svix;
8463 bool is_utf8 = FALSE; /* is this item utf8? */
8464 #ifdef HAS_LDBL_SPRINTF_BUG
8465 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8466 with sfio - Allen <allens@cpan.org> */
8467 bool fix_ldbl_sprintf_bug = FALSE;
8471 U8 utf8buf[UTF8_MAXBYTES+1];
8472 STRLEN esignlen = 0;
8474 const char *eptr = NULL;
8477 const U8 *vecstr = NULL;
8484 /* we need a long double target in case HAS_LONG_DOUBLE but
8487 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8495 const char *dotstr = ".";
8496 STRLEN dotstrlen = 1;
8497 I32 efix = 0; /* explicit format parameter index */
8498 I32 ewix = 0; /* explicit width index */
8499 I32 epix = 0; /* explicit precision index */
8500 I32 evix = 0; /* explicit vector index */
8501 bool asterisk = FALSE;
8503 /* echo everything up to the next format specification */
8504 for (q = p; q < patend && *q != '%'; ++q) ;
8506 if (has_utf8 && !pat_utf8)
8507 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8509 sv_catpvn(sv, p, q - p);
8516 We allow format specification elements in this order:
8517 \d+\$ explicit format parameter index
8519 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8520 0 flag (as above): repeated to allow "v02"
8521 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8522 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8524 [%bcdefginopsuxDFOUX] format (mandatory)
8529 As of perl5.9.3, printf format checking is on by default.
8530 Internally, perl uses %p formats to provide an escape to
8531 some extended formatting. This block deals with those
8532 extensions: if it does not match, (char*)q is reset and
8533 the normal format processing code is used.
8535 Currently defined extensions are:
8536 %p include pointer address (standard)
8537 %-p (SVf) include an SV (previously %_)
8538 %-<num>p include an SV with precision <num>
8539 %1p (VDf) include a v-string (as %vd)
8540 %<num>p reserved for future extensions
8542 Robin Barker 2005-07-14
8549 n = expect_number(&q);
8556 argsv = va_arg(*args, SV*);
8557 eptr = SvPVx_const(argsv, elen);
8563 else if (n == vdNUMBER) { /* VDf */
8570 if (ckWARN_d(WARN_INTERNAL))
8571 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8572 "internal %%<num>p might conflict with future printf extensions");
8578 if ( (width = expect_number(&q)) ) {
8593 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8622 if ( (ewix = expect_number(&q)) )
8631 if ((vectorarg = asterisk)) {
8644 width = expect_number(&q);
8650 vecsv = va_arg(*args, SV*);
8652 vecsv = (evix > 0 && evix <= svmax)
8653 ? svargs[evix-1] : &PL_sv_undef;
8655 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8657 dotstr = SvPV_const(vecsv, dotstrlen);
8658 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8659 bad with tied or overloaded values that return UTF8. */
8662 else if (has_utf8) {
8663 vecsv = sv_mortalcopy(vecsv);
8664 sv_utf8_upgrade(vecsv);
8665 dotstr = SvPV_const(vecsv, dotstrlen);
8672 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8673 vecsv = svargs[efix ? efix-1 : svix++];
8674 vecstr = (U8*)SvPV_const(vecsv,veclen);
8675 vec_utf8 = DO_UTF8(vecsv);
8677 /* if this is a version object, we need to convert
8678 * back into v-string notation and then let the
8679 * vectorize happen normally
8681 if (sv_derived_from(vecsv, "version")) {
8682 char *version = savesvpv(vecsv);
8683 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8684 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8685 "vector argument not supported with alpha versions");
8688 vecsv = sv_newmortal();
8689 /* scan_vstring is expected to be called during
8690 * tokenization, so we need to fake up the end
8691 * of the buffer for it
8693 PL_bufend = version + veclen;
8694 scan_vstring(version, vecsv);
8695 vecstr = (U8*)SvPV_const(vecsv, veclen);
8696 vec_utf8 = DO_UTF8(vecsv);
8708 i = va_arg(*args, int);
8710 i = (ewix ? ewix <= svmax : svix < svmax) ?
8711 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8713 width = (i < 0) ? -i : i;
8723 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8725 /* XXX: todo, support specified precision parameter */
8729 i = va_arg(*args, int);
8731 i = (ewix ? ewix <= svmax : svix < svmax)
8732 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8734 has_precis = !(i < 0);
8739 precis = precis * 10 + (*q++ - '0');
8748 case 'I': /* Ix, I32x, and I64x */
8750 if (q[1] == '6' && q[2] == '4') {
8756 if (q[1] == '3' && q[2] == '2') {
8766 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8777 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8778 if (*(q + 1) == 'l') { /* lld, llf */
8804 if (!vectorize && !args) {
8806 const I32 i = efix-1;
8807 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8809 argsv = (svix >= 0 && svix < svmax)
8810 ? svargs[svix++] : &PL_sv_undef;
8821 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8823 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8825 eptr = (char*)utf8buf;
8826 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8840 eptr = va_arg(*args, char*);
8842 #ifdef MACOS_TRADITIONAL
8843 /* On MacOS, %#s format is used for Pascal strings */
8848 elen = strlen(eptr);
8850 eptr = (char *)nullstr;
8851 elen = sizeof nullstr - 1;
8855 eptr = SvPVx_const(argsv, elen);
8856 if (DO_UTF8(argsv)) {
8857 I32 old_precis = precis;
8858 if (has_precis && precis < elen) {
8860 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8863 if (width) { /* fudge width (can't fudge elen) */
8864 if (has_precis && precis < elen)
8865 width += precis - old_precis;
8867 width += elen - sv_len_utf8(argsv);
8874 if (has_precis && elen > precis)
8881 if (alt || vectorize)
8883 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8904 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8913 esignbuf[esignlen++] = plus;
8917 case 'h': iv = (short)va_arg(*args, int); break;
8918 case 'l': iv = va_arg(*args, long); break;
8919 case 'V': iv = va_arg(*args, IV); break;
8920 default: iv = va_arg(*args, int); break;
8922 case 'q': iv = va_arg(*args, Quad_t); break;
8927 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8929 case 'h': iv = (short)tiv; break;
8930 case 'l': iv = (long)tiv; break;
8932 default: iv = tiv; break;
8934 case 'q': iv = (Quad_t)tiv; break;
8938 if ( !vectorize ) /* we already set uv above */
8943 esignbuf[esignlen++] = plus;
8947 esignbuf[esignlen++] = '-';
8991 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9002 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9003 case 'l': uv = va_arg(*args, unsigned long); break;
9004 case 'V': uv = va_arg(*args, UV); break;
9005 default: uv = va_arg(*args, unsigned); break;
9007 case 'q': uv = va_arg(*args, Uquad_t); break;
9012 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9014 case 'h': uv = (unsigned short)tuv; break;
9015 case 'l': uv = (unsigned long)tuv; break;
9017 default: uv = tuv; break;
9019 case 'q': uv = (Uquad_t)tuv; break;
9026 char *ptr = ebuf + sizeof ebuf;
9027 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9033 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9039 esignbuf[esignlen++] = '0';
9040 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9048 if (alt && *ptr != '0')
9057 esignbuf[esignlen++] = '0';
9058 esignbuf[esignlen++] = c;
9061 default: /* it had better be ten or less */
9065 } while (uv /= base);
9068 elen = (ebuf + sizeof ebuf) - ptr;
9072 zeros = precis - elen;
9073 else if (precis == 0 && elen == 1 && *eptr == '0'
9074 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9077 /* a precision nullifies the 0 flag. */
9084 /* FLOATING POINT */
9087 c = 'f'; /* maybe %F isn't supported here */
9095 /* This is evil, but floating point is even more evil */
9097 /* for SV-style calling, we can only get NV
9098 for C-style calling, we assume %f is double;
9099 for simplicity we allow any of %Lf, %llf, %qf for long double
9103 #if defined(USE_LONG_DOUBLE)
9107 /* [perl #20339] - we should accept and ignore %lf rather than die */
9111 #if defined(USE_LONG_DOUBLE)
9112 intsize = args ? 0 : 'q';
9116 #if defined(HAS_LONG_DOUBLE)
9125 /* now we need (long double) if intsize == 'q', else (double) */
9127 #if LONG_DOUBLESIZE > DOUBLESIZE
9129 va_arg(*args, long double) :
9130 va_arg(*args, double)
9132 va_arg(*args, double)
9137 if (c != 'e' && c != 'E') {
9139 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9140 will cast our (long double) to (double) */
9141 (void)Perl_frexp(nv, &i);
9142 if (i == PERL_INT_MIN)
9143 Perl_die(aTHX_ "panic: frexp");
9145 need = BIT_DIGITS(i);
9147 need += has_precis ? precis : 6; /* known default */
9152 #ifdef HAS_LDBL_SPRINTF_BUG
9153 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9154 with sfio - Allen <allens@cpan.org> */
9157 # define MY_DBL_MAX DBL_MAX
9158 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9159 # if DOUBLESIZE >= 8
9160 # define MY_DBL_MAX 1.7976931348623157E+308L
9162 # define MY_DBL_MAX 3.40282347E+38L
9166 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9167 # define MY_DBL_MAX_BUG 1L
9169 # define MY_DBL_MAX_BUG MY_DBL_MAX
9173 # define MY_DBL_MIN DBL_MIN
9174 # else /* XXX guessing! -Allen */
9175 # if DOUBLESIZE >= 8
9176 # define MY_DBL_MIN 2.2250738585072014E-308L
9178 # define MY_DBL_MIN 1.17549435E-38L
9182 if ((intsize == 'q') && (c == 'f') &&
9183 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9185 /* it's going to be short enough that
9186 * long double precision is not needed */
9188 if ((nv <= 0L) && (nv >= -0L))
9189 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9191 /* would use Perl_fp_class as a double-check but not
9192 * functional on IRIX - see perl.h comments */
9194 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9195 /* It's within the range that a double can represent */
9196 #if defined(DBL_MAX) && !defined(DBL_MIN)
9197 if ((nv >= ((long double)1/DBL_MAX)) ||
9198 (nv <= (-(long double)1/DBL_MAX)))
9200 fix_ldbl_sprintf_bug = TRUE;
9203 if (fix_ldbl_sprintf_bug == TRUE) {
9213 # undef MY_DBL_MAX_BUG
9216 #endif /* HAS_LDBL_SPRINTF_BUG */
9218 need += 20; /* fudge factor */
9219 if (PL_efloatsize < need) {
9220 Safefree(PL_efloatbuf);
9221 PL_efloatsize = need + 20; /* more fudge */
9222 Newx(PL_efloatbuf, PL_efloatsize, char);
9223 PL_efloatbuf[0] = '\0';
9226 if ( !(width || left || plus || alt) && fill != '0'
9227 && has_precis && intsize != 'q' ) { /* Shortcuts */
9228 /* See earlier comment about buggy Gconvert when digits,
9230 if ( c == 'g' && precis) {
9231 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9232 /* May return an empty string for digits==0 */
9233 if (*PL_efloatbuf) {
9234 elen = strlen(PL_efloatbuf);
9235 goto float_converted;
9237 } else if ( c == 'f' && !precis) {
9238 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9243 char *ptr = ebuf + sizeof ebuf;
9246 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9247 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9248 if (intsize == 'q') {
9249 /* Copy the one or more characters in a long double
9250 * format before the 'base' ([efgEFG]) character to
9251 * the format string. */
9252 static char const prifldbl[] = PERL_PRIfldbl;
9253 char const *p = prifldbl + sizeof(prifldbl) - 3;
9254 while (p >= prifldbl) { *--ptr = *p--; }
9259 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9264 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9276 /* No taint. Otherwise we are in the strange situation
9277 * where printf() taints but print($float) doesn't.
9279 #if defined(HAS_LONG_DOUBLE)
9280 elen = ((intsize == 'q')
9281 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9282 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9284 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9288 eptr = PL_efloatbuf;
9296 i = SvCUR(sv) - origlen;
9299 case 'h': *(va_arg(*args, short*)) = i; break;
9300 default: *(va_arg(*args, int*)) = i; break;
9301 case 'l': *(va_arg(*args, long*)) = i; break;
9302 case 'V': *(va_arg(*args, IV*)) = i; break;
9304 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9309 sv_setuv_mg(argsv, (UV)i);
9310 continue; /* not "break" */
9317 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9318 && ckWARN(WARN_PRINTF))
9320 SV * const msg = sv_newmortal();
9321 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9322 (PL_op->op_type == OP_PRTF) ? "" : "s");
9325 Perl_sv_catpvf(aTHX_ msg,
9326 "\"%%%c\"", c & 0xFF);
9328 Perl_sv_catpvf(aTHX_ msg,
9329 "\"%%\\%03"UVof"\"",
9332 sv_catpvs(msg, "end of string");
9333 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9336 /* output mangled stuff ... */
9342 /* ... right here, because formatting flags should not apply */
9343 SvGROW(sv, SvCUR(sv) + elen + 1);
9345 Copy(eptr, p, elen, char);
9348 SvCUR_set(sv, p - SvPVX_const(sv));
9350 continue; /* not "break" */
9353 if (is_utf8 != has_utf8) {
9356 sv_utf8_upgrade(sv);
9359 const STRLEN old_elen = elen;
9360 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9361 sv_utf8_upgrade(nsv);
9362 eptr = SvPVX_const(nsv);
9365 if (width) { /* fudge width (can't fudge elen) */
9366 width += elen - old_elen;
9372 have = esignlen + zeros + elen;
9374 Perl_croak_nocontext(PL_memory_wrap);
9376 need = (have > width ? have : width);
9379 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9380 Perl_croak_nocontext(PL_memory_wrap);
9381 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9383 if (esignlen && fill == '0') {
9385 for (i = 0; i < (int)esignlen; i++)
9389 memset(p, fill, gap);
9392 if (esignlen && fill != '0') {
9394 for (i = 0; i < (int)esignlen; i++)
9399 for (i = zeros; i; i--)
9403 Copy(eptr, p, elen, char);
9407 memset(p, ' ', gap);
9412 Copy(dotstr, p, dotstrlen, char);
9416 vectorize = FALSE; /* done iterating over vecstr */
9423 SvCUR_set(sv, p - SvPVX_const(sv));
9431 /* =========================================================================
9433 =head1 Cloning an interpreter
9435 All the macros and functions in this section are for the private use of
9436 the main function, perl_clone().
9438 The foo_dup() functions make an exact copy of an existing foo thinngy.
9439 During the course of a cloning, a hash table is used to map old addresses
9440 to new addresses. The table is created and manipulated with the
9441 ptr_table_* functions.
9445 ============================================================================*/
9448 #if defined(USE_ITHREADS)
9450 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9451 #ifndef GpREFCNT_inc
9452 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9456 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9457 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9458 If this changes, please unmerge ss_dup. */
9459 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9460 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9461 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9462 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9463 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9464 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9465 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9466 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9467 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9468 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9469 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9470 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9471 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9472 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9475 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9476 regcomp.c. AMS 20010712 */
9479 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9481 return CALLREGDUPE(r,param);
9484 /* duplicate a file handle */
9487 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9491 PERL_UNUSED_ARG(type);
9494 return (PerlIO*)NULL;
9496 /* look for it in the table first */
9497 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9501 /* create anew and remember what it is */
9502 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9503 ptr_table_store(PL_ptr_table, fp, ret);
9507 /* duplicate a directory handle */
9510 Perl_dirp_dup(pTHX_ DIR *dp)
9512 PERL_UNUSED_CONTEXT;
9519 /* duplicate a typeglob */
9522 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9528 /* look for it in the table first */
9529 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9533 /* create anew and remember what it is */
9535 ptr_table_store(PL_ptr_table, gp, ret);
9538 ret->gp_refcnt = 0; /* must be before any other dups! */
9539 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9540 ret->gp_io = io_dup_inc(gp->gp_io, param);
9541 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9542 ret->gp_av = av_dup_inc(gp->gp_av, param);
9543 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9544 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9545 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9546 ret->gp_cvgen = gp->gp_cvgen;
9547 ret->gp_line = gp->gp_line;
9548 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9552 /* duplicate a chain of magic */
9555 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9557 MAGIC *mgprev = (MAGIC*)NULL;
9560 return (MAGIC*)NULL;
9561 /* look for it in the table first */
9562 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9566 for (; mg; mg = mg->mg_moremagic) {
9568 Newxz(nmg, 1, MAGIC);
9570 mgprev->mg_moremagic = nmg;
9573 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9574 nmg->mg_private = mg->mg_private;
9575 nmg->mg_type = mg->mg_type;
9576 nmg->mg_flags = mg->mg_flags;
9577 if (mg->mg_type == PERL_MAGIC_qr) {
9578 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9580 else if(mg->mg_type == PERL_MAGIC_backref) {
9581 /* The backref AV has its reference count deliberately bumped by
9583 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9585 else if (mg->mg_type == PERL_MAGIC_symtab) {
9586 nmg->mg_obj = mg->mg_obj;
9589 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9590 ? sv_dup_inc(mg->mg_obj, param)
9591 : sv_dup(mg->mg_obj, param);
9593 nmg->mg_len = mg->mg_len;
9594 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9595 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9596 if (mg->mg_len > 0) {
9597 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9598 if (mg->mg_type == PERL_MAGIC_overload_table &&
9599 AMT_AMAGIC((AMT*)mg->mg_ptr))
9601 const AMT * const amtp = (AMT*)mg->mg_ptr;
9602 AMT * const namtp = (AMT*)nmg->mg_ptr;
9604 for (i = 1; i < NofAMmeth; i++) {
9605 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9609 else if (mg->mg_len == HEf_SVKEY)
9610 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9612 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9613 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9620 /* create a new pointer-mapping table */
9623 Perl_ptr_table_new(pTHX)
9626 PERL_UNUSED_CONTEXT;
9628 Newxz(tbl, 1, PTR_TBL_t);
9631 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9635 #define PTR_TABLE_HASH(ptr) \
9636 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9639 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9640 following define) and at call to new_body_inline made below in
9641 Perl_ptr_table_store()
9644 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9646 /* map an existing pointer using a table */
9648 STATIC PTR_TBL_ENT_t *
9649 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9650 PTR_TBL_ENT_t *tblent;
9651 const UV hash = PTR_TABLE_HASH(sv);
9653 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9654 for (; tblent; tblent = tblent->next) {
9655 if (tblent->oldval == sv)
9662 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9664 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9665 PERL_UNUSED_CONTEXT;
9666 return tblent ? tblent->newval : NULL;
9669 /* add a new entry to a pointer-mapping table */
9672 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9674 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9675 PERL_UNUSED_CONTEXT;
9678 tblent->newval = newsv;
9680 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9682 new_body_inline(tblent, PTE_SVSLOT);
9684 tblent->oldval = oldsv;
9685 tblent->newval = newsv;
9686 tblent->next = tbl->tbl_ary[entry];
9687 tbl->tbl_ary[entry] = tblent;
9689 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9690 ptr_table_split(tbl);
9694 /* double the hash bucket size of an existing ptr table */
9697 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9699 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9700 const UV oldsize = tbl->tbl_max + 1;
9701 UV newsize = oldsize * 2;
9703 PERL_UNUSED_CONTEXT;
9705 Renew(ary, newsize, PTR_TBL_ENT_t*);
9706 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9707 tbl->tbl_max = --newsize;
9709 for (i=0; i < oldsize; i++, ary++) {
9710 PTR_TBL_ENT_t **curentp, **entp, *ent;
9713 curentp = ary + oldsize;
9714 for (entp = ary, ent = *ary; ent; ent = *entp) {
9715 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9717 ent->next = *curentp;
9727 /* remove all the entries from a ptr table */
9730 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9732 if (tbl && tbl->tbl_items) {
9733 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9734 UV riter = tbl->tbl_max;
9737 PTR_TBL_ENT_t *entry = array[riter];
9740 PTR_TBL_ENT_t * const oentry = entry;
9741 entry = entry->next;
9750 /* clear and free a ptr table */
9753 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9758 ptr_table_clear(tbl);
9759 Safefree(tbl->tbl_ary);
9765 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9768 SvRV_set(dstr, SvWEAKREF(sstr)
9769 ? sv_dup(SvRV(sstr), param)
9770 : sv_dup_inc(SvRV(sstr), param));
9773 else if (SvPVX_const(sstr)) {
9774 /* Has something there */
9776 /* Normal PV - clone whole allocated space */
9777 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9778 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9779 /* Not that normal - actually sstr is copy on write.
9780 But we are a true, independant SV, so: */
9781 SvREADONLY_off(dstr);
9786 /* Special case - not normally malloced for some reason */
9787 if (isGV_with_GP(sstr)) {
9788 /* Don't need to do anything here. */
9790 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9791 /* A "shared" PV - clone it as "shared" PV */
9793 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9797 /* Some other special case - random pointer */
9798 SvPV_set(dstr, SvPVX(sstr));
9804 if (SvTYPE(dstr) == SVt_RV)
9805 SvRV_set(dstr, NULL);
9807 SvPV_set(dstr, NULL);
9811 /* duplicate an SV of any type (including AV, HV etc) */
9814 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9819 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9821 /* look for it in the table first */
9822 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9826 if(param->flags & CLONEf_JOIN_IN) {
9827 /** We are joining here so we don't want do clone
9828 something that is bad **/
9829 if (SvTYPE(sstr) == SVt_PVHV) {
9830 const char * const hvname = HvNAME_get(sstr);
9832 /** don't clone stashes if they already exist **/
9833 return (SV*)gv_stashpv(hvname,0);
9837 /* create anew and remember what it is */
9840 #ifdef DEBUG_LEAKING_SCALARS
9841 dstr->sv_debug_optype = sstr->sv_debug_optype;
9842 dstr->sv_debug_line = sstr->sv_debug_line;
9843 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9844 dstr->sv_debug_cloned = 1;
9845 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9848 ptr_table_store(PL_ptr_table, sstr, dstr);
9851 SvFLAGS(dstr) = SvFLAGS(sstr);
9852 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9853 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9856 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9857 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9858 PL_watch_pvx, SvPVX_const(sstr));
9861 /* don't clone objects whose class has asked us not to */
9862 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9863 SvFLAGS(dstr) &= ~SVTYPEMASK;
9868 switch (SvTYPE(sstr)) {
9873 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9874 SvIV_set(dstr, SvIVX(sstr));
9877 SvANY(dstr) = new_XNV();
9878 SvNV_set(dstr, SvNVX(sstr));
9881 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9882 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9886 /* These are all the types that need complex bodies allocating. */
9888 const svtype sv_type = SvTYPE(sstr);
9889 const struct body_details *const sv_type_details
9890 = bodies_by_type + sv_type;
9894 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9898 if (GvUNIQUE((GV*)sstr)) {
9899 NOOP; /* Do sharing here, and fall through */
9912 assert(sv_type_details->body_size);
9913 if (sv_type_details->arena) {
9914 new_body_inline(new_body, sv_type);
9916 = (void*)((char*)new_body - sv_type_details->offset);
9918 new_body = new_NOARENA(sv_type_details);
9922 SvANY(dstr) = new_body;
9925 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9926 ((char*)SvANY(dstr)) + sv_type_details->offset,
9927 sv_type_details->copy, char);
9929 Copy(((char*)SvANY(sstr)),
9930 ((char*)SvANY(dstr)),
9931 sv_type_details->body_size + sv_type_details->offset, char);
9934 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9935 && !isGV_with_GP(dstr))
9936 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9938 /* The Copy above means that all the source (unduplicated) pointers
9939 are now in the destination. We can check the flags and the
9940 pointers in either, but it's possible that there's less cache
9941 missing by always going for the destination.
9942 FIXME - instrument and check that assumption */
9943 if (sv_type >= SVt_PVMG) {
9944 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9945 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9946 } else if (SvMAGIC(dstr))
9947 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9949 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9952 /* The cast silences a GCC warning about unhandled types. */
9953 switch ((int)sv_type) {
9965 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9966 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9967 LvTARG(dstr) = dstr;
9968 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9969 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9971 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9974 if (GvNAME_HEK(dstr))
9975 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9977 /* Don't call sv_add_backref here as it's going to be created
9978 as part of the magic cloning of the symbol table. */
9979 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9980 if(isGV_with_GP(sstr)) {
9981 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9982 at the point of this comment. */
9983 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9984 (void)GpREFCNT_inc(GvGP(dstr));
9986 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9989 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9990 if (IoOFP(dstr) == IoIFP(sstr))
9991 IoOFP(dstr) = IoIFP(dstr);
9993 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9994 /* PL_rsfp_filters entries have fake IoDIRP() */
9995 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9996 /* I have no idea why fake dirp (rsfps)
9997 should be treated differently but otherwise
9998 we end up with leaks -- sky*/
9999 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10000 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10001 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10003 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10004 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10005 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10006 if (IoDIRP(dstr)) {
10007 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10010 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10013 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10014 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10015 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10018 if (AvARRAY((AV*)sstr)) {
10019 SV **dst_ary, **src_ary;
10020 SSize_t items = AvFILLp((AV*)sstr) + 1;
10022 src_ary = AvARRAY((AV*)sstr);
10023 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10024 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10025 AvARRAY((AV*)dstr) = dst_ary;
10026 AvALLOC((AV*)dstr) = dst_ary;
10027 if (AvREAL((AV*)sstr)) {
10028 while (items-- > 0)
10029 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10032 while (items-- > 0)
10033 *dst_ary++ = sv_dup(*src_ary++, param);
10035 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10036 while (items-- > 0) {
10037 *dst_ary++ = &PL_sv_undef;
10041 AvARRAY((AV*)dstr) = NULL;
10042 AvALLOC((AV*)dstr) = (SV**)NULL;
10046 if (HvARRAY((HV*)sstr)) {
10048 const bool sharekeys = !!HvSHAREKEYS(sstr);
10049 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10050 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10052 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10053 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10055 HvARRAY(dstr) = (HE**)darray;
10056 while (i <= sxhv->xhv_max) {
10057 const HE * const source = HvARRAY(sstr)[i];
10058 HvARRAY(dstr)[i] = source
10059 ? he_dup(source, sharekeys, param) : 0;
10064 const struct xpvhv_aux * const saux = HvAUX(sstr);
10065 struct xpvhv_aux * const daux = HvAUX(dstr);
10066 /* This flag isn't copied. */
10067 /* SvOOK_on(hv) attacks the IV flags. */
10068 SvFLAGS(dstr) |= SVf_OOK;
10070 hvname = saux->xhv_name;
10071 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10073 daux->xhv_riter = saux->xhv_riter;
10074 daux->xhv_eiter = saux->xhv_eiter
10075 ? he_dup(saux->xhv_eiter,
10076 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10077 daux->xhv_backreferences =
10078 saux->xhv_backreferences
10079 ? (AV*) SvREFCNT_inc(
10080 sv_dup((SV*)saux->xhv_backreferences, param))
10082 /* Record stashes for possible cloning in Perl_clone(). */
10084 av_push(param->stashes, dstr);
10088 HvARRAY((HV*)dstr) = NULL;
10091 if (!(param->flags & CLONEf_COPY_STACKS)) {
10095 /* NOTE: not refcounted */
10096 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10098 if (!CvISXSUB(dstr))
10099 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10101 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10102 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10103 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10104 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10106 /* don't dup if copying back - CvGV isn't refcounted, so the
10107 * duped GV may never be freed. A bit of a hack! DAPM */
10108 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10109 NULL : gv_dup(CvGV(dstr), param) ;
10110 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10112 CvWEAKOUTSIDE(sstr)
10113 ? cv_dup( CvOUTSIDE(dstr), param)
10114 : cv_dup_inc(CvOUTSIDE(dstr), param);
10115 if (!CvISXSUB(dstr))
10116 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10122 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10128 /* duplicate a context */
10131 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10133 PERL_CONTEXT *ncxs;
10136 return (PERL_CONTEXT*)NULL;
10138 /* look for it in the table first */
10139 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10143 /* create anew and remember what it is */
10144 Newxz(ncxs, max + 1, PERL_CONTEXT);
10145 ptr_table_store(PL_ptr_table, cxs, ncxs);
10148 PERL_CONTEXT * const cx = &cxs[ix];
10149 PERL_CONTEXT * const ncx = &ncxs[ix];
10150 ncx->cx_type = cx->cx_type;
10151 if (CxTYPE(cx) == CXt_SUBST) {
10152 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10155 ncx->blk_oldsp = cx->blk_oldsp;
10156 ncx->blk_oldcop = cx->blk_oldcop;
10157 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10158 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10159 ncx->blk_oldpm = cx->blk_oldpm;
10160 ncx->blk_gimme = cx->blk_gimme;
10161 switch (CxTYPE(cx)) {
10163 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10164 ? cv_dup_inc(cx->blk_sub.cv, param)
10165 : cv_dup(cx->blk_sub.cv,param));
10166 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10167 ? av_dup_inc(cx->blk_sub.argarray, param)
10169 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10170 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10171 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10172 ncx->blk_sub.lval = cx->blk_sub.lval;
10173 ncx->blk_sub.retop = cx->blk_sub.retop;
10174 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10175 cx->blk_sub.oldcomppad);
10178 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10179 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10180 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10181 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10182 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10183 ncx->blk_eval.retop = cx->blk_eval.retop;
10186 ncx->blk_loop.label = cx->blk_loop.label;
10187 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10188 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10189 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10190 ? cx->blk_loop.iterdata
10191 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10192 ncx->blk_loop.oldcomppad
10193 = (PAD*)ptr_table_fetch(PL_ptr_table,
10194 cx->blk_loop.oldcomppad);
10195 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10196 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10197 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10198 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10199 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10202 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10203 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10204 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10205 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10206 ncx->blk_sub.retop = cx->blk_sub.retop;
10218 /* duplicate a stack info structure */
10221 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10226 return (PERL_SI*)NULL;
10228 /* look for it in the table first */
10229 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10233 /* create anew and remember what it is */
10234 Newxz(nsi, 1, PERL_SI);
10235 ptr_table_store(PL_ptr_table, si, nsi);
10237 nsi->si_stack = av_dup_inc(si->si_stack, param);
10238 nsi->si_cxix = si->si_cxix;
10239 nsi->si_cxmax = si->si_cxmax;
10240 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10241 nsi->si_type = si->si_type;
10242 nsi->si_prev = si_dup(si->si_prev, param);
10243 nsi->si_next = si_dup(si->si_next, param);
10244 nsi->si_markoff = si->si_markoff;
10249 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10250 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10251 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10252 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10253 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10254 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10255 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10256 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10257 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10258 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10259 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10260 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10261 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10262 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10265 #define pv_dup_inc(p) SAVEPV(p)
10266 #define pv_dup(p) SAVEPV(p)
10267 #define svp_dup_inc(p,pp) any_dup(p,pp)
10269 /* map any object to the new equivent - either something in the
10270 * ptr table, or something in the interpreter structure
10274 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10279 return (void*)NULL;
10281 /* look for it in the table first */
10282 ret = ptr_table_fetch(PL_ptr_table, v);
10286 /* see if it is part of the interpreter structure */
10287 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10288 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10296 /* duplicate the save stack */
10299 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10301 ANY * const ss = proto_perl->Tsavestack;
10302 const I32 max = proto_perl->Tsavestack_max;
10303 I32 ix = proto_perl->Tsavestack_ix;
10316 void (*dptr) (void*);
10317 void (*dxptr) (pTHX_ void*);
10319 Newxz(nss, max, ANY);
10322 const I32 type = POPINT(ss,ix);
10323 TOPINT(nss,ix) = type;
10325 case SAVEt_HELEM: /* hash element */
10326 sv = (SV*)POPPTR(ss,ix);
10327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10329 case SAVEt_ITEM: /* normal string */
10330 case SAVEt_SV: /* scalar reference */
10331 sv = (SV*)POPPTR(ss,ix);
10332 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10335 case SAVEt_MORTALIZESV:
10336 sv = (SV*)POPPTR(ss,ix);
10337 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10339 case SAVEt_SHARED_PVREF: /* char* in shared space */
10340 c = (char*)POPPTR(ss,ix);
10341 TOPPTR(nss,ix) = savesharedpv(c);
10342 ptr = POPPTR(ss,ix);
10343 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10345 case SAVEt_GENERIC_SVREF: /* generic sv */
10346 case SAVEt_SVREF: /* scalar reference */
10347 sv = (SV*)POPPTR(ss,ix);
10348 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10349 ptr = POPPTR(ss,ix);
10350 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10352 case SAVEt_HV: /* hash reference */
10353 case SAVEt_AV: /* array reference */
10354 sv = (SV*) POPPTR(ss,ix);
10355 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10357 case SAVEt_COMPPAD:
10359 sv = (SV*) POPPTR(ss,ix);
10360 TOPPTR(nss,ix) = sv_dup(sv, param);
10362 case SAVEt_INT: /* int reference */
10363 ptr = POPPTR(ss,ix);
10364 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10365 intval = (int)POPINT(ss,ix);
10366 TOPINT(nss,ix) = intval;
10368 case SAVEt_LONG: /* long reference */
10369 ptr = POPPTR(ss,ix);
10370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10372 case SAVEt_CLEARSV:
10373 longval = (long)POPLONG(ss,ix);
10374 TOPLONG(nss,ix) = longval;
10376 case SAVEt_I32: /* I32 reference */
10377 case SAVEt_I16: /* I16 reference */
10378 case SAVEt_I8: /* I8 reference */
10379 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10380 ptr = POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10383 TOPINT(nss,ix) = i;
10385 case SAVEt_IV: /* IV reference */
10386 ptr = POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10389 TOPIV(nss,ix) = iv;
10391 case SAVEt_HPTR: /* HV* reference */
10392 case SAVEt_APTR: /* AV* reference */
10393 case SAVEt_SPTR: /* SV* reference */
10394 ptr = POPPTR(ss,ix);
10395 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10396 sv = (SV*)POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = sv_dup(sv, param);
10399 case SAVEt_VPTR: /* random* reference */
10400 ptr = POPPTR(ss,ix);
10401 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10402 ptr = POPPTR(ss,ix);
10403 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10405 case SAVEt_GENERIC_PVREF: /* generic char* */
10406 case SAVEt_PPTR: /* char* reference */
10407 ptr = POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10409 c = (char*)POPPTR(ss,ix);
10410 TOPPTR(nss,ix) = pv_dup(c);
10412 case SAVEt_GP: /* scalar reference */
10413 gp = (GP*)POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10415 (void)GpREFCNT_inc(gp);
10416 gv = (GV*)POPPTR(ss,ix);
10417 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10420 ptr = POPPTR(ss,ix);
10421 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10422 /* these are assumed to be refcounted properly */
10424 switch (((OP*)ptr)->op_type) {
10426 case OP_LEAVESUBLV:
10430 case OP_LEAVEWRITE:
10431 TOPPTR(nss,ix) = ptr;
10436 TOPPTR(nss,ix) = NULL;
10441 TOPPTR(nss,ix) = NULL;
10444 c = (char*)POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = pv_dup_inc(c);
10448 hv = (HV*)POPPTR(ss,ix);
10449 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10450 c = (char*)POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = pv_dup_inc(c);
10453 case SAVEt_STACK_POS: /* Position on Perl stack */
10455 TOPINT(nss,ix) = i;
10457 case SAVEt_DESTRUCTOR:
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10460 dptr = POPDPTR(ss,ix);
10461 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10462 any_dup(FPTR2DPTR(void *, dptr),
10465 case SAVEt_DESTRUCTOR_X:
10466 ptr = POPPTR(ss,ix);
10467 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10468 dxptr = POPDXPTR(ss,ix);
10469 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10470 any_dup(FPTR2DPTR(void *, dxptr),
10473 case SAVEt_REGCONTEXT:
10476 TOPINT(nss,ix) = i;
10479 case SAVEt_AELEM: /* array element */
10480 sv = (SV*)POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10483 TOPINT(nss,ix) = i;
10484 av = (AV*)POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = av_dup_inc(av, param);
10488 ptr = POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = ptr;
10493 TOPINT(nss,ix) = i;
10494 ptr = POPPTR(ss,ix);
10497 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10498 HINTS_REFCNT_UNLOCK;
10500 TOPPTR(nss,ix) = ptr;
10501 if (i & HINT_LOCALIZE_HH) {
10502 hv = (HV*)POPPTR(ss,ix);
10503 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10507 longval = (long)POPLONG(ss,ix);
10508 TOPLONG(nss,ix) = longval;
10509 ptr = POPPTR(ss,ix);
10510 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10511 sv = (SV*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = sv_dup(sv, param);
10515 ptr = POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10517 longval = (long)POPBOOL(ss,ix);
10518 TOPBOOL(nss,ix) = (bool)longval;
10520 case SAVEt_SET_SVFLAGS:
10522 TOPINT(nss,ix) = i;
10524 TOPINT(nss,ix) = i;
10525 sv = (SV*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = sv_dup(sv, param);
10528 case SAVEt_RE_STATE:
10530 const struct re_save_state *const old_state
10531 = (struct re_save_state *)
10532 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10533 struct re_save_state *const new_state
10534 = (struct re_save_state *)
10535 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10537 Copy(old_state, new_state, 1, struct re_save_state);
10538 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10540 new_state->re_state_bostr
10541 = pv_dup(old_state->re_state_bostr);
10542 new_state->re_state_reginput
10543 = pv_dup(old_state->re_state_reginput);
10544 new_state->re_state_regeol
10545 = pv_dup(old_state->re_state_regeol);
10546 new_state->re_state_regstartp
10547 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10548 new_state->re_state_regendp
10549 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10550 new_state->re_state_reglastparen
10551 = (U32*) any_dup(old_state->re_state_reglastparen,
10553 new_state->re_state_reglastcloseparen
10554 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10556 /* XXX This just has to be broken. The old save_re_context
10557 code did SAVEGENERICPV(PL_reg_start_tmp);
10558 PL_reg_start_tmp is char **.
10559 Look above to what the dup code does for
10560 SAVEt_GENERIC_PVREF
10561 It can never have worked.
10562 So this is merely a faithful copy of the exiting bug: */
10563 new_state->re_state_reg_start_tmp
10564 = (char **) pv_dup((char *)
10565 old_state->re_state_reg_start_tmp);
10566 /* I assume that it only ever "worked" because no-one called
10567 (pseudo)fork while the regexp engine had re-entered itself.
10569 #ifdef PERL_OLD_COPY_ON_WRITE
10570 new_state->re_state_nrs
10571 = sv_dup(old_state->re_state_nrs, param);
10573 new_state->re_state_reg_magic
10574 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10576 new_state->re_state_reg_oldcurpm
10577 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10579 new_state->re_state_reg_curpm
10580 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10582 new_state->re_state_reg_oldsaved
10583 = pv_dup(old_state->re_state_reg_oldsaved);
10584 new_state->re_state_reg_poscache
10585 = pv_dup(old_state->re_state_reg_poscache);
10586 new_state->re_state_reg_starttry
10587 = pv_dup(old_state->re_state_reg_starttry);
10590 case SAVEt_COMPILE_WARNINGS:
10591 ptr = POPPTR(ss,ix);
10592 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10596 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10604 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10605 * flag to the result. This is done for each stash before cloning starts,
10606 * so we know which stashes want their objects cloned */
10609 do_mark_cloneable_stash(pTHX_ SV *sv)
10611 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10613 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10614 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10615 if (cloner && GvCV(cloner)) {
10622 XPUSHs(sv_2mortal(newSVhek(hvname)));
10624 call_sv((SV*)GvCV(cloner), G_SCALAR);
10631 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10639 =for apidoc perl_clone
10641 Create and return a new interpreter by cloning the current one.
10643 perl_clone takes these flags as parameters:
10645 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10646 without it we only clone the data and zero the stacks,
10647 with it we copy the stacks and the new perl interpreter is
10648 ready to run at the exact same point as the previous one.
10649 The pseudo-fork code uses COPY_STACKS while the
10650 threads->new doesn't.
10652 CLONEf_KEEP_PTR_TABLE
10653 perl_clone keeps a ptr_table with the pointer of the old
10654 variable as a key and the new variable as a value,
10655 this allows it to check if something has been cloned and not
10656 clone it again but rather just use the value and increase the
10657 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10658 the ptr_table using the function
10659 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10660 reason to keep it around is if you want to dup some of your own
10661 variable who are outside the graph perl scans, example of this
10662 code is in threads.xs create
10665 This is a win32 thing, it is ignored on unix, it tells perls
10666 win32host code (which is c++) to clone itself, this is needed on
10667 win32 if you want to run two threads at the same time,
10668 if you just want to do some stuff in a separate perl interpreter
10669 and then throw it away and return to the original one,
10670 you don't need to do anything.
10675 /* XXX the above needs expanding by someone who actually understands it ! */
10676 EXTERN_C PerlInterpreter *
10677 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10680 perl_clone(PerlInterpreter *proto_perl, UV flags)
10683 #ifdef PERL_IMPLICIT_SYS
10685 /* perlhost.h so we need to call into it
10686 to clone the host, CPerlHost should have a c interface, sky */
10688 if (flags & CLONEf_CLONE_HOST) {
10689 return perl_clone_host(proto_perl,flags);
10691 return perl_clone_using(proto_perl, flags,
10693 proto_perl->IMemShared,
10694 proto_perl->IMemParse,
10696 proto_perl->IStdIO,
10700 proto_perl->IProc);
10704 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10705 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10706 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10707 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10708 struct IPerlDir* ipD, struct IPerlSock* ipS,
10709 struct IPerlProc* ipP)
10711 /* XXX many of the string copies here can be optimized if they're
10712 * constants; they need to be allocated as common memory and just
10713 * their pointers copied. */
10716 CLONE_PARAMS clone_params;
10717 CLONE_PARAMS* const param = &clone_params;
10719 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10720 /* for each stash, determine whether its objects should be cloned */
10721 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10722 PERL_SET_THX(my_perl);
10725 PoisonNew(my_perl, 1, PerlInterpreter);
10731 PL_savestack_ix = 0;
10732 PL_savestack_max = -1;
10733 PL_sig_pending = 0;
10734 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10735 # else /* !DEBUGGING */
10736 Zero(my_perl, 1, PerlInterpreter);
10737 # endif /* DEBUGGING */
10739 /* host pointers */
10741 PL_MemShared = ipMS;
10742 PL_MemParse = ipMP;
10749 #else /* !PERL_IMPLICIT_SYS */
10751 CLONE_PARAMS clone_params;
10752 CLONE_PARAMS* param = &clone_params;
10753 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10754 /* for each stash, determine whether its objects should be cloned */
10755 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10756 PERL_SET_THX(my_perl);
10759 PoisonNew(my_perl, 1, PerlInterpreter);
10765 PL_savestack_ix = 0;
10766 PL_savestack_max = -1;
10767 PL_sig_pending = 0;
10768 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10769 # else /* !DEBUGGING */
10770 Zero(my_perl, 1, PerlInterpreter);
10771 # endif /* DEBUGGING */
10772 #endif /* PERL_IMPLICIT_SYS */
10773 param->flags = flags;
10774 param->proto_perl = proto_perl;
10776 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10778 PL_body_arenas = NULL;
10779 Zero(&PL_body_roots, 1, PL_body_roots);
10781 PL_nice_chunk = NULL;
10782 PL_nice_chunk_size = 0;
10784 PL_sv_objcount = 0;
10786 PL_sv_arenaroot = NULL;
10788 PL_debug = proto_perl->Idebug;
10790 PL_hash_seed = proto_perl->Ihash_seed;
10791 PL_rehash_seed = proto_perl->Irehash_seed;
10793 #ifdef USE_REENTRANT_API
10794 /* XXX: things like -Dm will segfault here in perlio, but doing
10795 * PERL_SET_CONTEXT(proto_perl);
10796 * breaks too many other things
10798 Perl_reentrant_init(aTHX);
10801 /* create SV map for pointer relocation */
10802 PL_ptr_table = ptr_table_new();
10804 /* initialize these special pointers as early as possible */
10805 SvANY(&PL_sv_undef) = NULL;
10806 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10807 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10808 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10810 SvANY(&PL_sv_no) = new_XPVNV();
10811 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10812 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10813 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10814 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10815 SvCUR_set(&PL_sv_no, 0);
10816 SvLEN_set(&PL_sv_no, 1);
10817 SvIV_set(&PL_sv_no, 0);
10818 SvNV_set(&PL_sv_no, 0);
10819 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10821 SvANY(&PL_sv_yes) = new_XPVNV();
10822 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10823 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10824 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10825 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10826 SvCUR_set(&PL_sv_yes, 1);
10827 SvLEN_set(&PL_sv_yes, 2);
10828 SvIV_set(&PL_sv_yes, 1);
10829 SvNV_set(&PL_sv_yes, 1);
10830 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10832 /* create (a non-shared!) shared string table */
10833 PL_strtab = newHV();
10834 HvSHAREKEYS_off(PL_strtab);
10835 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10836 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10838 PL_compiling = proto_perl->Icompiling;
10840 /* These two PVs will be free'd special way so must set them same way op.c does */
10841 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10842 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10844 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10845 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10847 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10848 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10849 if (PL_compiling.cop_hints_hash) {
10851 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10852 HINTS_REFCNT_UNLOCK;
10854 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10856 /* pseudo environmental stuff */
10857 PL_origargc = proto_perl->Iorigargc;
10858 PL_origargv = proto_perl->Iorigargv;
10860 param->stashes = newAV(); /* Setup array of objects to call clone on */
10862 /* Set tainting stuff before PerlIO_debug can possibly get called */
10863 PL_tainting = proto_perl->Itainting;
10864 PL_taint_warn = proto_perl->Itaint_warn;
10866 #ifdef PERLIO_LAYERS
10867 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10868 PerlIO_clone(aTHX_ proto_perl, param);
10871 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10872 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10873 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10874 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10875 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10876 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10879 PL_minus_c = proto_perl->Iminus_c;
10880 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10881 PL_localpatches = proto_perl->Ilocalpatches;
10882 PL_splitstr = proto_perl->Isplitstr;
10883 PL_preprocess = proto_perl->Ipreprocess;
10884 PL_minus_n = proto_perl->Iminus_n;
10885 PL_minus_p = proto_perl->Iminus_p;
10886 PL_minus_l = proto_perl->Iminus_l;
10887 PL_minus_a = proto_perl->Iminus_a;
10888 PL_minus_E = proto_perl->Iminus_E;
10889 PL_minus_F = proto_perl->Iminus_F;
10890 PL_doswitches = proto_perl->Idoswitches;
10891 PL_dowarn = proto_perl->Idowarn;
10892 PL_doextract = proto_perl->Idoextract;
10893 PL_sawampersand = proto_perl->Isawampersand;
10894 PL_unsafe = proto_perl->Iunsafe;
10895 PL_inplace = SAVEPV(proto_perl->Iinplace);
10896 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10897 PL_perldb = proto_perl->Iperldb;
10898 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10899 PL_exit_flags = proto_perl->Iexit_flags;
10901 /* magical thingies */
10902 /* XXX time(&PL_basetime) when asked for? */
10903 PL_basetime = proto_perl->Ibasetime;
10904 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10906 PL_maxsysfd = proto_perl->Imaxsysfd;
10907 PL_statusvalue = proto_perl->Istatusvalue;
10909 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10911 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10913 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10915 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10916 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10917 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10920 /* RE engine related */
10921 Zero(&PL_reg_state, 1, struct re_save_state);
10922 PL_reginterp_cnt = 0;
10923 PL_regmatch_slab = NULL;
10925 /* Clone the regex array */
10926 PL_regex_padav = newAV();
10928 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10929 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10931 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10932 for(i = 1; i <= len; i++) {
10933 const SV * const regex = regexen[i];
10936 ? sv_dup_inc(regex, param)
10938 newSViv(PTR2IV(re_dup(
10939 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10941 av_push(PL_regex_padav, sv);
10944 PL_regex_pad = AvARRAY(PL_regex_padav);
10946 /* shortcuts to various I/O objects */
10947 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10948 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10949 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10950 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10951 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10952 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10954 /* shortcuts to regexp stuff */
10955 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10957 /* shortcuts to misc objects */
10958 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10960 /* shortcuts to debugging objects */
10961 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10962 PL_DBline = gv_dup(proto_perl->IDBline, param);
10963 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10964 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10965 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10966 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10967 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10968 PL_lineary = av_dup(proto_perl->Ilineary, param);
10969 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10971 /* symbol tables */
10972 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10973 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10974 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10975 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10976 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10978 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10979 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10980 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10981 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
10982 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
10983 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10984 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10985 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10987 PL_sub_generation = proto_perl->Isub_generation;
10989 /* funky return mechanisms */
10990 PL_forkprocess = proto_perl->Iforkprocess;
10992 /* subprocess state */
10993 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10995 /* internal state */
10996 PL_maxo = proto_perl->Imaxo;
10997 if (proto_perl->Iop_mask)
10998 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11001 /* PL_asserting = proto_perl->Iasserting; */
11003 /* current interpreter roots */
11004 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11005 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11006 PL_main_start = proto_perl->Imain_start;
11007 PL_eval_root = proto_perl->Ieval_root;
11008 PL_eval_start = proto_perl->Ieval_start;
11010 /* runtime control stuff */
11011 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11012 PL_copline = proto_perl->Icopline;
11014 PL_filemode = proto_perl->Ifilemode;
11015 PL_lastfd = proto_perl->Ilastfd;
11016 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11019 PL_gensym = proto_perl->Igensym;
11020 PL_preambled = proto_perl->Ipreambled;
11021 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11022 PL_laststatval = proto_perl->Ilaststatval;
11023 PL_laststype = proto_perl->Ilaststype;
11026 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11028 /* interpreter atexit processing */
11029 PL_exitlistlen = proto_perl->Iexitlistlen;
11030 if (PL_exitlistlen) {
11031 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11032 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11035 PL_exitlist = (PerlExitListEntry*)NULL;
11037 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11038 if (PL_my_cxt_size) {
11039 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11040 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11043 PL_my_cxt_list = (void**)NULL;
11044 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11045 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11046 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11048 PL_profiledata = NULL;
11049 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11050 /* PL_rsfp_filters entries have fake IoDIRP() */
11051 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11053 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11055 PAD_CLONE_VARS(proto_perl, param);
11057 #ifdef HAVE_INTERP_INTERN
11058 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11061 /* more statics moved here */
11062 PL_generation = proto_perl->Igeneration;
11063 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11065 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11066 PL_in_clean_all = proto_perl->Iin_clean_all;
11068 PL_uid = proto_perl->Iuid;
11069 PL_euid = proto_perl->Ieuid;
11070 PL_gid = proto_perl->Igid;
11071 PL_egid = proto_perl->Iegid;
11072 PL_nomemok = proto_perl->Inomemok;
11073 PL_an = proto_perl->Ian;
11074 PL_evalseq = proto_perl->Ievalseq;
11075 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11076 PL_origalen = proto_perl->Iorigalen;
11077 #ifdef PERL_USES_PL_PIDSTATUS
11078 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11080 PL_osname = SAVEPV(proto_perl->Iosname);
11081 PL_sighandlerp = proto_perl->Isighandlerp;
11083 PL_runops = proto_perl->Irunops;
11085 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11088 PL_cshlen = proto_perl->Icshlen;
11089 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11092 PL_lex_state = proto_perl->Ilex_state;
11093 PL_lex_defer = proto_perl->Ilex_defer;
11094 PL_lex_expect = proto_perl->Ilex_expect;
11095 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11096 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11097 PL_lex_starts = proto_perl->Ilex_starts;
11098 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11099 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11100 PL_lex_op = proto_perl->Ilex_op;
11101 PL_lex_inpat = proto_perl->Ilex_inpat;
11102 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11103 PL_lex_brackets = proto_perl->Ilex_brackets;
11104 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11105 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11106 PL_lex_casemods = proto_perl->Ilex_casemods;
11107 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11108 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11111 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11112 PL_lasttoke = proto_perl->Ilasttoke;
11113 PL_realtokenstart = proto_perl->Irealtokenstart;
11114 PL_faketokens = proto_perl->Ifaketokens;
11115 PL_thismad = proto_perl->Ithismad;
11116 PL_thistoken = proto_perl->Ithistoken;
11117 PL_thisopen = proto_perl->Ithisopen;
11118 PL_thisstuff = proto_perl->Ithisstuff;
11119 PL_thisclose = proto_perl->Ithisclose;
11120 PL_thiswhite = proto_perl->Ithiswhite;
11121 PL_nextwhite = proto_perl->Inextwhite;
11122 PL_skipwhite = proto_perl->Iskipwhite;
11123 PL_endwhite = proto_perl->Iendwhite;
11124 PL_curforce = proto_perl->Icurforce;
11126 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11127 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11128 PL_nexttoke = proto_perl->Inexttoke;
11131 /* XXX This is probably masking the deeper issue of why
11132 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11133 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11134 * (A little debugging with a watchpoint on it may help.)
11136 if (SvANY(proto_perl->Ilinestr)) {
11137 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11138 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11139 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11140 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11141 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11142 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11143 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11144 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11145 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11148 PL_linestr = newSV(79);
11149 sv_upgrade(PL_linestr,SVt_PVIV);
11150 sv_setpvn(PL_linestr,"",0);
11151 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11153 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11154 PL_pending_ident = proto_perl->Ipending_ident;
11155 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11157 PL_expect = proto_perl->Iexpect;
11159 PL_multi_start = proto_perl->Imulti_start;
11160 PL_multi_end = proto_perl->Imulti_end;
11161 PL_multi_open = proto_perl->Imulti_open;
11162 PL_multi_close = proto_perl->Imulti_close;
11164 PL_error_count = proto_perl->Ierror_count;
11165 PL_subline = proto_perl->Isubline;
11166 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11168 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11169 if (SvANY(proto_perl->Ilinestr)) {
11170 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11171 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11172 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11173 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11174 PL_last_lop_op = proto_perl->Ilast_lop_op;
11177 PL_last_uni = SvPVX(PL_linestr);
11178 PL_last_lop = SvPVX(PL_linestr);
11179 PL_last_lop_op = 0;
11181 PL_in_my = proto_perl->Iin_my;
11182 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11184 PL_cryptseen = proto_perl->Icryptseen;
11187 PL_hints = proto_perl->Ihints;
11189 PL_amagic_generation = proto_perl->Iamagic_generation;
11191 #ifdef USE_LOCALE_COLLATE
11192 PL_collation_ix = proto_perl->Icollation_ix;
11193 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11194 PL_collation_standard = proto_perl->Icollation_standard;
11195 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11196 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11197 #endif /* USE_LOCALE_COLLATE */
11199 #ifdef USE_LOCALE_NUMERIC
11200 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11201 PL_numeric_standard = proto_perl->Inumeric_standard;
11202 PL_numeric_local = proto_perl->Inumeric_local;
11203 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11204 #endif /* !USE_LOCALE_NUMERIC */
11206 /* utf8 character classes */
11207 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11208 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11209 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11210 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11211 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11212 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11213 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11214 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11215 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11216 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11217 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11218 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11219 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11220 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11221 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11222 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11223 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11224 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11225 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11226 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11228 /* Did the locale setup indicate UTF-8? */
11229 PL_utf8locale = proto_perl->Iutf8locale;
11230 /* Unicode features (see perlrun/-C) */
11231 PL_unicode = proto_perl->Iunicode;
11233 /* Pre-5.8 signals control */
11234 PL_signals = proto_perl->Isignals;
11236 /* times() ticks per second */
11237 PL_clocktick = proto_perl->Iclocktick;
11239 /* Recursion stopper for PerlIO_find_layer */
11240 PL_in_load_module = proto_perl->Iin_load_module;
11242 /* sort() routine */
11243 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11245 /* Not really needed/useful since the reenrant_retint is "volatile",
11246 * but do it for consistency's sake. */
11247 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11249 /* Hooks to shared SVs and locks. */
11250 PL_sharehook = proto_perl->Isharehook;
11251 PL_lockhook = proto_perl->Ilockhook;
11252 PL_unlockhook = proto_perl->Iunlockhook;
11253 PL_threadhook = proto_perl->Ithreadhook;
11255 PL_runops_std = proto_perl->Irunops_std;
11256 PL_runops_dbg = proto_perl->Irunops_dbg;
11258 #ifdef THREADS_HAVE_PIDS
11259 PL_ppid = proto_perl->Ippid;
11263 PL_last_swash_hv = NULL; /* reinits on demand */
11264 PL_last_swash_klen = 0;
11265 PL_last_swash_key[0]= '\0';
11266 PL_last_swash_tmps = (U8*)NULL;
11267 PL_last_swash_slen = 0;
11269 PL_glob_index = proto_perl->Iglob_index;
11270 PL_srand_called = proto_perl->Isrand_called;
11271 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11272 PL_bitcount = NULL; /* reinits on demand */
11274 if (proto_perl->Ipsig_pend) {
11275 Newxz(PL_psig_pend, SIG_SIZE, int);
11278 PL_psig_pend = (int*)NULL;
11281 if (proto_perl->Ipsig_ptr) {
11282 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11283 Newxz(PL_psig_name, SIG_SIZE, SV*);
11284 for (i = 1; i < SIG_SIZE; i++) {
11285 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11286 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11290 PL_psig_ptr = (SV**)NULL;
11291 PL_psig_name = (SV**)NULL;
11294 /* thrdvar.h stuff */
11296 if (flags & CLONEf_COPY_STACKS) {
11297 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11298 PL_tmps_ix = proto_perl->Ttmps_ix;
11299 PL_tmps_max = proto_perl->Ttmps_max;
11300 PL_tmps_floor = proto_perl->Ttmps_floor;
11301 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11303 while (i <= PL_tmps_ix) {
11304 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11308 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11309 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11310 Newxz(PL_markstack, i, I32);
11311 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11312 - proto_perl->Tmarkstack);
11313 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11314 - proto_perl->Tmarkstack);
11315 Copy(proto_perl->Tmarkstack, PL_markstack,
11316 PL_markstack_ptr - PL_markstack + 1, I32);
11318 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11319 * NOTE: unlike the others! */
11320 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11321 PL_scopestack_max = proto_perl->Tscopestack_max;
11322 Newxz(PL_scopestack, PL_scopestack_max, I32);
11323 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11325 /* NOTE: si_dup() looks at PL_markstack */
11326 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11328 /* PL_curstack = PL_curstackinfo->si_stack; */
11329 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11330 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11332 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11333 PL_stack_base = AvARRAY(PL_curstack);
11334 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11335 - proto_perl->Tstack_base);
11336 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11338 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11339 * NOTE: unlike the others! */
11340 PL_savestack_ix = proto_perl->Tsavestack_ix;
11341 PL_savestack_max = proto_perl->Tsavestack_max;
11342 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11343 PL_savestack = ss_dup(proto_perl, param);
11347 ENTER; /* perl_destruct() wants to LEAVE; */
11349 /* although we're not duplicating the tmps stack, we should still
11350 * add entries for any SVs on the tmps stack that got cloned by a
11351 * non-refcount means (eg a temp in @_); otherwise they will be
11354 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11355 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11356 proto_perl->Ttmps_stack[i]);
11357 if (nsv && !SvREFCNT(nsv)) {
11359 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11364 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11365 PL_top_env = &PL_start_env;
11367 PL_op = proto_perl->Top;
11370 PL_Xpv = (XPV*)NULL;
11371 PL_na = proto_perl->Tna;
11373 PL_statbuf = proto_perl->Tstatbuf;
11374 PL_statcache = proto_perl->Tstatcache;
11375 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11376 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11378 PL_timesbuf = proto_perl->Ttimesbuf;
11381 PL_tainted = proto_perl->Ttainted;
11382 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11383 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11384 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11385 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11386 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11387 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11388 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11389 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11390 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11392 PL_restartop = proto_perl->Trestartop;
11393 PL_in_eval = proto_perl->Tin_eval;
11394 PL_delaymagic = proto_perl->Tdelaymagic;
11395 PL_dirty = proto_perl->Tdirty;
11396 PL_localizing = proto_perl->Tlocalizing;
11398 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11399 PL_hv_fetch_ent_mh = NULL;
11400 PL_modcount = proto_perl->Tmodcount;
11401 PL_lastgotoprobe = NULL;
11402 PL_dumpindent = proto_perl->Tdumpindent;
11404 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11405 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11406 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11407 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11408 PL_efloatbuf = NULL; /* reinits on demand */
11409 PL_efloatsize = 0; /* reinits on demand */
11413 PL_screamfirst = NULL;
11414 PL_screamnext = NULL;
11415 PL_maxscream = -1; /* reinits on demand */
11416 PL_lastscream = NULL;
11418 PL_watchaddr = NULL;
11421 PL_regdummy = proto_perl->Tregdummy;
11422 PL_colorset = 0; /* reinits PL_colors[] */
11423 /*PL_colors[6] = {0,0,0,0,0,0};*/
11427 /* Pluggable optimizer */
11428 PL_peepp = proto_perl->Tpeepp;
11430 PL_stashcache = newHV();
11432 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11433 ptr_table_free(PL_ptr_table);
11434 PL_ptr_table = NULL;
11437 /* Call the ->CLONE method, if it exists, for each of the stashes
11438 identified by sv_dup() above.
11440 while(av_len(param->stashes) != -1) {
11441 HV* const stash = (HV*) av_shift(param->stashes);
11442 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11443 if (cloner && GvCV(cloner)) {
11448 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11450 call_sv((SV*)GvCV(cloner), G_DISCARD);
11456 SvREFCNT_dec(param->stashes);
11458 /* orphaned? eg threads->new inside BEGIN or use */
11459 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11460 SvREFCNT_inc_simple_void(PL_compcv);
11461 SAVEFREESV(PL_compcv);
11467 #endif /* USE_ITHREADS */
11470 =head1 Unicode Support
11472 =for apidoc sv_recode_to_utf8
11474 The encoding is assumed to be an Encode object, on entry the PV
11475 of the sv is assumed to be octets in that encoding, and the sv
11476 will be converted into Unicode (and UTF-8).
11478 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11479 is not a reference, nothing is done to the sv. If the encoding is not
11480 an C<Encode::XS> Encoding object, bad things will happen.
11481 (See F<lib/encoding.pm> and L<Encode>).
11483 The PV of the sv is returned.
11488 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11491 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11505 Passing sv_yes is wrong - it needs to be or'ed set of constants
11506 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11507 remove converted chars from source.
11509 Both will default the value - let them.
11511 XPUSHs(&PL_sv_yes);
11514 call_method("decode", G_SCALAR);
11518 s = SvPV_const(uni, len);
11519 if (s != SvPVX_const(sv)) {
11520 SvGROW(sv, len + 1);
11521 Move(s, SvPVX(sv), len + 1, char);
11522 SvCUR_set(sv, len);
11529 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11533 =for apidoc sv_cat_decode
11535 The encoding is assumed to be an Encode object, the PV of the ssv is
11536 assumed to be octets in that encoding and decoding the input starts
11537 from the position which (PV + *offset) pointed to. The dsv will be
11538 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11539 when the string tstr appears in decoding output or the input ends on
11540 the PV of the ssv. The value which the offset points will be modified
11541 to the last input position on the ssv.
11543 Returns TRUE if the terminator was found, else returns FALSE.
11548 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11549 SV *ssv, int *offset, char *tstr, int tlen)
11553 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11564 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11565 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11567 call_method("cat_decode", G_SCALAR);
11569 ret = SvTRUE(TOPs);
11570 *offset = SvIV(offsv);
11576 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11581 /* ---------------------------------------------------------------------
11583 * support functions for report_uninit()
11586 /* the maxiumum size of array or hash where we will scan looking
11587 * for the undefined element that triggered the warning */
11589 #define FUV_MAX_SEARCH_SIZE 1000
11591 /* Look for an entry in the hash whose value has the same SV as val;
11592 * If so, return a mortal copy of the key. */
11595 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11598 register HE **array;
11601 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11602 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11605 array = HvARRAY(hv);
11607 for (i=HvMAX(hv); i>0; i--) {
11608 register HE *entry;
11609 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11610 if (HeVAL(entry) != val)
11612 if ( HeVAL(entry) == &PL_sv_undef ||
11613 HeVAL(entry) == &PL_sv_placeholder)
11617 if (HeKLEN(entry) == HEf_SVKEY)
11618 return sv_mortalcopy(HeKEY_sv(entry));
11619 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11625 /* Look for an entry in the array whose value has the same SV as val;
11626 * If so, return the index, otherwise return -1. */
11629 S_find_array_subscript(pTHX_ AV *av, SV* val)
11632 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11633 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11636 if (val != &PL_sv_undef) {
11637 SV ** const svp = AvARRAY(av);
11640 for (i=AvFILLp(av); i>=0; i--)
11647 /* S_varname(): return the name of a variable, optionally with a subscript.
11648 * If gv is non-zero, use the name of that global, along with gvtype (one
11649 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11650 * targ. Depending on the value of the subscript_type flag, return:
11653 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11654 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11655 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11656 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11659 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11660 SV* keyname, I32 aindex, int subscript_type)
11663 SV * const name = sv_newmortal();
11666 buffer[0] = gvtype;
11669 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11671 gv_fullname4(name, gv, buffer, 0);
11673 if ((unsigned int)SvPVX(name)[1] <= 26) {
11675 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11677 /* Swap the 1 unprintable control character for the 2 byte pretty
11678 version - ie substr($name, 1, 1) = $buffer; */
11679 sv_insert(name, 1, 1, buffer, 2);
11684 CV * const cv = find_runcv(&unused);
11688 if (!cv || !CvPADLIST(cv))
11690 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11691 sv = *av_fetch(av, targ, FALSE);
11692 /* SvLEN in a pad name is not to be trusted */
11693 sv_setpv(name, SvPV_nolen_const(sv));
11696 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11697 SV * const sv = newSV(0);
11698 *SvPVX(name) = '$';
11699 Perl_sv_catpvf(aTHX_ name, "{%s}",
11700 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11703 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11704 *SvPVX(name) = '$';
11705 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11707 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11708 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11715 =for apidoc find_uninit_var
11717 Find the name of the undefined variable (if any) that caused the operator o
11718 to issue a "Use of uninitialized value" warning.
11719 If match is true, only return a name if it's value matches uninit_sv.
11720 So roughly speaking, if a unary operator (such as OP_COS) generates a
11721 warning, then following the direct child of the op may yield an
11722 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11723 other hand, with OP_ADD there are two branches to follow, so we only print
11724 the variable name if we get an exact match.
11726 The name is returned as a mortal SV.
11728 Assumes that PL_op is the op that originally triggered the error, and that
11729 PL_comppad/PL_curpad points to the currently executing pad.
11735 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11743 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11744 uninit_sv == &PL_sv_placeholder)))
11747 switch (obase->op_type) {
11754 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11755 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11758 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11760 if (pad) { /* @lex, %lex */
11761 sv = PAD_SVl(obase->op_targ);
11765 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11766 /* @global, %global */
11767 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11770 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11772 else /* @{expr}, %{expr} */
11773 return find_uninit_var(cUNOPx(obase)->op_first,
11777 /* attempt to find a match within the aggregate */
11779 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11781 subscript_type = FUV_SUBSCRIPT_HASH;
11784 index = find_array_subscript((AV*)sv, uninit_sv);
11786 subscript_type = FUV_SUBSCRIPT_ARRAY;
11789 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11792 return varname(gv, hash ? '%' : '@', obase->op_targ,
11793 keysv, index, subscript_type);
11797 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11799 return varname(NULL, '$', obase->op_targ,
11800 NULL, 0, FUV_SUBSCRIPT_NONE);
11803 gv = cGVOPx_gv(obase);
11804 if (!gv || (match && GvSV(gv) != uninit_sv))
11806 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11809 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11812 av = (AV*)PAD_SV(obase->op_targ);
11813 if (!av || SvRMAGICAL(av))
11815 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11816 if (!svp || *svp != uninit_sv)
11819 return varname(NULL, '$', obase->op_targ,
11820 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11823 gv = cGVOPx_gv(obase);
11829 if (!av || SvRMAGICAL(av))
11831 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11832 if (!svp || *svp != uninit_sv)
11835 return varname(gv, '$', 0,
11836 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11841 o = cUNOPx(obase)->op_first;
11842 if (!o || o->op_type != OP_NULL ||
11843 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11845 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11849 if (PL_op == obase)
11850 /* $a[uninit_expr] or $h{uninit_expr} */
11851 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11854 o = cBINOPx(obase)->op_first;
11855 kid = cBINOPx(obase)->op_last;
11857 /* get the av or hv, and optionally the gv */
11859 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11860 sv = PAD_SV(o->op_targ);
11862 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11863 && cUNOPo->op_first->op_type == OP_GV)
11865 gv = cGVOPx_gv(cUNOPo->op_first);
11868 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11873 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11874 /* index is constant */
11878 if (obase->op_type == OP_HELEM) {
11879 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11880 if (!he || HeVAL(he) != uninit_sv)
11884 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11885 if (!svp || *svp != uninit_sv)
11889 if (obase->op_type == OP_HELEM)
11890 return varname(gv, '%', o->op_targ,
11891 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11893 return varname(gv, '@', o->op_targ, NULL,
11894 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11897 /* index is an expression;
11898 * attempt to find a match within the aggregate */
11899 if (obase->op_type == OP_HELEM) {
11900 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11902 return varname(gv, '%', o->op_targ,
11903 keysv, 0, FUV_SUBSCRIPT_HASH);
11906 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11908 return varname(gv, '@', o->op_targ,
11909 NULL, index, FUV_SUBSCRIPT_ARRAY);
11914 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11916 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11921 /* only examine RHS */
11922 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11925 o = cUNOPx(obase)->op_first;
11926 if (o->op_type == OP_PUSHMARK)
11929 if (!o->op_sibling) {
11930 /* one-arg version of open is highly magical */
11932 if (o->op_type == OP_GV) { /* open FOO; */
11934 if (match && GvSV(gv) != uninit_sv)
11936 return varname(gv, '$', 0,
11937 NULL, 0, FUV_SUBSCRIPT_NONE);
11939 /* other possibilities not handled are:
11940 * open $x; or open my $x; should return '${*$x}'
11941 * open expr; should return '$'.expr ideally
11947 /* ops where $_ may be an implicit arg */
11951 if ( !(obase->op_flags & OPf_STACKED)) {
11952 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11953 ? PAD_SVl(obase->op_targ)
11956 sv = sv_newmortal();
11957 sv_setpvn(sv, "$_", 2);
11965 /* skip filehandle as it can't produce 'undef' warning */
11966 o = cUNOPx(obase)->op_first;
11967 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11968 o = o->op_sibling->op_sibling;
11975 match = 1; /* XS or custom code could trigger random warnings */
11980 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11981 return sv_2mortal(newSVpvs("${$/}"));
11986 if (!(obase->op_flags & OPf_KIDS))
11988 o = cUNOPx(obase)->op_first;
11994 /* if all except one arg are constant, or have no side-effects,
11995 * or are optimized away, then it's unambiguous */
11997 for (kid=o; kid; kid = kid->op_sibling) {
11999 const OPCODE type = kid->op_type;
12000 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12001 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12002 || (type == OP_PUSHMARK)
12006 if (o2) { /* more than one found */
12013 return find_uninit_var(o2, uninit_sv, match);
12015 /* scan all args */
12017 sv = find_uninit_var(o, uninit_sv, 1);
12029 =for apidoc report_uninit
12031 Print appropriate "Use of uninitialized variable" warning
12037 Perl_report_uninit(pTHX_ SV* uninit_sv)
12041 SV* varname = NULL;
12043 varname = find_uninit_var(PL_op, uninit_sv,0);
12045 sv_insert(varname, 0, 0, " ", 1);
12047 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12048 varname ? SvPV_nolen_const(varname) : "",
12049 " in ", OP_DESC(PL_op));
12052 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12058 * c-indentation-style: bsd
12059 * c-basic-offset: 4
12060 * indent-tabs-mode: t
12063 * ex: set ts=8 sts=4 sw=4 noet: