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)
1566 =for apidoc sv_setnv
1568 Copies a double into the given SV, upgrading first if necessary.
1569 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1575 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1578 SV_CHECK_THINKFIRST_COW_DROP(sv);
1579 switch (SvTYPE(sv)) {
1582 sv_upgrade(sv, SVt_NV);
1587 sv_upgrade(sv, SVt_PVNV);
1596 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1601 (void)SvNOK_only(sv); /* validate number */
1606 =for apidoc sv_setnv_mg
1608 Like C<sv_setnv>, but also handles 'set' magic.
1614 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1620 /* Print an "isn't numeric" warning, using a cleaned-up,
1621 * printable version of the offending string
1625 S_not_a_number(pTHX_ SV *sv)
1633 dsv = sv_2mortal(newSVpvs(""));
1634 pv = sv_uni_display(dsv, sv, 10, 0);
1637 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1638 /* each *s can expand to 4 chars + "...\0",
1639 i.e. need room for 8 chars */
1641 const char *s = SvPVX_const(sv);
1642 const char * const end = s + SvCUR(sv);
1643 for ( ; s < end && d < limit; s++ ) {
1645 if (ch & 128 && !isPRINT_LC(ch)) {
1654 else if (ch == '\r') {
1658 else if (ch == '\f') {
1662 else if (ch == '\\') {
1666 else if (ch == '\0') {
1670 else if (isPRINT_LC(ch))
1687 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1688 "Argument \"%s\" isn't numeric in %s", pv,
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric", pv);
1696 =for apidoc looks_like_number
1698 Test if the content of an SV looks like a number (or is a number).
1699 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1700 non-numeric warning), even if your atof() doesn't grok them.
1706 Perl_looks_like_number(pTHX_ SV *sv)
1708 register const char *sbegin;
1712 sbegin = SvPVX_const(sv);
1715 else if (SvPOKp(sv))
1716 sbegin = SvPV_const(sv, len);
1718 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1719 return grok_number(sbegin, len, NULL);
1723 S_glob_2number(pTHX_ GV * const gv)
1725 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1726 SV *const buffer = sv_newmortal();
1728 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1731 gv_efullname3(buffer, gv, "*");
1732 SvFLAGS(gv) |= wasfake;
1734 /* We know that all GVs stringify to something that is not-a-number,
1735 so no need to test that. */
1736 if (ckWARN(WARN_NUMERIC))
1737 not_a_number(buffer);
1738 /* We just want something true to return, so that S_sv_2iuv_common
1739 can tail call us and return true. */
1744 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1746 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1747 SV *const buffer = sv_newmortal();
1749 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1752 gv_efullname3(buffer, gv, "*");
1753 SvFLAGS(gv) |= wasfake;
1755 assert(SvPOK(buffer));
1757 *len = SvCUR(buffer);
1759 return SvPVX(buffer);
1762 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1763 until proven guilty, assume that things are not that bad... */
1768 As 64 bit platforms often have an NV that doesn't preserve all bits of
1769 an IV (an assumption perl has been based on to date) it becomes necessary
1770 to remove the assumption that the NV always carries enough precision to
1771 recreate the IV whenever needed, and that the NV is the canonical form.
1772 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1773 precision as a side effect of conversion (which would lead to insanity
1774 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1775 1) to distinguish between IV/UV/NV slots that have cached a valid
1776 conversion where precision was lost and IV/UV/NV slots that have a
1777 valid conversion which has lost no precision
1778 2) to ensure that if a numeric conversion to one form is requested that
1779 would lose precision, the precise conversion (or differently
1780 imprecise conversion) is also performed and cached, to prevent
1781 requests for different numeric formats on the same SV causing
1782 lossy conversion chains. (lossless conversion chains are perfectly
1787 SvIOKp is true if the IV slot contains a valid value
1788 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1789 SvNOKp is true if the NV slot contains a valid value
1790 SvNOK is true only if the NV value is accurate
1793 while converting from PV to NV, check to see if converting that NV to an
1794 IV(or UV) would lose accuracy over a direct conversion from PV to
1795 IV(or UV). If it would, cache both conversions, return NV, but mark
1796 SV as IOK NOKp (ie not NOK).
1798 While converting from PV to IV, check to see if converting that IV to an
1799 NV would lose accuracy over a direct conversion from PV to NV. If it
1800 would, cache both conversions, flag similarly.
1802 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1803 correctly because if IV & NV were set NV *always* overruled.
1804 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1805 changes - now IV and NV together means that the two are interchangeable:
1806 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1808 The benefit of this is that operations such as pp_add know that if
1809 SvIOK is true for both left and right operands, then integer addition
1810 can be used instead of floating point (for cases where the result won't
1811 overflow). Before, floating point was always used, which could lead to
1812 loss of precision compared with integer addition.
1814 * making IV and NV equal status should make maths accurate on 64 bit
1816 * may speed up maths somewhat if pp_add and friends start to use
1817 integers when possible instead of fp. (Hopefully the overhead in
1818 looking for SvIOK and checking for overflow will not outweigh the
1819 fp to integer speedup)
1820 * will slow down integer operations (callers of SvIV) on "inaccurate"
1821 values, as the change from SvIOK to SvIOKp will cause a call into
1822 sv_2iv each time rather than a macro access direct to the IV slot
1823 * should speed up number->string conversion on integers as IV is
1824 favoured when IV and NV are equally accurate
1826 ####################################################################
1827 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1828 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1829 On the other hand, SvUOK is true iff UV.
1830 ####################################################################
1832 Your mileage will vary depending your CPU's relative fp to integer
1836 #ifndef NV_PRESERVES_UV
1837 # define IS_NUMBER_UNDERFLOW_IV 1
1838 # define IS_NUMBER_UNDERFLOW_UV 2
1839 # define IS_NUMBER_IV_AND_UV 2
1840 # define IS_NUMBER_OVERFLOW_IV 4
1841 # define IS_NUMBER_OVERFLOW_UV 5
1843 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1845 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1847 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1850 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1851 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));
1852 if (SvNVX(sv) < (NV)IV_MIN) {
1853 (void)SvIOKp_on(sv);
1855 SvIV_set(sv, IV_MIN);
1856 return IS_NUMBER_UNDERFLOW_IV;
1858 if (SvNVX(sv) > (NV)UV_MAX) {
1859 (void)SvIOKp_on(sv);
1862 SvUV_set(sv, UV_MAX);
1863 return IS_NUMBER_OVERFLOW_UV;
1865 (void)SvIOKp_on(sv);
1867 /* Can't use strtol etc to convert this string. (See truth table in
1869 if (SvNVX(sv) <= (UV)IV_MAX) {
1870 SvIV_set(sv, I_V(SvNVX(sv)));
1871 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1872 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1879 SvUV_set(sv, U_V(SvNVX(sv)));
1880 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1881 if (SvUVX(sv) == UV_MAX) {
1882 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1883 possibly be preserved by NV. Hence, it must be overflow.
1885 return IS_NUMBER_OVERFLOW_UV;
1887 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1889 /* Integer is imprecise. NOK, IOKp */
1891 return IS_NUMBER_OVERFLOW_IV;
1893 #endif /* !NV_PRESERVES_UV*/
1896 S_sv_2iuv_common(pTHX_ SV *sv) {
1899 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1900 * without also getting a cached IV/UV from it at the same time
1901 * (ie PV->NV conversion should detect loss of accuracy and cache
1902 * IV or UV at same time to avoid this. */
1903 /* IV-over-UV optimisation - choose to cache IV if possible */
1905 if (SvTYPE(sv) == SVt_NV)
1906 sv_upgrade(sv, SVt_PVNV);
1908 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1909 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1910 certainly cast into the IV range at IV_MAX, whereas the correct
1911 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1913 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1914 if (Perl_isnan(SvNVX(sv))) {
1920 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1921 SvIV_set(sv, I_V(SvNVX(sv)));
1922 if (SvNVX(sv) == (NV) SvIVX(sv)
1923 #ifndef NV_PRESERVES_UV
1924 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1925 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1926 /* Don't flag it as "accurately an integer" if the number
1927 came from a (by definition imprecise) NV operation, and
1928 we're outside the range of NV integer precision */
1931 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1932 DEBUG_c(PerlIO_printf(Perl_debug_log,
1933 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1939 /* IV not precise. No need to convert from PV, as NV
1940 conversion would already have cached IV if it detected
1941 that PV->IV would be better than PV->NV->IV
1942 flags already correct - don't set public IOK. */
1943 DEBUG_c(PerlIO_printf(Perl_debug_log,
1944 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1949 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1950 but the cast (NV)IV_MIN rounds to a the value less (more
1951 negative) than IV_MIN which happens to be equal to SvNVX ??
1952 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1953 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1954 (NV)UVX == NVX are both true, but the values differ. :-(
1955 Hopefully for 2s complement IV_MIN is something like
1956 0x8000000000000000 which will be exact. NWC */
1959 SvUV_set(sv, U_V(SvNVX(sv)));
1961 (SvNVX(sv) == (NV) SvUVX(sv))
1962 #ifndef NV_PRESERVES_UV
1963 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1964 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1965 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1966 /* Don't flag it as "accurately an integer" if the number
1967 came from a (by definition imprecise) NV operation, and
1968 we're outside the range of NV integer precision */
1973 DEBUG_c(PerlIO_printf(Perl_debug_log,
1974 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1980 else if (SvPOKp(sv) && SvLEN(sv)) {
1982 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1983 /* We want to avoid a possible problem when we cache an IV/ a UV which
1984 may be later translated to an NV, and the resulting NV is not
1985 the same as the direct translation of the initial string
1986 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1987 be careful to ensure that the value with the .456 is around if the
1988 NV value is requested in the future).
1990 This means that if we cache such an IV/a UV, we need to cache the
1991 NV as well. Moreover, we trade speed for space, and do not
1992 cache the NV if we are sure it's not needed.
1995 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1996 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1997 == IS_NUMBER_IN_UV) {
1998 /* It's definitely an integer, only upgrade to PVIV */
1999 if (SvTYPE(sv) < SVt_PVIV)
2000 sv_upgrade(sv, SVt_PVIV);
2002 } else if (SvTYPE(sv) < SVt_PVNV)
2003 sv_upgrade(sv, SVt_PVNV);
2005 /* If NVs preserve UVs then we only use the UV value if we know that
2006 we aren't going to call atof() below. If NVs don't preserve UVs
2007 then the value returned may have more precision than atof() will
2008 return, even though value isn't perfectly accurate. */
2009 if ((numtype & (IS_NUMBER_IN_UV
2010 #ifdef NV_PRESERVES_UV
2013 )) == IS_NUMBER_IN_UV) {
2014 /* This won't turn off the public IOK flag if it was set above */
2015 (void)SvIOKp_on(sv);
2017 if (!(numtype & IS_NUMBER_NEG)) {
2019 if (value <= (UV)IV_MAX) {
2020 SvIV_set(sv, (IV)value);
2022 /* it didn't overflow, and it was positive. */
2023 SvUV_set(sv, value);
2027 /* 2s complement assumption */
2028 if (value <= (UV)IV_MIN) {
2029 SvIV_set(sv, -(IV)value);
2031 /* Too negative for an IV. This is a double upgrade, but
2032 I'm assuming it will be rare. */
2033 if (SvTYPE(sv) < SVt_PVNV)
2034 sv_upgrade(sv, SVt_PVNV);
2038 SvNV_set(sv, -(NV)value);
2039 SvIV_set(sv, IV_MIN);
2043 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2044 will be in the previous block to set the IV slot, and the next
2045 block to set the NV slot. So no else here. */
2047 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2048 != IS_NUMBER_IN_UV) {
2049 /* It wasn't an (integer that doesn't overflow the UV). */
2050 SvNV_set(sv, Atof(SvPVX_const(sv)));
2052 if (! numtype && ckWARN(WARN_NUMERIC))
2055 #if defined(USE_LONG_DOUBLE)
2056 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2057 PTR2UV(sv), SvNVX(sv)));
2059 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2060 PTR2UV(sv), SvNVX(sv)));
2063 #ifdef NV_PRESERVES_UV
2064 (void)SvIOKp_on(sv);
2066 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2067 SvIV_set(sv, I_V(SvNVX(sv)));
2068 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2071 NOOP; /* Integer is imprecise. NOK, IOKp */
2073 /* UV will not work better than IV */
2075 if (SvNVX(sv) > (NV)UV_MAX) {
2077 /* Integer is inaccurate. NOK, IOKp, is UV */
2078 SvUV_set(sv, UV_MAX);
2080 SvUV_set(sv, U_V(SvNVX(sv)));
2081 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2082 NV preservse UV so can do correct comparison. */
2083 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2086 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2091 #else /* NV_PRESERVES_UV */
2092 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2093 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2094 /* The IV/UV slot will have been set from value returned by
2095 grok_number above. The NV slot has just been set using
2098 assert (SvIOKp(sv));
2100 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2101 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2102 /* Small enough to preserve all bits. */
2103 (void)SvIOKp_on(sv);
2105 SvIV_set(sv, I_V(SvNVX(sv)));
2106 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2108 /* Assumption: first non-preserved integer is < IV_MAX,
2109 this NV is in the preserved range, therefore: */
2110 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2112 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);
2116 0 0 already failed to read UV.
2117 0 1 already failed to read UV.
2118 1 0 you won't get here in this case. IV/UV
2119 slot set, public IOK, Atof() unneeded.
2120 1 1 already read UV.
2121 so there's no point in sv_2iuv_non_preserve() attempting
2122 to use atol, strtol, strtoul etc. */
2123 sv_2iuv_non_preserve (sv, numtype);
2126 #endif /* NV_PRESERVES_UV */
2130 if (isGV_with_GP(sv))
2131 return glob_2number((GV *)sv);
2133 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2134 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2137 if (SvTYPE(sv) < SVt_IV)
2138 /* Typically the caller expects that sv_any is not NULL now. */
2139 sv_upgrade(sv, SVt_IV);
2140 /* Return 0 from the caller. */
2147 =for apidoc sv_2iv_flags
2149 Return the integer value of an SV, doing any necessary string
2150 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2151 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2157 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2162 if (SvGMAGICAL(sv)) {
2163 if (flags & SV_GMAGIC)
2168 return I_V(SvNVX(sv));
2170 if (SvPOKp(sv) && SvLEN(sv)) {
2173 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2175 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2176 == IS_NUMBER_IN_UV) {
2177 /* It's definitely an integer */
2178 if (numtype & IS_NUMBER_NEG) {
2179 if (value < (UV)IV_MIN)
2182 if (value < (UV)IV_MAX)
2187 if (ckWARN(WARN_NUMERIC))
2190 return I_V(Atof(SvPVX_const(sv)));
2195 assert(SvTYPE(sv) >= SVt_PVMG);
2196 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2197 } else if (SvTHINKFIRST(sv)) {
2201 SV * const tmpstr=AMG_CALLun(sv,numer);
2202 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2203 return SvIV(tmpstr);
2206 return PTR2IV(SvRV(sv));
2209 sv_force_normal_flags(sv, 0);
2211 if (SvREADONLY(sv) && !SvOK(sv)) {
2212 if (ckWARN(WARN_UNINITIALIZED))
2218 if (S_sv_2iuv_common(aTHX_ sv))
2221 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2222 PTR2UV(sv),SvIVX(sv)));
2223 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2227 =for apidoc sv_2uv_flags
2229 Return the unsigned integer value of an SV, doing any necessary string
2230 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2231 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2237 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2242 if (SvGMAGICAL(sv)) {
2243 if (flags & SV_GMAGIC)
2248 return U_V(SvNVX(sv));
2249 if (SvPOKp(sv) && SvLEN(sv)) {
2252 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2254 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2255 == IS_NUMBER_IN_UV) {
2256 /* It's definitely an integer */
2257 if (!(numtype & IS_NUMBER_NEG))
2261 if (ckWARN(WARN_NUMERIC))
2264 return U_V(Atof(SvPVX_const(sv)));
2269 assert(SvTYPE(sv) >= SVt_PVMG);
2270 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2271 } else if (SvTHINKFIRST(sv)) {
2275 SV *const tmpstr = AMG_CALLun(sv,numer);
2276 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2277 return SvUV(tmpstr);
2280 return PTR2UV(SvRV(sv));
2283 sv_force_normal_flags(sv, 0);
2285 if (SvREADONLY(sv) && !SvOK(sv)) {
2286 if (ckWARN(WARN_UNINITIALIZED))
2292 if (S_sv_2iuv_common(aTHX_ sv))
2296 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2297 PTR2UV(sv),SvUVX(sv)));
2298 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2304 Return the num value of an SV, doing any necessary string or integer
2305 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2312 Perl_sv_2nv(pTHX_ register SV *sv)
2317 if (SvGMAGICAL(sv)) {
2321 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2322 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2323 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2325 return Atof(SvPVX_const(sv));
2329 return (NV)SvUVX(sv);
2331 return (NV)SvIVX(sv);
2336 assert(SvTYPE(sv) >= SVt_PVMG);
2337 /* This falls through to the report_uninit near the end of the
2339 } else if (SvTHINKFIRST(sv)) {
2343 SV *const tmpstr = AMG_CALLun(sv,numer);
2344 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2345 return SvNV(tmpstr);
2348 return PTR2NV(SvRV(sv));
2351 sv_force_normal_flags(sv, 0);
2353 if (SvREADONLY(sv) && !SvOK(sv)) {
2354 if (ckWARN(WARN_UNINITIALIZED))
2359 if (SvTYPE(sv) < SVt_NV) {
2360 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2361 sv_upgrade(sv, SVt_NV);
2362 #ifdef USE_LONG_DOUBLE
2364 STORE_NUMERIC_LOCAL_SET_STANDARD();
2365 PerlIO_printf(Perl_debug_log,
2366 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2367 PTR2UV(sv), SvNVX(sv));
2368 RESTORE_NUMERIC_LOCAL();
2372 STORE_NUMERIC_LOCAL_SET_STANDARD();
2373 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2374 PTR2UV(sv), SvNVX(sv));
2375 RESTORE_NUMERIC_LOCAL();
2379 else if (SvTYPE(sv) < SVt_PVNV)
2380 sv_upgrade(sv, SVt_PVNV);
2385 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2386 #ifdef NV_PRESERVES_UV
2389 /* Only set the public NV OK flag if this NV preserves the IV */
2390 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2391 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2392 : (SvIVX(sv) == I_V(SvNVX(sv))))
2398 else if (SvPOKp(sv) && SvLEN(sv)) {
2400 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2401 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2403 #ifdef NV_PRESERVES_UV
2404 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2405 == IS_NUMBER_IN_UV) {
2406 /* It's definitely an integer */
2407 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2409 SvNV_set(sv, Atof(SvPVX_const(sv)));
2412 SvNV_set(sv, Atof(SvPVX_const(sv)));
2413 /* Only set the public NV OK flag if this NV preserves the value in
2414 the PV at least as well as an IV/UV would.
2415 Not sure how to do this 100% reliably. */
2416 /* if that shift count is out of range then Configure's test is
2417 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2419 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2420 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2421 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2422 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2423 /* Can't use strtol etc to convert this string, so don't try.
2424 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2427 /* value has been set. It may not be precise. */
2428 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2429 /* 2s complement assumption for (UV)IV_MIN */
2430 SvNOK_on(sv); /* Integer is too negative. */
2435 if (numtype & IS_NUMBER_NEG) {
2436 SvIV_set(sv, -(IV)value);
2437 } else if (value <= (UV)IV_MAX) {
2438 SvIV_set(sv, (IV)value);
2440 SvUV_set(sv, value);
2444 if (numtype & IS_NUMBER_NOT_INT) {
2445 /* I believe that even if the original PV had decimals,
2446 they are lost beyond the limit of the FP precision.
2447 However, neither is canonical, so both only get p
2448 flags. NWC, 2000/11/25 */
2449 /* Both already have p flags, so do nothing */
2451 const NV nv = SvNVX(sv);
2452 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2453 if (SvIVX(sv) == I_V(nv)) {
2456 /* It had no "." so it must be integer. */
2460 /* between IV_MAX and NV(UV_MAX).
2461 Could be slightly > UV_MAX */
2463 if (numtype & IS_NUMBER_NOT_INT) {
2464 /* UV and NV both imprecise. */
2466 const UV nv_as_uv = U_V(nv);
2468 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2477 #endif /* NV_PRESERVES_UV */
2480 if (isGV_with_GP(sv)) {
2481 glob_2number((GV *)sv);
2485 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2487 assert (SvTYPE(sv) >= SVt_NV);
2488 /* Typically the caller expects that sv_any is not NULL now. */
2489 /* XXX Ilya implies that this is a bug in callers that assume this
2490 and ideally should be fixed. */
2493 #if defined(USE_LONG_DOUBLE)
2495 STORE_NUMERIC_LOCAL_SET_STANDARD();
2496 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2497 PTR2UV(sv), SvNVX(sv));
2498 RESTORE_NUMERIC_LOCAL();
2502 STORE_NUMERIC_LOCAL_SET_STANDARD();
2503 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2504 PTR2UV(sv), SvNVX(sv));
2505 RESTORE_NUMERIC_LOCAL();
2511 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2512 * UV as a string towards the end of buf, and return pointers to start and
2515 * We assume that buf is at least TYPE_CHARS(UV) long.
2519 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2521 char *ptr = buf + TYPE_CHARS(UV);
2522 char * const ebuf = ptr;
2535 *--ptr = '0' + (char)(uv % 10);
2544 =for apidoc sv_2pv_flags
2546 Returns a pointer to the string value of an SV, and sets *lp to its length.
2547 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2549 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2550 usually end up here too.
2556 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2566 if (SvGMAGICAL(sv)) {
2567 if (flags & SV_GMAGIC)
2572 if (flags & SV_MUTABLE_RETURN)
2573 return SvPVX_mutable(sv);
2574 if (flags & SV_CONST_RETURN)
2575 return (char *)SvPVX_const(sv);
2578 if (SvIOKp(sv) || SvNOKp(sv)) {
2579 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2584 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2585 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2587 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2594 #ifdef FIXNEGATIVEZERO
2595 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2601 SvUPGRADE(sv, SVt_PV);
2604 s = SvGROW_mutable(sv, len + 1);
2607 return (char*)memcpy(s, tbuf, len + 1);
2613 assert(SvTYPE(sv) >= SVt_PVMG);
2614 /* This falls through to the report_uninit near the end of the
2616 } else if (SvTHINKFIRST(sv)) {
2620 SV *const tmpstr = AMG_CALLun(sv,string);
2621 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2623 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2627 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2628 if (flags & SV_CONST_RETURN) {
2629 pv = (char *) SvPVX_const(tmpstr);
2631 pv = (flags & SV_MUTABLE_RETURN)
2632 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2635 *lp = SvCUR(tmpstr);
2637 pv = sv_2pv_flags(tmpstr, lp, flags);
2651 const SV *const referent = (SV*)SvRV(sv);
2655 retval = buffer = savepvn("NULLREF", len);
2656 } else if (SvTYPE(referent) == SVt_PVMG
2657 && ((SvFLAGS(referent) &
2658 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2659 == (SVs_OBJECT|SVs_SMG))
2660 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2665 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2670 PL_reginterp_cnt += haseval;
2673 const char *const typestr = sv_reftype(referent, 0);
2674 const STRLEN typelen = strlen(typestr);
2675 UV addr = PTR2UV(referent);
2676 const char *stashname = NULL;
2677 STRLEN stashnamelen = 0; /* hush, gcc */
2678 const char *buffer_end;
2680 if (SvOBJECT(referent)) {
2681 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2684 stashname = HEK_KEY(name);
2685 stashnamelen = HEK_LEN(name);
2687 if (HEK_UTF8(name)) {
2693 stashname = "__ANON__";
2696 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2697 + 2 * sizeof(UV) + 2 /* )\0 */;
2699 len = typelen + 3 /* (0x */
2700 + 2 * sizeof(UV) + 2 /* )\0 */;
2703 Newx(buffer, len, char);
2704 buffer_end = retval = buffer + len;
2706 /* Working backwards */
2710 *--retval = PL_hexdigit[addr & 15];
2711 } while (addr >>= 4);
2717 memcpy(retval, typestr, typelen);
2721 retval -= stashnamelen;
2722 memcpy(retval, stashname, stashnamelen);
2724 /* retval may not neccesarily have reached the start of the
2726 assert (retval >= buffer);
2728 len = buffer_end - retval - 1; /* -1 for that \0 */
2736 if (SvREADONLY(sv) && !SvOK(sv)) {
2737 if (ckWARN(WARN_UNINITIALIZED))
2744 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2745 /* I'm assuming that if both IV and NV are equally valid then
2746 converting the IV is going to be more efficient */
2747 const U32 isUIOK = SvIsUV(sv);
2748 char buf[TYPE_CHARS(UV)];
2751 if (SvTYPE(sv) < SVt_PVIV)
2752 sv_upgrade(sv, SVt_PVIV);
2753 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2754 /* inlined from sv_setpvn */
2755 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2756 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2757 SvCUR_set(sv, ebuf - ptr);
2761 else if (SvNOKp(sv)) {
2762 const int olderrno = errno;
2763 if (SvTYPE(sv) < SVt_PVNV)
2764 sv_upgrade(sv, SVt_PVNV);
2765 /* The +20 is pure guesswork. Configure test needed. --jhi */
2766 s = SvGROW_mutable(sv, NV_DIG + 20);
2767 /* some Xenix systems wipe out errno here */
2769 if (SvNVX(sv) == 0.0)
2770 my_strlcpy(s, "0", SvLEN(sv));
2774 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2777 #ifdef FIXNEGATIVEZERO
2778 if (*s == '-' && s[1] == '0' && !s[2])
2779 my_strlcpy(s, "0", SvLEN(s));
2788 if (isGV_with_GP(sv))
2789 return glob_2pv((GV *)sv, lp);
2791 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2795 if (SvTYPE(sv) < SVt_PV)
2796 /* Typically the caller expects that sv_any is not NULL now. */
2797 sv_upgrade(sv, SVt_PV);
2801 const STRLEN len = s - SvPVX_const(sv);
2807 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2808 PTR2UV(sv),SvPVX_const(sv)));
2809 if (flags & SV_CONST_RETURN)
2810 return (char *)SvPVX_const(sv);
2811 if (flags & SV_MUTABLE_RETURN)
2812 return SvPVX_mutable(sv);
2817 =for apidoc sv_copypv
2819 Copies a stringified representation of the source SV into the
2820 destination SV. Automatically performs any necessary mg_get and
2821 coercion of numeric values into strings. Guaranteed to preserve
2822 UTF-8 flag even from overloaded objects. Similar in nature to
2823 sv_2pv[_flags] but operates directly on an SV instead of just the
2824 string. Mostly uses sv_2pv_flags to do its work, except when that
2825 would lose the UTF-8'ness of the PV.
2831 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2834 const char * const s = SvPV_const(ssv,len);
2835 sv_setpvn(dsv,s,len);
2843 =for apidoc sv_2pvbyte
2845 Return a pointer to the byte-encoded representation of the SV, and set *lp
2846 to its length. May cause the SV to be downgraded from UTF-8 as a
2849 Usually accessed via the C<SvPVbyte> macro.
2855 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2857 sv_utf8_downgrade(sv,0);
2858 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2862 =for apidoc sv_2pvutf8
2864 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2865 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2867 Usually accessed via the C<SvPVutf8> macro.
2873 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2875 sv_utf8_upgrade(sv);
2876 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2881 =for apidoc sv_2bool
2883 This function is only called on magical items, and is only used by
2884 sv_true() or its macro equivalent.
2890 Perl_sv_2bool(pTHX_ register SV *sv)
2899 SV * const tmpsv = AMG_CALLun(sv,bool_);
2900 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2901 return (bool)SvTRUE(tmpsv);
2903 return SvRV(sv) != 0;
2906 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2908 (*sv->sv_u.svu_pv > '0' ||
2909 Xpvtmp->xpv_cur > 1 ||
2910 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2917 return SvIVX(sv) != 0;
2920 return SvNVX(sv) != 0.0;
2922 if (isGV_with_GP(sv))
2932 =for apidoc sv_utf8_upgrade
2934 Converts the PV of an SV to its UTF-8-encoded form.
2935 Forces the SV to string form if it is not already.
2936 Always sets the SvUTF8 flag to avoid future validity checks even
2937 if all the bytes have hibit clear.
2939 This is not as a general purpose byte encoding to Unicode interface:
2940 use the Encode extension for that.
2942 =for apidoc sv_utf8_upgrade_flags
2944 Converts the PV of an SV to its UTF-8-encoded form.
2945 Forces the SV to string form if it is not already.
2946 Always sets the SvUTF8 flag to avoid future validity checks even
2947 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2948 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2949 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2951 This is not as a general purpose byte encoding to Unicode interface:
2952 use the Encode extension for that.
2958 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2961 if (sv == &PL_sv_undef)
2965 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2966 (void) sv_2pv_flags(sv,&len, flags);
2970 (void) SvPV_force(sv,len);
2979 sv_force_normal_flags(sv, 0);
2982 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2983 sv_recode_to_utf8(sv, PL_encoding);
2984 else { /* Assume Latin-1/EBCDIC */
2985 /* This function could be much more efficient if we
2986 * had a FLAG in SVs to signal if there are any hibit
2987 * chars in the PV. Given that there isn't such a flag
2988 * make the loop as fast as possible. */
2989 const U8 * const s = (U8 *) SvPVX_const(sv);
2990 const U8 * const e = (U8 *) SvEND(sv);
2995 /* Check for hi bit */
2996 if (!NATIVE_IS_INVARIANT(ch)) {
2997 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2998 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3000 SvPV_free(sv); /* No longer using what was there before. */
3001 SvPV_set(sv, (char*)recoded);
3002 SvCUR_set(sv, len - 1);
3003 SvLEN_set(sv, len); /* No longer know the real size. */
3007 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3014 =for apidoc sv_utf8_downgrade
3016 Attempts to convert the PV of an SV from characters to bytes.
3017 If the PV contains a character beyond byte, this conversion will fail;
3018 in this case, either returns false or, if C<fail_ok> is not
3021 This is not as a general purpose Unicode to byte encoding interface:
3022 use the Encode extension for that.
3028 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3031 if (SvPOKp(sv) && SvUTF8(sv)) {
3037 sv_force_normal_flags(sv, 0);
3039 s = (U8 *) SvPV(sv, len);
3040 if (!utf8_to_bytes(s, &len)) {
3045 Perl_croak(aTHX_ "Wide character in %s",
3048 Perl_croak(aTHX_ "Wide character");
3059 =for apidoc sv_utf8_encode
3061 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3062 flag off so that it looks like octets again.
3068 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3071 sv_force_normal_flags(sv, 0);
3073 if (SvREADONLY(sv)) {
3074 Perl_croak(aTHX_ PL_no_modify);
3076 (void) sv_utf8_upgrade(sv);
3081 =for apidoc sv_utf8_decode
3083 If the PV of the SV is an octet sequence in UTF-8
3084 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3085 so that it looks like a character. If the PV contains only single-byte
3086 characters, the C<SvUTF8> flag stays being off.
3087 Scans PV for validity and returns false if the PV is invalid UTF-8.
3093 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3099 /* The octets may have got themselves encoded - get them back as
3102 if (!sv_utf8_downgrade(sv, TRUE))
3105 /* it is actually just a matter of turning the utf8 flag on, but
3106 * we want to make sure everything inside is valid utf8 first.
3108 c = (const U8 *) SvPVX_const(sv);
3109 if (!is_utf8_string(c, SvCUR(sv)+1))
3111 e = (const U8 *) SvEND(sv);
3114 if (!UTF8_IS_INVARIANT(ch)) {
3124 =for apidoc sv_setsv
3126 Copies the contents of the source SV C<ssv> into the destination SV
3127 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3128 function if the source SV needs to be reused. Does not handle 'set' magic.
3129 Loosely speaking, it performs a copy-by-value, obliterating any previous
3130 content of the destination.
3132 You probably want to use one of the assortment of wrappers, such as
3133 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3134 C<SvSetMagicSV_nosteal>.
3136 =for apidoc sv_setsv_flags
3138 Copies the contents of the source SV C<ssv> into the destination SV
3139 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3140 function if the source SV needs to be reused. Does not handle 'set' magic.
3141 Loosely speaking, it performs a copy-by-value, obliterating any previous
3142 content of the destination.
3143 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3144 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3145 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3146 and C<sv_setsv_nomg> are implemented in terms of this function.
3148 You probably want to use one of the assortment of wrappers, such as
3149 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3150 C<SvSetMagicSV_nosteal>.
3152 This is the primary function for copying scalars, and most other
3153 copy-ish functions and macros use this underneath.
3159 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3161 if (dtype != SVt_PVGV) {
3162 const char * const name = GvNAME(sstr);
3163 const STRLEN len = GvNAMELEN(sstr);
3164 /* don't upgrade SVt_PVLV: it can hold a glob */
3165 if (dtype != SVt_PVLV) {
3166 if (dtype >= SVt_PV) {
3172 sv_upgrade(dstr, SVt_PVGV);
3173 (void)SvOK_off(dstr);
3176 GvSTASH(dstr) = GvSTASH(sstr);
3178 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3179 gv_name_set((GV *)dstr, name, len, GV_ADD);
3180 SvFAKE_on(dstr); /* can coerce to non-glob */
3183 #ifdef GV_UNIQUE_CHECK
3184 if (GvUNIQUE((GV*)dstr)) {
3185 Perl_croak(aTHX_ PL_no_modify);
3191 (void)SvOK_off(dstr);
3193 GvINTRO_off(dstr); /* one-shot flag */
3194 GvGP(dstr) = gp_ref(GvGP(sstr));
3195 if (SvTAINTED(sstr))
3197 if (GvIMPORTED(dstr) != GVf_IMPORTED
3198 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3200 GvIMPORTED_on(dstr);
3207 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3208 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3210 const int intro = GvINTRO(dstr);
3213 const U32 stype = SvTYPE(sref);
3216 #ifdef GV_UNIQUE_CHECK
3217 if (GvUNIQUE((GV*)dstr)) {
3218 Perl_croak(aTHX_ PL_no_modify);
3223 GvINTRO_off(dstr); /* one-shot flag */
3224 GvLINE(dstr) = CopLINE(PL_curcop);
3225 GvEGV(dstr) = (GV*)dstr;
3230 location = (SV **) &GvCV(dstr);
3231 import_flag = GVf_IMPORTED_CV;
3234 location = (SV **) &GvHV(dstr);
3235 import_flag = GVf_IMPORTED_HV;
3238 location = (SV **) &GvAV(dstr);
3239 import_flag = GVf_IMPORTED_AV;
3242 location = (SV **) &GvIOp(dstr);
3245 location = (SV **) &GvFORM(dstr);
3247 location = &GvSV(dstr);
3248 import_flag = GVf_IMPORTED_SV;
3251 if (stype == SVt_PVCV) {
3252 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3253 SvREFCNT_dec(GvCV(dstr));
3255 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3256 PL_sub_generation++;
3259 SAVEGENERICSV(*location);
3263 if (stype == SVt_PVCV && *location != sref) {
3264 CV* const cv = (CV*)*location;
3266 if (!GvCVGEN((GV*)dstr) &&
3267 (CvROOT(cv) || CvXSUB(cv)))
3269 /* Redefining a sub - warning is mandatory if
3270 it was a const and its value changed. */
3271 if (CvCONST(cv) && CvCONST((CV*)sref)
3272 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3274 /* They are 2 constant subroutines generated from
3275 the same constant. This probably means that
3276 they are really the "same" proxy subroutine
3277 instantiated in 2 places. Most likely this is
3278 when a constant is exported twice. Don't warn.
3281 else if (ckWARN(WARN_REDEFINE)
3283 && (!CvCONST((CV*)sref)
3284 || sv_cmp(cv_const_sv(cv),
3285 cv_const_sv((CV*)sref))))) {
3286 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3289 ? "Constant subroutine %s::%s redefined"
3290 : "Subroutine %s::%s redefined"),
3291 HvNAME_get(GvSTASH((GV*)dstr)),
3292 GvENAME((GV*)dstr));
3296 cv_ckproto_len(cv, (GV*)dstr,
3297 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3298 SvPOK(sref) ? SvCUR(sref) : 0);
3300 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3301 GvASSUMECV_on(dstr);
3302 PL_sub_generation++;
3305 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3306 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3307 GvFLAGS(dstr) |= import_flag;
3312 if (SvTAINTED(sstr))
3318 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3321 register U32 sflags;
3323 register svtype stype;
3328 if (SvIS_FREED(dstr)) {
3329 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3330 " to a freed scalar %p", sstr, dstr);
3332 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3334 sstr = &PL_sv_undef;
3335 if (SvIS_FREED(sstr)) {
3336 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3339 stype = SvTYPE(sstr);
3340 dtype = SvTYPE(dstr);
3345 /* need to nuke the magic */
3347 SvRMAGICAL_off(dstr);
3350 /* There's a lot of redundancy below but we're going for speed here */
3355 if (dtype != SVt_PVGV) {
3356 (void)SvOK_off(dstr);
3364 sv_upgrade(dstr, SVt_IV);
3369 sv_upgrade(dstr, SVt_PVIV);
3372 (void)SvIOK_only(dstr);
3373 SvIV_set(dstr, SvIVX(sstr));
3376 /* SvTAINTED can only be true if the SV has taint magic, which in
3377 turn means that the SV type is PVMG (or greater). This is the
3378 case statement for SVt_IV, so this cannot be true (whatever gcov
3380 assert(!SvTAINTED(sstr));
3390 sv_upgrade(dstr, SVt_NV);
3395 sv_upgrade(dstr, SVt_PVNV);
3398 SvNV_set(dstr, SvNVX(sstr));
3399 (void)SvNOK_only(dstr);
3400 /* SvTAINTED can only be true if the SV has taint magic, which in
3401 turn means that the SV type is PVMG (or greater). This is the
3402 case statement for SVt_NV, so this cannot be true (whatever gcov
3404 assert(!SvTAINTED(sstr));
3411 sv_upgrade(dstr, SVt_RV);
3414 #ifdef PERL_OLD_COPY_ON_WRITE
3415 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3416 if (dtype < SVt_PVIV)
3417 sv_upgrade(dstr, SVt_PVIV);
3424 sv_upgrade(dstr, SVt_PV);
3427 if (dtype < SVt_PVIV)
3428 sv_upgrade(dstr, SVt_PVIV);
3431 if (dtype < SVt_PVNV)
3432 sv_upgrade(dstr, SVt_PVNV);
3436 const char * const type = sv_reftype(sstr,0);
3438 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3440 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3445 if (dtype <= SVt_PVGV) {
3446 glob_assign_glob(dstr, sstr, dtype);
3454 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3456 if (SvTYPE(sstr) != stype) {
3457 stype = SvTYPE(sstr);
3458 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3459 glob_assign_glob(dstr, sstr, dtype);
3464 if (stype == SVt_PVLV)
3465 SvUPGRADE(dstr, SVt_PVNV);
3467 SvUPGRADE(dstr, (svtype)stype);
3470 /* dstr may have been upgraded. */
3471 dtype = SvTYPE(dstr);
3472 sflags = SvFLAGS(sstr);
3474 if (dtype == SVt_PVCV) {
3475 /* Assigning to a subroutine sets the prototype. */
3478 const char *const ptr = SvPV_const(sstr, len);
3480 SvGROW(dstr, len + 1);
3481 Copy(ptr, SvPVX(dstr), len + 1, char);
3482 SvCUR_set(dstr, len);
3487 } else if (sflags & SVf_ROK) {
3488 if (dtype == SVt_PVGV && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3491 if (GvIMPORTED(dstr) != GVf_IMPORTED
3492 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3494 GvIMPORTED_on(dstr);
3499 glob_assign_glob(dstr, sstr, dtype);
3503 if (dtype >= SVt_PV) {
3504 if (dtype == SVt_PVGV) {
3505 glob_assign_ref(dstr, sstr);
3508 if (SvPVX_const(dstr)) {
3514 (void)SvOK_off(dstr);
3515 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3516 SvFLAGS(dstr) |= sflags & SVf_ROK;
3517 assert(!(sflags & SVp_NOK));
3518 assert(!(sflags & SVp_IOK));
3519 assert(!(sflags & SVf_NOK));
3520 assert(!(sflags & SVf_IOK));
3522 else if (dtype == SVt_PVGV) {
3523 if (!(sflags & SVf_OK)) {
3524 if (ckWARN(WARN_MISC))
3525 Perl_warner(aTHX_ packWARN(WARN_MISC),
3526 "Undefined value assigned to typeglob");
3529 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3530 if (dstr != (SV*)gv) {
3533 GvGP(dstr) = gp_ref(GvGP(gv));
3537 else if (sflags & SVp_POK) {
3541 * Check to see if we can just swipe the string. If so, it's a
3542 * possible small lose on short strings, but a big win on long ones.
3543 * It might even be a win on short strings if SvPVX_const(dstr)
3544 * has to be allocated and SvPVX_const(sstr) has to be freed.
3545 * Likewise if we can set up COW rather than doing an actual copy, we
3546 * drop to the else clause, as the swipe code and the COW setup code
3547 * have much in common.
3550 /* Whichever path we take through the next code, we want this true,
3551 and doing it now facilitates the COW check. */
3552 (void)SvPOK_only(dstr);
3555 /* If we're already COW then this clause is not true, and if COW
3556 is allowed then we drop down to the else and make dest COW
3557 with us. If caller hasn't said that we're allowed to COW
3558 shared hash keys then we don't do the COW setup, even if the
3559 source scalar is a shared hash key scalar. */
3560 (((flags & SV_COW_SHARED_HASH_KEYS)
3561 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3562 : 1 /* If making a COW copy is forbidden then the behaviour we
3563 desire is as if the source SV isn't actually already
3564 COW, even if it is. So we act as if the source flags
3565 are not COW, rather than actually testing them. */
3567 #ifndef PERL_OLD_COPY_ON_WRITE
3568 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3569 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3570 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3571 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3572 but in turn, it's somewhat dead code, never expected to go
3573 live, but more kept as a placeholder on how to do it better
3574 in a newer implementation. */
3575 /* If we are COW and dstr is a suitable target then we drop down
3576 into the else and make dest a COW of us. */
3577 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3582 (sflags & SVs_TEMP) && /* slated for free anyway? */
3583 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3584 (!(flags & SV_NOSTEAL)) &&
3585 /* and we're allowed to steal temps */
3586 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3587 SvLEN(sstr) && /* and really is a string */
3588 /* and won't be needed again, potentially */
3589 !(PL_op && PL_op->op_type == OP_AASSIGN))
3590 #ifdef PERL_OLD_COPY_ON_WRITE
3591 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3592 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3593 && SvTYPE(sstr) >= SVt_PVIV)
3596 /* Failed the swipe test, and it's not a shared hash key either.
3597 Have to copy the string. */
3598 STRLEN len = SvCUR(sstr);
3599 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3600 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3601 SvCUR_set(dstr, len);
3602 *SvEND(dstr) = '\0';
3604 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3606 /* Either it's a shared hash key, or it's suitable for
3607 copy-on-write or we can swipe the string. */
3609 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3613 #ifdef PERL_OLD_COPY_ON_WRITE
3615 /* I believe I should acquire a global SV mutex if
3616 it's a COW sv (not a shared hash key) to stop
3617 it going un copy-on-write.
3618 If the source SV has gone un copy on write between up there
3619 and down here, then (assert() that) it is of the correct
3620 form to make it copy on write again */
3621 if ((sflags & (SVf_FAKE | SVf_READONLY))
3622 != (SVf_FAKE | SVf_READONLY)) {
3623 SvREADONLY_on(sstr);
3625 /* Make the source SV into a loop of 1.
3626 (about to become 2) */
3627 SV_COW_NEXT_SV_SET(sstr, sstr);
3631 /* Initial code is common. */
3632 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3637 /* making another shared SV. */
3638 STRLEN cur = SvCUR(sstr);
3639 STRLEN len = SvLEN(sstr);
3640 #ifdef PERL_OLD_COPY_ON_WRITE
3642 assert (SvTYPE(dstr) >= SVt_PVIV);
3643 /* SvIsCOW_normal */
3644 /* splice us in between source and next-after-source. */
3645 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3646 SV_COW_NEXT_SV_SET(sstr, dstr);
3647 SvPV_set(dstr, SvPVX_mutable(sstr));
3651 /* SvIsCOW_shared_hash */
3652 DEBUG_C(PerlIO_printf(Perl_debug_log,
3653 "Copy on write: Sharing hash\n"));
3655 assert (SvTYPE(dstr) >= SVt_PV);
3657 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3659 SvLEN_set(dstr, len);
3660 SvCUR_set(dstr, cur);
3661 SvREADONLY_on(dstr);
3663 /* Relesase a global SV mutex. */
3666 { /* Passes the swipe test. */
3667 SvPV_set(dstr, SvPVX_mutable(sstr));
3668 SvLEN_set(dstr, SvLEN(sstr));
3669 SvCUR_set(dstr, SvCUR(sstr));
3672 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3673 SvPV_set(sstr, NULL);
3679 if (sflags & SVp_NOK) {
3680 SvNV_set(dstr, SvNVX(sstr));
3682 if (sflags & SVp_IOK) {
3683 SvRELEASE_IVX(dstr);
3684 SvIV_set(dstr, SvIVX(sstr));
3685 /* Must do this otherwise some other overloaded use of 0x80000000
3686 gets confused. I guess SVpbm_VALID */
3687 if (sflags & SVf_IVisUV)
3690 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3692 const MAGIC * const smg = SvVSTRING_mg(sstr);
3694 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3695 smg->mg_ptr, smg->mg_len);
3696 SvRMAGICAL_on(dstr);
3700 else if (sflags & (SVp_IOK|SVp_NOK)) {
3701 (void)SvOK_off(dstr);
3702 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3703 if (sflags & SVp_IOK) {
3704 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3705 SvIV_set(dstr, SvIVX(sstr));
3707 if (sflags & SVp_NOK) {
3708 SvNV_set(dstr, SvNVX(sstr));
3712 if (isGV_with_GP(sstr)) {
3713 /* This stringification rule for globs is spread in 3 places.
3714 This feels bad. FIXME. */
3715 const U32 wasfake = sflags & SVf_FAKE;
3717 /* FAKE globs can get coerced, so need to turn this off
3718 temporarily if it is on. */
3720 gv_efullname3(dstr, (GV *)sstr, "*");
3721 SvFLAGS(sstr) |= wasfake;
3724 (void)SvOK_off(dstr);
3726 if (SvTAINTED(sstr))
3731 =for apidoc sv_setsv_mg
3733 Like C<sv_setsv>, but also handles 'set' magic.
3739 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3741 sv_setsv(dstr,sstr);
3745 #ifdef PERL_OLD_COPY_ON_WRITE
3747 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3749 STRLEN cur = SvCUR(sstr);
3750 STRLEN len = SvLEN(sstr);
3751 register char *new_pv;
3754 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3762 if (SvTHINKFIRST(dstr))
3763 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3764 else if (SvPVX_const(dstr))
3765 Safefree(SvPVX_const(dstr));
3769 SvUPGRADE(dstr, SVt_PVIV);
3771 assert (SvPOK(sstr));
3772 assert (SvPOKp(sstr));
3773 assert (!SvIOK(sstr));
3774 assert (!SvIOKp(sstr));
3775 assert (!SvNOK(sstr));
3776 assert (!SvNOKp(sstr));
3778 if (SvIsCOW(sstr)) {
3780 if (SvLEN(sstr) == 0) {
3781 /* source is a COW shared hash key. */
3782 DEBUG_C(PerlIO_printf(Perl_debug_log,
3783 "Fast copy on write: Sharing hash\n"));
3784 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3787 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3789 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3790 SvUPGRADE(sstr, SVt_PVIV);
3791 SvREADONLY_on(sstr);
3793 DEBUG_C(PerlIO_printf(Perl_debug_log,
3794 "Fast copy on write: Converting sstr to COW\n"));
3795 SV_COW_NEXT_SV_SET(dstr, sstr);
3797 SV_COW_NEXT_SV_SET(sstr, dstr);
3798 new_pv = SvPVX_mutable(sstr);
3801 SvPV_set(dstr, new_pv);
3802 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3805 SvLEN_set(dstr, len);
3806 SvCUR_set(dstr, cur);
3815 =for apidoc sv_setpvn
3817 Copies a string into an SV. The C<len> parameter indicates the number of
3818 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3819 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3825 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3828 register char *dptr;
3830 SV_CHECK_THINKFIRST_COW_DROP(sv);
3836 /* len is STRLEN which is unsigned, need to copy to signed */
3839 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3841 SvUPGRADE(sv, SVt_PV);
3843 dptr = SvGROW(sv, len + 1);
3844 Move(ptr,dptr,len,char);
3847 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3852 =for apidoc sv_setpvn_mg
3854 Like C<sv_setpvn>, but also handles 'set' magic.
3860 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3862 sv_setpvn(sv,ptr,len);
3867 =for apidoc sv_setpv
3869 Copies a string into an SV. The string must be null-terminated. Does not
3870 handle 'set' magic. See C<sv_setpv_mg>.
3876 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3879 register STRLEN len;
3881 SV_CHECK_THINKFIRST_COW_DROP(sv);
3887 SvUPGRADE(sv, SVt_PV);
3889 SvGROW(sv, len + 1);
3890 Move(ptr,SvPVX(sv),len+1,char);
3892 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3897 =for apidoc sv_setpv_mg
3899 Like C<sv_setpv>, but also handles 'set' magic.
3905 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3912 =for apidoc sv_usepvn_flags
3914 Tells an SV to use C<ptr> to find its string value. Normally the
3915 string is stored inside the SV but sv_usepvn allows the SV to use an
3916 outside string. The C<ptr> should point to memory that was allocated
3917 by C<malloc>. The string length, C<len>, must be supplied. By default
3918 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3919 so that pointer should not be freed or used by the programmer after
3920 giving it to sv_usepvn, and neither should any pointers from "behind"
3921 that pointer (e.g. ptr + 1) be used.
3923 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3924 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3925 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3926 C<len>, and already meets the requirements for storing in C<SvPVX>)
3932 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3936 SV_CHECK_THINKFIRST_COW_DROP(sv);
3937 SvUPGRADE(sv, SVt_PV);
3940 if (flags & SV_SMAGIC)
3944 if (SvPVX_const(sv))
3948 if (flags & SV_HAS_TRAILING_NUL)
3949 assert(ptr[len] == '\0');
3952 allocate = (flags & SV_HAS_TRAILING_NUL)
3953 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3954 if (flags & SV_HAS_TRAILING_NUL) {
3955 /* It's long enough - do nothing.
3956 Specfically Perl_newCONSTSUB is relying on this. */
3959 /* Force a move to shake out bugs in callers. */
3960 char *new_ptr = (char*)safemalloc(allocate);
3961 Copy(ptr, new_ptr, len, char);
3962 PoisonFree(ptr,len,char);
3966 ptr = (char*) saferealloc (ptr, allocate);
3971 SvLEN_set(sv, allocate);
3972 if (!(flags & SV_HAS_TRAILING_NUL)) {
3975 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3977 if (flags & SV_SMAGIC)
3981 #ifdef PERL_OLD_COPY_ON_WRITE
3982 /* Need to do this *after* making the SV normal, as we need the buffer
3983 pointer to remain valid until after we've copied it. If we let go too early,
3984 another thread could invalidate it by unsharing last of the same hash key
3985 (which it can do by means other than releasing copy-on-write Svs)
3986 or by changing the other copy-on-write SVs in the loop. */
3988 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3990 if (len) { /* this SV was SvIsCOW_normal(sv) */
3991 /* we need to find the SV pointing to us. */
3992 SV *current = SV_COW_NEXT_SV(after);
3994 if (current == sv) {
3995 /* The SV we point to points back to us (there were only two of us
3997 Hence other SV is no longer copy on write either. */
3999 SvREADONLY_off(after);
4001 /* We need to follow the pointers around the loop. */
4003 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4006 /* don't loop forever if the structure is bust, and we have
4007 a pointer into a closed loop. */
4008 assert (current != after);
4009 assert (SvPVX_const(current) == pvx);
4011 /* Make the SV before us point to the SV after us. */
4012 SV_COW_NEXT_SV_SET(current, after);
4015 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4020 Perl_sv_release_IVX(pTHX_ register SV *sv)
4023 sv_force_normal_flags(sv, 0);
4029 =for apidoc sv_force_normal_flags
4031 Undo various types of fakery on an SV: if the PV is a shared string, make
4032 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4033 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4034 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4035 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4036 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4037 set to some other value.) In addition, the C<flags> parameter gets passed to
4038 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4039 with flags set to 0.
4045 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4048 #ifdef PERL_OLD_COPY_ON_WRITE
4049 if (SvREADONLY(sv)) {
4050 /* At this point I believe I should acquire a global SV mutex. */
4052 const char * const pvx = SvPVX_const(sv);
4053 const STRLEN len = SvLEN(sv);
4054 const STRLEN cur = SvCUR(sv);
4055 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4057 PerlIO_printf(Perl_debug_log,
4058 "Copy on write: Force normal %ld\n",
4064 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4067 if (flags & SV_COW_DROP_PV) {
4068 /* OK, so we don't need to copy our buffer. */
4071 SvGROW(sv, cur + 1);
4072 Move(pvx,SvPVX(sv),cur,char);
4076 sv_release_COW(sv, pvx, len, next);
4081 else if (IN_PERL_RUNTIME)
4082 Perl_croak(aTHX_ PL_no_modify);
4083 /* At this point I believe that I can drop the global SV mutex. */
4086 if (SvREADONLY(sv)) {
4088 const char * const pvx = SvPVX_const(sv);
4089 const STRLEN len = SvCUR(sv);
4094 SvGROW(sv, len + 1);
4095 Move(pvx,SvPVX(sv),len,char);
4097 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4099 else if (IN_PERL_RUNTIME)
4100 Perl_croak(aTHX_ PL_no_modify);
4104 sv_unref_flags(sv, flags);
4105 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4112 Efficient removal of characters from the beginning of the string buffer.
4113 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4114 the string buffer. The C<ptr> becomes the first character of the adjusted
4115 string. Uses the "OOK hack".
4116 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4117 refer to the same chunk of data.
4123 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4125 register STRLEN delta;
4126 if (!ptr || !SvPOKp(sv))
4128 delta = ptr - SvPVX_const(sv);
4129 SV_CHECK_THINKFIRST(sv);
4130 if (SvTYPE(sv) < SVt_PVIV)
4131 sv_upgrade(sv,SVt_PVIV);
4134 if (!SvLEN(sv)) { /* make copy of shared string */
4135 const char *pvx = SvPVX_const(sv);
4136 const STRLEN len = SvCUR(sv);
4137 SvGROW(sv, len + 1);
4138 Move(pvx,SvPVX(sv),len,char);
4142 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4143 and we do that anyway inside the SvNIOK_off
4145 SvFLAGS(sv) |= SVf_OOK;
4148 SvLEN_set(sv, SvLEN(sv) - delta);
4149 SvCUR_set(sv, SvCUR(sv) - delta);
4150 SvPV_set(sv, SvPVX(sv) + delta);
4151 SvIV_set(sv, SvIVX(sv) + delta);
4155 =for apidoc sv_catpvn
4157 Concatenates the string onto the end of the string which is in the SV. The
4158 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4159 status set, then the bytes appended should be valid UTF-8.
4160 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4162 =for apidoc sv_catpvn_flags
4164 Concatenates the string onto the end of the string which is in the SV. The
4165 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4166 status set, then the bytes appended should be valid UTF-8.
4167 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4168 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4169 in terms of this function.
4175 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4179 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4181 SvGROW(dsv, dlen + slen + 1);
4183 sstr = SvPVX_const(dsv);
4184 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4185 SvCUR_set(dsv, SvCUR(dsv) + slen);
4187 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4189 if (flags & SV_SMAGIC)
4194 =for apidoc sv_catsv
4196 Concatenates the string from SV C<ssv> onto the end of the string in
4197 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4198 not 'set' magic. See C<sv_catsv_mg>.
4200 =for apidoc sv_catsv_flags
4202 Concatenates the string from SV C<ssv> onto the end of the string in
4203 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4204 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4205 and C<sv_catsv_nomg> are implemented in terms of this function.
4210 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4215 const char *spv = SvPV_const(ssv, slen);
4217 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4218 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4219 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4220 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4221 dsv->sv_flags doesn't have that bit set.
4222 Andy Dougherty 12 Oct 2001
4224 const I32 sutf8 = DO_UTF8(ssv);
4227 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4229 dutf8 = DO_UTF8(dsv);
4231 if (dutf8 != sutf8) {
4233 /* Not modifying source SV, so taking a temporary copy. */
4234 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4236 sv_utf8_upgrade(csv);
4237 spv = SvPV_const(csv, slen);
4240 sv_utf8_upgrade_nomg(dsv);
4242 sv_catpvn_nomg(dsv, spv, slen);
4245 if (flags & SV_SMAGIC)
4250 =for apidoc sv_catpv
4252 Concatenates the string onto the end of the string which is in the SV.
4253 If the SV has the UTF-8 status set, then the bytes appended should be
4254 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4259 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4262 register STRLEN len;
4268 junk = SvPV_force(sv, tlen);
4270 SvGROW(sv, tlen + len + 1);
4272 ptr = SvPVX_const(sv);
4273 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4274 SvCUR_set(sv, SvCUR(sv) + len);
4275 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4280 =for apidoc sv_catpv_mg
4282 Like C<sv_catpv>, but also handles 'set' magic.
4288 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4297 Creates a new SV. A non-zero C<len> parameter indicates the number of
4298 bytes of preallocated string space the SV should have. An extra byte for a
4299 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4300 space is allocated.) The reference count for the new SV is set to 1.
4302 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4303 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4304 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4305 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4306 modules supporting older perls.
4312 Perl_newSV(pTHX_ STRLEN len)
4319 sv_upgrade(sv, SVt_PV);
4320 SvGROW(sv, len + 1);
4325 =for apidoc sv_magicext
4327 Adds magic to an SV, upgrading it if necessary. Applies the
4328 supplied vtable and returns a pointer to the magic added.
4330 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4331 In particular, you can add magic to SvREADONLY SVs, and add more than
4332 one instance of the same 'how'.
4334 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4335 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4336 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4337 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4339 (This is now used as a subroutine by C<sv_magic>.)
4344 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4345 const char* name, I32 namlen)
4350 if (SvTYPE(sv) < SVt_PVMG) {
4351 SvUPGRADE(sv, SVt_PVMG);
4353 Newxz(mg, 1, MAGIC);
4354 mg->mg_moremagic = SvMAGIC(sv);
4355 SvMAGIC_set(sv, mg);
4357 /* Sometimes a magic contains a reference loop, where the sv and
4358 object refer to each other. To prevent a reference loop that
4359 would prevent such objects being freed, we look for such loops
4360 and if we find one we avoid incrementing the object refcount.
4362 Note we cannot do this to avoid self-tie loops as intervening RV must
4363 have its REFCNT incremented to keep it in existence.
4366 if (!obj || obj == sv ||
4367 how == PERL_MAGIC_arylen ||
4368 how == PERL_MAGIC_qr ||
4369 how == PERL_MAGIC_symtab ||
4370 (SvTYPE(obj) == SVt_PVGV &&
4371 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4372 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4373 GvFORM(obj) == (CV*)sv)))
4378 mg->mg_obj = SvREFCNT_inc_simple(obj);
4379 mg->mg_flags |= MGf_REFCOUNTED;
4382 /* Normal self-ties simply pass a null object, and instead of
4383 using mg_obj directly, use the SvTIED_obj macro to produce a
4384 new RV as needed. For glob "self-ties", we are tieing the PVIO
4385 with an RV obj pointing to the glob containing the PVIO. In
4386 this case, to avoid a reference loop, we need to weaken the
4390 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4391 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4397 mg->mg_len = namlen;
4400 mg->mg_ptr = savepvn(name, namlen);
4401 else if (namlen == HEf_SVKEY)
4402 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4404 mg->mg_ptr = (char *) name;
4406 mg->mg_virtual = vtable;
4410 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4415 =for apidoc sv_magic
4417 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4418 then adds a new magic item of type C<how> to the head of the magic list.
4420 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4421 handling of the C<name> and C<namlen> arguments.
4423 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4424 to add more than one instance of the same 'how'.
4430 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4436 #ifdef PERL_OLD_COPY_ON_WRITE
4438 sv_force_normal_flags(sv, 0);
4440 if (SvREADONLY(sv)) {
4442 /* its okay to attach magic to shared strings; the subsequent
4443 * upgrade to PVMG will unshare the string */
4444 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4447 && how != PERL_MAGIC_regex_global
4448 && how != PERL_MAGIC_bm
4449 && how != PERL_MAGIC_fm
4450 && how != PERL_MAGIC_sv
4451 && how != PERL_MAGIC_backref
4454 Perl_croak(aTHX_ PL_no_modify);
4457 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4458 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4459 /* sv_magic() refuses to add a magic of the same 'how' as an
4462 if (how == PERL_MAGIC_taint) {
4464 /* Any scalar which already had taint magic on which someone
4465 (erroneously?) did SvIOK_on() or similar will now be
4466 incorrectly sporting public "OK" flags. */
4467 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4475 vtable = &PL_vtbl_sv;
4477 case PERL_MAGIC_overload:
4478 vtable = &PL_vtbl_amagic;
4480 case PERL_MAGIC_overload_elem:
4481 vtable = &PL_vtbl_amagicelem;
4483 case PERL_MAGIC_overload_table:
4484 vtable = &PL_vtbl_ovrld;
4487 vtable = &PL_vtbl_bm;
4489 case PERL_MAGIC_regdata:
4490 vtable = &PL_vtbl_regdata;
4492 case PERL_MAGIC_regdata_names:
4493 vtable = &PL_vtbl_regdata_names;
4495 case PERL_MAGIC_regdatum:
4496 vtable = &PL_vtbl_regdatum;
4498 case PERL_MAGIC_env:
4499 vtable = &PL_vtbl_env;
4502 vtable = &PL_vtbl_fm;
4504 case PERL_MAGIC_envelem:
4505 vtable = &PL_vtbl_envelem;
4507 case PERL_MAGIC_regex_global:
4508 vtable = &PL_vtbl_mglob;
4510 case PERL_MAGIC_isa:
4511 vtable = &PL_vtbl_isa;
4513 case PERL_MAGIC_isaelem:
4514 vtable = &PL_vtbl_isaelem;
4516 case PERL_MAGIC_nkeys:
4517 vtable = &PL_vtbl_nkeys;
4519 case PERL_MAGIC_dbfile:
4522 case PERL_MAGIC_dbline:
4523 vtable = &PL_vtbl_dbline;
4525 #ifdef USE_LOCALE_COLLATE
4526 case PERL_MAGIC_collxfrm:
4527 vtable = &PL_vtbl_collxfrm;
4529 #endif /* USE_LOCALE_COLLATE */
4530 case PERL_MAGIC_tied:
4531 vtable = &PL_vtbl_pack;
4533 case PERL_MAGIC_tiedelem:
4534 case PERL_MAGIC_tiedscalar:
4535 vtable = &PL_vtbl_packelem;
4538 vtable = &PL_vtbl_regexp;
4540 case PERL_MAGIC_hints:
4541 /* As this vtable is all NULL, we can reuse it. */
4542 case PERL_MAGIC_sig:
4543 vtable = &PL_vtbl_sig;
4545 case PERL_MAGIC_sigelem:
4546 vtable = &PL_vtbl_sigelem;
4548 case PERL_MAGIC_taint:
4549 vtable = &PL_vtbl_taint;
4551 case PERL_MAGIC_uvar:
4552 vtable = &PL_vtbl_uvar;
4554 case PERL_MAGIC_vec:
4555 vtable = &PL_vtbl_vec;
4557 case PERL_MAGIC_arylen_p:
4558 case PERL_MAGIC_rhash:
4559 case PERL_MAGIC_symtab:
4560 case PERL_MAGIC_vstring:
4563 case PERL_MAGIC_utf8:
4564 vtable = &PL_vtbl_utf8;
4566 case PERL_MAGIC_substr:
4567 vtable = &PL_vtbl_substr;
4569 case PERL_MAGIC_defelem:
4570 vtable = &PL_vtbl_defelem;
4572 case PERL_MAGIC_arylen:
4573 vtable = &PL_vtbl_arylen;
4575 case PERL_MAGIC_pos:
4576 vtable = &PL_vtbl_pos;
4578 case PERL_MAGIC_backref:
4579 vtable = &PL_vtbl_backref;
4581 case PERL_MAGIC_hintselem:
4582 vtable = &PL_vtbl_hintselem;
4584 case PERL_MAGIC_ext:
4585 /* Reserved for use by extensions not perl internals. */
4586 /* Useful for attaching extension internal data to perl vars. */
4587 /* Note that multiple extensions may clash if magical scalars */
4588 /* etc holding private data from one are passed to another. */
4592 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4595 /* Rest of work is done else where */
4596 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4599 case PERL_MAGIC_taint:
4602 case PERL_MAGIC_ext:
4603 case PERL_MAGIC_dbfile:
4610 =for apidoc sv_unmagic
4612 Removes all magic of type C<type> from an SV.
4618 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4622 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4624 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4625 for (mg = *mgp; mg; mg = *mgp) {
4626 if (mg->mg_type == type) {
4627 const MGVTBL* const vtbl = mg->mg_virtual;
4628 *mgp = mg->mg_moremagic;
4629 if (vtbl && vtbl->svt_free)
4630 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4631 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4633 Safefree(mg->mg_ptr);
4634 else if (mg->mg_len == HEf_SVKEY)
4635 SvREFCNT_dec((SV*)mg->mg_ptr);
4636 else if (mg->mg_type == PERL_MAGIC_utf8)
4637 Safefree(mg->mg_ptr);
4639 if (mg->mg_flags & MGf_REFCOUNTED)
4640 SvREFCNT_dec(mg->mg_obj);
4644 mgp = &mg->mg_moremagic;
4648 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4649 SvMAGIC_set(sv, NULL);
4656 =for apidoc sv_rvweaken
4658 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4659 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4660 push a back-reference to this RV onto the array of backreferences
4661 associated with that magic. If the RV is magical, set magic will be
4662 called after the RV is cleared.
4668 Perl_sv_rvweaken(pTHX_ SV *sv)
4671 if (!SvOK(sv)) /* let undefs pass */
4674 Perl_croak(aTHX_ "Can't weaken a nonreference");
4675 else if (SvWEAKREF(sv)) {
4676 if (ckWARN(WARN_MISC))
4677 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4681 Perl_sv_add_backref(aTHX_ tsv, sv);
4687 /* Give tsv backref magic if it hasn't already got it, then push a
4688 * back-reference to sv onto the array associated with the backref magic.
4692 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4697 if (SvTYPE(tsv) == SVt_PVHV) {
4698 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4702 /* There is no AV in the offical place - try a fixup. */
4703 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4706 /* Aha. They've got it stowed in magic. Bring it back. */
4707 av = (AV*)mg->mg_obj;
4708 /* Stop mg_free decreasing the refernce count. */
4710 /* Stop mg_free even calling the destructor, given that
4711 there's no AV to free up. */
4713 sv_unmagic(tsv, PERL_MAGIC_backref);
4717 SvREFCNT_inc_simple_void(av);
4722 const MAGIC *const mg
4723 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4725 av = (AV*)mg->mg_obj;
4729 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4730 /* av now has a refcnt of 2, which avoids it getting freed
4731 * before us during global cleanup. The extra ref is removed
4732 * by magic_killbackrefs() when tsv is being freed */
4735 if (AvFILLp(av) >= AvMAX(av)) {
4736 av_extend(av, AvFILLp(av)+1);
4738 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4741 /* delete a back-reference to ourselves from the backref magic associated
4742 * with the SV we point to.
4746 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4753 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4754 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4755 /* We mustn't attempt to "fix up" the hash here by moving the
4756 backreference array back to the hv_aux structure, as that is stored
4757 in the main HvARRAY(), and hfreentries assumes that no-one
4758 reallocates HvARRAY() while it is running. */
4761 const MAGIC *const mg
4762 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4764 av = (AV *)mg->mg_obj;
4767 if (PL_in_clean_all)
4769 Perl_croak(aTHX_ "panic: del_backref");
4776 /* We shouldn't be in here more than once, but for paranoia reasons lets
4778 for (i = AvFILLp(av); i >= 0; i--) {
4780 const SSize_t fill = AvFILLp(av);
4782 /* We weren't the last entry.
4783 An unordered list has this property that you can take the
4784 last element off the end to fill the hole, and it's still
4785 an unordered list :-)
4790 AvFILLp(av) = fill - 1;
4796 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4798 SV **svp = AvARRAY(av);
4800 PERL_UNUSED_ARG(sv);
4802 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4803 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4804 if (svp && !SvIS_FREED(av)) {
4805 SV *const *const last = svp + AvFILLp(av);
4807 while (svp <= last) {
4809 SV *const referrer = *svp;
4810 if (SvWEAKREF(referrer)) {
4811 /* XXX Should we check that it hasn't changed? */
4812 SvRV_set(referrer, 0);
4814 SvWEAKREF_off(referrer);
4815 SvSETMAGIC(referrer);
4816 } else if (SvTYPE(referrer) == SVt_PVGV ||
4817 SvTYPE(referrer) == SVt_PVLV) {
4818 /* You lookin' at me? */
4819 assert(GvSTASH(referrer));
4820 assert(GvSTASH(referrer) == (HV*)sv);
4821 GvSTASH(referrer) = 0;
4824 "panic: magic_killbackrefs (flags=%"UVxf")",
4825 (UV)SvFLAGS(referrer));
4833 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4838 =for apidoc sv_insert
4840 Inserts a string at the specified offset/length within the SV. Similar to
4841 the Perl substr() function.
4847 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4852 register char *midend;
4853 register char *bigend;
4859 Perl_croak(aTHX_ "Can't modify non-existent substring");
4860 SvPV_force(bigstr, curlen);
4861 (void)SvPOK_only_UTF8(bigstr);
4862 if (offset + len > curlen) {
4863 SvGROW(bigstr, offset+len+1);
4864 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4865 SvCUR_set(bigstr, offset+len);
4869 i = littlelen - len;
4870 if (i > 0) { /* string might grow */
4871 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4872 mid = big + offset + len;
4873 midend = bigend = big + SvCUR(bigstr);
4876 while (midend > mid) /* shove everything down */
4877 *--bigend = *--midend;
4878 Move(little,big+offset,littlelen,char);
4879 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4884 Move(little,SvPVX(bigstr)+offset,len,char);
4889 big = SvPVX(bigstr);
4892 bigend = big + SvCUR(bigstr);
4894 if (midend > bigend)
4895 Perl_croak(aTHX_ "panic: sv_insert");
4897 if (mid - big > bigend - midend) { /* faster to shorten from end */
4899 Move(little, mid, littlelen,char);
4902 i = bigend - midend;
4904 Move(midend, mid, i,char);
4908 SvCUR_set(bigstr, mid - big);
4910 else if ((i = mid - big)) { /* faster from front */
4911 midend -= littlelen;
4913 sv_chop(bigstr,midend-i);
4918 Move(little, mid, littlelen,char);
4920 else if (littlelen) {
4921 midend -= littlelen;
4922 sv_chop(bigstr,midend);
4923 Move(little,midend,littlelen,char);
4926 sv_chop(bigstr,midend);
4932 =for apidoc sv_replace
4934 Make the first argument a copy of the second, then delete the original.
4935 The target SV physically takes over ownership of the body of the source SV
4936 and inherits its flags; however, the target keeps any magic it owns,
4937 and any magic in the source is discarded.
4938 Note that this is a rather specialist SV copying operation; most of the
4939 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4945 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4948 const U32 refcnt = SvREFCNT(sv);
4949 SV_CHECK_THINKFIRST_COW_DROP(sv);
4950 if (SvREFCNT(nsv) != 1) {
4951 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4952 UVuf " != 1)", (UV) SvREFCNT(nsv));
4954 if (SvMAGICAL(sv)) {
4958 sv_upgrade(nsv, SVt_PVMG);
4959 SvMAGIC_set(nsv, SvMAGIC(sv));
4960 SvFLAGS(nsv) |= SvMAGICAL(sv);
4962 SvMAGIC_set(sv, NULL);
4966 assert(!SvREFCNT(sv));
4967 #ifdef DEBUG_LEAKING_SCALARS
4968 sv->sv_flags = nsv->sv_flags;
4969 sv->sv_any = nsv->sv_any;
4970 sv->sv_refcnt = nsv->sv_refcnt;
4971 sv->sv_u = nsv->sv_u;
4973 StructCopy(nsv,sv,SV);
4975 /* Currently could join these into one piece of pointer arithmetic, but
4976 it would be unclear. */
4977 if(SvTYPE(sv) == SVt_IV)
4979 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4980 else if (SvTYPE(sv) == SVt_RV) {
4981 SvANY(sv) = &sv->sv_u.svu_rv;
4985 #ifdef PERL_OLD_COPY_ON_WRITE
4986 if (SvIsCOW_normal(nsv)) {
4987 /* We need to follow the pointers around the loop to make the
4988 previous SV point to sv, rather than nsv. */
4991 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4994 assert(SvPVX_const(current) == SvPVX_const(nsv));
4996 /* Make the SV before us point to the SV after us. */
4998 PerlIO_printf(Perl_debug_log, "previous is\n");
5000 PerlIO_printf(Perl_debug_log,
5001 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5002 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5004 SV_COW_NEXT_SV_SET(current, sv);
5007 SvREFCNT(sv) = refcnt;
5008 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5014 =for apidoc sv_clear
5016 Clear an SV: call any destructors, free up any memory used by the body,
5017 and free the body itself. The SV's head is I<not> freed, although
5018 its type is set to all 1's so that it won't inadvertently be assumed
5019 to be live during global destruction etc.
5020 This function should only be called when REFCNT is zero. Most of the time
5021 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5028 Perl_sv_clear(pTHX_ register SV *sv)
5031 const U32 type = SvTYPE(sv);
5032 const struct body_details *const sv_type_details
5033 = bodies_by_type + type;
5036 assert(SvREFCNT(sv) == 0);
5038 if (type <= SVt_IV) {
5039 /* See the comment in sv.h about the collusion between this early
5040 return and the overloading of the NULL and IV slots in the size
5046 if (PL_defstash) { /* Still have a symbol table? */
5051 stash = SvSTASH(sv);
5052 destructor = StashHANDLER(stash,DESTROY);
5054 SV* const tmpref = newRV(sv);
5055 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5057 PUSHSTACKi(PERLSI_DESTROY);
5062 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5068 if(SvREFCNT(tmpref) < 2) {
5069 /* tmpref is not kept alive! */
5071 SvRV_set(tmpref, NULL);
5074 SvREFCNT_dec(tmpref);
5076 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5080 if (PL_in_clean_objs)
5081 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5083 /* DESTROY gave object new lease on life */
5089 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5090 SvOBJECT_off(sv); /* Curse the object. */
5091 if (type != SVt_PVIO)
5092 --PL_sv_objcount; /* XXX Might want something more general */
5095 if (type >= SVt_PVMG) {
5096 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5097 SvREFCNT_dec(OURSTASH(sv));
5098 } else if (SvMAGIC(sv))
5100 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5101 SvREFCNT_dec(SvSTASH(sv));
5106 IoIFP(sv) != PerlIO_stdin() &&
5107 IoIFP(sv) != PerlIO_stdout() &&
5108 IoIFP(sv) != PerlIO_stderr())
5110 io_close((IO*)sv, FALSE);
5112 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5113 PerlDir_close(IoDIRP(sv));
5114 IoDIRP(sv) = (DIR*)NULL;
5115 Safefree(IoTOP_NAME(sv));
5116 Safefree(IoFMT_NAME(sv));
5117 Safefree(IoBOTTOM_NAME(sv));
5126 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5133 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5134 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5135 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5136 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5138 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5139 SvREFCNT_dec(LvTARG(sv));
5143 if (GvNAME_HEK(sv)) {
5144 unshare_hek(GvNAME_HEK(sv));
5146 /* If we're in a stash, we don't own a reference to it. However it does
5147 have a back reference to us, which needs to be cleared. */
5149 sv_del_backref((SV*)GvSTASH(sv), sv);
5154 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5156 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5157 /* Don't even bother with turning off the OOK flag. */
5162 SV * const target = SvRV(sv);
5164 sv_del_backref(target, sv);
5166 SvREFCNT_dec(target);
5168 #ifdef PERL_OLD_COPY_ON_WRITE
5169 else if (SvPVX_const(sv)) {
5171 /* I believe I need to grab the global SV mutex here and
5172 then recheck the COW status. */
5174 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5177 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5178 SV_COW_NEXT_SV(sv));
5179 /* And drop it here. */
5181 } else if (SvLEN(sv)) {
5182 Safefree(SvPVX_const(sv));
5186 else if (SvPVX_const(sv) && SvLEN(sv))
5187 Safefree(SvPVX_mutable(sv));
5188 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5189 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5198 SvFLAGS(sv) &= SVf_BREAK;
5199 SvFLAGS(sv) |= SVTYPEMASK;
5201 if (sv_type_details->arena) {
5202 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5203 &PL_body_roots[type]);
5205 else if (sv_type_details->body_size) {
5206 my_safefree(SvANY(sv));
5211 =for apidoc sv_newref
5213 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5220 Perl_sv_newref(pTHX_ SV *sv)
5222 PERL_UNUSED_CONTEXT;
5231 Decrement an SV's reference count, and if it drops to zero, call
5232 C<sv_clear> to invoke destructors and free up any memory used by
5233 the body; finally, deallocate the SV's head itself.
5234 Normally called via a wrapper macro C<SvREFCNT_dec>.
5240 Perl_sv_free(pTHX_ SV *sv)
5245 if (SvREFCNT(sv) == 0) {
5246 if (SvFLAGS(sv) & SVf_BREAK)
5247 /* this SV's refcnt has been artificially decremented to
5248 * trigger cleanup */
5250 if (PL_in_clean_all) /* All is fair */
5252 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5253 /* make sure SvREFCNT(sv)==0 happens very seldom */
5254 SvREFCNT(sv) = (~(U32)0)/2;
5257 if (ckWARN_d(WARN_INTERNAL)) {
5258 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5259 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5260 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5261 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5262 Perl_dump_sv_child(aTHX_ sv);
5267 if (--(SvREFCNT(sv)) > 0)
5269 Perl_sv_free2(aTHX_ sv);
5273 Perl_sv_free2(pTHX_ SV *sv)
5278 if (ckWARN_d(WARN_DEBUGGING))
5279 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5280 "Attempt to free temp prematurely: SV 0x%"UVxf
5281 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5285 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5286 /* make sure SvREFCNT(sv)==0 happens very seldom */
5287 SvREFCNT(sv) = (~(U32)0)/2;
5298 Returns the length of the string in the SV. Handles magic and type
5299 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5305 Perl_sv_len(pTHX_ register SV *sv)
5313 len = mg_length(sv);
5315 (void)SvPV_const(sv, len);
5320 =for apidoc sv_len_utf8
5322 Returns the number of characters in the string in an SV, counting wide
5323 UTF-8 bytes as a single character. Handles magic and type coercion.
5329 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5330 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5331 * (Note that the mg_len is not the length of the mg_ptr field.
5332 * This allows the cache to store the character length of the string without
5333 * needing to malloc() extra storage to attach to the mg_ptr.)
5338 Perl_sv_len_utf8(pTHX_ register SV *sv)
5344 return mg_length(sv);
5348 const U8 *s = (U8*)SvPV_const(sv, len);
5352 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5354 if (mg && mg->mg_len != -1) {
5356 if (PL_utf8cache < 0) {
5357 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5359 /* Need to turn the assertions off otherwise we may
5360 recurse infinitely while printing error messages.
5362 SAVEI8(PL_utf8cache);
5364 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5365 " real %"UVuf" for %"SVf,
5366 (UV) ulen, (UV) real, (void*)sv);
5371 ulen = Perl_utf8_length(aTHX_ s, s + len);
5372 if (!SvREADONLY(sv)) {
5374 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5375 &PL_vtbl_utf8, 0, 0);
5383 return Perl_utf8_length(aTHX_ s, s + len);
5387 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5390 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5393 const U8 *s = start;
5395 while (s < send && uoffset--)
5398 /* This is the existing behaviour. Possibly it should be a croak, as
5399 it's actually a bounds error */
5405 /* Given the length of the string in both bytes and UTF-8 characters, decide
5406 whether to walk forwards or backwards to find the byte corresponding to
5407 the passed in UTF-8 offset. */
5409 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5410 STRLEN uoffset, STRLEN uend)
5412 STRLEN backw = uend - uoffset;
5413 if (uoffset < 2 * backw) {
5414 /* The assumption is that going forwards is twice the speed of going
5415 forward (that's where the 2 * backw comes from).
5416 (The real figure of course depends on the UTF-8 data.) */
5417 return sv_pos_u2b_forwards(start, send, uoffset);
5422 while (UTF8_IS_CONTINUATION(*send))
5425 return send - start;
5428 /* For the string representation of the given scalar, find the byte
5429 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5430 give another position in the string, *before* the sought offset, which
5431 (which is always true, as 0, 0 is a valid pair of positions), which should
5432 help reduce the amount of linear searching.
5433 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5434 will be used to reduce the amount of linear searching. The cache will be
5435 created if necessary, and the found value offered to it for update. */
5437 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5438 const U8 *const send, STRLEN uoffset,
5439 STRLEN uoffset0, STRLEN boffset0) {
5440 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5443 assert (uoffset >= uoffset0);
5445 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5446 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5447 if ((*mgp)->mg_ptr) {
5448 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5449 if (cache[0] == uoffset) {
5450 /* An exact match. */
5453 if (cache[2] == uoffset) {
5454 /* An exact match. */
5458 if (cache[0] < uoffset) {
5459 /* The cache already knows part of the way. */
5460 if (cache[0] > uoffset0) {
5461 /* The cache knows more than the passed in pair */
5462 uoffset0 = cache[0];
5463 boffset0 = cache[1];
5465 if ((*mgp)->mg_len != -1) {
5466 /* And we know the end too. */
5468 + sv_pos_u2b_midway(start + boffset0, send,
5470 (*mgp)->mg_len - uoffset0);
5473 + sv_pos_u2b_forwards(start + boffset0,
5474 send, uoffset - uoffset0);
5477 else if (cache[2] < uoffset) {
5478 /* We're between the two cache entries. */
5479 if (cache[2] > uoffset0) {
5480 /* and the cache knows more than the passed in pair */
5481 uoffset0 = cache[2];
5482 boffset0 = cache[3];
5486 + sv_pos_u2b_midway(start + boffset0,
5489 cache[0] - uoffset0);
5492 + sv_pos_u2b_midway(start + boffset0,
5495 cache[2] - uoffset0);
5499 else if ((*mgp)->mg_len != -1) {
5500 /* If we can take advantage of a passed in offset, do so. */
5501 /* In fact, offset0 is either 0, or less than offset, so don't
5502 need to worry about the other possibility. */
5504 + sv_pos_u2b_midway(start + boffset0, send,
5506 (*mgp)->mg_len - uoffset0);
5511 if (!found || PL_utf8cache < 0) {
5512 const STRLEN real_boffset
5513 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5514 send, uoffset - uoffset0);
5516 if (found && PL_utf8cache < 0) {
5517 if (real_boffset != boffset) {
5518 /* Need to turn the assertions off otherwise we may recurse
5519 infinitely while printing error messages. */
5520 SAVEI8(PL_utf8cache);
5522 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5523 " real %"UVuf" for %"SVf,
5524 (UV) boffset, (UV) real_boffset, (void*)sv);
5527 boffset = real_boffset;
5530 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5536 =for apidoc sv_pos_u2b
5538 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5539 the start of the string, to a count of the equivalent number of bytes; if
5540 lenp is non-zero, it does the same to lenp, but this time starting from
5541 the offset, rather than from the start of the string. Handles magic and
5548 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5549 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5550 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5555 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5563 start = (U8*)SvPV_const(sv, len);
5565 STRLEN uoffset = (STRLEN) *offsetp;
5566 const U8 * const send = start + len;
5568 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5571 *offsetp = (I32) boffset;
5574 /* Convert the relative offset to absolute. */
5575 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5576 const STRLEN boffset2
5577 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5578 uoffset, boffset) - boffset;
5592 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5593 byte length pairing. The (byte) length of the total SV is passed in too,
5594 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5595 may not have updated SvCUR, so we can't rely on reading it directly.
5597 The proffered utf8/byte length pairing isn't used if the cache already has
5598 two pairs, and swapping either for the proffered pair would increase the
5599 RMS of the intervals between known byte offsets.
5601 The cache itself consists of 4 STRLEN values
5602 0: larger UTF-8 offset
5603 1: corresponding byte offset
5604 2: smaller UTF-8 offset
5605 3: corresponding byte offset
5607 Unused cache pairs have the value 0, 0.
5608 Keeping the cache "backwards" means that the invariant of
5609 cache[0] >= cache[2] is maintained even with empty slots, which means that
5610 the code that uses it doesn't need to worry if only 1 entry has actually
5611 been set to non-zero. It also makes the "position beyond the end of the
5612 cache" logic much simpler, as the first slot is always the one to start
5616 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5624 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5626 (*mgp)->mg_len = -1;
5630 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5631 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5632 (*mgp)->mg_ptr = (char *) cache;
5636 if (PL_utf8cache < 0) {
5637 const U8 *start = (const U8 *) SvPVX_const(sv);
5638 const STRLEN realutf8 = utf8_length(start, start + byte);
5640 if (realutf8 != utf8) {
5641 /* Need to turn the assertions off otherwise we may recurse
5642 infinitely while printing error messages. */
5643 SAVEI8(PL_utf8cache);
5645 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5646 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5650 /* Cache is held with the later position first, to simplify the code
5651 that deals with unbounded ends. */
5653 ASSERT_UTF8_CACHE(cache);
5654 if (cache[1] == 0) {
5655 /* Cache is totally empty */
5658 } else if (cache[3] == 0) {
5659 if (byte > cache[1]) {
5660 /* New one is larger, so goes first. */
5661 cache[2] = cache[0];
5662 cache[3] = cache[1];
5670 #define THREEWAY_SQUARE(a,b,c,d) \
5671 ((float)((d) - (c))) * ((float)((d) - (c))) \
5672 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5673 + ((float)((b) - (a))) * ((float)((b) - (a)))
5675 /* Cache has 2 slots in use, and we know three potential pairs.
5676 Keep the two that give the lowest RMS distance. Do the
5677 calcualation in bytes simply because we always know the byte
5678 length. squareroot has the same ordering as the positive value,
5679 so don't bother with the actual square root. */
5680 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5681 if (byte > cache[1]) {
5682 /* New position is after the existing pair of pairs. */
5683 const float keep_earlier
5684 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5685 const float keep_later
5686 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5688 if (keep_later < keep_earlier) {
5689 if (keep_later < existing) {
5690 cache[2] = cache[0];
5691 cache[3] = cache[1];
5697 if (keep_earlier < existing) {
5703 else if (byte > cache[3]) {
5704 /* New position is between the existing pair of pairs. */
5705 const float keep_earlier
5706 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5707 const float keep_later
5708 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5710 if (keep_later < keep_earlier) {
5711 if (keep_later < existing) {
5717 if (keep_earlier < existing) {
5724 /* New position is before the existing pair of pairs. */
5725 const float keep_earlier
5726 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5727 const float keep_later
5728 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5730 if (keep_later < keep_earlier) {
5731 if (keep_later < existing) {
5737 if (keep_earlier < existing) {
5738 cache[0] = cache[2];
5739 cache[1] = cache[3];
5746 ASSERT_UTF8_CACHE(cache);
5749 /* We already know all of the way, now we may be able to walk back. The same
5750 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5751 backward is half the speed of walking forward. */
5753 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5756 const STRLEN forw = target - s;
5757 STRLEN backw = end - target;
5759 if (forw < 2 * backw) {
5760 return utf8_length(s, target);
5763 while (end > target) {
5765 while (UTF8_IS_CONTINUATION(*end)) {
5774 =for apidoc sv_pos_b2u
5776 Converts the value pointed to by offsetp from a count of bytes from the
5777 start of the string, to a count of the equivalent number of UTF-8 chars.
5778 Handles magic and type coercion.
5784 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5785 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5790 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5793 const STRLEN byte = *offsetp;
5794 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5803 s = (const U8*)SvPV_const(sv, blen);
5806 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5810 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5811 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5813 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5814 if (cache[1] == byte) {
5815 /* An exact match. */
5816 *offsetp = cache[0];
5819 if (cache[3] == byte) {
5820 /* An exact match. */
5821 *offsetp = cache[2];
5825 if (cache[1] < byte) {
5826 /* We already know part of the way. */
5827 if (mg->mg_len != -1) {
5828 /* Actually, we know the end too. */
5830 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5831 s + blen, mg->mg_len - cache[0]);
5833 len = cache[0] + utf8_length(s + cache[1], send);
5836 else if (cache[3] < byte) {
5837 /* We're between the two cached pairs, so we do the calculation
5838 offset by the byte/utf-8 positions for the earlier pair,
5839 then add the utf-8 characters from the string start to
5841 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5842 s + cache[1], cache[0] - cache[2])
5846 else { /* cache[3] > byte */
5847 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5851 ASSERT_UTF8_CACHE(cache);
5853 } else if (mg->mg_len != -1) {
5854 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5858 if (!found || PL_utf8cache < 0) {
5859 const STRLEN real_len = utf8_length(s, send);
5861 if (found && PL_utf8cache < 0) {
5862 if (len != real_len) {
5863 /* Need to turn the assertions off otherwise we may recurse
5864 infinitely while printing error messages. */
5865 SAVEI8(PL_utf8cache);
5867 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5868 " real %"UVuf" for %"SVf,
5869 (UV) len, (UV) real_len, (void*)sv);
5876 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5882 Returns a boolean indicating whether the strings in the two SVs are
5883 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5884 coerce its args to strings if necessary.
5890 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5899 SV* svrecode = NULL;
5906 /* if pv1 and pv2 are the same, second SvPV_const call may
5907 * invalidate pv1, so we may need to make a copy */
5908 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5909 pv1 = SvPV_const(sv1, cur1);
5910 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5911 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5913 pv1 = SvPV_const(sv1, cur1);
5921 pv2 = SvPV_const(sv2, cur2);
5923 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5924 /* Differing utf8ness.
5925 * Do not UTF8size the comparands as a side-effect. */
5928 svrecode = newSVpvn(pv2, cur2);
5929 sv_recode_to_utf8(svrecode, PL_encoding);
5930 pv2 = SvPV_const(svrecode, cur2);
5933 svrecode = newSVpvn(pv1, cur1);
5934 sv_recode_to_utf8(svrecode, PL_encoding);
5935 pv1 = SvPV_const(svrecode, cur1);
5937 /* Now both are in UTF-8. */
5939 SvREFCNT_dec(svrecode);
5944 bool is_utf8 = TRUE;
5947 /* sv1 is the UTF-8 one,
5948 * if is equal it must be downgrade-able */
5949 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5955 /* sv2 is the UTF-8 one,
5956 * if is equal it must be downgrade-able */
5957 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5963 /* Downgrade not possible - cannot be eq */
5971 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5973 SvREFCNT_dec(svrecode);
5983 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5984 string in C<sv1> is less than, equal to, or greater than the string in
5985 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5986 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5992 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5996 const char *pv1, *pv2;
5999 SV *svrecode = NULL;
6006 pv1 = SvPV_const(sv1, cur1);
6013 pv2 = SvPV_const(sv2, cur2);
6015 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6016 /* Differing utf8ness.
6017 * Do not UTF8size the comparands as a side-effect. */
6020 svrecode = newSVpvn(pv2, cur2);
6021 sv_recode_to_utf8(svrecode, PL_encoding);
6022 pv2 = SvPV_const(svrecode, cur2);
6025 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6030 svrecode = newSVpvn(pv1, cur1);
6031 sv_recode_to_utf8(svrecode, PL_encoding);
6032 pv1 = SvPV_const(svrecode, cur1);
6035 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6041 cmp = cur2 ? -1 : 0;
6045 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6048 cmp = retval < 0 ? -1 : 1;
6049 } else if (cur1 == cur2) {
6052 cmp = cur1 < cur2 ? -1 : 1;
6056 SvREFCNT_dec(svrecode);
6064 =for apidoc sv_cmp_locale
6066 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6067 'use bytes' aware, handles get magic, and will coerce its args to strings
6068 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6074 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6077 #ifdef USE_LOCALE_COLLATE
6083 if (PL_collation_standard)
6087 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6089 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6091 if (!pv1 || !len1) {
6102 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6105 return retval < 0 ? -1 : 1;
6108 * When the result of collation is equality, that doesn't mean
6109 * that there are no differences -- some locales exclude some
6110 * characters from consideration. So to avoid false equalities,
6111 * we use the raw string as a tiebreaker.
6117 #endif /* USE_LOCALE_COLLATE */
6119 return sv_cmp(sv1, sv2);
6123 #ifdef USE_LOCALE_COLLATE
6126 =for apidoc sv_collxfrm
6128 Add Collate Transform magic to an SV if it doesn't already have it.
6130 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6131 scalar data of the variable, but transformed to such a format that a normal
6132 memory comparison can be used to compare the data according to the locale
6139 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6144 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6145 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6151 Safefree(mg->mg_ptr);
6152 s = SvPV_const(sv, len);
6153 if ((xf = mem_collxfrm(s, len, &xlen))) {
6154 if (SvREADONLY(sv)) {
6157 return xf + sizeof(PL_collation_ix);
6160 #ifdef PERL_OLD_COPY_ON_WRITE
6162 sv_force_normal_flags(sv, 0);
6164 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6178 if (mg && mg->mg_ptr) {
6180 return mg->mg_ptr + sizeof(PL_collation_ix);
6188 #endif /* USE_LOCALE_COLLATE */
6193 Get a line from the filehandle and store it into the SV, optionally
6194 appending to the currently-stored string.
6200 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6205 register STDCHAR rslast;
6206 register STDCHAR *bp;
6211 if (SvTHINKFIRST(sv))
6212 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6213 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6215 However, perlbench says it's slower, because the existing swipe code
6216 is faster than copy on write.
6217 Swings and roundabouts. */
6218 SvUPGRADE(sv, SVt_PV);
6223 if (PerlIO_isutf8(fp)) {
6225 sv_utf8_upgrade_nomg(sv);
6226 sv_pos_u2b(sv,&append,0);
6228 } else if (SvUTF8(sv)) {
6229 SV * const tsv = newSV(0);
6230 sv_gets(tsv, fp, 0);
6231 sv_utf8_upgrade_nomg(tsv);
6232 SvCUR_set(sv,append);
6235 goto return_string_or_null;
6240 if (PerlIO_isutf8(fp))
6243 if (IN_PERL_COMPILETIME) {
6244 /* we always read code in line mode */
6248 else if (RsSNARF(PL_rs)) {
6249 /* If it is a regular disk file use size from stat() as estimate
6250 of amount we are going to read -- may result in mallocing
6251 more memory than we really need if the layers below reduce
6252 the size we read (e.g. CRLF or a gzip layer).
6255 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6256 const Off_t offset = PerlIO_tell(fp);
6257 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6258 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6264 else if (RsRECORD(PL_rs)) {
6269 /* Grab the size of the record we're getting */
6270 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6271 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6274 /* VMS wants read instead of fread, because fread doesn't respect */
6275 /* RMS record boundaries. This is not necessarily a good thing to be */
6276 /* doing, but we've got no other real choice - except avoid stdio
6277 as implementation - perhaps write a :vms layer ?
6279 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6281 bytesread = PerlIO_read(fp, buffer, recsize);
6285 SvCUR_set(sv, bytesread += append);
6286 buffer[bytesread] = '\0';
6287 goto return_string_or_null;
6289 else if (RsPARA(PL_rs)) {
6295 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6296 if (PerlIO_isutf8(fp)) {
6297 rsptr = SvPVutf8(PL_rs, rslen);
6300 if (SvUTF8(PL_rs)) {
6301 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6302 Perl_croak(aTHX_ "Wide character in $/");
6305 rsptr = SvPV_const(PL_rs, rslen);
6309 rslast = rslen ? rsptr[rslen - 1] : '\0';
6311 if (rspara) { /* have to do this both before and after */
6312 do { /* to make sure file boundaries work right */
6315 i = PerlIO_getc(fp);
6319 PerlIO_ungetc(fp,i);
6325 /* See if we know enough about I/O mechanism to cheat it ! */
6327 /* This used to be #ifdef test - it is made run-time test for ease
6328 of abstracting out stdio interface. One call should be cheap
6329 enough here - and may even be a macro allowing compile
6333 if (PerlIO_fast_gets(fp)) {
6336 * We're going to steal some values from the stdio struct
6337 * and put EVERYTHING in the innermost loop into registers.
6339 register STDCHAR *ptr;
6343 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6344 /* An ungetc()d char is handled separately from the regular
6345 * buffer, so we getc() it back out and stuff it in the buffer.
6347 i = PerlIO_getc(fp);
6348 if (i == EOF) return 0;
6349 *(--((*fp)->_ptr)) = (unsigned char) i;
6353 /* Here is some breathtakingly efficient cheating */
6355 cnt = PerlIO_get_cnt(fp); /* get count into register */
6356 /* make sure we have the room */
6357 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6358 /* Not room for all of it
6359 if we are looking for a separator and room for some
6361 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6362 /* just process what we have room for */
6363 shortbuffered = cnt - SvLEN(sv) + append + 1;
6364 cnt -= shortbuffered;
6368 /* remember that cnt can be negative */
6369 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6374 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6375 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6376 DEBUG_P(PerlIO_printf(Perl_debug_log,
6377 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6378 DEBUG_P(PerlIO_printf(Perl_debug_log,
6379 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6380 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6381 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6386 while (cnt > 0) { /* this | eat */
6388 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6389 goto thats_all_folks; /* screams | sed :-) */
6393 Copy(ptr, bp, cnt, char); /* this | eat */
6394 bp += cnt; /* screams | dust */
6395 ptr += cnt; /* louder | sed :-) */
6400 if (shortbuffered) { /* oh well, must extend */
6401 cnt = shortbuffered;
6403 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6405 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6406 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6410 DEBUG_P(PerlIO_printf(Perl_debug_log,
6411 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6412 PTR2UV(ptr),(long)cnt));
6413 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6415 DEBUG_P(PerlIO_printf(Perl_debug_log,
6416 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6417 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6418 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6420 /* This used to call 'filbuf' in stdio form, but as that behaves like
6421 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6422 another abstraction. */
6423 i = PerlIO_getc(fp); /* get more characters */
6425 DEBUG_P(PerlIO_printf(Perl_debug_log,
6426 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6427 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6428 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6430 cnt = PerlIO_get_cnt(fp);
6431 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6432 DEBUG_P(PerlIO_printf(Perl_debug_log,
6433 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6435 if (i == EOF) /* all done for ever? */
6436 goto thats_really_all_folks;
6438 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6440 SvGROW(sv, bpx + cnt + 2);
6441 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6443 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6445 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6446 goto thats_all_folks;
6450 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6451 memNE((char*)bp - rslen, rsptr, rslen))
6452 goto screamer; /* go back to the fray */
6453 thats_really_all_folks:
6455 cnt += shortbuffered;
6456 DEBUG_P(PerlIO_printf(Perl_debug_log,
6457 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6458 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6459 DEBUG_P(PerlIO_printf(Perl_debug_log,
6460 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6461 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6462 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6464 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: done, len=%ld, string=|%.*s|\n",
6467 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6471 /*The big, slow, and stupid way. */
6472 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6473 STDCHAR *buf = NULL;
6474 Newx(buf, 8192, STDCHAR);
6482 register const STDCHAR * const bpe = buf + sizeof(buf);
6484 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6485 ; /* keep reading */
6489 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6490 /* Accomodate broken VAXC compiler, which applies U8 cast to
6491 * both args of ?: operator, causing EOF to change into 255
6494 i = (U8)buf[cnt - 1];
6500 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6502 sv_catpvn(sv, (char *) buf, cnt);
6504 sv_setpvn(sv, (char *) buf, cnt);
6506 if (i != EOF && /* joy */
6508 SvCUR(sv) < rslen ||
6509 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6513 * If we're reading from a TTY and we get a short read,
6514 * indicating that the user hit his EOF character, we need
6515 * to notice it now, because if we try to read from the TTY
6516 * again, the EOF condition will disappear.
6518 * The comparison of cnt to sizeof(buf) is an optimization
6519 * that prevents unnecessary calls to feof().
6523 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6527 #ifdef USE_HEAP_INSTEAD_OF_STACK
6532 if (rspara) { /* have to do this both before and after */
6533 while (i != EOF) { /* to make sure file boundaries work right */
6534 i = PerlIO_getc(fp);
6536 PerlIO_ungetc(fp,i);
6542 return_string_or_null:
6543 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6549 Auto-increment of the value in the SV, doing string to numeric conversion
6550 if necessary. Handles 'get' magic.
6556 Perl_sv_inc(pTHX_ register SV *sv)
6565 if (SvTHINKFIRST(sv)) {
6567 sv_force_normal_flags(sv, 0);
6568 if (SvREADONLY(sv)) {
6569 if (IN_PERL_RUNTIME)
6570 Perl_croak(aTHX_ PL_no_modify);
6574 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6576 i = PTR2IV(SvRV(sv));
6581 flags = SvFLAGS(sv);
6582 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6583 /* It's (privately or publicly) a float, but not tested as an
6584 integer, so test it to see. */
6586 flags = SvFLAGS(sv);
6588 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6589 /* It's publicly an integer, or privately an integer-not-float */
6590 #ifdef PERL_PRESERVE_IVUV
6594 if (SvUVX(sv) == UV_MAX)
6595 sv_setnv(sv, UV_MAX_P1);
6597 (void)SvIOK_only_UV(sv);
6598 SvUV_set(sv, SvUVX(sv) + 1);
6600 if (SvIVX(sv) == IV_MAX)
6601 sv_setuv(sv, (UV)IV_MAX + 1);
6603 (void)SvIOK_only(sv);
6604 SvIV_set(sv, SvIVX(sv) + 1);
6609 if (flags & SVp_NOK) {
6610 (void)SvNOK_only(sv);
6611 SvNV_set(sv, SvNVX(sv) + 1.0);
6615 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6616 if ((flags & SVTYPEMASK) < SVt_PVIV)
6617 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6618 (void)SvIOK_only(sv);
6623 while (isALPHA(*d)) d++;
6624 while (isDIGIT(*d)) d++;
6626 #ifdef PERL_PRESERVE_IVUV
6627 /* Got to punt this as an integer if needs be, but we don't issue
6628 warnings. Probably ought to make the sv_iv_please() that does
6629 the conversion if possible, and silently. */
6630 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6631 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6632 /* Need to try really hard to see if it's an integer.
6633 9.22337203685478e+18 is an integer.
6634 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6635 so $a="9.22337203685478e+18"; $a+0; $a++
6636 needs to be the same as $a="9.22337203685478e+18"; $a++
6643 /* sv_2iv *should* have made this an NV */
6644 if (flags & SVp_NOK) {
6645 (void)SvNOK_only(sv);
6646 SvNV_set(sv, SvNVX(sv) + 1.0);
6649 /* I don't think we can get here. Maybe I should assert this
6650 And if we do get here I suspect that sv_setnv will croak. NWC
6652 #if defined(USE_LONG_DOUBLE)
6653 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",
6654 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6656 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6657 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6660 #endif /* PERL_PRESERVE_IVUV */
6661 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6665 while (d >= SvPVX_const(sv)) {
6673 /* MKS: The original code here died if letters weren't consecutive.
6674 * at least it didn't have to worry about non-C locales. The
6675 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6676 * arranged in order (although not consecutively) and that only
6677 * [A-Za-z] are accepted by isALPHA in the C locale.
6679 if (*d != 'z' && *d != 'Z') {
6680 do { ++*d; } while (!isALPHA(*d));
6683 *(d--) -= 'z' - 'a';
6688 *(d--) -= 'z' - 'a' + 1;
6692 /* oh,oh, the number grew */
6693 SvGROW(sv, SvCUR(sv) + 2);
6694 SvCUR_set(sv, SvCUR(sv) + 1);
6695 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6706 Auto-decrement of the value in the SV, doing string to numeric conversion
6707 if necessary. Handles 'get' magic.
6713 Perl_sv_dec(pTHX_ register SV *sv)
6721 if (SvTHINKFIRST(sv)) {
6723 sv_force_normal_flags(sv, 0);
6724 if (SvREADONLY(sv)) {
6725 if (IN_PERL_RUNTIME)
6726 Perl_croak(aTHX_ PL_no_modify);
6730 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6732 i = PTR2IV(SvRV(sv));
6737 /* Unlike sv_inc we don't have to worry about string-never-numbers
6738 and keeping them magic. But we mustn't warn on punting */
6739 flags = SvFLAGS(sv);
6740 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6741 /* It's publicly an integer, or privately an integer-not-float */
6742 #ifdef PERL_PRESERVE_IVUV
6746 if (SvUVX(sv) == 0) {
6747 (void)SvIOK_only(sv);
6751 (void)SvIOK_only_UV(sv);
6752 SvUV_set(sv, SvUVX(sv) - 1);
6755 if (SvIVX(sv) == IV_MIN)
6756 sv_setnv(sv, (NV)IV_MIN - 1.0);
6758 (void)SvIOK_only(sv);
6759 SvIV_set(sv, SvIVX(sv) - 1);
6764 if (flags & SVp_NOK) {
6765 SvNV_set(sv, SvNVX(sv) - 1.0);
6766 (void)SvNOK_only(sv);
6769 if (!(flags & SVp_POK)) {
6770 if ((flags & SVTYPEMASK) < SVt_PVIV)
6771 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6773 (void)SvIOK_only(sv);
6776 #ifdef PERL_PRESERVE_IVUV
6778 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6779 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6780 /* Need to try really hard to see if it's an integer.
6781 9.22337203685478e+18 is an integer.
6782 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6783 so $a="9.22337203685478e+18"; $a+0; $a--
6784 needs to be the same as $a="9.22337203685478e+18"; $a--
6791 /* sv_2iv *should* have made this an NV */
6792 if (flags & SVp_NOK) {
6793 (void)SvNOK_only(sv);
6794 SvNV_set(sv, SvNVX(sv) - 1.0);
6797 /* I don't think we can get here. Maybe I should assert this
6798 And if we do get here I suspect that sv_setnv will croak. NWC
6800 #if defined(USE_LONG_DOUBLE)
6801 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",
6802 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6804 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6805 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6809 #endif /* PERL_PRESERVE_IVUV */
6810 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6814 =for apidoc sv_mortalcopy
6816 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6817 The new SV is marked as mortal. It will be destroyed "soon", either by an
6818 explicit call to FREETMPS, or by an implicit call at places such as
6819 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6824 /* Make a string that will exist for the duration of the expression
6825 * evaluation. Actually, it may have to last longer than that, but
6826 * hopefully we won't free it until it has been assigned to a
6827 * permanent location. */
6830 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6836 sv_setsv(sv,oldstr);
6838 PL_tmps_stack[++PL_tmps_ix] = sv;
6844 =for apidoc sv_newmortal
6846 Creates a new null SV which is mortal. The reference count of the SV is
6847 set to 1. It will be destroyed "soon", either by an explicit call to
6848 FREETMPS, or by an implicit call at places such as statement boundaries.
6849 See also C<sv_mortalcopy> and C<sv_2mortal>.
6855 Perl_sv_newmortal(pTHX)
6861 SvFLAGS(sv) = SVs_TEMP;
6863 PL_tmps_stack[++PL_tmps_ix] = sv;
6868 =for apidoc sv_2mortal
6870 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6871 by an explicit call to FREETMPS, or by an implicit call at places such as
6872 statement boundaries. SvTEMP() is turned on which means that the SV's
6873 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6874 and C<sv_mortalcopy>.
6880 Perl_sv_2mortal(pTHX_ register SV *sv)
6885 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6888 PL_tmps_stack[++PL_tmps_ix] = sv;
6896 Creates a new SV and copies a string into it. The reference count for the
6897 SV is set to 1. If C<len> is zero, Perl will compute the length using
6898 strlen(). For efficiency, consider using C<newSVpvn> instead.
6904 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6910 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6915 =for apidoc newSVpvn
6917 Creates a new SV and copies a string into it. The reference count for the
6918 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6919 string. You are responsible for ensuring that the source string is at least
6920 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6926 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6932 sv_setpvn(sv,s,len);
6938 =for apidoc newSVhek
6940 Creates a new SV from the hash key structure. It will generate scalars that
6941 point to the shared string table where possible. Returns a new (undefined)
6942 SV if the hek is NULL.
6948 Perl_newSVhek(pTHX_ const HEK *hek)
6958 if (HEK_LEN(hek) == HEf_SVKEY) {
6959 return newSVsv(*(SV**)HEK_KEY(hek));
6961 const int flags = HEK_FLAGS(hek);
6962 if (flags & HVhek_WASUTF8) {
6964 Andreas would like keys he put in as utf8 to come back as utf8
6966 STRLEN utf8_len = HEK_LEN(hek);
6967 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6968 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6971 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6973 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6974 /* We don't have a pointer to the hv, so we have to replicate the
6975 flag into every HEK. This hv is using custom a hasing
6976 algorithm. Hence we can't return a shared string scalar, as
6977 that would contain the (wrong) hash value, and might get passed
6978 into an hv routine with a regular hash.
6979 Similarly, a hash that isn't using shared hash keys has to have
6980 the flag in every key so that we know not to try to call
6981 share_hek_kek on it. */
6983 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6988 /* This will be overwhelminly the most common case. */
6990 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6991 more efficient than sharepvn(). */
6995 sv_upgrade(sv, SVt_PV);
6996 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
6997 SvCUR_set(sv, HEK_LEN(hek));
7010 =for apidoc newSVpvn_share
7012 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7013 table. If the string does not already exist in the table, it is created
7014 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7015 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7016 otherwise the hash is computed. The idea here is that as the string table
7017 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7018 hash lookup will avoid string compare.
7024 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7028 bool is_utf8 = FALSE;
7029 const char *const orig_src = src;
7032 STRLEN tmplen = -len;
7034 /* See the note in hv.c:hv_fetch() --jhi */
7035 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7039 PERL_HASH(hash, src, len);
7041 sv_upgrade(sv, SVt_PV);
7042 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7050 if (src != orig_src)
7056 #if defined(PERL_IMPLICIT_CONTEXT)
7058 /* pTHX_ magic can't cope with varargs, so this is a no-context
7059 * version of the main function, (which may itself be aliased to us).
7060 * Don't access this version directly.
7064 Perl_newSVpvf_nocontext(const char* pat, ...)
7069 va_start(args, pat);
7070 sv = vnewSVpvf(pat, &args);
7077 =for apidoc newSVpvf
7079 Creates a new SV and initializes it with the string formatted like
7086 Perl_newSVpvf(pTHX_ const char* pat, ...)
7090 va_start(args, pat);
7091 sv = vnewSVpvf(pat, &args);
7096 /* backend for newSVpvf() and newSVpvf_nocontext() */
7099 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7104 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7111 Creates a new SV and copies a floating point value into it.
7112 The reference count for the SV is set to 1.
7118 Perl_newSVnv(pTHX_ NV n)
7131 Creates a new SV and copies an integer into it. The reference count for the
7138 Perl_newSViv(pTHX_ IV i)
7151 Creates a new SV and copies an unsigned integer into it.
7152 The reference count for the SV is set to 1.
7158 Perl_newSVuv(pTHX_ UV u)
7169 =for apidoc newRV_noinc
7171 Creates an RV wrapper for an SV. The reference count for the original
7172 SV is B<not> incremented.
7178 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7184 sv_upgrade(sv, SVt_RV);
7186 SvRV_set(sv, tmpRef);
7191 /* newRV_inc is the official function name to use now.
7192 * newRV_inc is in fact #defined to newRV in sv.h
7196 Perl_newRV(pTHX_ SV *sv)
7199 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7205 Creates a new SV which is an exact duplicate of the original SV.
7212 Perl_newSVsv(pTHX_ register SV *old)
7219 if (SvTYPE(old) == SVTYPEMASK) {
7220 if (ckWARN_d(WARN_INTERNAL))
7221 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7225 /* SV_GMAGIC is the default for sv_setv()
7226 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7227 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7228 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7233 =for apidoc sv_reset
7235 Underlying implementation for the C<reset> Perl function.
7236 Note that the perl-level function is vaguely deprecated.
7242 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7245 char todo[PERL_UCHAR_MAX+1];
7250 if (!*s) { /* reset ?? searches */
7251 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7253 PMOP *pm = (PMOP *) mg->mg_obj;
7255 pm->op_pmdynflags &= ~PMdf_USED;
7262 /* reset variables */
7264 if (!HvARRAY(stash))
7267 Zero(todo, 256, char);
7270 I32 i = (unsigned char)*s;
7274 max = (unsigned char)*s++;
7275 for ( ; i <= max; i++) {
7278 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7280 for (entry = HvARRAY(stash)[i];
7282 entry = HeNEXT(entry))
7287 if (!todo[(U8)*HeKEY(entry)])
7289 gv = (GV*)HeVAL(entry);
7292 if (SvTHINKFIRST(sv)) {
7293 if (!SvREADONLY(sv) && SvROK(sv))
7295 /* XXX Is this continue a bug? Why should THINKFIRST
7296 exempt us from resetting arrays and hashes? */
7300 if (SvTYPE(sv) >= SVt_PV) {
7302 if (SvPVX_const(sv) != NULL)
7310 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7312 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7315 # if defined(USE_ENVIRON_ARRAY)
7318 # endif /* USE_ENVIRON_ARRAY */
7329 Using various gambits, try to get an IO from an SV: the IO slot if its a
7330 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7331 named after the PV if we're a string.
7337 Perl_sv_2io(pTHX_ SV *sv)
7342 switch (SvTYPE(sv)) {
7350 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7354 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7356 return sv_2io(SvRV(sv));
7357 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7363 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7372 Using various gambits, try to get a CV from an SV; in addition, try if
7373 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7374 The flags in C<lref> are passed to sv_fetchsv.
7380 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7391 switch (SvTYPE(sv)) {
7410 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7411 tryAMAGICunDEREF(to_cv);
7414 if (SvTYPE(sv) == SVt_PVCV) {
7423 Perl_croak(aTHX_ "Not a subroutine reference");
7428 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7434 /* Some flags to gv_fetchsv mean don't really create the GV */
7435 if (SvTYPE(gv) != SVt_PVGV) {
7441 if (lref && !GvCVu(gv)) {
7445 gv_efullname3(tmpsv, gv, NULL);
7446 /* XXX this is probably not what they think they're getting.
7447 * It has the same effect as "sub name;", i.e. just a forward
7449 newSUB(start_subparse(FALSE, 0),
7450 newSVOP(OP_CONST, 0, tmpsv),
7454 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7464 Returns true if the SV has a true value by Perl's rules.
7465 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7466 instead use an in-line version.
7472 Perl_sv_true(pTHX_ register SV *sv)
7477 register const XPV* const tXpv = (XPV*)SvANY(sv);
7479 (tXpv->xpv_cur > 1 ||
7480 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7487 return SvIVX(sv) != 0;
7490 return SvNVX(sv) != 0.0;
7492 return sv_2bool(sv);
7498 =for apidoc sv_pvn_force
7500 Get a sensible string out of the SV somehow.
7501 A private implementation of the C<SvPV_force> macro for compilers which
7502 can't cope with complex macro expressions. Always use the macro instead.
7504 =for apidoc sv_pvn_force_flags
7506 Get a sensible string out of the SV somehow.
7507 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7508 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7509 implemented in terms of this function.
7510 You normally want to use the various wrapper macros instead: see
7511 C<SvPV_force> and C<SvPV_force_nomg>
7517 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7520 if (SvTHINKFIRST(sv) && !SvROK(sv))
7521 sv_force_normal_flags(sv, 0);
7531 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7532 const char * const ref = sv_reftype(sv,0);
7534 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7535 ref, OP_NAME(PL_op));
7537 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7539 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7540 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7542 s = sv_2pv_flags(sv, &len, flags);
7546 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7549 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7550 SvGROW(sv, len + 1);
7551 Move(s,SvPVX(sv),len,char);
7556 SvPOK_on(sv); /* validate pointer */
7558 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7559 PTR2UV(sv),SvPVX_const(sv)));
7562 return SvPVX_mutable(sv);
7566 =for apidoc sv_pvbyten_force
7568 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7574 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7576 sv_pvn_force(sv,lp);
7577 sv_utf8_downgrade(sv,0);
7583 =for apidoc sv_pvutf8n_force
7585 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7591 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7593 sv_pvn_force(sv,lp);
7594 sv_utf8_upgrade(sv);
7600 =for apidoc sv_reftype
7602 Returns a string describing what the SV is a reference to.
7608 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7610 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7611 inside return suggests a const propagation bug in g++. */
7612 if (ob && SvOBJECT(sv)) {
7613 char * const name = HvNAME_get(SvSTASH(sv));
7614 return name ? name : (char *) "__ANON__";
7617 switch (SvTYPE(sv)) {
7634 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7635 /* tied lvalues should appear to be
7636 * scalars for backwards compatitbility */
7637 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7638 ? "SCALAR" : "LVALUE");
7639 case SVt_PVAV: return "ARRAY";
7640 case SVt_PVHV: return "HASH";
7641 case SVt_PVCV: return "CODE";
7642 case SVt_PVGV: return "GLOB";
7643 case SVt_PVFM: return "FORMAT";
7644 case SVt_PVIO: return "IO";
7645 default: return "UNKNOWN";
7651 =for apidoc sv_isobject
7653 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7654 object. If the SV is not an RV, or if the object is not blessed, then this
7661 Perl_sv_isobject(pTHX_ SV *sv)
7677 Returns a boolean indicating whether the SV is blessed into the specified
7678 class. This does not check for subtypes; use C<sv_derived_from> to verify
7679 an inheritance relationship.
7685 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7696 hvname = HvNAME_get(SvSTASH(sv));
7700 return strEQ(hvname, name);
7706 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7707 it will be upgraded to one. If C<classname> is non-null then the new SV will
7708 be blessed in the specified package. The new SV is returned and its
7709 reference count is 1.
7715 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7722 SV_CHECK_THINKFIRST_COW_DROP(rv);
7725 if (SvTYPE(rv) >= SVt_PVMG) {
7726 const U32 refcnt = SvREFCNT(rv);
7730 SvREFCNT(rv) = refcnt;
7732 sv_upgrade(rv, SVt_RV);
7733 } else if (SvROK(rv)) {
7734 SvREFCNT_dec(SvRV(rv));
7735 } else if (SvTYPE(rv) < SVt_RV)
7736 sv_upgrade(rv, SVt_RV);
7737 else if (SvTYPE(rv) > SVt_RV) {
7748 HV* const stash = gv_stashpv(classname, TRUE);
7749 (void)sv_bless(rv, stash);
7755 =for apidoc sv_setref_pv
7757 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7758 argument will be upgraded to an RV. That RV will be modified to point to
7759 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7760 into the SV. The C<classname> argument indicates the package for the
7761 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7762 will have a reference count of 1, and the RV will be returned.
7764 Do not use with other Perl types such as HV, AV, SV, CV, because those
7765 objects will become corrupted by the pointer copy process.
7767 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7773 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7777 sv_setsv(rv, &PL_sv_undef);
7781 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7786 =for apidoc sv_setref_iv
7788 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7789 argument will be upgraded to an RV. That RV will be modified to point to
7790 the new SV. The C<classname> argument indicates the package for the
7791 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7792 will have a reference count of 1, and the RV will be returned.
7798 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7800 sv_setiv(newSVrv(rv,classname), iv);
7805 =for apidoc sv_setref_uv
7807 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7808 argument will be upgraded to an RV. That RV will be modified to point to
7809 the new SV. The C<classname> argument indicates the package for the
7810 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7811 will have a reference count of 1, and the RV will be returned.
7817 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7819 sv_setuv(newSVrv(rv,classname), uv);
7824 =for apidoc sv_setref_nv
7826 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7827 argument will be upgraded to an RV. That RV will be modified to point to
7828 the new SV. The C<classname> argument indicates the package for the
7829 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7830 will have a reference count of 1, and the RV will be returned.
7836 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7838 sv_setnv(newSVrv(rv,classname), nv);
7843 =for apidoc sv_setref_pvn
7845 Copies a string into a new SV, optionally blessing the SV. The length of the
7846 string must be specified with C<n>. The C<rv> argument will be upgraded to
7847 an RV. That RV will be modified to point to the new SV. The C<classname>
7848 argument indicates the package for the blessing. Set C<classname> to
7849 C<NULL> to avoid the blessing. The new SV will have a reference count
7850 of 1, and the RV will be returned.
7852 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7858 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7860 sv_setpvn(newSVrv(rv,classname), pv, n);
7865 =for apidoc sv_bless
7867 Blesses an SV into a specified package. The SV must be an RV. The package
7868 must be designated by its stash (see C<gv_stashpv()>). The reference count
7869 of the SV is unaffected.
7875 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7880 Perl_croak(aTHX_ "Can't bless non-reference value");
7882 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7883 if (SvREADONLY(tmpRef))
7884 Perl_croak(aTHX_ PL_no_modify);
7885 if (SvOBJECT(tmpRef)) {
7886 if (SvTYPE(tmpRef) != SVt_PVIO)
7888 SvREFCNT_dec(SvSTASH(tmpRef));
7891 SvOBJECT_on(tmpRef);
7892 if (SvTYPE(tmpRef) != SVt_PVIO)
7894 SvUPGRADE(tmpRef, SVt_PVMG);
7895 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7902 if(SvSMAGICAL(tmpRef))
7903 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7911 /* Downgrades a PVGV to a PVMG.
7915 S_sv_unglob(pTHX_ SV *sv)
7919 SV * const temp = sv_newmortal();
7921 assert(SvTYPE(sv) == SVt_PVGV);
7923 gv_efullname3(temp, (GV *) sv, "*");
7929 sv_del_backref((SV*)GvSTASH(sv), sv);
7933 if (GvNAME_HEK(sv)) {
7934 unshare_hek(GvNAME_HEK(sv));
7938 /* need to keep SvANY(sv) in the right arena */
7939 xpvmg = new_XPVMG();
7940 StructCopy(SvANY(sv), xpvmg, XPVMG);
7941 del_XPVGV(SvANY(sv));
7944 SvFLAGS(sv) &= ~SVTYPEMASK;
7945 SvFLAGS(sv) |= SVt_PVMG;
7947 /* Intentionally not calling any local SET magic, as this isn't so much a
7948 set operation as merely an internal storage change. */
7949 sv_setsv_flags(sv, temp, 0);
7953 =for apidoc sv_unref_flags
7955 Unsets the RV status of the SV, and decrements the reference count of
7956 whatever was being referenced by the RV. This can almost be thought of
7957 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7958 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7959 (otherwise the decrementing is conditional on the reference count being
7960 different from one or the reference being a readonly SV).
7967 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7969 SV* const target = SvRV(ref);
7971 if (SvWEAKREF(ref)) {
7972 sv_del_backref(target, ref);
7974 SvRV_set(ref, NULL);
7977 SvRV_set(ref, NULL);
7979 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7980 assigned to as BEGIN {$a = \"Foo"} will fail. */
7981 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7982 SvREFCNT_dec(target);
7983 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7984 sv_2mortal(target); /* Schedule for freeing later */
7988 =for apidoc sv_untaint
7990 Untaint an SV. Use C<SvTAINTED_off> instead.
7995 Perl_sv_untaint(pTHX_ SV *sv)
7997 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7998 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8005 =for apidoc sv_tainted
8007 Test an SV for taintedness. Use C<SvTAINTED> instead.
8012 Perl_sv_tainted(pTHX_ SV *sv)
8014 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8015 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8016 if (mg && (mg->mg_len & 1) )
8023 =for apidoc sv_setpviv
8025 Copies an integer into the given SV, also updating its string value.
8026 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8032 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8034 char buf[TYPE_CHARS(UV)];
8036 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8038 sv_setpvn(sv, ptr, ebuf - ptr);
8042 =for apidoc sv_setpviv_mg
8044 Like C<sv_setpviv>, but also handles 'set' magic.
8050 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8056 #if defined(PERL_IMPLICIT_CONTEXT)
8058 /* pTHX_ magic can't cope with varargs, so this is a no-context
8059 * version of the main function, (which may itself be aliased to us).
8060 * Don't access this version directly.
8064 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8068 va_start(args, pat);
8069 sv_vsetpvf(sv, pat, &args);
8073 /* pTHX_ magic can't cope with varargs, so this is a no-context
8074 * version of the main function, (which may itself be aliased to us).
8075 * Don't access this version directly.
8079 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8083 va_start(args, pat);
8084 sv_vsetpvf_mg(sv, pat, &args);
8090 =for apidoc sv_setpvf
8092 Works like C<sv_catpvf> but copies the text into the SV instead of
8093 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8099 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8102 va_start(args, pat);
8103 sv_vsetpvf(sv, pat, &args);
8108 =for apidoc sv_vsetpvf
8110 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8111 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8113 Usually used via its frontend C<sv_setpvf>.
8119 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8121 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8125 =for apidoc sv_setpvf_mg
8127 Like C<sv_setpvf>, but also handles 'set' magic.
8133 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8136 va_start(args, pat);
8137 sv_vsetpvf_mg(sv, pat, &args);
8142 =for apidoc sv_vsetpvf_mg
8144 Like C<sv_vsetpvf>, but also handles 'set' magic.
8146 Usually used via its frontend C<sv_setpvf_mg>.
8152 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8154 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8158 #if defined(PERL_IMPLICIT_CONTEXT)
8160 /* pTHX_ magic can't cope with varargs, so this is a no-context
8161 * version of the main function, (which may itself be aliased to us).
8162 * Don't access this version directly.
8166 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8170 va_start(args, pat);
8171 sv_vcatpvf(sv, pat, &args);
8175 /* pTHX_ magic can't cope with varargs, so this is a no-context
8176 * version of the main function, (which may itself be aliased to us).
8177 * Don't access this version directly.
8181 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8185 va_start(args, pat);
8186 sv_vcatpvf_mg(sv, pat, &args);
8192 =for apidoc sv_catpvf
8194 Processes its arguments like C<sprintf> and appends the formatted
8195 output to an SV. If the appended data contains "wide" characters
8196 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8197 and characters >255 formatted with %c), the original SV might get
8198 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8199 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8200 valid UTF-8; if the original SV was bytes, the pattern should be too.
8205 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8208 va_start(args, pat);
8209 sv_vcatpvf(sv, pat, &args);
8214 =for apidoc sv_vcatpvf
8216 Processes its arguments like C<vsprintf> and appends the formatted output
8217 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8219 Usually used via its frontend C<sv_catpvf>.
8225 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8227 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8231 =for apidoc sv_catpvf_mg
8233 Like C<sv_catpvf>, but also handles 'set' magic.
8239 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8242 va_start(args, pat);
8243 sv_vcatpvf_mg(sv, pat, &args);
8248 =for apidoc sv_vcatpvf_mg
8250 Like C<sv_vcatpvf>, but also handles 'set' magic.
8252 Usually used via its frontend C<sv_catpvf_mg>.
8258 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8260 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8265 =for apidoc sv_vsetpvfn
8267 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8270 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8276 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8278 sv_setpvn(sv, "", 0);
8279 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8283 S_expect_number(pTHX_ char** pattern)
8287 switch (**pattern) {
8288 case '1': case '2': case '3':
8289 case '4': case '5': case '6':
8290 case '7': case '8': case '9':
8291 var = *(*pattern)++ - '0';
8292 while (isDIGIT(**pattern)) {
8293 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8295 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8303 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8305 const int neg = nv < 0;
8314 if (uv & 1 && uv == nv)
8315 uv--; /* Round to even */
8317 const unsigned dig = uv % 10;
8330 =for apidoc sv_vcatpvfn
8332 Processes its arguments like C<vsprintf> and appends the formatted output
8333 to an SV. Uses an array of SVs if the C style variable argument list is
8334 missing (NULL). When running with taint checks enabled, indicates via
8335 C<maybe_tainted> if results are untrustworthy (often due to the use of
8338 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8344 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8345 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8346 vec_utf8 = DO_UTF8(vecsv);
8348 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8351 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8359 static const char nullstr[] = "(null)";
8361 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8362 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8364 /* Times 4: a decimal digit takes more than 3 binary digits.
8365 * NV_DIG: mantissa takes than many decimal digits.
8366 * Plus 32: Playing safe. */
8367 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8368 /* large enough for "%#.#f" --chip */
8369 /* what about long double NVs? --jhi */
8371 PERL_UNUSED_ARG(maybe_tainted);
8373 /* no matter what, this is a string now */
8374 (void)SvPV_force(sv, origlen);
8376 /* special-case "", "%s", and "%-p" (SVf - see below) */
8379 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8381 const char * const s = va_arg(*args, char*);
8382 sv_catpv(sv, s ? s : nullstr);
8384 else if (svix < svmax) {
8385 sv_catsv(sv, *svargs);
8389 if (args && patlen == 3 && pat[0] == '%' &&
8390 pat[1] == '-' && pat[2] == 'p') {
8391 argsv = va_arg(*args, SV*);
8392 sv_catsv(sv, argsv);
8396 #ifndef USE_LONG_DOUBLE
8397 /* special-case "%.<number>[gf]" */
8398 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8399 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8400 unsigned digits = 0;
8404 while (*pp >= '0' && *pp <= '9')
8405 digits = 10 * digits + (*pp++ - '0');
8406 if (pp - pat == (int)patlen - 1) {
8414 /* Add check for digits != 0 because it seems that some
8415 gconverts are buggy in this case, and we don't yet have
8416 a Configure test for this. */
8417 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8418 /* 0, point, slack */
8419 Gconvert(nv, (int)digits, 0, ebuf);
8421 if (*ebuf) /* May return an empty string for digits==0 */
8424 } else if (!digits) {
8427 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8428 sv_catpvn(sv, p, l);
8434 #endif /* !USE_LONG_DOUBLE */
8436 if (!args && svix < svmax && DO_UTF8(*svargs))
8439 patend = (char*)pat + patlen;
8440 for (p = (char*)pat; p < patend; p = q) {
8443 bool vectorize = FALSE;
8444 bool vectorarg = FALSE;
8445 bool vec_utf8 = FALSE;
8451 bool has_precis = FALSE;
8453 const I32 osvix = svix;
8454 bool is_utf8 = FALSE; /* is this item utf8? */
8455 #ifdef HAS_LDBL_SPRINTF_BUG
8456 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8457 with sfio - Allen <allens@cpan.org> */
8458 bool fix_ldbl_sprintf_bug = FALSE;
8462 U8 utf8buf[UTF8_MAXBYTES+1];
8463 STRLEN esignlen = 0;
8465 const char *eptr = NULL;
8468 const U8 *vecstr = NULL;
8475 /* we need a long double target in case HAS_LONG_DOUBLE but
8478 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8486 const char *dotstr = ".";
8487 STRLEN dotstrlen = 1;
8488 I32 efix = 0; /* explicit format parameter index */
8489 I32 ewix = 0; /* explicit width index */
8490 I32 epix = 0; /* explicit precision index */
8491 I32 evix = 0; /* explicit vector index */
8492 bool asterisk = FALSE;
8494 /* echo everything up to the next format specification */
8495 for (q = p; q < patend && *q != '%'; ++q) ;
8497 if (has_utf8 && !pat_utf8)
8498 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8500 sv_catpvn(sv, p, q - p);
8507 We allow format specification elements in this order:
8508 \d+\$ explicit format parameter index
8510 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8511 0 flag (as above): repeated to allow "v02"
8512 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8513 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8515 [%bcdefginopsuxDFOUX] format (mandatory)
8520 As of perl5.9.3, printf format checking is on by default.
8521 Internally, perl uses %p formats to provide an escape to
8522 some extended formatting. This block deals with those
8523 extensions: if it does not match, (char*)q is reset and
8524 the normal format processing code is used.
8526 Currently defined extensions are:
8527 %p include pointer address (standard)
8528 %-p (SVf) include an SV (previously %_)
8529 %-<num>p include an SV with precision <num>
8530 %1p (VDf) include a v-string (as %vd)
8531 %<num>p reserved for future extensions
8533 Robin Barker 2005-07-14
8540 n = expect_number(&q);
8547 argsv = va_arg(*args, SV*);
8548 eptr = SvPVx_const(argsv, elen);
8554 else if (n == vdNUMBER) { /* VDf */
8561 if (ckWARN_d(WARN_INTERNAL))
8562 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8563 "internal %%<num>p might conflict with future printf extensions");
8569 if ( (width = expect_number(&q)) ) {
8584 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8613 if ( (ewix = expect_number(&q)) )
8622 if ((vectorarg = asterisk)) {
8635 width = expect_number(&q);
8641 vecsv = va_arg(*args, SV*);
8643 vecsv = (evix > 0 && evix <= svmax)
8644 ? svargs[evix-1] : &PL_sv_undef;
8646 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8648 dotstr = SvPV_const(vecsv, dotstrlen);
8649 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8650 bad with tied or overloaded values that return UTF8. */
8653 else if (has_utf8) {
8654 vecsv = sv_mortalcopy(vecsv);
8655 sv_utf8_upgrade(vecsv);
8656 dotstr = SvPV_const(vecsv, dotstrlen);
8663 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8664 vecsv = svargs[efix ? efix-1 : svix++];
8665 vecstr = (U8*)SvPV_const(vecsv,veclen);
8666 vec_utf8 = DO_UTF8(vecsv);
8668 /* if this is a version object, we need to convert
8669 * back into v-string notation and then let the
8670 * vectorize happen normally
8672 if (sv_derived_from(vecsv, "version")) {
8673 char *version = savesvpv(vecsv);
8674 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8675 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8676 "vector argument not supported with alpha versions");
8679 vecsv = sv_newmortal();
8680 /* scan_vstring is expected to be called during
8681 * tokenization, so we need to fake up the end
8682 * of the buffer for it
8684 PL_bufend = version + veclen;
8685 scan_vstring(version, vecsv);
8686 vecstr = (U8*)SvPV_const(vecsv, veclen);
8687 vec_utf8 = DO_UTF8(vecsv);
8699 i = va_arg(*args, int);
8701 i = (ewix ? ewix <= svmax : svix < svmax) ?
8702 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8704 width = (i < 0) ? -i : i;
8714 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8716 /* XXX: todo, support specified precision parameter */
8720 i = va_arg(*args, int);
8722 i = (ewix ? ewix <= svmax : svix < svmax)
8723 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8725 has_precis = !(i < 0);
8730 precis = precis * 10 + (*q++ - '0');
8739 case 'I': /* Ix, I32x, and I64x */
8741 if (q[1] == '6' && q[2] == '4') {
8747 if (q[1] == '3' && q[2] == '2') {
8757 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8768 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8769 if (*(q + 1) == 'l') { /* lld, llf */
8795 if (!vectorize && !args) {
8797 const I32 i = efix-1;
8798 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8800 argsv = (svix >= 0 && svix < svmax)
8801 ? svargs[svix++] : &PL_sv_undef;
8812 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8814 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8816 eptr = (char*)utf8buf;
8817 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8831 eptr = va_arg(*args, char*);
8833 #ifdef MACOS_TRADITIONAL
8834 /* On MacOS, %#s format is used for Pascal strings */
8839 elen = strlen(eptr);
8841 eptr = (char *)nullstr;
8842 elen = sizeof nullstr - 1;
8846 eptr = SvPVx_const(argsv, elen);
8847 if (DO_UTF8(argsv)) {
8848 I32 old_precis = precis;
8849 if (has_precis && precis < elen) {
8851 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8854 if (width) { /* fudge width (can't fudge elen) */
8855 if (has_precis && precis < elen)
8856 width += precis - old_precis;
8858 width += elen - sv_len_utf8(argsv);
8865 if (has_precis && elen > precis)
8872 if (alt || vectorize)
8874 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8895 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8904 esignbuf[esignlen++] = plus;
8908 case 'h': iv = (short)va_arg(*args, int); break;
8909 case 'l': iv = va_arg(*args, long); break;
8910 case 'V': iv = va_arg(*args, IV); break;
8911 default: iv = va_arg(*args, int); break;
8913 case 'q': iv = va_arg(*args, Quad_t); break;
8918 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8920 case 'h': iv = (short)tiv; break;
8921 case 'l': iv = (long)tiv; break;
8923 default: iv = tiv; break;
8925 case 'q': iv = (Quad_t)tiv; break;
8929 if ( !vectorize ) /* we already set uv above */
8934 esignbuf[esignlen++] = plus;
8938 esignbuf[esignlen++] = '-';
8982 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8993 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8994 case 'l': uv = va_arg(*args, unsigned long); break;
8995 case 'V': uv = va_arg(*args, UV); break;
8996 default: uv = va_arg(*args, unsigned); break;
8998 case 'q': uv = va_arg(*args, Uquad_t); break;
9003 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9005 case 'h': uv = (unsigned short)tuv; break;
9006 case 'l': uv = (unsigned long)tuv; break;
9008 default: uv = tuv; break;
9010 case 'q': uv = (Uquad_t)tuv; break;
9017 char *ptr = ebuf + sizeof ebuf;
9018 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9024 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9030 esignbuf[esignlen++] = '0';
9031 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9039 if (alt && *ptr != '0')
9048 esignbuf[esignlen++] = '0';
9049 esignbuf[esignlen++] = c;
9052 default: /* it had better be ten or less */
9056 } while (uv /= base);
9059 elen = (ebuf + sizeof ebuf) - ptr;
9063 zeros = precis - elen;
9064 else if (precis == 0 && elen == 1 && *eptr == '0'
9065 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9068 /* a precision nullifies the 0 flag. */
9075 /* FLOATING POINT */
9078 c = 'f'; /* maybe %F isn't supported here */
9086 /* This is evil, but floating point is even more evil */
9088 /* for SV-style calling, we can only get NV
9089 for C-style calling, we assume %f is double;
9090 for simplicity we allow any of %Lf, %llf, %qf for long double
9094 #if defined(USE_LONG_DOUBLE)
9098 /* [perl #20339] - we should accept and ignore %lf rather than die */
9102 #if defined(USE_LONG_DOUBLE)
9103 intsize = args ? 0 : 'q';
9107 #if defined(HAS_LONG_DOUBLE)
9116 /* now we need (long double) if intsize == 'q', else (double) */
9118 #if LONG_DOUBLESIZE > DOUBLESIZE
9120 va_arg(*args, long double) :
9121 va_arg(*args, double)
9123 va_arg(*args, double)
9128 if (c != 'e' && c != 'E') {
9130 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9131 will cast our (long double) to (double) */
9132 (void)Perl_frexp(nv, &i);
9133 if (i == PERL_INT_MIN)
9134 Perl_die(aTHX_ "panic: frexp");
9136 need = BIT_DIGITS(i);
9138 need += has_precis ? precis : 6; /* known default */
9143 #ifdef HAS_LDBL_SPRINTF_BUG
9144 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9145 with sfio - Allen <allens@cpan.org> */
9148 # define MY_DBL_MAX DBL_MAX
9149 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9150 # if DOUBLESIZE >= 8
9151 # define MY_DBL_MAX 1.7976931348623157E+308L
9153 # define MY_DBL_MAX 3.40282347E+38L
9157 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9158 # define MY_DBL_MAX_BUG 1L
9160 # define MY_DBL_MAX_BUG MY_DBL_MAX
9164 # define MY_DBL_MIN DBL_MIN
9165 # else /* XXX guessing! -Allen */
9166 # if DOUBLESIZE >= 8
9167 # define MY_DBL_MIN 2.2250738585072014E-308L
9169 # define MY_DBL_MIN 1.17549435E-38L
9173 if ((intsize == 'q') && (c == 'f') &&
9174 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9176 /* it's going to be short enough that
9177 * long double precision is not needed */
9179 if ((nv <= 0L) && (nv >= -0L))
9180 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9182 /* would use Perl_fp_class as a double-check but not
9183 * functional on IRIX - see perl.h comments */
9185 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9186 /* It's within the range that a double can represent */
9187 #if defined(DBL_MAX) && !defined(DBL_MIN)
9188 if ((nv >= ((long double)1/DBL_MAX)) ||
9189 (nv <= (-(long double)1/DBL_MAX)))
9191 fix_ldbl_sprintf_bug = TRUE;
9194 if (fix_ldbl_sprintf_bug == TRUE) {
9204 # undef MY_DBL_MAX_BUG
9207 #endif /* HAS_LDBL_SPRINTF_BUG */
9209 need += 20; /* fudge factor */
9210 if (PL_efloatsize < need) {
9211 Safefree(PL_efloatbuf);
9212 PL_efloatsize = need + 20; /* more fudge */
9213 Newx(PL_efloatbuf, PL_efloatsize, char);
9214 PL_efloatbuf[0] = '\0';
9217 if ( !(width || left || plus || alt) && fill != '0'
9218 && has_precis && intsize != 'q' ) { /* Shortcuts */
9219 /* See earlier comment about buggy Gconvert when digits,
9221 if ( c == 'g' && precis) {
9222 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9223 /* May return an empty string for digits==0 */
9224 if (*PL_efloatbuf) {
9225 elen = strlen(PL_efloatbuf);
9226 goto float_converted;
9228 } else if ( c == 'f' && !precis) {
9229 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9234 char *ptr = ebuf + sizeof ebuf;
9237 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9238 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9239 if (intsize == 'q') {
9240 /* Copy the one or more characters in a long double
9241 * format before the 'base' ([efgEFG]) character to
9242 * the format string. */
9243 static char const prifldbl[] = PERL_PRIfldbl;
9244 char const *p = prifldbl + sizeof(prifldbl) - 3;
9245 while (p >= prifldbl) { *--ptr = *p--; }
9250 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9255 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9267 /* No taint. Otherwise we are in the strange situation
9268 * where printf() taints but print($float) doesn't.
9270 #if defined(HAS_LONG_DOUBLE)
9271 elen = ((intsize == 'q')
9272 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9273 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9275 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9279 eptr = PL_efloatbuf;
9287 i = SvCUR(sv) - origlen;
9290 case 'h': *(va_arg(*args, short*)) = i; break;
9291 default: *(va_arg(*args, int*)) = i; break;
9292 case 'l': *(va_arg(*args, long*)) = i; break;
9293 case 'V': *(va_arg(*args, IV*)) = i; break;
9295 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9300 sv_setuv_mg(argsv, (UV)i);
9301 continue; /* not "break" */
9308 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9309 && ckWARN(WARN_PRINTF))
9311 SV * const msg = sv_newmortal();
9312 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9313 (PL_op->op_type == OP_PRTF) ? "" : "s");
9316 Perl_sv_catpvf(aTHX_ msg,
9317 "\"%%%c\"", c & 0xFF);
9319 Perl_sv_catpvf(aTHX_ msg,
9320 "\"%%\\%03"UVof"\"",
9323 sv_catpvs(msg, "end of string");
9324 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9327 /* output mangled stuff ... */
9333 /* ... right here, because formatting flags should not apply */
9334 SvGROW(sv, SvCUR(sv) + elen + 1);
9336 Copy(eptr, p, elen, char);
9339 SvCUR_set(sv, p - SvPVX_const(sv));
9341 continue; /* not "break" */
9344 if (is_utf8 != has_utf8) {
9347 sv_utf8_upgrade(sv);
9350 const STRLEN old_elen = elen;
9351 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9352 sv_utf8_upgrade(nsv);
9353 eptr = SvPVX_const(nsv);
9356 if (width) { /* fudge width (can't fudge elen) */
9357 width += elen - old_elen;
9363 have = esignlen + zeros + elen;
9365 Perl_croak_nocontext(PL_memory_wrap);
9367 need = (have > width ? have : width);
9370 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9371 Perl_croak_nocontext(PL_memory_wrap);
9372 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9374 if (esignlen && fill == '0') {
9376 for (i = 0; i < (int)esignlen; i++)
9380 memset(p, fill, gap);
9383 if (esignlen && fill != '0') {
9385 for (i = 0; i < (int)esignlen; i++)
9390 for (i = zeros; i; i--)
9394 Copy(eptr, p, elen, char);
9398 memset(p, ' ', gap);
9403 Copy(dotstr, p, dotstrlen, char);
9407 vectorize = FALSE; /* done iterating over vecstr */
9414 SvCUR_set(sv, p - SvPVX_const(sv));
9422 /* =========================================================================
9424 =head1 Cloning an interpreter
9426 All the macros and functions in this section are for the private use of
9427 the main function, perl_clone().
9429 The foo_dup() functions make an exact copy of an existing foo thinngy.
9430 During the course of a cloning, a hash table is used to map old addresses
9431 to new addresses. The table is created and manipulated with the
9432 ptr_table_* functions.
9436 ============================================================================*/
9439 #if defined(USE_ITHREADS)
9441 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9442 #ifndef GpREFCNT_inc
9443 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9447 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9448 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9449 If this changes, please unmerge ss_dup. */
9450 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9451 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9452 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9453 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9454 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9455 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9456 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9457 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9459 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9461 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9463 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9466 /* duplicate a file handle */
9469 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9473 PERL_UNUSED_ARG(type);
9476 return (PerlIO*)NULL;
9478 /* look for it in the table first */
9479 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9483 /* create anew and remember what it is */
9484 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9485 ptr_table_store(PL_ptr_table, fp, ret);
9489 /* duplicate a directory handle */
9492 Perl_dirp_dup(pTHX_ DIR *dp)
9494 PERL_UNUSED_CONTEXT;
9501 /* duplicate a typeglob */
9504 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9510 /* look for it in the table first */
9511 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9515 /* create anew and remember what it is */
9517 ptr_table_store(PL_ptr_table, gp, ret);
9520 ret->gp_refcnt = 0; /* must be before any other dups! */
9521 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9522 ret->gp_io = io_dup_inc(gp->gp_io, param);
9523 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9524 ret->gp_av = av_dup_inc(gp->gp_av, param);
9525 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9526 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9527 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9528 ret->gp_cvgen = gp->gp_cvgen;
9529 ret->gp_line = gp->gp_line;
9530 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9534 /* duplicate a chain of magic */
9537 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9539 MAGIC *mgprev = (MAGIC*)NULL;
9542 return (MAGIC*)NULL;
9543 /* look for it in the table first */
9544 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9548 for (; mg; mg = mg->mg_moremagic) {
9550 Newxz(nmg, 1, MAGIC);
9552 mgprev->mg_moremagic = nmg;
9555 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9556 nmg->mg_private = mg->mg_private;
9557 nmg->mg_type = mg->mg_type;
9558 nmg->mg_flags = mg->mg_flags;
9559 if (mg->mg_type == PERL_MAGIC_qr) {
9560 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9562 else if(mg->mg_type == PERL_MAGIC_backref) {
9563 /* The backref AV has its reference count deliberately bumped by
9565 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9567 else if (mg->mg_type == PERL_MAGIC_symtab) {
9568 nmg->mg_obj = mg->mg_obj;
9571 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9572 ? sv_dup_inc(mg->mg_obj, param)
9573 : sv_dup(mg->mg_obj, param);
9575 nmg->mg_len = mg->mg_len;
9576 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9577 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9578 if (mg->mg_len > 0) {
9579 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9580 if (mg->mg_type == PERL_MAGIC_overload_table &&
9581 AMT_AMAGIC((AMT*)mg->mg_ptr))
9583 const AMT * const amtp = (AMT*)mg->mg_ptr;
9584 AMT * const namtp = (AMT*)nmg->mg_ptr;
9586 for (i = 1; i < NofAMmeth; i++) {
9587 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9591 else if (mg->mg_len == HEf_SVKEY)
9592 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9594 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9595 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9602 /* create a new pointer-mapping table */
9605 Perl_ptr_table_new(pTHX)
9608 PERL_UNUSED_CONTEXT;
9610 Newxz(tbl, 1, PTR_TBL_t);
9613 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9617 #define PTR_TABLE_HASH(ptr) \
9618 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9621 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9622 following define) and at call to new_body_inline made below in
9623 Perl_ptr_table_store()
9626 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9628 /* map an existing pointer using a table */
9630 STATIC PTR_TBL_ENT_t *
9631 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9632 PTR_TBL_ENT_t *tblent;
9633 const UV hash = PTR_TABLE_HASH(sv);
9635 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9636 for (; tblent; tblent = tblent->next) {
9637 if (tblent->oldval == sv)
9644 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9646 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9647 PERL_UNUSED_CONTEXT;
9648 return tblent ? tblent->newval : NULL;
9651 /* add a new entry to a pointer-mapping table */
9654 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9656 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9657 PERL_UNUSED_CONTEXT;
9660 tblent->newval = newsv;
9662 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9664 new_body_inline(tblent, PTE_SVSLOT);
9666 tblent->oldval = oldsv;
9667 tblent->newval = newsv;
9668 tblent->next = tbl->tbl_ary[entry];
9669 tbl->tbl_ary[entry] = tblent;
9671 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9672 ptr_table_split(tbl);
9676 /* double the hash bucket size of an existing ptr table */
9679 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9681 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9682 const UV oldsize = tbl->tbl_max + 1;
9683 UV newsize = oldsize * 2;
9685 PERL_UNUSED_CONTEXT;
9687 Renew(ary, newsize, PTR_TBL_ENT_t*);
9688 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9689 tbl->tbl_max = --newsize;
9691 for (i=0; i < oldsize; i++, ary++) {
9692 PTR_TBL_ENT_t **curentp, **entp, *ent;
9695 curentp = ary + oldsize;
9696 for (entp = ary, ent = *ary; ent; ent = *entp) {
9697 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9699 ent->next = *curentp;
9709 /* remove all the entries from a ptr table */
9712 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9714 if (tbl && tbl->tbl_items) {
9715 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9716 UV riter = tbl->tbl_max;
9719 PTR_TBL_ENT_t *entry = array[riter];
9722 PTR_TBL_ENT_t * const oentry = entry;
9723 entry = entry->next;
9732 /* clear and free a ptr table */
9735 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9740 ptr_table_clear(tbl);
9741 Safefree(tbl->tbl_ary);
9747 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9750 SvRV_set(dstr, SvWEAKREF(sstr)
9751 ? sv_dup(SvRV(sstr), param)
9752 : sv_dup_inc(SvRV(sstr), param));
9755 else if (SvPVX_const(sstr)) {
9756 /* Has something there */
9758 /* Normal PV - clone whole allocated space */
9759 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9760 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9761 /* Not that normal - actually sstr is copy on write.
9762 But we are a true, independant SV, so: */
9763 SvREADONLY_off(dstr);
9768 /* Special case - not normally malloced for some reason */
9769 if (isGV_with_GP(sstr)) {
9770 /* Don't need to do anything here. */
9772 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9773 /* A "shared" PV - clone it as "shared" PV */
9775 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9779 /* Some other special case - random pointer */
9780 SvPV_set(dstr, SvPVX(sstr));
9786 if (SvTYPE(dstr) == SVt_RV)
9787 SvRV_set(dstr, NULL);
9789 SvPV_set(dstr, NULL);
9793 /* duplicate an SV of any type (including AV, HV etc) */
9796 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9801 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9803 /* look for it in the table first */
9804 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9808 if(param->flags & CLONEf_JOIN_IN) {
9809 /** We are joining here so we don't want do clone
9810 something that is bad **/
9811 if (SvTYPE(sstr) == SVt_PVHV) {
9812 const char * const hvname = HvNAME_get(sstr);
9814 /** don't clone stashes if they already exist **/
9815 return (SV*)gv_stashpv(hvname,0);
9819 /* create anew and remember what it is */
9822 #ifdef DEBUG_LEAKING_SCALARS
9823 dstr->sv_debug_optype = sstr->sv_debug_optype;
9824 dstr->sv_debug_line = sstr->sv_debug_line;
9825 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9826 dstr->sv_debug_cloned = 1;
9827 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9830 ptr_table_store(PL_ptr_table, sstr, dstr);
9833 SvFLAGS(dstr) = SvFLAGS(sstr);
9834 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9835 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9838 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9839 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9840 PL_watch_pvx, SvPVX_const(sstr));
9843 /* don't clone objects whose class has asked us not to */
9844 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9845 SvFLAGS(dstr) &= ~SVTYPEMASK;
9850 switch (SvTYPE(sstr)) {
9855 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9856 SvIV_set(dstr, SvIVX(sstr));
9859 SvANY(dstr) = new_XNV();
9860 SvNV_set(dstr, SvNVX(sstr));
9863 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9864 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9868 /* These are all the types that need complex bodies allocating. */
9870 const svtype sv_type = SvTYPE(sstr);
9871 const struct body_details *const sv_type_details
9872 = bodies_by_type + sv_type;
9876 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9880 if (GvUNIQUE((GV*)sstr)) {
9881 NOOP; /* Do sharing here, and fall through */
9894 assert(sv_type_details->body_size);
9895 if (sv_type_details->arena) {
9896 new_body_inline(new_body, sv_type);
9898 = (void*)((char*)new_body - sv_type_details->offset);
9900 new_body = new_NOARENA(sv_type_details);
9904 SvANY(dstr) = new_body;
9907 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9908 ((char*)SvANY(dstr)) + sv_type_details->offset,
9909 sv_type_details->copy, char);
9911 Copy(((char*)SvANY(sstr)),
9912 ((char*)SvANY(dstr)),
9913 sv_type_details->body_size + sv_type_details->offset, char);
9916 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9917 && !isGV_with_GP(dstr))
9918 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9920 /* The Copy above means that all the source (unduplicated) pointers
9921 are now in the destination. We can check the flags and the
9922 pointers in either, but it's possible that there's less cache
9923 missing by always going for the destination.
9924 FIXME - instrument and check that assumption */
9925 if (sv_type >= SVt_PVMG) {
9926 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9927 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9928 } else if (SvMAGIC(dstr))
9929 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9931 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9934 /* The cast silences a GCC warning about unhandled types. */
9935 switch ((int)sv_type) {
9947 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9948 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9949 LvTARG(dstr) = dstr;
9950 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9951 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9953 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9956 if (GvNAME_HEK(dstr))
9957 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9959 /* Don't call sv_add_backref here as it's going to be created
9960 as part of the magic cloning of the symbol table. */
9961 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9962 if(isGV_with_GP(sstr)) {
9963 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9964 at the point of this comment. */
9965 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9966 (void)GpREFCNT_inc(GvGP(dstr));
9968 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9971 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9972 if (IoOFP(dstr) == IoIFP(sstr))
9973 IoOFP(dstr) = IoIFP(dstr);
9975 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9976 /* PL_rsfp_filters entries have fake IoDIRP() */
9977 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9978 /* I have no idea why fake dirp (rsfps)
9979 should be treated differently but otherwise
9980 we end up with leaks -- sky*/
9981 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9982 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9983 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9985 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9986 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9987 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9989 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9992 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9995 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9996 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9997 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10000 if (AvARRAY((AV*)sstr)) {
10001 SV **dst_ary, **src_ary;
10002 SSize_t items = AvFILLp((AV*)sstr) + 1;
10004 src_ary = AvARRAY((AV*)sstr);
10005 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10006 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10007 AvARRAY((AV*)dstr) = dst_ary;
10008 AvALLOC((AV*)dstr) = dst_ary;
10009 if (AvREAL((AV*)sstr)) {
10010 while (items-- > 0)
10011 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10014 while (items-- > 0)
10015 *dst_ary++ = sv_dup(*src_ary++, param);
10017 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10018 while (items-- > 0) {
10019 *dst_ary++ = &PL_sv_undef;
10023 AvARRAY((AV*)dstr) = NULL;
10024 AvALLOC((AV*)dstr) = (SV**)NULL;
10028 if (HvARRAY((HV*)sstr)) {
10030 const bool sharekeys = !!HvSHAREKEYS(sstr);
10031 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10032 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10034 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10035 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10037 HvARRAY(dstr) = (HE**)darray;
10038 while (i <= sxhv->xhv_max) {
10039 const HE * const source = HvARRAY(sstr)[i];
10040 HvARRAY(dstr)[i] = source
10041 ? he_dup(source, sharekeys, param) : 0;
10046 const struct xpvhv_aux * const saux = HvAUX(sstr);
10047 struct xpvhv_aux * const daux = HvAUX(dstr);
10048 /* This flag isn't copied. */
10049 /* SvOOK_on(hv) attacks the IV flags. */
10050 SvFLAGS(dstr) |= SVf_OOK;
10052 hvname = saux->xhv_name;
10053 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10055 daux->xhv_riter = saux->xhv_riter;
10056 daux->xhv_eiter = saux->xhv_eiter
10057 ? he_dup(saux->xhv_eiter,
10058 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10059 daux->xhv_backreferences =
10060 saux->xhv_backreferences
10061 ? (AV*) SvREFCNT_inc(
10062 sv_dup((SV*)saux->xhv_backreferences, param))
10064 /* Record stashes for possible cloning in Perl_clone(). */
10066 av_push(param->stashes, dstr);
10070 HvARRAY((HV*)dstr) = NULL;
10073 if (!(param->flags & CLONEf_COPY_STACKS)) {
10077 /* NOTE: not refcounted */
10078 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10080 if (!CvISXSUB(dstr))
10081 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10083 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10084 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10085 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10086 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10088 /* don't dup if copying back - CvGV isn't refcounted, so the
10089 * duped GV may never be freed. A bit of a hack! DAPM */
10090 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10091 NULL : gv_dup(CvGV(dstr), param) ;
10092 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10094 CvWEAKOUTSIDE(sstr)
10095 ? cv_dup( CvOUTSIDE(dstr), param)
10096 : cv_dup_inc(CvOUTSIDE(dstr), param);
10097 if (!CvISXSUB(dstr))
10098 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10104 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10110 /* duplicate a context */
10113 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10115 PERL_CONTEXT *ncxs;
10118 return (PERL_CONTEXT*)NULL;
10120 /* look for it in the table first */
10121 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10125 /* create anew and remember what it is */
10126 Newxz(ncxs, max + 1, PERL_CONTEXT);
10127 ptr_table_store(PL_ptr_table, cxs, ncxs);
10130 PERL_CONTEXT * const cx = &cxs[ix];
10131 PERL_CONTEXT * const ncx = &ncxs[ix];
10132 ncx->cx_type = cx->cx_type;
10133 if (CxTYPE(cx) == CXt_SUBST) {
10134 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10137 ncx->blk_oldsp = cx->blk_oldsp;
10138 ncx->blk_oldcop = cx->blk_oldcop;
10139 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10140 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10141 ncx->blk_oldpm = cx->blk_oldpm;
10142 ncx->blk_gimme = cx->blk_gimme;
10143 switch (CxTYPE(cx)) {
10145 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10146 ? cv_dup_inc(cx->blk_sub.cv, param)
10147 : cv_dup(cx->blk_sub.cv,param));
10148 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10149 ? av_dup_inc(cx->blk_sub.argarray, param)
10151 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10152 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10153 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10154 ncx->blk_sub.lval = cx->blk_sub.lval;
10155 ncx->blk_sub.retop = cx->blk_sub.retop;
10156 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10157 cx->blk_sub.oldcomppad);
10160 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10161 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10162 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10163 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10164 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10165 ncx->blk_eval.retop = cx->blk_eval.retop;
10168 ncx->blk_loop.label = cx->blk_loop.label;
10169 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10170 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10171 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10172 ? cx->blk_loop.iterdata
10173 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10174 ncx->blk_loop.oldcomppad
10175 = (PAD*)ptr_table_fetch(PL_ptr_table,
10176 cx->blk_loop.oldcomppad);
10177 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10178 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10179 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10180 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10181 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10184 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10185 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10186 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10187 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10188 ncx->blk_sub.retop = cx->blk_sub.retop;
10200 /* duplicate a stack info structure */
10203 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10208 return (PERL_SI*)NULL;
10210 /* look for it in the table first */
10211 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10215 /* create anew and remember what it is */
10216 Newxz(nsi, 1, PERL_SI);
10217 ptr_table_store(PL_ptr_table, si, nsi);
10219 nsi->si_stack = av_dup_inc(si->si_stack, param);
10220 nsi->si_cxix = si->si_cxix;
10221 nsi->si_cxmax = si->si_cxmax;
10222 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10223 nsi->si_type = si->si_type;
10224 nsi->si_prev = si_dup(si->si_prev, param);
10225 nsi->si_next = si_dup(si->si_next, param);
10226 nsi->si_markoff = si->si_markoff;
10231 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10232 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10233 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10234 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10235 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10236 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10237 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10238 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10239 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10240 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10241 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10242 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10243 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10244 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10247 #define pv_dup_inc(p) SAVEPV(p)
10248 #define pv_dup(p) SAVEPV(p)
10249 #define svp_dup_inc(p,pp) any_dup(p,pp)
10251 /* map any object to the new equivent - either something in the
10252 * ptr table, or something in the interpreter structure
10256 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10261 return (void*)NULL;
10263 /* look for it in the table first */
10264 ret = ptr_table_fetch(PL_ptr_table, v);
10268 /* see if it is part of the interpreter structure */
10269 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10270 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10278 /* duplicate the save stack */
10281 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10283 ANY * const ss = proto_perl->Tsavestack;
10284 const I32 max = proto_perl->Tsavestack_max;
10285 I32 ix = proto_perl->Tsavestack_ix;
10298 void (*dptr) (void*);
10299 void (*dxptr) (pTHX_ void*);
10301 Newxz(nss, max, ANY);
10304 const I32 type = POPINT(ss,ix);
10305 TOPINT(nss,ix) = type;
10307 case SAVEt_HELEM: /* hash element */
10308 sv = (SV*)POPPTR(ss,ix);
10309 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10311 case SAVEt_ITEM: /* normal string */
10312 case SAVEt_SV: /* scalar reference */
10313 sv = (SV*)POPPTR(ss,ix);
10314 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10317 case SAVEt_MORTALIZESV:
10318 sv = (SV*)POPPTR(ss,ix);
10319 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10321 case SAVEt_SHARED_PVREF: /* char* in shared space */
10322 c = (char*)POPPTR(ss,ix);
10323 TOPPTR(nss,ix) = savesharedpv(c);
10324 ptr = POPPTR(ss,ix);
10325 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10327 case SAVEt_GENERIC_SVREF: /* generic sv */
10328 case SAVEt_SVREF: /* scalar reference */
10329 sv = (SV*)POPPTR(ss,ix);
10330 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10331 ptr = POPPTR(ss,ix);
10332 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10334 case SAVEt_HV: /* hash reference */
10335 case SAVEt_AV: /* array reference */
10336 sv = (SV*) POPPTR(ss,ix);
10337 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10339 case SAVEt_COMPPAD:
10341 sv = (SV*) POPPTR(ss,ix);
10342 TOPPTR(nss,ix) = sv_dup(sv, param);
10344 case SAVEt_INT: /* int reference */
10345 ptr = POPPTR(ss,ix);
10346 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10347 intval = (int)POPINT(ss,ix);
10348 TOPINT(nss,ix) = intval;
10350 case SAVEt_LONG: /* long reference */
10351 ptr = POPPTR(ss,ix);
10352 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10354 case SAVEt_CLEARSV:
10355 longval = (long)POPLONG(ss,ix);
10356 TOPLONG(nss,ix) = longval;
10358 case SAVEt_I32: /* I32 reference */
10359 case SAVEt_I16: /* I16 reference */
10360 case SAVEt_I8: /* I8 reference */
10361 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10362 ptr = POPPTR(ss,ix);
10363 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10365 TOPINT(nss,ix) = i;
10367 case SAVEt_IV: /* IV reference */
10368 ptr = POPPTR(ss,ix);
10369 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10371 TOPIV(nss,ix) = iv;
10373 case SAVEt_HPTR: /* HV* reference */
10374 case SAVEt_APTR: /* AV* reference */
10375 case SAVEt_SPTR: /* SV* reference */
10376 ptr = POPPTR(ss,ix);
10377 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10378 sv = (SV*)POPPTR(ss,ix);
10379 TOPPTR(nss,ix) = sv_dup(sv, param);
10381 case SAVEt_VPTR: /* random* reference */
10382 ptr = POPPTR(ss,ix);
10383 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10384 ptr = POPPTR(ss,ix);
10385 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10387 case SAVEt_GENERIC_PVREF: /* generic char* */
10388 case SAVEt_PPTR: /* char* reference */
10389 ptr = POPPTR(ss,ix);
10390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10391 c = (char*)POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = pv_dup(c);
10394 case SAVEt_GP: /* scalar reference */
10395 gp = (GP*)POPPTR(ss,ix);
10396 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10397 (void)GpREFCNT_inc(gp);
10398 gv = (GV*)POPPTR(ss,ix);
10399 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10402 ptr = POPPTR(ss,ix);
10403 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10404 /* these are assumed to be refcounted properly */
10406 switch (((OP*)ptr)->op_type) {
10408 case OP_LEAVESUBLV:
10412 case OP_LEAVEWRITE:
10413 TOPPTR(nss,ix) = ptr;
10420 TOPPTR(nss,ix) = NULL;
10425 TOPPTR(nss,ix) = NULL;
10428 c = (char*)POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = pv_dup_inc(c);
10432 hv = (HV*)POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10434 c = (char*)POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = pv_dup_inc(c);
10437 case SAVEt_STACK_POS: /* Position on Perl stack */
10439 TOPINT(nss,ix) = i;
10441 case SAVEt_DESTRUCTOR:
10442 ptr = POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10444 dptr = POPDPTR(ss,ix);
10445 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10446 any_dup(FPTR2DPTR(void *, dptr),
10449 case SAVEt_DESTRUCTOR_X:
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10452 dxptr = POPDXPTR(ss,ix);
10453 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10454 any_dup(FPTR2DPTR(void *, dxptr),
10457 case SAVEt_REGCONTEXT:
10460 TOPINT(nss,ix) = i;
10463 case SAVEt_AELEM: /* array element */
10464 sv = (SV*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10467 TOPINT(nss,ix) = i;
10468 av = (AV*)POPPTR(ss,ix);
10469 TOPPTR(nss,ix) = av_dup_inc(av, param);
10472 ptr = POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = ptr;
10477 TOPINT(nss,ix) = i;
10478 ptr = POPPTR(ss,ix);
10481 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10482 HINTS_REFCNT_UNLOCK;
10484 TOPPTR(nss,ix) = ptr;
10485 if (i & HINT_LOCALIZE_HH) {
10486 hv = (HV*)POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10491 longval = (long)POPLONG(ss,ix);
10492 TOPLONG(nss,ix) = longval;
10493 ptr = POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10495 sv = (SV*)POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = sv_dup(sv, param);
10499 ptr = POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10501 longval = (long)POPBOOL(ss,ix);
10502 TOPBOOL(nss,ix) = (bool)longval;
10504 case SAVEt_SET_SVFLAGS:
10506 TOPINT(nss,ix) = i;
10508 TOPINT(nss,ix) = i;
10509 sv = (SV*)POPPTR(ss,ix);
10510 TOPPTR(nss,ix) = sv_dup(sv, param);
10512 case SAVEt_RE_STATE:
10514 const struct re_save_state *const old_state
10515 = (struct re_save_state *)
10516 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10517 struct re_save_state *const new_state
10518 = (struct re_save_state *)
10519 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10521 Copy(old_state, new_state, 1, struct re_save_state);
10522 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10524 new_state->re_state_bostr
10525 = pv_dup(old_state->re_state_bostr);
10526 new_state->re_state_reginput
10527 = pv_dup(old_state->re_state_reginput);
10528 new_state->re_state_regeol
10529 = pv_dup(old_state->re_state_regeol);
10530 new_state->re_state_regstartp
10531 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10532 new_state->re_state_regendp
10533 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10534 new_state->re_state_reglastparen
10535 = (U32*) any_dup(old_state->re_state_reglastparen,
10537 new_state->re_state_reglastcloseparen
10538 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10540 /* XXX This just has to be broken. The old save_re_context
10541 code did SAVEGENERICPV(PL_reg_start_tmp);
10542 PL_reg_start_tmp is char **.
10543 Look above to what the dup code does for
10544 SAVEt_GENERIC_PVREF
10545 It can never have worked.
10546 So this is merely a faithful copy of the exiting bug: */
10547 new_state->re_state_reg_start_tmp
10548 = (char **) pv_dup((char *)
10549 old_state->re_state_reg_start_tmp);
10550 /* I assume that it only ever "worked" because no-one called
10551 (pseudo)fork while the regexp engine had re-entered itself.
10553 #ifdef PERL_OLD_COPY_ON_WRITE
10554 new_state->re_state_nrs
10555 = sv_dup(old_state->re_state_nrs, param);
10557 new_state->re_state_reg_magic
10558 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10560 new_state->re_state_reg_oldcurpm
10561 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10563 new_state->re_state_reg_curpm
10564 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10566 new_state->re_state_reg_oldsaved
10567 = pv_dup(old_state->re_state_reg_oldsaved);
10568 new_state->re_state_reg_poscache
10569 = pv_dup(old_state->re_state_reg_poscache);
10570 new_state->re_state_reg_starttry
10571 = pv_dup(old_state->re_state_reg_starttry);
10574 case SAVEt_COMPILE_WARNINGS:
10575 ptr = POPPTR(ss,ix);
10576 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10580 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10588 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10589 * flag to the result. This is done for each stash before cloning starts,
10590 * so we know which stashes want their objects cloned */
10593 do_mark_cloneable_stash(pTHX_ SV *sv)
10595 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10597 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10598 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10599 if (cloner && GvCV(cloner)) {
10606 XPUSHs(sv_2mortal(newSVhek(hvname)));
10608 call_sv((SV*)GvCV(cloner), G_SCALAR);
10615 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10623 =for apidoc perl_clone
10625 Create and return a new interpreter by cloning the current one.
10627 perl_clone takes these flags as parameters:
10629 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10630 without it we only clone the data and zero the stacks,
10631 with it we copy the stacks and the new perl interpreter is
10632 ready to run at the exact same point as the previous one.
10633 The pseudo-fork code uses COPY_STACKS while the
10634 threads->new doesn't.
10636 CLONEf_KEEP_PTR_TABLE
10637 perl_clone keeps a ptr_table with the pointer of the old
10638 variable as a key and the new variable as a value,
10639 this allows it to check if something has been cloned and not
10640 clone it again but rather just use the value and increase the
10641 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10642 the ptr_table using the function
10643 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10644 reason to keep it around is if you want to dup some of your own
10645 variable who are outside the graph perl scans, example of this
10646 code is in threads.xs create
10649 This is a win32 thing, it is ignored on unix, it tells perls
10650 win32host code (which is c++) to clone itself, this is needed on
10651 win32 if you want to run two threads at the same time,
10652 if you just want to do some stuff in a separate perl interpreter
10653 and then throw it away and return to the original one,
10654 you don't need to do anything.
10659 /* XXX the above needs expanding by someone who actually understands it ! */
10660 EXTERN_C PerlInterpreter *
10661 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10664 perl_clone(PerlInterpreter *proto_perl, UV flags)
10667 #ifdef PERL_IMPLICIT_SYS
10669 /* perlhost.h so we need to call into it
10670 to clone the host, CPerlHost should have a c interface, sky */
10672 if (flags & CLONEf_CLONE_HOST) {
10673 return perl_clone_host(proto_perl,flags);
10675 return perl_clone_using(proto_perl, flags,
10677 proto_perl->IMemShared,
10678 proto_perl->IMemParse,
10680 proto_perl->IStdIO,
10684 proto_perl->IProc);
10688 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10689 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10690 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10691 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10692 struct IPerlDir* ipD, struct IPerlSock* ipS,
10693 struct IPerlProc* ipP)
10695 /* XXX many of the string copies here can be optimized if they're
10696 * constants; they need to be allocated as common memory and just
10697 * their pointers copied. */
10700 CLONE_PARAMS clone_params;
10701 CLONE_PARAMS* const param = &clone_params;
10703 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10704 /* for each stash, determine whether its objects should be cloned */
10705 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10706 PERL_SET_THX(my_perl);
10709 PoisonNew(my_perl, 1, PerlInterpreter);
10715 PL_savestack_ix = 0;
10716 PL_savestack_max = -1;
10717 PL_sig_pending = 0;
10718 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10719 # else /* !DEBUGGING */
10720 Zero(my_perl, 1, PerlInterpreter);
10721 # endif /* DEBUGGING */
10723 /* host pointers */
10725 PL_MemShared = ipMS;
10726 PL_MemParse = ipMP;
10733 #else /* !PERL_IMPLICIT_SYS */
10735 CLONE_PARAMS clone_params;
10736 CLONE_PARAMS* param = &clone_params;
10737 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10738 /* for each stash, determine whether its objects should be cloned */
10739 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10740 PERL_SET_THX(my_perl);
10743 PoisonNew(my_perl, 1, PerlInterpreter);
10749 PL_savestack_ix = 0;
10750 PL_savestack_max = -1;
10751 PL_sig_pending = 0;
10752 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10753 # else /* !DEBUGGING */
10754 Zero(my_perl, 1, PerlInterpreter);
10755 # endif /* DEBUGGING */
10756 #endif /* PERL_IMPLICIT_SYS */
10757 param->flags = flags;
10758 param->proto_perl = proto_perl;
10760 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10762 PL_body_arenas = NULL;
10763 Zero(&PL_body_roots, 1, PL_body_roots);
10765 PL_nice_chunk = NULL;
10766 PL_nice_chunk_size = 0;
10768 PL_sv_objcount = 0;
10770 PL_sv_arenaroot = NULL;
10772 PL_debug = proto_perl->Idebug;
10774 PL_hash_seed = proto_perl->Ihash_seed;
10775 PL_rehash_seed = proto_perl->Irehash_seed;
10777 #ifdef USE_REENTRANT_API
10778 /* XXX: things like -Dm will segfault here in perlio, but doing
10779 * PERL_SET_CONTEXT(proto_perl);
10780 * breaks too many other things
10782 Perl_reentrant_init(aTHX);
10785 /* create SV map for pointer relocation */
10786 PL_ptr_table = ptr_table_new();
10788 /* initialize these special pointers as early as possible */
10789 SvANY(&PL_sv_undef) = NULL;
10790 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10791 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10792 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10794 SvANY(&PL_sv_no) = new_XPVNV();
10795 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10796 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10797 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10798 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10799 SvCUR_set(&PL_sv_no, 0);
10800 SvLEN_set(&PL_sv_no, 1);
10801 SvIV_set(&PL_sv_no, 0);
10802 SvNV_set(&PL_sv_no, 0);
10803 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10805 SvANY(&PL_sv_yes) = new_XPVNV();
10806 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10807 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10808 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10809 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10810 SvCUR_set(&PL_sv_yes, 1);
10811 SvLEN_set(&PL_sv_yes, 2);
10812 SvIV_set(&PL_sv_yes, 1);
10813 SvNV_set(&PL_sv_yes, 1);
10814 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10816 /* create (a non-shared!) shared string table */
10817 PL_strtab = newHV();
10818 HvSHAREKEYS_off(PL_strtab);
10819 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10820 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10822 PL_compiling = proto_perl->Icompiling;
10824 /* These two PVs will be free'd special way so must set them same way op.c does */
10825 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10826 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10828 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10829 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10831 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10832 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10833 if (PL_compiling.cop_hints_hash) {
10835 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10836 HINTS_REFCNT_UNLOCK;
10838 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10840 /* pseudo environmental stuff */
10841 PL_origargc = proto_perl->Iorigargc;
10842 PL_origargv = proto_perl->Iorigargv;
10844 param->stashes = newAV(); /* Setup array of objects to call clone on */
10846 /* Set tainting stuff before PerlIO_debug can possibly get called */
10847 PL_tainting = proto_perl->Itainting;
10848 PL_taint_warn = proto_perl->Itaint_warn;
10850 #ifdef PERLIO_LAYERS
10851 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10852 PerlIO_clone(aTHX_ proto_perl, param);
10855 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10856 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10857 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10858 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10859 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10860 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10863 PL_minus_c = proto_perl->Iminus_c;
10864 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10865 PL_localpatches = proto_perl->Ilocalpatches;
10866 PL_splitstr = proto_perl->Isplitstr;
10867 PL_preprocess = proto_perl->Ipreprocess;
10868 PL_minus_n = proto_perl->Iminus_n;
10869 PL_minus_p = proto_perl->Iminus_p;
10870 PL_minus_l = proto_perl->Iminus_l;
10871 PL_minus_a = proto_perl->Iminus_a;
10872 PL_minus_E = proto_perl->Iminus_E;
10873 PL_minus_F = proto_perl->Iminus_F;
10874 PL_doswitches = proto_perl->Idoswitches;
10875 PL_dowarn = proto_perl->Idowarn;
10876 PL_doextract = proto_perl->Idoextract;
10877 PL_sawampersand = proto_perl->Isawampersand;
10878 PL_unsafe = proto_perl->Iunsafe;
10879 PL_inplace = SAVEPV(proto_perl->Iinplace);
10880 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10881 PL_perldb = proto_perl->Iperldb;
10882 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10883 PL_exit_flags = proto_perl->Iexit_flags;
10885 /* magical thingies */
10886 /* XXX time(&PL_basetime) when asked for? */
10887 PL_basetime = proto_perl->Ibasetime;
10888 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10890 PL_maxsysfd = proto_perl->Imaxsysfd;
10891 PL_statusvalue = proto_perl->Istatusvalue;
10893 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10895 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10897 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10899 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10900 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10901 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10904 /* RE engine related */
10905 Zero(&PL_reg_state, 1, struct re_save_state);
10906 PL_reginterp_cnt = 0;
10907 PL_regmatch_slab = NULL;
10909 /* Clone the regex array */
10910 PL_regex_padav = newAV();
10912 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10913 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10915 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10916 for(i = 1; i <= len; i++) {
10917 const SV * const regex = regexen[i];
10920 ? sv_dup_inc(regex, param)
10922 newSViv(PTR2IV(CALLREGDUPE(
10923 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10925 av_push(PL_regex_padav, sv);
10928 PL_regex_pad = AvARRAY(PL_regex_padav);
10930 /* shortcuts to various I/O objects */
10931 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10932 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10933 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10934 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10935 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10936 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10938 /* shortcuts to regexp stuff */
10939 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10941 /* shortcuts to misc objects */
10942 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10944 /* shortcuts to debugging objects */
10945 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10946 PL_DBline = gv_dup(proto_perl->IDBline, param);
10947 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10948 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10949 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10950 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10951 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10952 PL_lineary = av_dup(proto_perl->Ilineary, param);
10953 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10955 /* symbol tables */
10956 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10957 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10958 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10959 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10960 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10962 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10963 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10964 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10965 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
10966 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
10967 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10968 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10969 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10971 PL_sub_generation = proto_perl->Isub_generation;
10973 /* funky return mechanisms */
10974 PL_forkprocess = proto_perl->Iforkprocess;
10976 /* subprocess state */
10977 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10979 /* internal state */
10980 PL_maxo = proto_perl->Imaxo;
10981 if (proto_perl->Iop_mask)
10982 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10985 /* PL_asserting = proto_perl->Iasserting; */
10987 /* current interpreter roots */
10988 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10990 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10992 PL_main_start = proto_perl->Imain_start;
10993 PL_eval_root = proto_perl->Ieval_root;
10994 PL_eval_start = proto_perl->Ieval_start;
10996 /* runtime control stuff */
10997 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10998 PL_copline = proto_perl->Icopline;
11000 PL_filemode = proto_perl->Ifilemode;
11001 PL_lastfd = proto_perl->Ilastfd;
11002 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11005 PL_gensym = proto_perl->Igensym;
11006 PL_preambled = proto_perl->Ipreambled;
11007 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11008 PL_laststatval = proto_perl->Ilaststatval;
11009 PL_laststype = proto_perl->Ilaststype;
11012 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11014 /* interpreter atexit processing */
11015 PL_exitlistlen = proto_perl->Iexitlistlen;
11016 if (PL_exitlistlen) {
11017 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11018 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11021 PL_exitlist = (PerlExitListEntry*)NULL;
11023 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11024 if (PL_my_cxt_size) {
11025 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11026 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11029 PL_my_cxt_list = (void**)NULL;
11030 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11031 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11032 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11034 PL_profiledata = NULL;
11035 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11036 /* PL_rsfp_filters entries have fake IoDIRP() */
11037 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11039 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11041 PAD_CLONE_VARS(proto_perl, param);
11043 #ifdef HAVE_INTERP_INTERN
11044 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11047 /* more statics moved here */
11048 PL_generation = proto_perl->Igeneration;
11049 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11051 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11052 PL_in_clean_all = proto_perl->Iin_clean_all;
11054 PL_uid = proto_perl->Iuid;
11055 PL_euid = proto_perl->Ieuid;
11056 PL_gid = proto_perl->Igid;
11057 PL_egid = proto_perl->Iegid;
11058 PL_nomemok = proto_perl->Inomemok;
11059 PL_an = proto_perl->Ian;
11060 PL_evalseq = proto_perl->Ievalseq;
11061 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11062 PL_origalen = proto_perl->Iorigalen;
11063 #ifdef PERL_USES_PL_PIDSTATUS
11064 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11066 PL_osname = SAVEPV(proto_perl->Iosname);
11067 PL_sighandlerp = proto_perl->Isighandlerp;
11069 PL_runops = proto_perl->Irunops;
11071 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11074 PL_cshlen = proto_perl->Icshlen;
11075 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11078 PL_lex_state = proto_perl->Ilex_state;
11079 PL_lex_defer = proto_perl->Ilex_defer;
11080 PL_lex_expect = proto_perl->Ilex_expect;
11081 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11082 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11083 PL_lex_starts = proto_perl->Ilex_starts;
11084 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11085 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11086 PL_lex_op = proto_perl->Ilex_op;
11087 PL_lex_inpat = proto_perl->Ilex_inpat;
11088 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11089 PL_lex_brackets = proto_perl->Ilex_brackets;
11090 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11091 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11092 PL_lex_casemods = proto_perl->Ilex_casemods;
11093 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11094 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11097 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11098 PL_lasttoke = proto_perl->Ilasttoke;
11099 PL_realtokenstart = proto_perl->Irealtokenstart;
11100 PL_faketokens = proto_perl->Ifaketokens;
11101 PL_thismad = proto_perl->Ithismad;
11102 PL_thistoken = proto_perl->Ithistoken;
11103 PL_thisopen = proto_perl->Ithisopen;
11104 PL_thisstuff = proto_perl->Ithisstuff;
11105 PL_thisclose = proto_perl->Ithisclose;
11106 PL_thiswhite = proto_perl->Ithiswhite;
11107 PL_nextwhite = proto_perl->Inextwhite;
11108 PL_skipwhite = proto_perl->Iskipwhite;
11109 PL_endwhite = proto_perl->Iendwhite;
11110 PL_curforce = proto_perl->Icurforce;
11112 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11113 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11114 PL_nexttoke = proto_perl->Inexttoke;
11117 /* XXX This is probably masking the deeper issue of why
11118 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11119 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11120 * (A little debugging with a watchpoint on it may help.)
11122 if (SvANY(proto_perl->Ilinestr)) {
11123 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11124 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11125 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11126 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11127 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11128 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11129 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11130 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11131 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11134 PL_linestr = newSV(79);
11135 sv_upgrade(PL_linestr,SVt_PVIV);
11136 sv_setpvn(PL_linestr,"",0);
11137 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11139 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11140 PL_pending_ident = proto_perl->Ipending_ident;
11141 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11143 PL_expect = proto_perl->Iexpect;
11145 PL_multi_start = proto_perl->Imulti_start;
11146 PL_multi_end = proto_perl->Imulti_end;
11147 PL_multi_open = proto_perl->Imulti_open;
11148 PL_multi_close = proto_perl->Imulti_close;
11150 PL_error_count = proto_perl->Ierror_count;
11151 PL_subline = proto_perl->Isubline;
11152 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11154 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11155 if (SvANY(proto_perl->Ilinestr)) {
11156 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11157 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11158 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11159 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11160 PL_last_lop_op = proto_perl->Ilast_lop_op;
11163 PL_last_uni = SvPVX(PL_linestr);
11164 PL_last_lop = SvPVX(PL_linestr);
11165 PL_last_lop_op = 0;
11167 PL_in_my = proto_perl->Iin_my;
11168 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11170 PL_cryptseen = proto_perl->Icryptseen;
11173 PL_hints = proto_perl->Ihints;
11175 PL_amagic_generation = proto_perl->Iamagic_generation;
11177 #ifdef USE_LOCALE_COLLATE
11178 PL_collation_ix = proto_perl->Icollation_ix;
11179 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11180 PL_collation_standard = proto_perl->Icollation_standard;
11181 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11182 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11183 #endif /* USE_LOCALE_COLLATE */
11185 #ifdef USE_LOCALE_NUMERIC
11186 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11187 PL_numeric_standard = proto_perl->Inumeric_standard;
11188 PL_numeric_local = proto_perl->Inumeric_local;
11189 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11190 #endif /* !USE_LOCALE_NUMERIC */
11192 /* utf8 character classes */
11193 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11194 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11195 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11196 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11197 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11198 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11199 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11200 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11201 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11202 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11203 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11204 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11205 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11206 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11207 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11208 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11209 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11210 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11211 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11212 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11214 /* Did the locale setup indicate UTF-8? */
11215 PL_utf8locale = proto_perl->Iutf8locale;
11216 /* Unicode features (see perlrun/-C) */
11217 PL_unicode = proto_perl->Iunicode;
11219 /* Pre-5.8 signals control */
11220 PL_signals = proto_perl->Isignals;
11222 /* times() ticks per second */
11223 PL_clocktick = proto_perl->Iclocktick;
11225 /* Recursion stopper for PerlIO_find_layer */
11226 PL_in_load_module = proto_perl->Iin_load_module;
11228 /* sort() routine */
11229 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11231 /* Not really needed/useful since the reenrant_retint is "volatile",
11232 * but do it for consistency's sake. */
11233 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11235 /* Hooks to shared SVs and locks. */
11236 PL_sharehook = proto_perl->Isharehook;
11237 PL_lockhook = proto_perl->Ilockhook;
11238 PL_unlockhook = proto_perl->Iunlockhook;
11239 PL_threadhook = proto_perl->Ithreadhook;
11241 PL_runops_std = proto_perl->Irunops_std;
11242 PL_runops_dbg = proto_perl->Irunops_dbg;
11244 #ifdef THREADS_HAVE_PIDS
11245 PL_ppid = proto_perl->Ippid;
11249 PL_last_swash_hv = NULL; /* reinits on demand */
11250 PL_last_swash_klen = 0;
11251 PL_last_swash_key[0]= '\0';
11252 PL_last_swash_tmps = (U8*)NULL;
11253 PL_last_swash_slen = 0;
11255 PL_glob_index = proto_perl->Iglob_index;
11256 PL_srand_called = proto_perl->Isrand_called;
11257 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11258 PL_bitcount = NULL; /* reinits on demand */
11260 if (proto_perl->Ipsig_pend) {
11261 Newxz(PL_psig_pend, SIG_SIZE, int);
11264 PL_psig_pend = (int*)NULL;
11267 if (proto_perl->Ipsig_ptr) {
11268 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11269 Newxz(PL_psig_name, SIG_SIZE, SV*);
11270 for (i = 1; i < SIG_SIZE; i++) {
11271 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11272 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11276 PL_psig_ptr = (SV**)NULL;
11277 PL_psig_name = (SV**)NULL;
11280 /* thrdvar.h stuff */
11282 if (flags & CLONEf_COPY_STACKS) {
11283 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11284 PL_tmps_ix = proto_perl->Ttmps_ix;
11285 PL_tmps_max = proto_perl->Ttmps_max;
11286 PL_tmps_floor = proto_perl->Ttmps_floor;
11287 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11289 while (i <= PL_tmps_ix) {
11290 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11294 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11295 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11296 Newxz(PL_markstack, i, I32);
11297 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11298 - proto_perl->Tmarkstack);
11299 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11300 - proto_perl->Tmarkstack);
11301 Copy(proto_perl->Tmarkstack, PL_markstack,
11302 PL_markstack_ptr - PL_markstack + 1, I32);
11304 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11305 * NOTE: unlike the others! */
11306 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11307 PL_scopestack_max = proto_perl->Tscopestack_max;
11308 Newxz(PL_scopestack, PL_scopestack_max, I32);
11309 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11311 /* NOTE: si_dup() looks at PL_markstack */
11312 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11314 /* PL_curstack = PL_curstackinfo->si_stack; */
11315 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11316 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11318 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11319 PL_stack_base = AvARRAY(PL_curstack);
11320 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11321 - proto_perl->Tstack_base);
11322 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11324 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11325 * NOTE: unlike the others! */
11326 PL_savestack_ix = proto_perl->Tsavestack_ix;
11327 PL_savestack_max = proto_perl->Tsavestack_max;
11328 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11329 PL_savestack = ss_dup(proto_perl, param);
11333 ENTER; /* perl_destruct() wants to LEAVE; */
11335 /* although we're not duplicating the tmps stack, we should still
11336 * add entries for any SVs on the tmps stack that got cloned by a
11337 * non-refcount means (eg a temp in @_); otherwise they will be
11340 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11341 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11342 proto_perl->Ttmps_stack[i]);
11343 if (nsv && !SvREFCNT(nsv)) {
11345 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11350 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11351 PL_top_env = &PL_start_env;
11353 PL_op = proto_perl->Top;
11356 PL_Xpv = (XPV*)NULL;
11357 PL_na = proto_perl->Tna;
11359 PL_statbuf = proto_perl->Tstatbuf;
11360 PL_statcache = proto_perl->Tstatcache;
11361 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11362 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11364 PL_timesbuf = proto_perl->Ttimesbuf;
11367 PL_tainted = proto_perl->Ttainted;
11368 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11369 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11370 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11371 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11372 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11373 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11374 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11375 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11376 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11378 PL_restartop = proto_perl->Trestartop;
11379 PL_in_eval = proto_perl->Tin_eval;
11380 PL_delaymagic = proto_perl->Tdelaymagic;
11381 PL_dirty = proto_perl->Tdirty;
11382 PL_localizing = proto_perl->Tlocalizing;
11384 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11385 PL_hv_fetch_ent_mh = NULL;
11386 PL_modcount = proto_perl->Tmodcount;
11387 PL_lastgotoprobe = NULL;
11388 PL_dumpindent = proto_perl->Tdumpindent;
11390 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11391 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11392 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11393 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11394 PL_efloatbuf = NULL; /* reinits on demand */
11395 PL_efloatsize = 0; /* reinits on demand */
11399 PL_screamfirst = NULL;
11400 PL_screamnext = NULL;
11401 PL_maxscream = -1; /* reinits on demand */
11402 PL_lastscream = NULL;
11404 PL_watchaddr = NULL;
11407 PL_regdummy = proto_perl->Tregdummy;
11408 PL_colorset = 0; /* reinits PL_colors[] */
11409 /*PL_colors[6] = {0,0,0,0,0,0};*/
11413 /* Pluggable optimizer */
11414 PL_peepp = proto_perl->Tpeepp;
11416 PL_stashcache = newHV();
11418 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11419 ptr_table_free(PL_ptr_table);
11420 PL_ptr_table = NULL;
11423 /* Call the ->CLONE method, if it exists, for each of the stashes
11424 identified by sv_dup() above.
11426 while(av_len(param->stashes) != -1) {
11427 HV* const stash = (HV*) av_shift(param->stashes);
11428 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11429 if (cloner && GvCV(cloner)) {
11434 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11436 call_sv((SV*)GvCV(cloner), G_DISCARD);
11442 SvREFCNT_dec(param->stashes);
11444 /* orphaned? eg threads->new inside BEGIN or use */
11445 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11446 SvREFCNT_inc_simple_void(PL_compcv);
11447 SAVEFREESV(PL_compcv);
11453 #endif /* USE_ITHREADS */
11456 =head1 Unicode Support
11458 =for apidoc sv_recode_to_utf8
11460 The encoding is assumed to be an Encode object, on entry the PV
11461 of the sv is assumed to be octets in that encoding, and the sv
11462 will be converted into Unicode (and UTF-8).
11464 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11465 is not a reference, nothing is done to the sv. If the encoding is not
11466 an C<Encode::XS> Encoding object, bad things will happen.
11467 (See F<lib/encoding.pm> and L<Encode>).
11469 The PV of the sv is returned.
11474 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11477 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11491 Passing sv_yes is wrong - it needs to be or'ed set of constants
11492 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11493 remove converted chars from source.
11495 Both will default the value - let them.
11497 XPUSHs(&PL_sv_yes);
11500 call_method("decode", G_SCALAR);
11504 s = SvPV_const(uni, len);
11505 if (s != SvPVX_const(sv)) {
11506 SvGROW(sv, len + 1);
11507 Move(s, SvPVX(sv), len + 1, char);
11508 SvCUR_set(sv, len);
11515 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11519 =for apidoc sv_cat_decode
11521 The encoding is assumed to be an Encode object, the PV of the ssv is
11522 assumed to be octets in that encoding and decoding the input starts
11523 from the position which (PV + *offset) pointed to. The dsv will be
11524 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11525 when the string tstr appears in decoding output or the input ends on
11526 the PV of the ssv. The value which the offset points will be modified
11527 to the last input position on the ssv.
11529 Returns TRUE if the terminator was found, else returns FALSE.
11534 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11535 SV *ssv, int *offset, char *tstr, int tlen)
11539 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11550 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11551 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11553 call_method("cat_decode", G_SCALAR);
11555 ret = SvTRUE(TOPs);
11556 *offset = SvIV(offsv);
11562 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11567 /* ---------------------------------------------------------------------
11569 * support functions for report_uninit()
11572 /* the maxiumum size of array or hash where we will scan looking
11573 * for the undefined element that triggered the warning */
11575 #define FUV_MAX_SEARCH_SIZE 1000
11577 /* Look for an entry in the hash whose value has the same SV as val;
11578 * If so, return a mortal copy of the key. */
11581 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11584 register HE **array;
11587 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11588 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11591 array = HvARRAY(hv);
11593 for (i=HvMAX(hv); i>0; i--) {
11594 register HE *entry;
11595 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11596 if (HeVAL(entry) != val)
11598 if ( HeVAL(entry) == &PL_sv_undef ||
11599 HeVAL(entry) == &PL_sv_placeholder)
11603 if (HeKLEN(entry) == HEf_SVKEY)
11604 return sv_mortalcopy(HeKEY_sv(entry));
11605 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11611 /* Look for an entry in the array whose value has the same SV as val;
11612 * If so, return the index, otherwise return -1. */
11615 S_find_array_subscript(pTHX_ AV *av, SV* val)
11618 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11619 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11622 if (val != &PL_sv_undef) {
11623 SV ** const svp = AvARRAY(av);
11626 for (i=AvFILLp(av); i>=0; i--)
11633 /* S_varname(): return the name of a variable, optionally with a subscript.
11634 * If gv is non-zero, use the name of that global, along with gvtype (one
11635 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11636 * targ. Depending on the value of the subscript_type flag, return:
11639 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11640 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11641 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11642 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11645 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11646 SV* keyname, I32 aindex, int subscript_type)
11649 SV * const name = sv_newmortal();
11652 buffer[0] = gvtype;
11655 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11657 gv_fullname4(name, gv, buffer, 0);
11659 if ((unsigned int)SvPVX(name)[1] <= 26) {
11661 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11663 /* Swap the 1 unprintable control character for the 2 byte pretty
11664 version - ie substr($name, 1, 1) = $buffer; */
11665 sv_insert(name, 1, 1, buffer, 2);
11670 CV * const cv = find_runcv(&unused);
11674 if (!cv || !CvPADLIST(cv))
11676 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11677 sv = *av_fetch(av, targ, FALSE);
11678 /* SvLEN in a pad name is not to be trusted */
11679 sv_setpv(name, SvPV_nolen_const(sv));
11682 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11683 SV * const sv = newSV(0);
11684 *SvPVX(name) = '$';
11685 Perl_sv_catpvf(aTHX_ name, "{%s}",
11686 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11689 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11690 *SvPVX(name) = '$';
11691 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11693 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11694 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11701 =for apidoc find_uninit_var
11703 Find the name of the undefined variable (if any) that caused the operator o
11704 to issue a "Use of uninitialized value" warning.
11705 If match is true, only return a name if it's value matches uninit_sv.
11706 So roughly speaking, if a unary operator (such as OP_COS) generates a
11707 warning, then following the direct child of the op may yield an
11708 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11709 other hand, with OP_ADD there are two branches to follow, so we only print
11710 the variable name if we get an exact match.
11712 The name is returned as a mortal SV.
11714 Assumes that PL_op is the op that originally triggered the error, and that
11715 PL_comppad/PL_curpad points to the currently executing pad.
11721 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11729 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11730 uninit_sv == &PL_sv_placeholder)))
11733 switch (obase->op_type) {
11740 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11741 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11744 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11746 if (pad) { /* @lex, %lex */
11747 sv = PAD_SVl(obase->op_targ);
11751 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11752 /* @global, %global */
11753 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11756 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11758 else /* @{expr}, %{expr} */
11759 return find_uninit_var(cUNOPx(obase)->op_first,
11763 /* attempt to find a match within the aggregate */
11765 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11767 subscript_type = FUV_SUBSCRIPT_HASH;
11770 index = find_array_subscript((AV*)sv, uninit_sv);
11772 subscript_type = FUV_SUBSCRIPT_ARRAY;
11775 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11778 return varname(gv, hash ? '%' : '@', obase->op_targ,
11779 keysv, index, subscript_type);
11783 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11785 return varname(NULL, '$', obase->op_targ,
11786 NULL, 0, FUV_SUBSCRIPT_NONE);
11789 gv = cGVOPx_gv(obase);
11790 if (!gv || (match && GvSV(gv) != uninit_sv))
11792 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11795 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11798 av = (AV*)PAD_SV(obase->op_targ);
11799 if (!av || SvRMAGICAL(av))
11801 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11802 if (!svp || *svp != uninit_sv)
11805 return varname(NULL, '$', obase->op_targ,
11806 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11809 gv = cGVOPx_gv(obase);
11815 if (!av || SvRMAGICAL(av))
11817 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11818 if (!svp || *svp != uninit_sv)
11821 return varname(gv, '$', 0,
11822 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11827 o = cUNOPx(obase)->op_first;
11828 if (!o || o->op_type != OP_NULL ||
11829 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11831 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11835 if (PL_op == obase)
11836 /* $a[uninit_expr] or $h{uninit_expr} */
11837 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11840 o = cBINOPx(obase)->op_first;
11841 kid = cBINOPx(obase)->op_last;
11843 /* get the av or hv, and optionally the gv */
11845 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11846 sv = PAD_SV(o->op_targ);
11848 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11849 && cUNOPo->op_first->op_type == OP_GV)
11851 gv = cGVOPx_gv(cUNOPo->op_first);
11854 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11859 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11860 /* index is constant */
11864 if (obase->op_type == OP_HELEM) {
11865 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11866 if (!he || HeVAL(he) != uninit_sv)
11870 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11871 if (!svp || *svp != uninit_sv)
11875 if (obase->op_type == OP_HELEM)
11876 return varname(gv, '%', o->op_targ,
11877 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11879 return varname(gv, '@', o->op_targ, NULL,
11880 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11883 /* index is an expression;
11884 * attempt to find a match within the aggregate */
11885 if (obase->op_type == OP_HELEM) {
11886 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11888 return varname(gv, '%', o->op_targ,
11889 keysv, 0, FUV_SUBSCRIPT_HASH);
11892 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11894 return varname(gv, '@', o->op_targ,
11895 NULL, index, FUV_SUBSCRIPT_ARRAY);
11900 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11902 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11907 /* only examine RHS */
11908 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11911 o = cUNOPx(obase)->op_first;
11912 if (o->op_type == OP_PUSHMARK)
11915 if (!o->op_sibling) {
11916 /* one-arg version of open is highly magical */
11918 if (o->op_type == OP_GV) { /* open FOO; */
11920 if (match && GvSV(gv) != uninit_sv)
11922 return varname(gv, '$', 0,
11923 NULL, 0, FUV_SUBSCRIPT_NONE);
11925 /* other possibilities not handled are:
11926 * open $x; or open my $x; should return '${*$x}'
11927 * open expr; should return '$'.expr ideally
11933 /* ops where $_ may be an implicit arg */
11937 if ( !(obase->op_flags & OPf_STACKED)) {
11938 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11939 ? PAD_SVl(obase->op_targ)
11942 sv = sv_newmortal();
11943 sv_setpvn(sv, "$_", 2);
11951 /* skip filehandle as it can't produce 'undef' warning */
11952 o = cUNOPx(obase)->op_first;
11953 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11954 o = o->op_sibling->op_sibling;
11961 match = 1; /* XS or custom code could trigger random warnings */
11966 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11967 return sv_2mortal(newSVpvs("${$/}"));
11972 if (!(obase->op_flags & OPf_KIDS))
11974 o = cUNOPx(obase)->op_first;
11980 /* if all except one arg are constant, or have no side-effects,
11981 * or are optimized away, then it's unambiguous */
11983 for (kid=o; kid; kid = kid->op_sibling) {
11985 const OPCODE type = kid->op_type;
11986 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11987 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11988 || (type == OP_PUSHMARK)
11992 if (o2) { /* more than one found */
11999 return find_uninit_var(o2, uninit_sv, match);
12001 /* scan all args */
12003 sv = find_uninit_var(o, uninit_sv, 1);
12015 =for apidoc report_uninit
12017 Print appropriate "Use of uninitialized variable" warning
12023 Perl_report_uninit(pTHX_ SV* uninit_sv)
12027 SV* varname = NULL;
12029 varname = find_uninit_var(PL_op, uninit_sv,0);
12031 sv_insert(varname, 0, 0, " ", 1);
12033 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12034 varname ? SvPV_nolen_const(varname) : "",
12035 " in ", OP_DESC(PL_op));
12038 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12044 * c-indentation-style: bsd
12045 * c-basic-offset: 4
12046 * indent-tabs-mode: t
12049 * ex: set ts=8 sts=4 sw=4 noet: