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 /* Could put this in the else clause below, as PVMG must have SvPVX
1281 0 already (the assertion above) */
1284 if (old_type >= SVt_PVMG) {
1285 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1286 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 /* XXX Is this still needed? Was it ever needed? Surely as there is
1293 no route from NV to PVIV, NOK can never be true */
1294 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = (char*)saferealloc(s, newlen);
1456 s = (char*)safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1855 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));
1856 if (SvNVX(sv) < (NV)IV_MIN) {
1857 (void)SvIOKp_on(sv);
1859 SvIV_set(sv, IV_MIN);
1860 return IS_NUMBER_UNDERFLOW_IV;
1862 if (SvNVX(sv) > (NV)UV_MAX) {
1863 (void)SvIOKp_on(sv);
1866 SvUV_set(sv, UV_MAX);
1867 return IS_NUMBER_OVERFLOW_UV;
1869 (void)SvIOKp_on(sv);
1871 /* Can't use strtol etc to convert this string. (See truth table in
1873 if (SvNVX(sv) <= (UV)IV_MAX) {
1874 SvIV_set(sv, I_V(SvNVX(sv)));
1875 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1876 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1878 /* Integer is imprecise. NOK, IOKp */
1880 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1883 SvUV_set(sv, U_V(SvNVX(sv)));
1884 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1885 if (SvUVX(sv) == UV_MAX) {
1886 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1887 possibly be preserved by NV. Hence, it must be overflow.
1889 return IS_NUMBER_OVERFLOW_UV;
1891 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1893 /* Integer is imprecise. NOK, IOKp */
1895 return IS_NUMBER_OVERFLOW_IV;
1897 #endif /* !NV_PRESERVES_UV*/
1900 S_sv_2iuv_common(pTHX_ SV *sv) {
1903 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1904 * without also getting a cached IV/UV from it at the same time
1905 * (ie PV->NV conversion should detect loss of accuracy and cache
1906 * IV or UV at same time to avoid this. */
1907 /* IV-over-UV optimisation - choose to cache IV if possible */
1909 if (SvTYPE(sv) == SVt_NV)
1910 sv_upgrade(sv, SVt_PVNV);
1912 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1913 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1914 certainly cast into the IV range at IV_MAX, whereas the correct
1915 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1917 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1918 if (Perl_isnan(SvNVX(sv))) {
1924 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1925 SvIV_set(sv, I_V(SvNVX(sv)));
1926 if (SvNVX(sv) == (NV) SvIVX(sv)
1927 #ifndef NV_PRESERVES_UV
1928 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1929 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1930 /* Don't flag it as "accurately an integer" if the number
1931 came from a (by definition imprecise) NV operation, and
1932 we're outside the range of NV integer precision */
1935 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1943 /* IV not precise. No need to convert from PV, as NV
1944 conversion would already have cached IV if it detected
1945 that PV->IV would be better than PV->NV->IV
1946 flags already correct - don't set public IOK. */
1947 DEBUG_c(PerlIO_printf(Perl_debug_log,
1948 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1953 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1954 but the cast (NV)IV_MIN rounds to a the value less (more
1955 negative) than IV_MIN which happens to be equal to SvNVX ??
1956 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1957 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1958 (NV)UVX == NVX are both true, but the values differ. :-(
1959 Hopefully for 2s complement IV_MIN is something like
1960 0x8000000000000000 which will be exact. NWC */
1963 SvUV_set(sv, U_V(SvNVX(sv)));
1965 (SvNVX(sv) == (NV) SvUVX(sv))
1966 #ifndef NV_PRESERVES_UV
1967 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1968 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1969 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1970 /* Don't flag it as "accurately an integer" if the number
1971 came from a (by definition imprecise) NV operation, and
1972 we're outside the range of NV integer precision */
1977 DEBUG_c(PerlIO_printf(Perl_debug_log,
1978 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1984 else if (SvPOKp(sv) && SvLEN(sv)) {
1986 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1987 /* We want to avoid a possible problem when we cache an IV/ a UV which
1988 may be later translated to an NV, and the resulting NV is not
1989 the same as the direct translation of the initial string
1990 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1991 be careful to ensure that the value with the .456 is around if the
1992 NV value is requested in the future).
1994 This means that if we cache such an IV/a UV, we need to cache the
1995 NV as well. Moreover, we trade speed for space, and do not
1996 cache the NV if we are sure it's not needed.
1999 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2000 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2001 == IS_NUMBER_IN_UV) {
2002 /* It's definitely an integer, only upgrade to PVIV */
2003 if (SvTYPE(sv) < SVt_PVIV)
2004 sv_upgrade(sv, SVt_PVIV);
2006 } else if (SvTYPE(sv) < SVt_PVNV)
2007 sv_upgrade(sv, SVt_PVNV);
2009 /* If NVs preserve UVs then we only use the UV value if we know that
2010 we aren't going to call atof() below. If NVs don't preserve UVs
2011 then the value returned may have more precision than atof() will
2012 return, even though value isn't perfectly accurate. */
2013 if ((numtype & (IS_NUMBER_IN_UV
2014 #ifdef NV_PRESERVES_UV
2017 )) == IS_NUMBER_IN_UV) {
2018 /* This won't turn off the public IOK flag if it was set above */
2019 (void)SvIOKp_on(sv);
2021 if (!(numtype & IS_NUMBER_NEG)) {
2023 if (value <= (UV)IV_MAX) {
2024 SvIV_set(sv, (IV)value);
2026 /* it didn't overflow, and it was positive. */
2027 SvUV_set(sv, value);
2031 /* 2s complement assumption */
2032 if (value <= (UV)IV_MIN) {
2033 SvIV_set(sv, -(IV)value);
2035 /* Too negative for an IV. This is a double upgrade, but
2036 I'm assuming it will be rare. */
2037 if (SvTYPE(sv) < SVt_PVNV)
2038 sv_upgrade(sv, SVt_PVNV);
2042 SvNV_set(sv, -(NV)value);
2043 SvIV_set(sv, IV_MIN);
2047 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2048 will be in the previous block to set the IV slot, and the next
2049 block to set the NV slot. So no else here. */
2051 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2052 != IS_NUMBER_IN_UV) {
2053 /* It wasn't an (integer that doesn't overflow the UV). */
2054 SvNV_set(sv, Atof(SvPVX_const(sv)));
2056 if (! numtype && ckWARN(WARN_NUMERIC))
2059 #if defined(USE_LONG_DOUBLE)
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2067 #ifdef NV_PRESERVES_UV
2068 (void)SvIOKp_on(sv);
2070 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2071 SvIV_set(sv, I_V(SvNVX(sv)));
2072 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2075 NOOP; /* Integer is imprecise. NOK, IOKp */
2077 /* UV will not work better than IV */
2079 if (SvNVX(sv) > (NV)UV_MAX) {
2081 /* Integer is inaccurate. NOK, IOKp, is UV */
2082 SvUV_set(sv, UV_MAX);
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2085 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2086 NV preservse UV so can do correct comparison. */
2087 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2090 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2095 #else /* NV_PRESERVES_UV */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2098 /* The IV/UV slot will have been set from value returned by
2099 grok_number above. The NV slot has just been set using
2102 assert (SvIOKp(sv));
2104 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2105 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2106 /* Small enough to preserve all bits. */
2107 (void)SvIOKp_on(sv);
2109 SvIV_set(sv, I_V(SvNVX(sv)));
2110 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2112 /* Assumption: first non-preserved integer is < IV_MAX,
2113 this NV is in the preserved range, therefore: */
2114 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2116 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);
2120 0 0 already failed to read UV.
2121 0 1 already failed to read UV.
2122 1 0 you won't get here in this case. IV/UV
2123 slot set, public IOK, Atof() unneeded.
2124 1 1 already read UV.
2125 so there's no point in sv_2iuv_non_preserve() attempting
2126 to use atol, strtol, strtoul etc. */
2127 sv_2iuv_non_preserve (sv, numtype);
2130 #endif /* NV_PRESERVES_UV */
2134 if (isGV_with_GP(sv))
2135 return glob_2number((GV *)sv);
2137 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2138 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2141 if (SvTYPE(sv) < SVt_IV)
2142 /* Typically the caller expects that sv_any is not NULL now. */
2143 sv_upgrade(sv, SVt_IV);
2144 /* Return 0 from the caller. */
2151 =for apidoc sv_2iv_flags
2153 Return the integer value of an SV, doing any necessary string
2154 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2155 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2161 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2166 if (SvGMAGICAL(sv)) {
2167 if (flags & SV_GMAGIC)
2172 return I_V(SvNVX(sv));
2174 if (SvPOKp(sv) && SvLEN(sv)) {
2177 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == IS_NUMBER_IN_UV) {
2181 /* It's definitely an integer */
2182 if (numtype & IS_NUMBER_NEG) {
2183 if (value < (UV)IV_MIN)
2186 if (value < (UV)IV_MAX)
2191 if (ckWARN(WARN_NUMERIC))
2194 return I_V(Atof(SvPVX_const(sv)));
2199 assert(SvTYPE(sv) >= SVt_PVMG);
2200 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2201 } else if (SvTHINKFIRST(sv)) {
2205 SV * const tmpstr=AMG_CALLun(sv,numer);
2206 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207 return SvIV(tmpstr);
2210 return PTR2IV(SvRV(sv));
2213 sv_force_normal_flags(sv, 0);
2215 if (SvREADONLY(sv) && !SvOK(sv)) {
2216 if (ckWARN(WARN_UNINITIALIZED))
2222 if (S_sv_2iuv_common(aTHX_ sv))
2225 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226 PTR2UV(sv),SvIVX(sv)));
2227 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2231 =for apidoc sv_2uv_flags
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2246 if (SvGMAGICAL(sv)) {
2247 if (flags & SV_GMAGIC)
2252 return U_V(SvNVX(sv));
2253 if (SvPOKp(sv) && SvLEN(sv)) {
2256 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2258 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2259 == IS_NUMBER_IN_UV) {
2260 /* It's definitely an integer */
2261 if (!(numtype & IS_NUMBER_NEG))
2265 if (ckWARN(WARN_NUMERIC))
2268 return U_V(Atof(SvPVX_const(sv)));
2273 assert(SvTYPE(sv) >= SVt_PVMG);
2274 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2275 } else if (SvTHINKFIRST(sv)) {
2279 SV *const tmpstr = AMG_CALLun(sv,numer);
2280 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2281 return SvUV(tmpstr);
2284 return PTR2UV(SvRV(sv));
2287 sv_force_normal_flags(sv, 0);
2289 if (SvREADONLY(sv) && !SvOK(sv)) {
2290 if (ckWARN(WARN_UNINITIALIZED))
2296 if (S_sv_2iuv_common(aTHX_ sv))
2300 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2301 PTR2UV(sv),SvUVX(sv)));
2302 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2308 Return the num value of an SV, doing any necessary string or integer
2309 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2316 Perl_sv_2nv(pTHX_ register SV *sv)
2321 if (SvGMAGICAL(sv)) {
2325 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2326 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2327 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2329 return Atof(SvPVX_const(sv));
2333 return (NV)SvUVX(sv);
2335 return (NV)SvIVX(sv);
2340 assert(SvTYPE(sv) >= SVt_PVMG);
2341 /* This falls through to the report_uninit near the end of the
2343 } else if (SvTHINKFIRST(sv)) {
2347 SV *const tmpstr = AMG_CALLun(sv,numer);
2348 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2349 return SvNV(tmpstr);
2352 return PTR2NV(SvRV(sv));
2355 sv_force_normal_flags(sv, 0);
2357 if (SvREADONLY(sv) && !SvOK(sv)) {
2358 if (ckWARN(WARN_UNINITIALIZED))
2363 if (SvTYPE(sv) < SVt_NV) {
2364 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2365 sv_upgrade(sv, SVt_NV);
2366 #ifdef USE_LONG_DOUBLE
2368 STORE_NUMERIC_LOCAL_SET_STANDARD();
2369 PerlIO_printf(Perl_debug_log,
2370 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2371 PTR2UV(sv), SvNVX(sv));
2372 RESTORE_NUMERIC_LOCAL();
2376 STORE_NUMERIC_LOCAL_SET_STANDARD();
2377 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2378 PTR2UV(sv), SvNVX(sv));
2379 RESTORE_NUMERIC_LOCAL();
2383 else if (SvTYPE(sv) < SVt_PVNV)
2384 sv_upgrade(sv, SVt_PVNV);
2389 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2390 #ifdef NV_PRESERVES_UV
2393 /* Only set the public NV OK flag if this NV preserves the IV */
2394 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2395 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2396 : (SvIVX(sv) == I_V(SvNVX(sv))))
2402 else if (SvPOKp(sv) && SvLEN(sv)) {
2404 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2405 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2407 #ifdef NV_PRESERVES_UV
2408 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2409 == IS_NUMBER_IN_UV) {
2410 /* It's definitely an integer */
2411 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 SvNV_set(sv, Atof(SvPVX_const(sv)));
2417 /* Only set the public NV OK flag if this NV preserves the value in
2418 the PV at least as well as an IV/UV would.
2419 Not sure how to do this 100% reliably. */
2420 /* if that shift count is out of range then Configure's test is
2421 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2423 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2424 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2425 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2426 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2427 /* Can't use strtol etc to convert this string, so don't try.
2428 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2431 /* value has been set. It may not be precise. */
2432 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2433 /* 2s complement assumption for (UV)IV_MIN */
2434 SvNOK_on(sv); /* Integer is too negative. */
2439 if (numtype & IS_NUMBER_NEG) {
2440 SvIV_set(sv, -(IV)value);
2441 } else if (value <= (UV)IV_MAX) {
2442 SvIV_set(sv, (IV)value);
2444 SvUV_set(sv, value);
2448 if (numtype & IS_NUMBER_NOT_INT) {
2449 /* I believe that even if the original PV had decimals,
2450 they are lost beyond the limit of the FP precision.
2451 However, neither is canonical, so both only get p
2452 flags. NWC, 2000/11/25 */
2453 /* Both already have p flags, so do nothing */
2455 const NV nv = SvNVX(sv);
2456 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2457 if (SvIVX(sv) == I_V(nv)) {
2460 /* It had no "." so it must be integer. */
2464 /* between IV_MAX and NV(UV_MAX).
2465 Could be slightly > UV_MAX */
2467 if (numtype & IS_NUMBER_NOT_INT) {
2468 /* UV and NV both imprecise. */
2470 const UV nv_as_uv = U_V(nv);
2472 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2481 #endif /* NV_PRESERVES_UV */
2484 if (isGV_with_GP(sv)) {
2485 glob_2number((GV *)sv);
2489 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2491 assert (SvTYPE(sv) >= SVt_NV);
2492 /* Typically the caller expects that sv_any is not NULL now. */
2493 /* XXX Ilya implies that this is a bug in callers that assume this
2494 and ideally should be fixed. */
2497 #if defined(USE_LONG_DOUBLE)
2499 STORE_NUMERIC_LOCAL_SET_STANDARD();
2500 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2501 PTR2UV(sv), SvNVX(sv));
2502 RESTORE_NUMERIC_LOCAL();
2506 STORE_NUMERIC_LOCAL_SET_STANDARD();
2507 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2508 PTR2UV(sv), SvNVX(sv));
2509 RESTORE_NUMERIC_LOCAL();
2515 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2516 * UV as a string towards the end of buf, and return pointers to start and
2519 * We assume that buf is at least TYPE_CHARS(UV) long.
2523 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2525 char *ptr = buf + TYPE_CHARS(UV);
2526 char * const ebuf = ptr;
2539 *--ptr = '0' + (char)(uv % 10);
2547 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2548 * a regexp to its stringified form.
2552 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2554 const regexp * const re = (regexp *)mg->mg_obj;
2557 const char *fptr = "msix";
2562 bool need_newline = 0;
2563 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2565 while((ch = *fptr++)) {
2567 reflags[left++] = ch;
2570 reflags[right--] = ch;
2575 reflags[left] = '-';
2579 mg->mg_len = re->prelen + 4 + left;
2581 * If /x was used, we have to worry about a regex ending with a
2582 * comment later being embedded within another regex. If so, we don't
2583 * want this regex's "commentization" to leak out to the right part of
2584 * the enclosing regex, we must cap it with a newline.
2586 * So, if /x was used, we scan backwards from the end of the regex. If
2587 * we find a '#' before we find a newline, we need to add a newline
2588 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2589 * we don't need to add anything. -jfriedl
2591 if (PMf_EXTENDED & re->reganch) {
2592 const char *endptr = re->precomp + re->prelen;
2593 while (endptr >= re->precomp) {
2594 const char c = *(endptr--);
2596 break; /* don't need another */
2598 /* we end while in a comment, so we need a newline */
2599 mg->mg_len++; /* save space for it */
2600 need_newline = 1; /* note to add it */
2606 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2607 mg->mg_ptr[0] = '(';
2608 mg->mg_ptr[1] = '?';
2609 Copy(reflags, mg->mg_ptr+2, left, char);
2610 *(mg->mg_ptr+left+2) = ':';
2611 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2613 mg->mg_ptr[mg->mg_len - 2] = '\n';
2614 mg->mg_ptr[mg->mg_len - 1] = ')';
2615 mg->mg_ptr[mg->mg_len] = 0;
2617 PL_reginterp_cnt += re->program[0].next_off;
2619 if (re->reganch & ROPT_UTF8)
2629 =for apidoc sv_2pv_flags
2631 Returns a pointer to the string value of an SV, and sets *lp to its length.
2632 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2634 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2635 usually end up here too.
2641 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2651 if (SvGMAGICAL(sv)) {
2652 if (flags & SV_GMAGIC)
2657 if (flags & SV_MUTABLE_RETURN)
2658 return SvPVX_mutable(sv);
2659 if (flags & SV_CONST_RETURN)
2660 return (char *)SvPVX_const(sv);
2663 if (SvIOKp(sv) || SvNOKp(sv)) {
2664 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2669 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2670 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2672 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2679 #ifdef FIXNEGATIVEZERO
2680 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2686 SvUPGRADE(sv, SVt_PV);
2689 s = SvGROW_mutable(sv, len + 1);
2692 return (char*)memcpy(s, tbuf, len + 1);
2698 assert(SvTYPE(sv) >= SVt_PVMG);
2699 /* This falls through to the report_uninit near the end of the
2701 } else if (SvTHINKFIRST(sv)) {
2705 SV *const tmpstr = AMG_CALLun(sv,string);
2706 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2708 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2712 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2713 if (flags & SV_CONST_RETURN) {
2714 pv = (char *) SvPVX_const(tmpstr);
2716 pv = (flags & SV_MUTABLE_RETURN)
2717 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2720 *lp = SvCUR(tmpstr);
2722 pv = sv_2pv_flags(tmpstr, lp, flags);
2736 const SV *const referent = (SV*)SvRV(sv);
2740 retval = buffer = savepvn("NULLREF", len);
2741 } else if (SvTYPE(referent) == SVt_PVMG
2742 && ((SvFLAGS(referent) &
2743 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2744 == (SVs_OBJECT|SVs_SMG))
2745 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2746 return stringify_regexp(sv, mg, lp);
2748 const char *const typestr = sv_reftype(referent, 0);
2749 const STRLEN typelen = strlen(typestr);
2750 UV addr = PTR2UV(referent);
2751 const char *stashname = NULL;
2752 STRLEN stashnamelen = 0; /* hush, gcc */
2753 const char *buffer_end;
2755 if (SvOBJECT(referent)) {
2756 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2759 stashname = HEK_KEY(name);
2760 stashnamelen = HEK_LEN(name);
2762 if (HEK_UTF8(name)) {
2768 stashname = "__ANON__";
2771 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2772 + 2 * sizeof(UV) + 2 /* )\0 */;
2774 len = typelen + 3 /* (0x */
2775 + 2 * sizeof(UV) + 2 /* )\0 */;
2778 Newx(buffer, len, char);
2779 buffer_end = retval = buffer + len;
2781 /* Working backwards */
2785 *--retval = PL_hexdigit[addr & 15];
2786 } while (addr >>= 4);
2792 memcpy(retval, typestr, typelen);
2796 retval -= stashnamelen;
2797 memcpy(retval, stashname, stashnamelen);
2799 /* retval may not neccesarily have reached the start of the
2801 assert (retval >= buffer);
2803 len = buffer_end - retval - 1; /* -1 for that \0 */
2811 if (SvREADONLY(sv) && !SvOK(sv)) {
2812 if (ckWARN(WARN_UNINITIALIZED))
2819 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2820 /* I'm assuming that if both IV and NV are equally valid then
2821 converting the IV is going to be more efficient */
2822 const U32 isIOK = SvIOK(sv);
2823 const U32 isUIOK = SvIsUV(sv);
2824 char buf[TYPE_CHARS(UV)];
2827 if (SvTYPE(sv) < SVt_PVIV)
2828 sv_upgrade(sv, SVt_PVIV);
2829 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2830 /* inlined from sv_setpvn */
2831 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2832 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2833 SvCUR_set(sv, ebuf - ptr);
2843 else if (SvNOKp(sv)) {
2844 const int olderrno = errno;
2845 if (SvTYPE(sv) < SVt_PVNV)
2846 sv_upgrade(sv, SVt_PVNV);
2847 /* The +20 is pure guesswork. Configure test needed. --jhi */
2848 s = SvGROW_mutable(sv, NV_DIG + 20);
2849 /* some Xenix systems wipe out errno here */
2851 if (SvNVX(sv) == 0.0)
2852 my_strlcpy(s, "0", SvLEN(sv));
2856 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2859 #ifdef FIXNEGATIVEZERO
2860 if (*s == '-' && s[1] == '0' && !s[2])
2861 my_strlcpy(s, "0", SvLEN(s));
2870 if (isGV_with_GP(sv))
2871 return glob_2pv((GV *)sv, lp);
2873 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2877 if (SvTYPE(sv) < SVt_PV)
2878 /* Typically the caller expects that sv_any is not NULL now. */
2879 sv_upgrade(sv, SVt_PV);
2883 const STRLEN len = s - SvPVX_const(sv);
2889 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2890 PTR2UV(sv),SvPVX_const(sv)));
2891 if (flags & SV_CONST_RETURN)
2892 return (char *)SvPVX_const(sv);
2893 if (flags & SV_MUTABLE_RETURN)
2894 return SvPVX_mutable(sv);
2899 =for apidoc sv_copypv
2901 Copies a stringified representation of the source SV into the
2902 destination SV. Automatically performs any necessary mg_get and
2903 coercion of numeric values into strings. Guaranteed to preserve
2904 UTF-8 flag even from overloaded objects. Similar in nature to
2905 sv_2pv[_flags] but operates directly on an SV instead of just the
2906 string. Mostly uses sv_2pv_flags to do its work, except when that
2907 would lose the UTF-8'ness of the PV.
2913 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2916 const char * const s = SvPV_const(ssv,len);
2917 sv_setpvn(dsv,s,len);
2925 =for apidoc sv_2pvbyte
2927 Return a pointer to the byte-encoded representation of the SV, and set *lp
2928 to its length. May cause the SV to be downgraded from UTF-8 as a
2931 Usually accessed via the C<SvPVbyte> macro.
2937 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2939 sv_utf8_downgrade(sv,0);
2940 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2944 =for apidoc sv_2pvutf8
2946 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2947 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2949 Usually accessed via the C<SvPVutf8> macro.
2955 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2957 sv_utf8_upgrade(sv);
2958 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2963 =for apidoc sv_2bool
2965 This function is only called on magical items, and is only used by
2966 sv_true() or its macro equivalent.
2972 Perl_sv_2bool(pTHX_ register SV *sv)
2981 SV * const tmpsv = AMG_CALLun(sv,bool_);
2982 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2983 return (bool)SvTRUE(tmpsv);
2985 return SvRV(sv) != 0;
2988 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2990 (*sv->sv_u.svu_pv > '0' ||
2991 Xpvtmp->xpv_cur > 1 ||
2992 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2999 return SvIVX(sv) != 0;
3002 return SvNVX(sv) != 0.0;
3004 if (isGV_with_GP(sv))
3014 =for apidoc sv_utf8_upgrade
3016 Converts the PV of an SV to its UTF-8-encoded form.
3017 Forces the SV to string form if it is not already.
3018 Always sets the SvUTF8 flag to avoid future validity checks even
3019 if all the bytes have hibit clear.
3021 This is not as a general purpose byte encoding to Unicode interface:
3022 use the Encode extension for that.
3024 =for apidoc sv_utf8_upgrade_flags
3026 Converts the PV of an SV to its UTF-8-encoded form.
3027 Forces the SV to string form if it is not already.
3028 Always sets the SvUTF8 flag to avoid future validity checks even
3029 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3030 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3031 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3033 This is not as a general purpose byte encoding to Unicode interface:
3034 use the Encode extension for that.
3040 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3043 if (sv == &PL_sv_undef)
3047 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3048 (void) sv_2pv_flags(sv,&len, flags);
3052 (void) SvPV_force(sv,len);
3061 sv_force_normal_flags(sv, 0);
3064 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3065 sv_recode_to_utf8(sv, PL_encoding);
3066 else { /* Assume Latin-1/EBCDIC */
3067 /* This function could be much more efficient if we
3068 * had a FLAG in SVs to signal if there are any hibit
3069 * chars in the PV. Given that there isn't such a flag
3070 * make the loop as fast as possible. */
3071 const U8 * const s = (U8 *) SvPVX_const(sv);
3072 const U8 * const e = (U8 *) SvEND(sv);
3077 /* Check for hi bit */
3078 if (!NATIVE_IS_INVARIANT(ch)) {
3079 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3080 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3082 SvPV_free(sv); /* No longer using what was there before. */
3083 SvPV_set(sv, (char*)recoded);
3084 SvCUR_set(sv, len - 1);
3085 SvLEN_set(sv, len); /* No longer know the real size. */
3089 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3096 =for apidoc sv_utf8_downgrade
3098 Attempts to convert the PV of an SV from characters to bytes.
3099 If the PV contains a character beyond byte, this conversion will fail;
3100 in this case, either returns false or, if C<fail_ok> is not
3103 This is not as a general purpose Unicode to byte encoding interface:
3104 use the Encode extension for that.
3110 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3113 if (SvPOKp(sv) && SvUTF8(sv)) {
3119 sv_force_normal_flags(sv, 0);
3121 s = (U8 *) SvPV(sv, len);
3122 if (!utf8_to_bytes(s, &len)) {
3127 Perl_croak(aTHX_ "Wide character in %s",
3130 Perl_croak(aTHX_ "Wide character");
3141 =for apidoc sv_utf8_encode
3143 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3144 flag off so that it looks like octets again.
3150 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3153 sv_force_normal_flags(sv, 0);
3155 if (SvREADONLY(sv)) {
3156 Perl_croak(aTHX_ PL_no_modify);
3158 (void) sv_utf8_upgrade(sv);
3163 =for apidoc sv_utf8_decode
3165 If the PV of the SV is an octet sequence in UTF-8
3166 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3167 so that it looks like a character. If the PV contains only single-byte
3168 characters, the C<SvUTF8> flag stays being off.
3169 Scans PV for validity and returns false if the PV is invalid UTF-8.
3175 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3181 /* The octets may have got themselves encoded - get them back as
3184 if (!sv_utf8_downgrade(sv, TRUE))
3187 /* it is actually just a matter of turning the utf8 flag on, but
3188 * we want to make sure everything inside is valid utf8 first.
3190 c = (const U8 *) SvPVX_const(sv);
3191 if (!is_utf8_string(c, SvCUR(sv)+1))
3193 e = (const U8 *) SvEND(sv);
3196 if (!UTF8_IS_INVARIANT(ch)) {
3206 =for apidoc sv_setsv
3208 Copies the contents of the source SV C<ssv> into the destination SV
3209 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3210 function if the source SV needs to be reused. Does not handle 'set' magic.
3211 Loosely speaking, it performs a copy-by-value, obliterating any previous
3212 content of the destination.
3214 You probably want to use one of the assortment of wrappers, such as
3215 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3216 C<SvSetMagicSV_nosteal>.
3218 =for apidoc sv_setsv_flags
3220 Copies the contents of the source SV C<ssv> into the destination SV
3221 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3222 function if the source SV needs to be reused. Does not handle 'set' magic.
3223 Loosely speaking, it performs a copy-by-value, obliterating any previous
3224 content of the destination.
3225 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3226 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3227 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3228 and C<sv_setsv_nomg> are implemented in terms of this function.
3230 You probably want to use one of the assortment of wrappers, such as
3231 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3232 C<SvSetMagicSV_nosteal>.
3234 This is the primary function for copying scalars, and most other
3235 copy-ish functions and macros use this underneath.
3241 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3243 if (dtype != SVt_PVGV) {
3244 const char * const name = GvNAME(sstr);
3245 const STRLEN len = GvNAMELEN(sstr);
3246 /* don't upgrade SVt_PVLV: it can hold a glob */
3247 if (dtype != SVt_PVLV) {
3248 if (dtype >= SVt_PV) {
3254 sv_upgrade(dstr, SVt_PVGV);
3255 (void)SvOK_off(dstr);
3258 GvSTASH(dstr) = GvSTASH(sstr);
3260 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3261 gv_name_set((GV *)dstr, name, len, GV_ADD);
3262 SvFAKE_on(dstr); /* can coerce to non-glob */
3265 #ifdef GV_UNIQUE_CHECK
3266 if (GvUNIQUE((GV*)dstr)) {
3267 Perl_croak(aTHX_ PL_no_modify);
3273 (void)SvOK_off(dstr);
3275 GvINTRO_off(dstr); /* one-shot flag */
3276 GvGP(dstr) = gp_ref(GvGP(sstr));
3277 if (SvTAINTED(sstr))
3279 if (GvIMPORTED(dstr) != GVf_IMPORTED
3280 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3282 GvIMPORTED_on(dstr);
3289 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3290 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3292 const int intro = GvINTRO(dstr);
3295 const U32 stype = SvTYPE(sref);
3298 #ifdef GV_UNIQUE_CHECK
3299 if (GvUNIQUE((GV*)dstr)) {
3300 Perl_croak(aTHX_ PL_no_modify);
3305 GvINTRO_off(dstr); /* one-shot flag */
3306 GvLINE(dstr) = CopLINE(PL_curcop);
3307 GvEGV(dstr) = (GV*)dstr;
3312 location = (SV **) &GvCV(dstr);
3313 import_flag = GVf_IMPORTED_CV;
3316 location = (SV **) &GvHV(dstr);
3317 import_flag = GVf_IMPORTED_HV;
3320 location = (SV **) &GvAV(dstr);
3321 import_flag = GVf_IMPORTED_AV;
3324 location = (SV **) &GvIOp(dstr);
3327 location = (SV **) &GvFORM(dstr);
3329 location = &GvSV(dstr);
3330 import_flag = GVf_IMPORTED_SV;
3333 if (stype == SVt_PVCV) {
3334 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3335 SvREFCNT_dec(GvCV(dstr));
3337 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3338 PL_sub_generation++;
3341 SAVEGENERICSV(*location);
3345 if (stype == SVt_PVCV && *location != sref) {
3346 CV* const cv = (CV*)*location;
3348 if (!GvCVGEN((GV*)dstr) &&
3349 (CvROOT(cv) || CvXSUB(cv)))
3351 /* Redefining a sub - warning is mandatory if
3352 it was a const and its value changed. */
3353 if (CvCONST(cv) && CvCONST((CV*)sref)
3354 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3356 /* They are 2 constant subroutines generated from
3357 the same constant. This probably means that
3358 they are really the "same" proxy subroutine
3359 instantiated in 2 places. Most likely this is
3360 when a constant is exported twice. Don't warn.
3363 else if (ckWARN(WARN_REDEFINE)
3365 && (!CvCONST((CV*)sref)
3366 || sv_cmp(cv_const_sv(cv),
3367 cv_const_sv((CV*)sref))))) {
3368 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3371 ? "Constant subroutine %s::%s redefined"
3372 : "Subroutine %s::%s redefined"),
3373 HvNAME_get(GvSTASH((GV*)dstr)),
3374 GvENAME((GV*)dstr));
3378 cv_ckproto_len(cv, (GV*)dstr,
3379 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3380 SvPOK(sref) ? SvCUR(sref) : 0);
3382 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3383 GvASSUMECV_on(dstr);
3384 PL_sub_generation++;
3387 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3388 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3389 GvFLAGS(dstr) |= import_flag;
3394 if (SvTAINTED(sstr))
3400 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3403 register U32 sflags;
3405 register svtype stype;
3410 if (SvIS_FREED(dstr)) {
3411 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3412 " to a freed scalar %p", sstr, dstr);
3414 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3416 sstr = &PL_sv_undef;
3417 if (SvIS_FREED(sstr)) {
3418 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3421 stype = SvTYPE(sstr);
3422 dtype = SvTYPE(dstr);
3427 /* need to nuke the magic */
3429 SvRMAGICAL_off(dstr);
3432 /* There's a lot of redundancy below but we're going for speed here */
3437 if (dtype != SVt_PVGV) {
3438 (void)SvOK_off(dstr);
3446 sv_upgrade(dstr, SVt_IV);
3451 sv_upgrade(dstr, SVt_PVIV);
3454 (void)SvIOK_only(dstr);
3455 SvIV_set(dstr, SvIVX(sstr));
3458 /* SvTAINTED can only be true if the SV has taint magic, which in
3459 turn means that the SV type is PVMG (or greater). This is the
3460 case statement for SVt_IV, so this cannot be true (whatever gcov
3462 assert(!SvTAINTED(sstr));
3472 sv_upgrade(dstr, SVt_NV);
3477 sv_upgrade(dstr, SVt_PVNV);
3480 SvNV_set(dstr, SvNVX(sstr));
3481 (void)SvNOK_only(dstr);
3482 /* SvTAINTED can only be true if the SV has taint magic, which in
3483 turn means that the SV type is PVMG (or greater). This is the
3484 case statement for SVt_NV, so this cannot be true (whatever gcov
3486 assert(!SvTAINTED(sstr));
3493 sv_upgrade(dstr, SVt_RV);
3496 #ifdef PERL_OLD_COPY_ON_WRITE
3497 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3498 if (dtype < SVt_PVIV)
3499 sv_upgrade(dstr, SVt_PVIV);
3506 sv_upgrade(dstr, SVt_PV);
3509 if (dtype < SVt_PVIV)
3510 sv_upgrade(dstr, SVt_PVIV);
3513 if (dtype < SVt_PVNV)
3514 sv_upgrade(dstr, SVt_PVNV);
3518 const char * const type = sv_reftype(sstr,0);
3520 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3522 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3527 if (dtype <= SVt_PVGV) {
3528 glob_assign_glob(dstr, sstr, dtype);
3536 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3538 if (SvTYPE(sstr) != stype) {
3539 stype = SvTYPE(sstr);
3540 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3541 glob_assign_glob(dstr, sstr, dtype);
3546 if (stype == SVt_PVLV)
3547 SvUPGRADE(dstr, SVt_PVNV);
3549 SvUPGRADE(dstr, (svtype)stype);
3552 /* dstr may have been upgraded. */
3553 dtype = SvTYPE(dstr);
3554 sflags = SvFLAGS(sstr);
3556 if (sflags & SVf_ROK) {
3557 if (dtype == SVt_PVGV &&
3558 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3561 if (GvIMPORTED(dstr) != GVf_IMPORTED
3562 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3564 GvIMPORTED_on(dstr);
3569 glob_assign_glob(dstr, sstr, dtype);
3573 if (dtype >= SVt_PV) {
3574 if (dtype == SVt_PVGV) {
3575 glob_assign_ref(dstr, sstr);
3578 if (SvPVX_const(dstr)) {
3584 (void)SvOK_off(dstr);
3585 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3586 SvFLAGS(dstr) |= sflags & SVf_ROK;
3587 assert(!(sflags & SVp_NOK));
3588 assert(!(sflags & SVp_IOK));
3589 assert(!(sflags & SVf_NOK));
3590 assert(!(sflags & SVf_IOK));
3592 else if (dtype == SVt_PVGV) {
3593 if (!(sflags & SVf_OK)) {
3594 if (ckWARN(WARN_MISC))
3595 Perl_warner(aTHX_ packWARN(WARN_MISC),
3596 "Undefined value assigned to typeglob");
3599 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3600 if (dstr != (SV*)gv) {
3603 GvGP(dstr) = gp_ref(GvGP(gv));
3607 else if (sflags & SVp_POK) {
3611 * Check to see if we can just swipe the string. If so, it's a
3612 * possible small lose on short strings, but a big win on long ones.
3613 * It might even be a win on short strings if SvPVX_const(dstr)
3614 * has to be allocated and SvPVX_const(sstr) has to be freed.
3617 /* Whichever path we take through the next code, we want this true,
3618 and doing it now facilitates the COW check. */
3619 (void)SvPOK_only(dstr);
3622 /* We're not already COW */
3623 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3624 #ifndef PERL_OLD_COPY_ON_WRITE
3625 /* or we are, but dstr isn't a suitable target. */
3626 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3631 (sflags & SVs_TEMP) && /* slated for free anyway? */
3632 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3633 (!(flags & SV_NOSTEAL)) &&
3634 /* and we're allowed to steal temps */
3635 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3636 SvLEN(sstr) && /* and really is a string */
3637 /* and won't be needed again, potentially */
3638 !(PL_op && PL_op->op_type == OP_AASSIGN))
3639 #ifdef PERL_OLD_COPY_ON_WRITE
3640 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3641 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3642 && SvTYPE(sstr) >= SVt_PVIV)
3645 /* Failed the swipe test, and it's not a shared hash key either.
3646 Have to copy the string. */
3647 STRLEN len = SvCUR(sstr);
3648 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3649 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3650 SvCUR_set(dstr, len);
3651 *SvEND(dstr) = '\0';
3653 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3655 /* Either it's a shared hash key, or it's suitable for
3656 copy-on-write or we can swipe the string. */
3658 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3662 #ifdef PERL_OLD_COPY_ON_WRITE
3664 /* I believe I should acquire a global SV mutex if
3665 it's a COW sv (not a shared hash key) to stop
3666 it going un copy-on-write.
3667 If the source SV has gone un copy on write between up there
3668 and down here, then (assert() that) it is of the correct
3669 form to make it copy on write again */
3670 if ((sflags & (SVf_FAKE | SVf_READONLY))
3671 != (SVf_FAKE | SVf_READONLY)) {
3672 SvREADONLY_on(sstr);
3674 /* Make the source SV into a loop of 1.
3675 (about to become 2) */
3676 SV_COW_NEXT_SV_SET(sstr, sstr);
3680 /* Initial code is common. */
3681 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3686 /* making another shared SV. */
3687 STRLEN cur = SvCUR(sstr);
3688 STRLEN len = SvLEN(sstr);
3689 #ifdef PERL_OLD_COPY_ON_WRITE
3691 assert (SvTYPE(dstr) >= SVt_PVIV);
3692 /* SvIsCOW_normal */
3693 /* splice us in between source and next-after-source. */
3694 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3695 SV_COW_NEXT_SV_SET(sstr, dstr);
3696 SvPV_set(dstr, SvPVX_mutable(sstr));
3700 /* SvIsCOW_shared_hash */
3701 DEBUG_C(PerlIO_printf(Perl_debug_log,
3702 "Copy on write: Sharing hash\n"));
3704 assert (SvTYPE(dstr) >= SVt_PV);
3706 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3708 SvLEN_set(dstr, len);
3709 SvCUR_set(dstr, cur);
3710 SvREADONLY_on(dstr);
3712 /* Relesase a global SV mutex. */
3715 { /* Passes the swipe test. */
3716 SvPV_set(dstr, SvPVX_mutable(sstr));
3717 SvLEN_set(dstr, SvLEN(sstr));
3718 SvCUR_set(dstr, SvCUR(sstr));
3721 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3722 SvPV_set(sstr, NULL);
3728 if (sflags & SVp_NOK) {
3729 SvNV_set(dstr, SvNVX(sstr));
3731 if (sflags & SVp_IOK) {
3732 SvRELEASE_IVX(dstr);
3733 SvIV_set(dstr, SvIVX(sstr));
3734 /* Must do this otherwise some other overloaded use of 0x80000000
3735 gets confused. I guess SVpbm_VALID */
3736 if (sflags & SVf_IVisUV)
3739 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3741 const MAGIC * const smg = SvVSTRING_mg(sstr);
3743 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3744 smg->mg_ptr, smg->mg_len);
3745 SvRMAGICAL_on(dstr);
3749 else if (sflags & (SVp_IOK|SVp_NOK)) {
3750 (void)SvOK_off(dstr);
3751 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3752 if (sflags & SVp_IOK) {
3753 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3754 SvIV_set(dstr, SvIVX(sstr));
3756 if (sflags & SVp_NOK) {
3757 SvNV_set(dstr, SvNVX(sstr));
3761 if (isGV_with_GP(sstr)) {
3762 /* This stringification rule for globs is spread in 3 places.
3763 This feels bad. FIXME. */
3764 const U32 wasfake = sflags & SVf_FAKE;
3766 /* FAKE globs can get coerced, so need to turn this off
3767 temporarily if it is on. */
3769 gv_efullname3(dstr, (GV *)sstr, "*");
3770 SvFLAGS(sstr) |= wasfake;
3773 (void)SvOK_off(dstr);
3775 if (SvTAINTED(sstr))
3780 =for apidoc sv_setsv_mg
3782 Like C<sv_setsv>, but also handles 'set' magic.
3788 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3790 sv_setsv(dstr,sstr);
3794 #ifdef PERL_OLD_COPY_ON_WRITE
3796 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3798 STRLEN cur = SvCUR(sstr);
3799 STRLEN len = SvLEN(sstr);
3800 register char *new_pv;
3803 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3811 if (SvTHINKFIRST(dstr))
3812 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3813 else if (SvPVX_const(dstr))
3814 Safefree(SvPVX_const(dstr));
3818 SvUPGRADE(dstr, SVt_PVIV);
3820 assert (SvPOK(sstr));
3821 assert (SvPOKp(sstr));
3822 assert (!SvIOK(sstr));
3823 assert (!SvIOKp(sstr));
3824 assert (!SvNOK(sstr));
3825 assert (!SvNOKp(sstr));
3827 if (SvIsCOW(sstr)) {
3829 if (SvLEN(sstr) == 0) {
3830 /* source is a COW shared hash key. */
3831 DEBUG_C(PerlIO_printf(Perl_debug_log,
3832 "Fast copy on write: Sharing hash\n"));
3833 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3836 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3838 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3839 SvUPGRADE(sstr, SVt_PVIV);
3840 SvREADONLY_on(sstr);
3842 DEBUG_C(PerlIO_printf(Perl_debug_log,
3843 "Fast copy on write: Converting sstr to COW\n"));
3844 SV_COW_NEXT_SV_SET(dstr, sstr);
3846 SV_COW_NEXT_SV_SET(sstr, dstr);
3847 new_pv = SvPVX_mutable(sstr);
3850 SvPV_set(dstr, new_pv);
3851 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3854 SvLEN_set(dstr, len);
3855 SvCUR_set(dstr, cur);
3864 =for apidoc sv_setpvn
3866 Copies a string into an SV. The C<len> parameter indicates the number of
3867 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3868 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3874 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3877 register char *dptr;
3879 SV_CHECK_THINKFIRST_COW_DROP(sv);
3885 /* len is STRLEN which is unsigned, need to copy to signed */
3888 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3890 SvUPGRADE(sv, SVt_PV);
3892 dptr = SvGROW(sv, len + 1);
3893 Move(ptr,dptr,len,char);
3896 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3901 =for apidoc sv_setpvn_mg
3903 Like C<sv_setpvn>, but also handles 'set' magic.
3909 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3911 sv_setpvn(sv,ptr,len);
3916 =for apidoc sv_setpv
3918 Copies a string into an SV. The string must be null-terminated. Does not
3919 handle 'set' magic. See C<sv_setpv_mg>.
3925 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3928 register STRLEN len;
3930 SV_CHECK_THINKFIRST_COW_DROP(sv);
3936 SvUPGRADE(sv, SVt_PV);
3938 SvGROW(sv, len + 1);
3939 Move(ptr,SvPVX(sv),len+1,char);
3941 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3946 =for apidoc sv_setpv_mg
3948 Like C<sv_setpv>, but also handles 'set' magic.
3954 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3961 =for apidoc sv_usepvn_flags
3963 Tells an SV to use C<ptr> to find its string value. Normally the
3964 string is stored inside the SV but sv_usepvn allows the SV to use an
3965 outside string. The C<ptr> should point to memory that was allocated
3966 by C<malloc>. The string length, C<len>, must be supplied. By default
3967 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3968 so that pointer should not be freed or used by the programmer after
3969 giving it to sv_usepvn, and neither should any pointers from "behind"
3970 that pointer (e.g. ptr + 1) be used.
3972 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3973 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3974 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3975 C<len>, and already meets the requirements for storing in C<SvPVX>)
3981 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3985 SV_CHECK_THINKFIRST_COW_DROP(sv);
3986 SvUPGRADE(sv, SVt_PV);
3989 if (flags & SV_SMAGIC)
3993 if (SvPVX_const(sv))
3997 if (flags & SV_HAS_TRAILING_NUL)
3998 assert(ptr[len] == '\0');
4001 allocate = (flags & SV_HAS_TRAILING_NUL)
4002 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4003 if (flags & SV_HAS_TRAILING_NUL) {
4004 /* It's long enough - do nothing.
4005 Specfically Perl_newCONSTSUB is relying on this. */
4008 /* Force a move to shake out bugs in callers. */
4009 char *new_ptr = (char*)safemalloc(allocate);
4010 Copy(ptr, new_ptr, len, char);
4011 PoisonFree(ptr,len,char);
4015 ptr = (char*) saferealloc (ptr, allocate);
4020 SvLEN_set(sv, allocate);
4021 if (!(flags & SV_HAS_TRAILING_NUL)) {
4024 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4026 if (flags & SV_SMAGIC)
4030 #ifdef PERL_OLD_COPY_ON_WRITE
4031 /* Need to do this *after* making the SV normal, as we need the buffer
4032 pointer to remain valid until after we've copied it. If we let go too early,
4033 another thread could invalidate it by unsharing last of the same hash key
4034 (which it can do by means other than releasing copy-on-write Svs)
4035 or by changing the other copy-on-write SVs in the loop. */
4037 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4039 if (len) { /* this SV was SvIsCOW_normal(sv) */
4040 /* we need to find the SV pointing to us. */
4041 SV *current = SV_COW_NEXT_SV(after);
4043 if (current == sv) {
4044 /* The SV we point to points back to us (there were only two of us
4046 Hence other SV is no longer copy on write either. */
4048 SvREADONLY_off(after);
4050 /* We need to follow the pointers around the loop. */
4052 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4055 /* don't loop forever if the structure is bust, and we have
4056 a pointer into a closed loop. */
4057 assert (current != after);
4058 assert (SvPVX_const(current) == pvx);
4060 /* Make the SV before us point to the SV after us. */
4061 SV_COW_NEXT_SV_SET(current, after);
4064 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4069 Perl_sv_release_IVX(pTHX_ register SV *sv)
4072 sv_force_normal_flags(sv, 0);
4078 =for apidoc sv_force_normal_flags
4080 Undo various types of fakery on an SV: if the PV is a shared string, make
4081 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4082 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4083 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4084 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4085 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4086 set to some other value.) In addition, the C<flags> parameter gets passed to
4087 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4088 with flags set to 0.
4094 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098 if (SvREADONLY(sv)) {
4099 /* At this point I believe I should acquire a global SV mutex. */
4101 const char * const pvx = SvPVX_const(sv);
4102 const STRLEN len = SvLEN(sv);
4103 const STRLEN cur = SvCUR(sv);
4104 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4106 PerlIO_printf(Perl_debug_log,
4107 "Copy on write: Force normal %ld\n",
4113 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4116 if (flags & SV_COW_DROP_PV) {
4117 /* OK, so we don't need to copy our buffer. */
4120 SvGROW(sv, cur + 1);
4121 Move(pvx,SvPVX(sv),cur,char);
4125 sv_release_COW(sv, pvx, len, next);
4130 else if (IN_PERL_RUNTIME)
4131 Perl_croak(aTHX_ PL_no_modify);
4132 /* At this point I believe that I can drop the global SV mutex. */
4135 if (SvREADONLY(sv)) {
4137 const char * const pvx = SvPVX_const(sv);
4138 const STRLEN len = SvCUR(sv);
4143 SvGROW(sv, len + 1);
4144 Move(pvx,SvPVX(sv),len,char);
4146 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4148 else if (IN_PERL_RUNTIME)
4149 Perl_croak(aTHX_ PL_no_modify);
4153 sv_unref_flags(sv, flags);
4154 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4161 Efficient removal of characters from the beginning of the string buffer.
4162 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4163 the string buffer. The C<ptr> becomes the first character of the adjusted
4164 string. Uses the "OOK hack".
4165 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4166 refer to the same chunk of data.
4172 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4174 register STRLEN delta;
4175 if (!ptr || !SvPOKp(sv))
4177 delta = ptr - SvPVX_const(sv);
4178 SV_CHECK_THINKFIRST(sv);
4179 if (SvTYPE(sv) < SVt_PVIV)
4180 sv_upgrade(sv,SVt_PVIV);
4183 if (!SvLEN(sv)) { /* make copy of shared string */
4184 const char *pvx = SvPVX_const(sv);
4185 const STRLEN len = SvCUR(sv);
4186 SvGROW(sv, len + 1);
4187 Move(pvx,SvPVX(sv),len,char);
4191 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4192 and we do that anyway inside the SvNIOK_off
4194 SvFLAGS(sv) |= SVf_OOK;
4197 SvLEN_set(sv, SvLEN(sv) - delta);
4198 SvCUR_set(sv, SvCUR(sv) - delta);
4199 SvPV_set(sv, SvPVX(sv) + delta);
4200 SvIV_set(sv, SvIVX(sv) + delta);
4204 =for apidoc sv_catpvn
4206 Concatenates the string onto the end of the string which is in the SV. The
4207 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4208 status set, then the bytes appended should be valid UTF-8.
4209 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4211 =for apidoc sv_catpvn_flags
4213 Concatenates the string onto the end of the string which is in the SV. The
4214 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4215 status set, then the bytes appended should be valid UTF-8.
4216 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4217 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4218 in terms of this function.
4224 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4228 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4230 SvGROW(dsv, dlen + slen + 1);
4232 sstr = SvPVX_const(dsv);
4233 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4234 SvCUR_set(dsv, SvCUR(dsv) + slen);
4236 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4238 if (flags & SV_SMAGIC)
4243 =for apidoc sv_catsv
4245 Concatenates the string from SV C<ssv> onto the end of the string in
4246 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4247 not 'set' magic. See C<sv_catsv_mg>.
4249 =for apidoc sv_catsv_flags
4251 Concatenates the string from SV C<ssv> onto the end of the string in
4252 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4253 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4254 and C<sv_catsv_nomg> are implemented in terms of this function.
4259 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4264 const char *spv = SvPV_const(ssv, slen);
4266 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4267 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4268 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4269 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4270 dsv->sv_flags doesn't have that bit set.
4271 Andy Dougherty 12 Oct 2001
4273 const I32 sutf8 = DO_UTF8(ssv);
4276 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4278 dutf8 = DO_UTF8(dsv);
4280 if (dutf8 != sutf8) {
4282 /* Not modifying source SV, so taking a temporary copy. */
4283 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4285 sv_utf8_upgrade(csv);
4286 spv = SvPV_const(csv, slen);
4289 sv_utf8_upgrade_nomg(dsv);
4291 sv_catpvn_nomg(dsv, spv, slen);
4294 if (flags & SV_SMAGIC)
4299 =for apidoc sv_catpv
4301 Concatenates the string onto the end of the string which is in the SV.
4302 If the SV has the UTF-8 status set, then the bytes appended should be
4303 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4308 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4311 register STRLEN len;
4317 junk = SvPV_force(sv, tlen);
4319 SvGROW(sv, tlen + len + 1);
4321 ptr = SvPVX_const(sv);
4322 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4323 SvCUR_set(sv, SvCUR(sv) + len);
4324 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4329 =for apidoc sv_catpv_mg
4331 Like C<sv_catpv>, but also handles 'set' magic.
4337 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4346 Creates a new SV. A non-zero C<len> parameter indicates the number of
4347 bytes of preallocated string space the SV should have. An extra byte for a
4348 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4349 space is allocated.) The reference count for the new SV is set to 1.
4351 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4352 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4353 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4354 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4355 modules supporting older perls.
4361 Perl_newSV(pTHX_ STRLEN len)
4368 sv_upgrade(sv, SVt_PV);
4369 SvGROW(sv, len + 1);
4374 =for apidoc sv_magicext
4376 Adds magic to an SV, upgrading it if necessary. Applies the
4377 supplied vtable and returns a pointer to the magic added.
4379 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4380 In particular, you can add magic to SvREADONLY SVs, and add more than
4381 one instance of the same 'how'.
4383 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4384 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4385 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4386 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4388 (This is now used as a subroutine by C<sv_magic>.)
4393 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4394 const char* name, I32 namlen)
4399 if (SvTYPE(sv) < SVt_PVMG) {
4400 SvUPGRADE(sv, SVt_PVMG);
4402 Newxz(mg, 1, MAGIC);
4403 mg->mg_moremagic = SvMAGIC(sv);
4404 SvMAGIC_set(sv, mg);
4406 /* Sometimes a magic contains a reference loop, where the sv and
4407 object refer to each other. To prevent a reference loop that
4408 would prevent such objects being freed, we look for such loops
4409 and if we find one we avoid incrementing the object refcount.
4411 Note we cannot do this to avoid self-tie loops as intervening RV must
4412 have its REFCNT incremented to keep it in existence.
4415 if (!obj || obj == sv ||
4416 how == PERL_MAGIC_arylen ||
4417 how == PERL_MAGIC_qr ||
4418 how == PERL_MAGIC_symtab ||
4419 (SvTYPE(obj) == SVt_PVGV &&
4420 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4421 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4422 GvFORM(obj) == (CV*)sv)))
4427 mg->mg_obj = SvREFCNT_inc_simple(obj);
4428 mg->mg_flags |= MGf_REFCOUNTED;
4431 /* Normal self-ties simply pass a null object, and instead of
4432 using mg_obj directly, use the SvTIED_obj macro to produce a
4433 new RV as needed. For glob "self-ties", we are tieing the PVIO
4434 with an RV obj pointing to the glob containing the PVIO. In
4435 this case, to avoid a reference loop, we need to weaken the
4439 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4440 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4446 mg->mg_len = namlen;
4449 mg->mg_ptr = savepvn(name, namlen);
4450 else if (namlen == HEf_SVKEY)
4451 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4453 mg->mg_ptr = (char *) name;
4455 mg->mg_virtual = vtable;
4459 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4464 =for apidoc sv_magic
4466 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4467 then adds a new magic item of type C<how> to the head of the magic list.
4469 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4470 handling of the C<name> and C<namlen> arguments.
4472 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4473 to add more than one instance of the same 'how'.
4479 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4485 #ifdef PERL_OLD_COPY_ON_WRITE
4487 sv_force_normal_flags(sv, 0);
4489 if (SvREADONLY(sv)) {
4491 /* its okay to attach magic to shared strings; the subsequent
4492 * upgrade to PVMG will unshare the string */
4493 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4496 && how != PERL_MAGIC_regex_global
4497 && how != PERL_MAGIC_bm
4498 && how != PERL_MAGIC_fm
4499 && how != PERL_MAGIC_sv
4500 && how != PERL_MAGIC_backref
4503 Perl_croak(aTHX_ PL_no_modify);
4506 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4507 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4508 /* sv_magic() refuses to add a magic of the same 'how' as an
4511 if (how == PERL_MAGIC_taint) {
4513 /* Any scalar which already had taint magic on which someone
4514 (erroneously?) did SvIOK_on() or similar will now be
4515 incorrectly sporting public "OK" flags. */
4516 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4524 vtable = &PL_vtbl_sv;
4526 case PERL_MAGIC_overload:
4527 vtable = &PL_vtbl_amagic;
4529 case PERL_MAGIC_overload_elem:
4530 vtable = &PL_vtbl_amagicelem;
4532 case PERL_MAGIC_overload_table:
4533 vtable = &PL_vtbl_ovrld;
4536 vtable = &PL_vtbl_bm;
4538 case PERL_MAGIC_regdata:
4539 vtable = &PL_vtbl_regdata;
4541 case PERL_MAGIC_regdata_names:
4542 vtable = &PL_vtbl_regdata_names;
4544 case PERL_MAGIC_regdatum:
4545 vtable = &PL_vtbl_regdatum;
4547 case PERL_MAGIC_env:
4548 vtable = &PL_vtbl_env;
4551 vtable = &PL_vtbl_fm;
4553 case PERL_MAGIC_envelem:
4554 vtable = &PL_vtbl_envelem;
4556 case PERL_MAGIC_regex_global:
4557 vtable = &PL_vtbl_mglob;
4559 case PERL_MAGIC_isa:
4560 vtable = &PL_vtbl_isa;
4562 case PERL_MAGIC_isaelem:
4563 vtable = &PL_vtbl_isaelem;
4565 case PERL_MAGIC_nkeys:
4566 vtable = &PL_vtbl_nkeys;
4568 case PERL_MAGIC_dbfile:
4571 case PERL_MAGIC_dbline:
4572 vtable = &PL_vtbl_dbline;
4574 #ifdef USE_LOCALE_COLLATE
4575 case PERL_MAGIC_collxfrm:
4576 vtable = &PL_vtbl_collxfrm;
4578 #endif /* USE_LOCALE_COLLATE */
4579 case PERL_MAGIC_tied:
4580 vtable = &PL_vtbl_pack;
4582 case PERL_MAGIC_tiedelem:
4583 case PERL_MAGIC_tiedscalar:
4584 vtable = &PL_vtbl_packelem;
4587 vtable = &PL_vtbl_regexp;
4589 case PERL_MAGIC_hints:
4590 /* As this vtable is all NULL, we can reuse it. */
4591 case PERL_MAGIC_sig:
4592 vtable = &PL_vtbl_sig;
4594 case PERL_MAGIC_sigelem:
4595 vtable = &PL_vtbl_sigelem;
4597 case PERL_MAGIC_taint:
4598 vtable = &PL_vtbl_taint;
4600 case PERL_MAGIC_uvar:
4601 vtable = &PL_vtbl_uvar;
4603 case PERL_MAGIC_vec:
4604 vtable = &PL_vtbl_vec;
4606 case PERL_MAGIC_arylen_p:
4607 case PERL_MAGIC_rhash:
4608 case PERL_MAGIC_symtab:
4609 case PERL_MAGIC_vstring:
4612 case PERL_MAGIC_utf8:
4613 vtable = &PL_vtbl_utf8;
4615 case PERL_MAGIC_substr:
4616 vtable = &PL_vtbl_substr;
4618 case PERL_MAGIC_defelem:
4619 vtable = &PL_vtbl_defelem;
4621 case PERL_MAGIC_arylen:
4622 vtable = &PL_vtbl_arylen;
4624 case PERL_MAGIC_pos:
4625 vtable = &PL_vtbl_pos;
4627 case PERL_MAGIC_backref:
4628 vtable = &PL_vtbl_backref;
4630 case PERL_MAGIC_hintselem:
4631 vtable = &PL_vtbl_hintselem;
4633 case PERL_MAGIC_ext:
4634 /* Reserved for use by extensions not perl internals. */
4635 /* Useful for attaching extension internal data to perl vars. */
4636 /* Note that multiple extensions may clash if magical scalars */
4637 /* etc holding private data from one are passed to another. */
4641 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4644 /* Rest of work is done else where */
4645 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4648 case PERL_MAGIC_taint:
4651 case PERL_MAGIC_ext:
4652 case PERL_MAGIC_dbfile:
4659 =for apidoc sv_unmagic
4661 Removes all magic of type C<type> from an SV.
4667 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4671 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4673 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4674 for (mg = *mgp; mg; mg = *mgp) {
4675 if (mg->mg_type == type) {
4676 const MGVTBL* const vtbl = mg->mg_virtual;
4677 *mgp = mg->mg_moremagic;
4678 if (vtbl && vtbl->svt_free)
4679 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4680 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4682 Safefree(mg->mg_ptr);
4683 else if (mg->mg_len == HEf_SVKEY)
4684 SvREFCNT_dec((SV*)mg->mg_ptr);
4685 else if (mg->mg_type == PERL_MAGIC_utf8)
4686 Safefree(mg->mg_ptr);
4688 if (mg->mg_flags & MGf_REFCOUNTED)
4689 SvREFCNT_dec(mg->mg_obj);
4693 mgp = &mg->mg_moremagic;
4697 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4698 SvMAGIC_set(sv, NULL);
4705 =for apidoc sv_rvweaken
4707 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4708 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4709 push a back-reference to this RV onto the array of backreferences
4710 associated with that magic. If the RV is magical, set magic will be
4711 called after the RV is cleared.
4717 Perl_sv_rvweaken(pTHX_ SV *sv)
4720 if (!SvOK(sv)) /* let undefs pass */
4723 Perl_croak(aTHX_ "Can't weaken a nonreference");
4724 else if (SvWEAKREF(sv)) {
4725 if (ckWARN(WARN_MISC))
4726 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4730 Perl_sv_add_backref(aTHX_ tsv, sv);
4736 /* Give tsv backref magic if it hasn't already got it, then push a
4737 * back-reference to sv onto the array associated with the backref magic.
4741 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4746 if (SvTYPE(tsv) == SVt_PVHV) {
4747 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4751 /* There is no AV in the offical place - try a fixup. */
4752 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4755 /* Aha. They've got it stowed in magic. Bring it back. */
4756 av = (AV*)mg->mg_obj;
4757 /* Stop mg_free decreasing the refernce count. */
4759 /* Stop mg_free even calling the destructor, given that
4760 there's no AV to free up. */
4762 sv_unmagic(tsv, PERL_MAGIC_backref);
4766 SvREFCNT_inc_simple_void(av);
4771 const MAGIC *const mg
4772 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4774 av = (AV*)mg->mg_obj;
4778 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4779 /* av now has a refcnt of 2, which avoids it getting freed
4780 * before us during global cleanup. The extra ref is removed
4781 * by magic_killbackrefs() when tsv is being freed */
4784 if (AvFILLp(av) >= AvMAX(av)) {
4785 av_extend(av, AvFILLp(av)+1);
4787 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4790 /* delete a back-reference to ourselves from the backref magic associated
4791 * with the SV we point to.
4795 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4802 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4803 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4804 /* We mustn't attempt to "fix up" the hash here by moving the
4805 backreference array back to the hv_aux structure, as that is stored
4806 in the main HvARRAY(), and hfreentries assumes that no-one
4807 reallocates HvARRAY() while it is running. */
4810 const MAGIC *const mg
4811 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4813 av = (AV *)mg->mg_obj;
4816 if (PL_in_clean_all)
4818 Perl_croak(aTHX_ "panic: del_backref");
4825 /* We shouldn't be in here more than once, but for paranoia reasons lets
4827 for (i = AvFILLp(av); i >= 0; i--) {
4829 const SSize_t fill = AvFILLp(av);
4831 /* We weren't the last entry.
4832 An unordered list has this property that you can take the
4833 last element off the end to fill the hole, and it's still
4834 an unordered list :-)
4839 AvFILLp(av) = fill - 1;
4845 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4847 SV **svp = AvARRAY(av);
4849 PERL_UNUSED_ARG(sv);
4851 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4852 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4853 if (svp && !SvIS_FREED(av)) {
4854 SV *const *const last = svp + AvFILLp(av);
4856 while (svp <= last) {
4858 SV *const referrer = *svp;
4859 if (SvWEAKREF(referrer)) {
4860 /* XXX Should we check that it hasn't changed? */
4861 SvRV_set(referrer, 0);
4863 SvWEAKREF_off(referrer);
4864 SvSETMAGIC(referrer);
4865 } else if (SvTYPE(referrer) == SVt_PVGV ||
4866 SvTYPE(referrer) == SVt_PVLV) {
4867 /* You lookin' at me? */
4868 assert(GvSTASH(referrer));
4869 assert(GvSTASH(referrer) == (HV*)sv);
4870 GvSTASH(referrer) = 0;
4873 "panic: magic_killbackrefs (flags=%"UVxf")",
4874 (UV)SvFLAGS(referrer));
4882 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4887 =for apidoc sv_insert
4889 Inserts a string at the specified offset/length within the SV. Similar to
4890 the Perl substr() function.
4896 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4901 register char *midend;
4902 register char *bigend;
4908 Perl_croak(aTHX_ "Can't modify non-existent substring");
4909 SvPV_force(bigstr, curlen);
4910 (void)SvPOK_only_UTF8(bigstr);
4911 if (offset + len > curlen) {
4912 SvGROW(bigstr, offset+len+1);
4913 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4914 SvCUR_set(bigstr, offset+len);
4918 i = littlelen - len;
4919 if (i > 0) { /* string might grow */
4920 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4921 mid = big + offset + len;
4922 midend = bigend = big + SvCUR(bigstr);
4925 while (midend > mid) /* shove everything down */
4926 *--bigend = *--midend;
4927 Move(little,big+offset,littlelen,char);
4928 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4933 Move(little,SvPVX(bigstr)+offset,len,char);
4938 big = SvPVX(bigstr);
4941 bigend = big + SvCUR(bigstr);
4943 if (midend > bigend)
4944 Perl_croak(aTHX_ "panic: sv_insert");
4946 if (mid - big > bigend - midend) { /* faster to shorten from end */
4948 Move(little, mid, littlelen,char);
4951 i = bigend - midend;
4953 Move(midend, mid, i,char);
4957 SvCUR_set(bigstr, mid - big);
4959 else if ((i = mid - big)) { /* faster from front */
4960 midend -= littlelen;
4962 sv_chop(bigstr,midend-i);
4967 Move(little, mid, littlelen,char);
4969 else if (littlelen) {
4970 midend -= littlelen;
4971 sv_chop(bigstr,midend);
4972 Move(little,midend,littlelen,char);
4975 sv_chop(bigstr,midend);
4981 =for apidoc sv_replace
4983 Make the first argument a copy of the second, then delete the original.
4984 The target SV physically takes over ownership of the body of the source SV
4985 and inherits its flags; however, the target keeps any magic it owns,
4986 and any magic in the source is discarded.
4987 Note that this is a rather specialist SV copying operation; most of the
4988 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4994 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4997 const U32 refcnt = SvREFCNT(sv);
4998 SV_CHECK_THINKFIRST_COW_DROP(sv);
4999 if (SvREFCNT(nsv) != 1) {
5000 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5001 UVuf " != 1)", (UV) SvREFCNT(nsv));
5003 if (SvMAGICAL(sv)) {
5007 sv_upgrade(nsv, SVt_PVMG);
5008 SvMAGIC_set(nsv, SvMAGIC(sv));
5009 SvFLAGS(nsv) |= SvMAGICAL(sv);
5011 SvMAGIC_set(sv, NULL);
5015 assert(!SvREFCNT(sv));
5016 #ifdef DEBUG_LEAKING_SCALARS
5017 sv->sv_flags = nsv->sv_flags;
5018 sv->sv_any = nsv->sv_any;
5019 sv->sv_refcnt = nsv->sv_refcnt;
5020 sv->sv_u = nsv->sv_u;
5022 StructCopy(nsv,sv,SV);
5024 /* Currently could join these into one piece of pointer arithmetic, but
5025 it would be unclear. */
5026 if(SvTYPE(sv) == SVt_IV)
5028 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5029 else if (SvTYPE(sv) == SVt_RV) {
5030 SvANY(sv) = &sv->sv_u.svu_rv;
5034 #ifdef PERL_OLD_COPY_ON_WRITE
5035 if (SvIsCOW_normal(nsv)) {
5036 /* We need to follow the pointers around the loop to make the
5037 previous SV point to sv, rather than nsv. */
5040 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5043 assert(SvPVX_const(current) == SvPVX_const(nsv));
5045 /* Make the SV before us point to the SV after us. */
5047 PerlIO_printf(Perl_debug_log, "previous is\n");
5049 PerlIO_printf(Perl_debug_log,
5050 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5051 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5053 SV_COW_NEXT_SV_SET(current, sv);
5056 SvREFCNT(sv) = refcnt;
5057 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5063 =for apidoc sv_clear
5065 Clear an SV: call any destructors, free up any memory used by the body,
5066 and free the body itself. The SV's head is I<not> freed, although
5067 its type is set to all 1's so that it won't inadvertently be assumed
5068 to be live during global destruction etc.
5069 This function should only be called when REFCNT is zero. Most of the time
5070 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5077 Perl_sv_clear(pTHX_ register SV *sv)
5080 const U32 type = SvTYPE(sv);
5081 const struct body_details *const sv_type_details
5082 = bodies_by_type + type;
5085 assert(SvREFCNT(sv) == 0);
5087 if (type <= SVt_IV) {
5088 /* See the comment in sv.h about the collusion between this early
5089 return and the overloading of the NULL and IV slots in the size
5095 if (PL_defstash) { /* Still have a symbol table? */
5100 stash = SvSTASH(sv);
5101 destructor = StashHANDLER(stash,DESTROY);
5103 SV* const tmpref = newRV(sv);
5104 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5106 PUSHSTACKi(PERLSI_DESTROY);
5111 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5117 if(SvREFCNT(tmpref) < 2) {
5118 /* tmpref is not kept alive! */
5120 SvRV_set(tmpref, NULL);
5123 SvREFCNT_dec(tmpref);
5125 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5129 if (PL_in_clean_objs)
5130 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5132 /* DESTROY gave object new lease on life */
5138 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5139 SvOBJECT_off(sv); /* Curse the object. */
5140 if (type != SVt_PVIO)
5141 --PL_sv_objcount; /* XXX Might want something more general */
5144 if (type >= SVt_PVMG) {
5145 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5146 SvREFCNT_dec(OURSTASH(sv));
5147 } else if (SvMAGIC(sv))
5149 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5150 SvREFCNT_dec(SvSTASH(sv));
5155 IoIFP(sv) != PerlIO_stdin() &&
5156 IoIFP(sv) != PerlIO_stdout() &&
5157 IoIFP(sv) != PerlIO_stderr())
5159 io_close((IO*)sv, FALSE);
5161 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5162 PerlDir_close(IoDIRP(sv));
5163 IoDIRP(sv) = (DIR*)NULL;
5164 Safefree(IoTOP_NAME(sv));
5165 Safefree(IoFMT_NAME(sv));
5166 Safefree(IoBOTTOM_NAME(sv));
5175 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5182 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5183 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5184 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5185 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5187 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5188 SvREFCNT_dec(LvTARG(sv));
5192 if (GvNAME_HEK(sv)) {
5193 unshare_hek(GvNAME_HEK(sv));
5195 /* If we're in a stash, we don't own a reference to it. However it does
5196 have a back reference to us, which needs to be cleared. */
5198 sv_del_backref((SV*)GvSTASH(sv), sv);
5203 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5205 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5206 /* Don't even bother with turning off the OOK flag. */
5211 SV * const target = SvRV(sv);
5213 sv_del_backref(target, sv);
5215 SvREFCNT_dec(target);
5217 #ifdef PERL_OLD_COPY_ON_WRITE
5218 else if (SvPVX_const(sv)) {
5220 /* I believe I need to grab the global SV mutex here and
5221 then recheck the COW status. */
5223 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5226 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5227 SV_COW_NEXT_SV(sv));
5228 /* And drop it here. */
5230 } else if (SvLEN(sv)) {
5231 Safefree(SvPVX_const(sv));
5235 else if (SvPVX_const(sv) && SvLEN(sv))
5236 Safefree(SvPVX_mutable(sv));
5237 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5238 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5247 SvFLAGS(sv) &= SVf_BREAK;
5248 SvFLAGS(sv) |= SVTYPEMASK;
5250 if (sv_type_details->arena) {
5251 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5252 &PL_body_roots[type]);
5254 else if (sv_type_details->body_size) {
5255 my_safefree(SvANY(sv));
5260 =for apidoc sv_newref
5262 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5269 Perl_sv_newref(pTHX_ SV *sv)
5271 PERL_UNUSED_CONTEXT;
5280 Decrement an SV's reference count, and if it drops to zero, call
5281 C<sv_clear> to invoke destructors and free up any memory used by
5282 the body; finally, deallocate the SV's head itself.
5283 Normally called via a wrapper macro C<SvREFCNT_dec>.
5289 Perl_sv_free(pTHX_ SV *sv)
5294 if (SvREFCNT(sv) == 0) {
5295 if (SvFLAGS(sv) & SVf_BREAK)
5296 /* this SV's refcnt has been artificially decremented to
5297 * trigger cleanup */
5299 if (PL_in_clean_all) /* All is fair */
5301 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5302 /* make sure SvREFCNT(sv)==0 happens very seldom */
5303 SvREFCNT(sv) = (~(U32)0)/2;
5306 if (ckWARN_d(WARN_INTERNAL)) {
5307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5308 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5309 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5310 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5311 Perl_dump_sv_child(aTHX_ sv);
5316 if (--(SvREFCNT(sv)) > 0)
5318 Perl_sv_free2(aTHX_ sv);
5322 Perl_sv_free2(pTHX_ SV *sv)
5327 if (ckWARN_d(WARN_DEBUGGING))
5328 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5329 "Attempt to free temp prematurely: SV 0x%"UVxf
5330 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5334 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5335 /* make sure SvREFCNT(sv)==0 happens very seldom */
5336 SvREFCNT(sv) = (~(U32)0)/2;
5347 Returns the length of the string in the SV. Handles magic and type
5348 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5354 Perl_sv_len(pTHX_ register SV *sv)
5362 len = mg_length(sv);
5364 (void)SvPV_const(sv, len);
5369 =for apidoc sv_len_utf8
5371 Returns the number of characters in the string in an SV, counting wide
5372 UTF-8 bytes as a single character. Handles magic and type coercion.
5378 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5379 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5380 * (Note that the mg_len is not the length of the mg_ptr field.
5381 * This allows the cache to store the character length of the string without
5382 * needing to malloc() extra storage to attach to the mg_ptr.)
5387 Perl_sv_len_utf8(pTHX_ register SV *sv)
5393 return mg_length(sv);
5397 const U8 *s = (U8*)SvPV_const(sv, len);
5401 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5403 if (mg && mg->mg_len != -1) {
5405 if (PL_utf8cache < 0) {
5406 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5408 /* Need to turn the assertions off otherwise we may
5409 recurse infinitely while printing error messages.
5411 SAVEI8(PL_utf8cache);
5413 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5414 " real %"UVuf" for %"SVf,
5415 (UV) ulen, (UV) real, (void*)sv);
5420 ulen = Perl_utf8_length(aTHX_ s, s + len);
5421 if (!SvREADONLY(sv)) {
5423 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5424 &PL_vtbl_utf8, 0, 0);
5432 return Perl_utf8_length(aTHX_ s, s + len);
5436 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5439 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5442 const U8 *s = start;
5444 while (s < send && uoffset--)
5447 /* This is the existing behaviour. Possibly it should be a croak, as
5448 it's actually a bounds error */
5454 /* Given the length of the string in both bytes and UTF-8 characters, decide
5455 whether to walk forwards or backwards to find the byte corresponding to
5456 the passed in UTF-8 offset. */
5458 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5459 STRLEN uoffset, STRLEN uend)
5461 STRLEN backw = uend - uoffset;
5462 if (uoffset < 2 * backw) {
5463 /* The assumption is that going forwards is twice the speed of going
5464 forward (that's where the 2 * backw comes from).
5465 (The real figure of course depends on the UTF-8 data.) */
5466 return sv_pos_u2b_forwards(start, send, uoffset);
5471 while (UTF8_IS_CONTINUATION(*send))
5474 return send - start;
5477 /* For the string representation of the given scalar, find the byte
5478 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5479 give another position in the string, *before* the sought offset, which
5480 (which is always true, as 0, 0 is a valid pair of positions), which should
5481 help reduce the amount of linear searching.
5482 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5483 will be used to reduce the amount of linear searching. The cache will be
5484 created if necessary, and the found value offered to it for update. */
5486 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5487 const U8 *const send, STRLEN uoffset,
5488 STRLEN uoffset0, STRLEN boffset0) {
5489 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5492 assert (uoffset >= uoffset0);
5494 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5495 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5496 if ((*mgp)->mg_ptr) {
5497 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5498 if (cache[0] == uoffset) {
5499 /* An exact match. */
5502 if (cache[2] == uoffset) {
5503 /* An exact match. */
5507 if (cache[0] < uoffset) {
5508 /* The cache already knows part of the way. */
5509 if (cache[0] > uoffset0) {
5510 /* The cache knows more than the passed in pair */
5511 uoffset0 = cache[0];
5512 boffset0 = cache[1];
5514 if ((*mgp)->mg_len != -1) {
5515 /* And we know the end too. */
5517 + sv_pos_u2b_midway(start + boffset0, send,
5519 (*mgp)->mg_len - uoffset0);
5522 + sv_pos_u2b_forwards(start + boffset0,
5523 send, uoffset - uoffset0);
5526 else if (cache[2] < uoffset) {
5527 /* We're between the two cache entries. */
5528 if (cache[2] > uoffset0) {
5529 /* and the cache knows more than the passed in pair */
5530 uoffset0 = cache[2];
5531 boffset0 = cache[3];
5535 + sv_pos_u2b_midway(start + boffset0,
5538 cache[0] - uoffset0);
5541 + sv_pos_u2b_midway(start + boffset0,
5544 cache[2] - uoffset0);
5548 else if ((*mgp)->mg_len != -1) {
5549 /* If we can take advantage of a passed in offset, do so. */
5550 /* In fact, offset0 is either 0, or less than offset, so don't
5551 need to worry about the other possibility. */
5553 + sv_pos_u2b_midway(start + boffset0, send,
5555 (*mgp)->mg_len - uoffset0);
5560 if (!found || PL_utf8cache < 0) {
5561 const STRLEN real_boffset
5562 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5563 send, uoffset - uoffset0);
5565 if (found && PL_utf8cache < 0) {
5566 if (real_boffset != boffset) {
5567 /* Need to turn the assertions off otherwise we may recurse
5568 infinitely while printing error messages. */
5569 SAVEI8(PL_utf8cache);
5571 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5572 " real %"UVuf" for %"SVf,
5573 (UV) boffset, (UV) real_boffset, (void*)sv);
5576 boffset = real_boffset;
5579 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5585 =for apidoc sv_pos_u2b
5587 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5588 the start of the string, to a count of the equivalent number of bytes; if
5589 lenp is non-zero, it does the same to lenp, but this time starting from
5590 the offset, rather than from the start of the string. Handles magic and
5597 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5598 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5599 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5604 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5612 start = (U8*)SvPV_const(sv, len);
5614 STRLEN uoffset = (STRLEN) *offsetp;
5615 const U8 * const send = start + len;
5617 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5620 *offsetp = (I32) boffset;
5623 /* Convert the relative offset to absolute. */
5624 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5625 const STRLEN boffset2
5626 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5627 uoffset, boffset) - boffset;
5641 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5642 byte length pairing. The (byte) length of the total SV is passed in too,
5643 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5644 may not have updated SvCUR, so we can't rely on reading it directly.
5646 The proffered utf8/byte length pairing isn't used if the cache already has
5647 two pairs, and swapping either for the proffered pair would increase the
5648 RMS of the intervals between known byte offsets.
5650 The cache itself consists of 4 STRLEN values
5651 0: larger UTF-8 offset
5652 1: corresponding byte offset
5653 2: smaller UTF-8 offset
5654 3: corresponding byte offset
5656 Unused cache pairs have the value 0, 0.
5657 Keeping the cache "backwards" means that the invariant of
5658 cache[0] >= cache[2] is maintained even with empty slots, which means that
5659 the code that uses it doesn't need to worry if only 1 entry has actually
5660 been set to non-zero. It also makes the "position beyond the end of the
5661 cache" logic much simpler, as the first slot is always the one to start
5665 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5673 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5675 (*mgp)->mg_len = -1;
5679 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5680 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5681 (*mgp)->mg_ptr = (char *) cache;
5685 if (PL_utf8cache < 0) {
5686 const U8 *start = (const U8 *) SvPVX_const(sv);
5687 const STRLEN realutf8 = utf8_length(start, start + byte);
5689 if (realutf8 != utf8) {
5690 /* Need to turn the assertions off otherwise we may recurse
5691 infinitely while printing error messages. */
5692 SAVEI8(PL_utf8cache);
5694 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5695 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5699 /* Cache is held with the later position first, to simplify the code
5700 that deals with unbounded ends. */
5702 ASSERT_UTF8_CACHE(cache);
5703 if (cache[1] == 0) {
5704 /* Cache is totally empty */
5707 } else if (cache[3] == 0) {
5708 if (byte > cache[1]) {
5709 /* New one is larger, so goes first. */
5710 cache[2] = cache[0];
5711 cache[3] = cache[1];
5719 #define THREEWAY_SQUARE(a,b,c,d) \
5720 ((float)((d) - (c))) * ((float)((d) - (c))) \
5721 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5722 + ((float)((b) - (a))) * ((float)((b) - (a)))
5724 /* Cache has 2 slots in use, and we know three potential pairs.
5725 Keep the two that give the lowest RMS distance. Do the
5726 calcualation in bytes simply because we always know the byte
5727 length. squareroot has the same ordering as the positive value,
5728 so don't bother with the actual square root. */
5729 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5730 if (byte > cache[1]) {
5731 /* New position is after the existing pair of pairs. */
5732 const float keep_earlier
5733 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5734 const float keep_later
5735 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5737 if (keep_later < keep_earlier) {
5738 if (keep_later < existing) {
5739 cache[2] = cache[0];
5740 cache[3] = cache[1];
5746 if (keep_earlier < existing) {
5752 else if (byte > cache[3]) {
5753 /* New position is between the existing pair of pairs. */
5754 const float keep_earlier
5755 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5756 const float keep_later
5757 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5759 if (keep_later < keep_earlier) {
5760 if (keep_later < existing) {
5766 if (keep_earlier < existing) {
5773 /* New position is before the existing pair of pairs. */
5774 const float keep_earlier
5775 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5776 const float keep_later
5777 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5779 if (keep_later < keep_earlier) {
5780 if (keep_later < existing) {
5786 if (keep_earlier < existing) {
5787 cache[0] = cache[2];
5788 cache[1] = cache[3];
5795 ASSERT_UTF8_CACHE(cache);
5798 /* We already know all of the way, now we may be able to walk back. The same
5799 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5800 backward is half the speed of walking forward. */
5802 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5805 const STRLEN forw = target - s;
5806 STRLEN backw = end - target;
5808 if (forw < 2 * backw) {
5809 return utf8_length(s, target);
5812 while (end > target) {
5814 while (UTF8_IS_CONTINUATION(*end)) {
5823 =for apidoc sv_pos_b2u
5825 Converts the value pointed to by offsetp from a count of bytes from the
5826 start of the string, to a count of the equivalent number of UTF-8 chars.
5827 Handles magic and type coercion.
5833 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5834 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5839 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5842 const STRLEN byte = *offsetp;
5843 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5852 s = (const U8*)SvPV_const(sv, blen);
5855 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5859 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5860 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5862 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5863 if (cache[1] == byte) {
5864 /* An exact match. */
5865 *offsetp = cache[0];
5868 if (cache[3] == byte) {
5869 /* An exact match. */
5870 *offsetp = cache[2];
5874 if (cache[1] < byte) {
5875 /* We already know part of the way. */
5876 if (mg->mg_len != -1) {
5877 /* Actually, we know the end too. */
5879 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5880 s + blen, mg->mg_len - cache[0]);
5882 len = cache[0] + utf8_length(s + cache[1], send);
5885 else if (cache[3] < byte) {
5886 /* We're between the two cached pairs, so we do the calculation
5887 offset by the byte/utf-8 positions for the earlier pair,
5888 then add the utf-8 characters from the string start to
5890 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5891 s + cache[1], cache[0] - cache[2])
5895 else { /* cache[3] > byte */
5896 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5900 ASSERT_UTF8_CACHE(cache);
5902 } else if (mg->mg_len != -1) {
5903 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5907 if (!found || PL_utf8cache < 0) {
5908 const STRLEN real_len = utf8_length(s, send);
5910 if (found && PL_utf8cache < 0) {
5911 if (len != real_len) {
5912 /* Need to turn the assertions off otherwise we may recurse
5913 infinitely while printing error messages. */
5914 SAVEI8(PL_utf8cache);
5916 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5917 " real %"UVuf" for %"SVf,
5918 (UV) len, (UV) real_len, (void*)sv);
5925 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5931 Returns a boolean indicating whether the strings in the two SVs are
5932 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5933 coerce its args to strings if necessary.
5939 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5948 SV* svrecode = NULL;
5955 /* if pv1 and pv2 are the same, second SvPV_const call may
5956 * invalidate pv1, so we may need to make a copy */
5957 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5958 pv1 = SvPV_const(sv1, cur1);
5959 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5960 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5962 pv1 = SvPV_const(sv1, cur1);
5970 pv2 = SvPV_const(sv2, cur2);
5972 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5973 /* Differing utf8ness.
5974 * Do not UTF8size the comparands as a side-effect. */
5977 svrecode = newSVpvn(pv2, cur2);
5978 sv_recode_to_utf8(svrecode, PL_encoding);
5979 pv2 = SvPV_const(svrecode, cur2);
5982 svrecode = newSVpvn(pv1, cur1);
5983 sv_recode_to_utf8(svrecode, PL_encoding);
5984 pv1 = SvPV_const(svrecode, cur1);
5986 /* Now both are in UTF-8. */
5988 SvREFCNT_dec(svrecode);
5993 bool is_utf8 = TRUE;
5996 /* sv1 is the UTF-8 one,
5997 * if is equal it must be downgrade-able */
5998 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6004 /* sv2 is the UTF-8 one,
6005 * if is equal it must be downgrade-able */
6006 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6012 /* Downgrade not possible - cannot be eq */
6020 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6022 SvREFCNT_dec(svrecode);
6032 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6033 string in C<sv1> is less than, equal to, or greater than the string in
6034 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6035 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6041 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6045 const char *pv1, *pv2;
6048 SV *svrecode = NULL;
6055 pv1 = SvPV_const(sv1, cur1);
6062 pv2 = SvPV_const(sv2, cur2);
6064 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6065 /* Differing utf8ness.
6066 * Do not UTF8size the comparands as a side-effect. */
6069 svrecode = newSVpvn(pv2, cur2);
6070 sv_recode_to_utf8(svrecode, PL_encoding);
6071 pv2 = SvPV_const(svrecode, cur2);
6074 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6079 svrecode = newSVpvn(pv1, cur1);
6080 sv_recode_to_utf8(svrecode, PL_encoding);
6081 pv1 = SvPV_const(svrecode, cur1);
6084 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6090 cmp = cur2 ? -1 : 0;
6094 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6097 cmp = retval < 0 ? -1 : 1;
6098 } else if (cur1 == cur2) {
6101 cmp = cur1 < cur2 ? -1 : 1;
6105 SvREFCNT_dec(svrecode);
6113 =for apidoc sv_cmp_locale
6115 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6116 'use bytes' aware, handles get magic, and will coerce its args to strings
6117 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6123 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6126 #ifdef USE_LOCALE_COLLATE
6132 if (PL_collation_standard)
6136 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6138 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6140 if (!pv1 || !len1) {
6151 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6154 return retval < 0 ? -1 : 1;
6157 * When the result of collation is equality, that doesn't mean
6158 * that there are no differences -- some locales exclude some
6159 * characters from consideration. So to avoid false equalities,
6160 * we use the raw string as a tiebreaker.
6166 #endif /* USE_LOCALE_COLLATE */
6168 return sv_cmp(sv1, sv2);
6172 #ifdef USE_LOCALE_COLLATE
6175 =for apidoc sv_collxfrm
6177 Add Collate Transform magic to an SV if it doesn't already have it.
6179 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6180 scalar data of the variable, but transformed to such a format that a normal
6181 memory comparison can be used to compare the data according to the locale
6188 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6193 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6194 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6200 Safefree(mg->mg_ptr);
6201 s = SvPV_const(sv, len);
6202 if ((xf = mem_collxfrm(s, len, &xlen))) {
6203 if (SvREADONLY(sv)) {
6206 return xf + sizeof(PL_collation_ix);
6209 #ifdef PERL_OLD_COPY_ON_WRITE
6211 sv_force_normal_flags(sv, 0);
6213 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6227 if (mg && mg->mg_ptr) {
6229 return mg->mg_ptr + sizeof(PL_collation_ix);
6237 #endif /* USE_LOCALE_COLLATE */
6242 Get a line from the filehandle and store it into the SV, optionally
6243 appending to the currently-stored string.
6249 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6254 register STDCHAR rslast;
6255 register STDCHAR *bp;
6260 if (SvTHINKFIRST(sv))
6261 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6262 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6264 However, perlbench says it's slower, because the existing swipe code
6265 is faster than copy on write.
6266 Swings and roundabouts. */
6267 SvUPGRADE(sv, SVt_PV);
6272 if (PerlIO_isutf8(fp)) {
6274 sv_utf8_upgrade_nomg(sv);
6275 sv_pos_u2b(sv,&append,0);
6277 } else if (SvUTF8(sv)) {
6278 SV * const tsv = newSV(0);
6279 sv_gets(tsv, fp, 0);
6280 sv_utf8_upgrade_nomg(tsv);
6281 SvCUR_set(sv,append);
6284 goto return_string_or_null;
6289 if (PerlIO_isutf8(fp))
6292 if (IN_PERL_COMPILETIME) {
6293 /* we always read code in line mode */
6297 else if (RsSNARF(PL_rs)) {
6298 /* If it is a regular disk file use size from stat() as estimate
6299 of amount we are going to read -- may result in mallocing
6300 more memory than we really need if the layers below reduce
6301 the size we read (e.g. CRLF or a gzip layer).
6304 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6305 const Off_t offset = PerlIO_tell(fp);
6306 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6307 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6313 else if (RsRECORD(PL_rs)) {
6318 /* Grab the size of the record we're getting */
6319 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6320 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6323 /* VMS wants read instead of fread, because fread doesn't respect */
6324 /* RMS record boundaries. This is not necessarily a good thing to be */
6325 /* doing, but we've got no other real choice - except avoid stdio
6326 as implementation - perhaps write a :vms layer ?
6328 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6330 bytesread = PerlIO_read(fp, buffer, recsize);
6334 SvCUR_set(sv, bytesread += append);
6335 buffer[bytesread] = '\0';
6336 goto return_string_or_null;
6338 else if (RsPARA(PL_rs)) {
6344 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6345 if (PerlIO_isutf8(fp)) {
6346 rsptr = SvPVutf8(PL_rs, rslen);
6349 if (SvUTF8(PL_rs)) {
6350 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6351 Perl_croak(aTHX_ "Wide character in $/");
6354 rsptr = SvPV_const(PL_rs, rslen);
6358 rslast = rslen ? rsptr[rslen - 1] : '\0';
6360 if (rspara) { /* have to do this both before and after */
6361 do { /* to make sure file boundaries work right */
6364 i = PerlIO_getc(fp);
6368 PerlIO_ungetc(fp,i);
6374 /* See if we know enough about I/O mechanism to cheat it ! */
6376 /* This used to be #ifdef test - it is made run-time test for ease
6377 of abstracting out stdio interface. One call should be cheap
6378 enough here - and may even be a macro allowing compile
6382 if (PerlIO_fast_gets(fp)) {
6385 * We're going to steal some values from the stdio struct
6386 * and put EVERYTHING in the innermost loop into registers.
6388 register STDCHAR *ptr;
6392 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6393 /* An ungetc()d char is handled separately from the regular
6394 * buffer, so we getc() it back out and stuff it in the buffer.
6396 i = PerlIO_getc(fp);
6397 if (i == EOF) return 0;
6398 *(--((*fp)->_ptr)) = (unsigned char) i;
6402 /* Here is some breathtakingly efficient cheating */
6404 cnt = PerlIO_get_cnt(fp); /* get count into register */
6405 /* make sure we have the room */
6406 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6407 /* Not room for all of it
6408 if we are looking for a separator and room for some
6410 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6411 /* just process what we have room for */
6412 shortbuffered = cnt - SvLEN(sv) + append + 1;
6413 cnt -= shortbuffered;
6417 /* remember that cnt can be negative */
6418 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6423 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6424 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6425 DEBUG_P(PerlIO_printf(Perl_debug_log,
6426 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6427 DEBUG_P(PerlIO_printf(Perl_debug_log,
6428 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6429 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6430 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6435 while (cnt > 0) { /* this | eat */
6437 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6438 goto thats_all_folks; /* screams | sed :-) */
6442 Copy(ptr, bp, cnt, char); /* this | eat */
6443 bp += cnt; /* screams | dust */
6444 ptr += cnt; /* louder | sed :-) */
6449 if (shortbuffered) { /* oh well, must extend */
6450 cnt = shortbuffered;
6452 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6454 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6455 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6459 DEBUG_P(PerlIO_printf(Perl_debug_log,
6460 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6461 PTR2UV(ptr),(long)cnt));
6462 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6464 DEBUG_P(PerlIO_printf(Perl_debug_log,
6465 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6466 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6467 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6469 /* This used to call 'filbuf' in stdio form, but as that behaves like
6470 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6471 another abstraction. */
6472 i = PerlIO_getc(fp); /* get more characters */
6474 DEBUG_P(PerlIO_printf(Perl_debug_log,
6475 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6476 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6477 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6479 cnt = PerlIO_get_cnt(fp);
6480 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6481 DEBUG_P(PerlIO_printf(Perl_debug_log,
6482 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6484 if (i == EOF) /* all done for ever? */
6485 goto thats_really_all_folks;
6487 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6489 SvGROW(sv, bpx + cnt + 2);
6490 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6492 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6494 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6495 goto thats_all_folks;
6499 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6500 memNE((char*)bp - rslen, rsptr, rslen))
6501 goto screamer; /* go back to the fray */
6502 thats_really_all_folks:
6504 cnt += shortbuffered;
6505 DEBUG_P(PerlIO_printf(Perl_debug_log,
6506 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6507 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6508 DEBUG_P(PerlIO_printf(Perl_debug_log,
6509 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6510 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6511 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6513 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6514 DEBUG_P(PerlIO_printf(Perl_debug_log,
6515 "Screamer: done, len=%ld, string=|%.*s|\n",
6516 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6520 /*The big, slow, and stupid way. */
6521 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6522 STDCHAR *buf = NULL;
6523 Newx(buf, 8192, STDCHAR);
6531 register const STDCHAR * const bpe = buf + sizeof(buf);
6533 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6534 ; /* keep reading */
6538 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6539 /* Accomodate broken VAXC compiler, which applies U8 cast to
6540 * both args of ?: operator, causing EOF to change into 255
6543 i = (U8)buf[cnt - 1];
6549 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6551 sv_catpvn(sv, (char *) buf, cnt);
6553 sv_setpvn(sv, (char *) buf, cnt);
6555 if (i != EOF && /* joy */
6557 SvCUR(sv) < rslen ||
6558 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6562 * If we're reading from a TTY and we get a short read,
6563 * indicating that the user hit his EOF character, we need
6564 * to notice it now, because if we try to read from the TTY
6565 * again, the EOF condition will disappear.
6567 * The comparison of cnt to sizeof(buf) is an optimization
6568 * that prevents unnecessary calls to feof().
6572 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6576 #ifdef USE_HEAP_INSTEAD_OF_STACK
6581 if (rspara) { /* have to do this both before and after */
6582 while (i != EOF) { /* to make sure file boundaries work right */
6583 i = PerlIO_getc(fp);
6585 PerlIO_ungetc(fp,i);
6591 return_string_or_null:
6592 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6598 Auto-increment of the value in the SV, doing string to numeric conversion
6599 if necessary. Handles 'get' magic.
6605 Perl_sv_inc(pTHX_ register SV *sv)
6614 if (SvTHINKFIRST(sv)) {
6616 sv_force_normal_flags(sv, 0);
6617 if (SvREADONLY(sv)) {
6618 if (IN_PERL_RUNTIME)
6619 Perl_croak(aTHX_ PL_no_modify);
6623 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6625 i = PTR2IV(SvRV(sv));
6630 flags = SvFLAGS(sv);
6631 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6632 /* It's (privately or publicly) a float, but not tested as an
6633 integer, so test it to see. */
6635 flags = SvFLAGS(sv);
6637 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6638 /* It's publicly an integer, or privately an integer-not-float */
6639 #ifdef PERL_PRESERVE_IVUV
6643 if (SvUVX(sv) == UV_MAX)
6644 sv_setnv(sv, UV_MAX_P1);
6646 (void)SvIOK_only_UV(sv);
6647 SvUV_set(sv, SvUVX(sv) + 1);
6649 if (SvIVX(sv) == IV_MAX)
6650 sv_setuv(sv, (UV)IV_MAX + 1);
6652 (void)SvIOK_only(sv);
6653 SvIV_set(sv, SvIVX(sv) + 1);
6658 if (flags & SVp_NOK) {
6659 (void)SvNOK_only(sv);
6660 SvNV_set(sv, SvNVX(sv) + 1.0);
6664 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6665 if ((flags & SVTYPEMASK) < SVt_PVIV)
6666 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6667 (void)SvIOK_only(sv);
6672 while (isALPHA(*d)) d++;
6673 while (isDIGIT(*d)) d++;
6675 #ifdef PERL_PRESERVE_IVUV
6676 /* Got to punt this as an integer if needs be, but we don't issue
6677 warnings. Probably ought to make the sv_iv_please() that does
6678 the conversion if possible, and silently. */
6679 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6680 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6681 /* Need to try really hard to see if it's an integer.
6682 9.22337203685478e+18 is an integer.
6683 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6684 so $a="9.22337203685478e+18"; $a+0; $a++
6685 needs to be the same as $a="9.22337203685478e+18"; $a++
6692 /* sv_2iv *should* have made this an NV */
6693 if (flags & SVp_NOK) {
6694 (void)SvNOK_only(sv);
6695 SvNV_set(sv, SvNVX(sv) + 1.0);
6698 /* I don't think we can get here. Maybe I should assert this
6699 And if we do get here I suspect that sv_setnv will croak. NWC
6701 #if defined(USE_LONG_DOUBLE)
6702 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",
6703 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6705 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6706 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6709 #endif /* PERL_PRESERVE_IVUV */
6710 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6714 while (d >= SvPVX_const(sv)) {
6722 /* MKS: The original code here died if letters weren't consecutive.
6723 * at least it didn't have to worry about non-C locales. The
6724 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6725 * arranged in order (although not consecutively) and that only
6726 * [A-Za-z] are accepted by isALPHA in the C locale.
6728 if (*d != 'z' && *d != 'Z') {
6729 do { ++*d; } while (!isALPHA(*d));
6732 *(d--) -= 'z' - 'a';
6737 *(d--) -= 'z' - 'a' + 1;
6741 /* oh,oh, the number grew */
6742 SvGROW(sv, SvCUR(sv) + 2);
6743 SvCUR_set(sv, SvCUR(sv) + 1);
6744 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6755 Auto-decrement of the value in the SV, doing string to numeric conversion
6756 if necessary. Handles 'get' magic.
6762 Perl_sv_dec(pTHX_ register SV *sv)
6770 if (SvTHINKFIRST(sv)) {
6772 sv_force_normal_flags(sv, 0);
6773 if (SvREADONLY(sv)) {
6774 if (IN_PERL_RUNTIME)
6775 Perl_croak(aTHX_ PL_no_modify);
6779 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6781 i = PTR2IV(SvRV(sv));
6786 /* Unlike sv_inc we don't have to worry about string-never-numbers
6787 and keeping them magic. But we mustn't warn on punting */
6788 flags = SvFLAGS(sv);
6789 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6790 /* It's publicly an integer, or privately an integer-not-float */
6791 #ifdef PERL_PRESERVE_IVUV
6795 if (SvUVX(sv) == 0) {
6796 (void)SvIOK_only(sv);
6800 (void)SvIOK_only_UV(sv);
6801 SvUV_set(sv, SvUVX(sv) - 1);
6804 if (SvIVX(sv) == IV_MIN)
6805 sv_setnv(sv, (NV)IV_MIN - 1.0);
6807 (void)SvIOK_only(sv);
6808 SvIV_set(sv, SvIVX(sv) - 1);
6813 if (flags & SVp_NOK) {
6814 SvNV_set(sv, SvNVX(sv) - 1.0);
6815 (void)SvNOK_only(sv);
6818 if (!(flags & SVp_POK)) {
6819 if ((flags & SVTYPEMASK) < SVt_PVIV)
6820 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6822 (void)SvIOK_only(sv);
6825 #ifdef PERL_PRESERVE_IVUV
6827 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6828 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6829 /* Need to try really hard to see if it's an integer.
6830 9.22337203685478e+18 is an integer.
6831 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6832 so $a="9.22337203685478e+18"; $a+0; $a--
6833 needs to be the same as $a="9.22337203685478e+18"; $a--
6840 /* sv_2iv *should* have made this an NV */
6841 if (flags & SVp_NOK) {
6842 (void)SvNOK_only(sv);
6843 SvNV_set(sv, SvNVX(sv) - 1.0);
6846 /* I don't think we can get here. Maybe I should assert this
6847 And if we do get here I suspect that sv_setnv will croak. NWC
6849 #if defined(USE_LONG_DOUBLE)
6850 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",
6851 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6853 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6854 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6858 #endif /* PERL_PRESERVE_IVUV */
6859 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6863 =for apidoc sv_mortalcopy
6865 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6866 The new SV is marked as mortal. It will be destroyed "soon", either by an
6867 explicit call to FREETMPS, or by an implicit call at places such as
6868 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6873 /* Make a string that will exist for the duration of the expression
6874 * evaluation. Actually, it may have to last longer than that, but
6875 * hopefully we won't free it until it has been assigned to a
6876 * permanent location. */
6879 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6885 sv_setsv(sv,oldstr);
6887 PL_tmps_stack[++PL_tmps_ix] = sv;
6893 =for apidoc sv_newmortal
6895 Creates a new null SV which is mortal. The reference count of the SV is
6896 set to 1. It will be destroyed "soon", either by an explicit call to
6897 FREETMPS, or by an implicit call at places such as statement boundaries.
6898 See also C<sv_mortalcopy> and C<sv_2mortal>.
6904 Perl_sv_newmortal(pTHX)
6910 SvFLAGS(sv) = SVs_TEMP;
6912 PL_tmps_stack[++PL_tmps_ix] = sv;
6917 =for apidoc sv_2mortal
6919 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6920 by an explicit call to FREETMPS, or by an implicit call at places such as
6921 statement boundaries. SvTEMP() is turned on which means that the SV's
6922 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6923 and C<sv_mortalcopy>.
6929 Perl_sv_2mortal(pTHX_ register SV *sv)
6934 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6937 PL_tmps_stack[++PL_tmps_ix] = sv;
6945 Creates a new SV and copies a string into it. The reference count for the
6946 SV is set to 1. If C<len> is zero, Perl will compute the length using
6947 strlen(). For efficiency, consider using C<newSVpvn> instead.
6953 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6959 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6964 =for apidoc newSVpvn
6966 Creates a new SV and copies a string into it. The reference count for the
6967 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6968 string. You are responsible for ensuring that the source string is at least
6969 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6975 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6981 sv_setpvn(sv,s,len);
6987 =for apidoc newSVhek
6989 Creates a new SV from the hash key structure. It will generate scalars that
6990 point to the shared string table where possible. Returns a new (undefined)
6991 SV if the hek is NULL.
6997 Perl_newSVhek(pTHX_ const HEK *hek)
7007 if (HEK_LEN(hek) == HEf_SVKEY) {
7008 return newSVsv(*(SV**)HEK_KEY(hek));
7010 const int flags = HEK_FLAGS(hek);
7011 if (flags & HVhek_WASUTF8) {
7013 Andreas would like keys he put in as utf8 to come back as utf8
7015 STRLEN utf8_len = HEK_LEN(hek);
7016 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7017 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7020 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7022 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7023 /* We don't have a pointer to the hv, so we have to replicate the
7024 flag into every HEK. This hv is using custom a hasing
7025 algorithm. Hence we can't return a shared string scalar, as
7026 that would contain the (wrong) hash value, and might get passed
7027 into an hv routine with a regular hash.
7028 Similarly, a hash that isn't using shared hash keys has to have
7029 the flag in every key so that we know not to try to call
7030 share_hek_kek on it. */
7032 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7037 /* This will be overwhelminly the most common case. */
7039 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7040 more efficient than sharepvn(). */
7044 sv_upgrade(sv, SVt_PV);
7045 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7046 SvCUR_set(sv, HEK_LEN(hek));
7059 =for apidoc newSVpvn_share
7061 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7062 table. If the string does not already exist in the table, it is created
7063 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7064 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7065 otherwise the hash is computed. The idea here is that as the string table
7066 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7067 hash lookup will avoid string compare.
7073 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7077 bool is_utf8 = FALSE;
7078 const char *const orig_src = src;
7081 STRLEN tmplen = -len;
7083 /* See the note in hv.c:hv_fetch() --jhi */
7084 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7088 PERL_HASH(hash, src, len);
7090 sv_upgrade(sv, SVt_PV);
7091 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7099 if (src != orig_src)
7105 #if defined(PERL_IMPLICIT_CONTEXT)
7107 /* pTHX_ magic can't cope with varargs, so this is a no-context
7108 * version of the main function, (which may itself be aliased to us).
7109 * Don't access this version directly.
7113 Perl_newSVpvf_nocontext(const char* pat, ...)
7118 va_start(args, pat);
7119 sv = vnewSVpvf(pat, &args);
7126 =for apidoc newSVpvf
7128 Creates a new SV and initializes it with the string formatted like
7135 Perl_newSVpvf(pTHX_ const char* pat, ...)
7139 va_start(args, pat);
7140 sv = vnewSVpvf(pat, &args);
7145 /* backend for newSVpvf() and newSVpvf_nocontext() */
7148 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7153 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7160 Creates a new SV and copies a floating point value into it.
7161 The reference count for the SV is set to 1.
7167 Perl_newSVnv(pTHX_ NV n)
7180 Creates a new SV and copies an integer into it. The reference count for the
7187 Perl_newSViv(pTHX_ IV i)
7200 Creates a new SV and copies an unsigned integer into it.
7201 The reference count for the SV is set to 1.
7207 Perl_newSVuv(pTHX_ UV u)
7218 =for apidoc newRV_noinc
7220 Creates an RV wrapper for an SV. The reference count for the original
7221 SV is B<not> incremented.
7227 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7233 sv_upgrade(sv, SVt_RV);
7235 SvRV_set(sv, tmpRef);
7240 /* newRV_inc is the official function name to use now.
7241 * newRV_inc is in fact #defined to newRV in sv.h
7245 Perl_newRV(pTHX_ SV *sv)
7248 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7254 Creates a new SV which is an exact duplicate of the original SV.
7261 Perl_newSVsv(pTHX_ register SV *old)
7268 if (SvTYPE(old) == SVTYPEMASK) {
7269 if (ckWARN_d(WARN_INTERNAL))
7270 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7274 /* SV_GMAGIC is the default for sv_setv()
7275 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7276 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7277 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7282 =for apidoc sv_reset
7284 Underlying implementation for the C<reset> Perl function.
7285 Note that the perl-level function is vaguely deprecated.
7291 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7294 char todo[PERL_UCHAR_MAX+1];
7299 if (!*s) { /* reset ?? searches */
7300 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7302 PMOP *pm = (PMOP *) mg->mg_obj;
7304 pm->op_pmdynflags &= ~PMdf_USED;
7311 /* reset variables */
7313 if (!HvARRAY(stash))
7316 Zero(todo, 256, char);
7319 I32 i = (unsigned char)*s;
7323 max = (unsigned char)*s++;
7324 for ( ; i <= max; i++) {
7327 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7329 for (entry = HvARRAY(stash)[i];
7331 entry = HeNEXT(entry))
7336 if (!todo[(U8)*HeKEY(entry)])
7338 gv = (GV*)HeVAL(entry);
7341 if (SvTHINKFIRST(sv)) {
7342 if (!SvREADONLY(sv) && SvROK(sv))
7344 /* XXX Is this continue a bug? Why should THINKFIRST
7345 exempt us from resetting arrays and hashes? */
7349 if (SvTYPE(sv) >= SVt_PV) {
7351 if (SvPVX_const(sv) != NULL)
7359 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7361 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7364 # if defined(USE_ENVIRON_ARRAY)
7367 # endif /* USE_ENVIRON_ARRAY */
7378 Using various gambits, try to get an IO from an SV: the IO slot if its a
7379 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7380 named after the PV if we're a string.
7386 Perl_sv_2io(pTHX_ SV *sv)
7391 switch (SvTYPE(sv)) {
7399 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7403 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7405 return sv_2io(SvRV(sv));
7406 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7412 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7421 Using various gambits, try to get a CV from an SV; in addition, try if
7422 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7423 The flags in C<lref> are passed to sv_fetchsv.
7429 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7440 switch (SvTYPE(sv)) {
7459 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7460 tryAMAGICunDEREF(to_cv);
7463 if (SvTYPE(sv) == SVt_PVCV) {
7472 Perl_croak(aTHX_ "Not a subroutine reference");
7477 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7483 /* Some flags to gv_fetchsv mean don't really create the GV */
7484 if (SvTYPE(gv) != SVt_PVGV) {
7490 if (lref && !GvCVu(gv)) {
7494 gv_efullname3(tmpsv, gv, NULL);
7495 /* XXX this is probably not what they think they're getting.
7496 * It has the same effect as "sub name;", i.e. just a forward
7498 newSUB(start_subparse(FALSE, 0),
7499 newSVOP(OP_CONST, 0, tmpsv),
7503 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7513 Returns true if the SV has a true value by Perl's rules.
7514 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7515 instead use an in-line version.
7521 Perl_sv_true(pTHX_ register SV *sv)
7526 register const XPV* const tXpv = (XPV*)SvANY(sv);
7528 (tXpv->xpv_cur > 1 ||
7529 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7536 return SvIVX(sv) != 0;
7539 return SvNVX(sv) != 0.0;
7541 return sv_2bool(sv);
7547 =for apidoc sv_pvn_force
7549 Get a sensible string out of the SV somehow.
7550 A private implementation of the C<SvPV_force> macro for compilers which
7551 can't cope with complex macro expressions. Always use the macro instead.
7553 =for apidoc sv_pvn_force_flags
7555 Get a sensible string out of the SV somehow.
7556 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7557 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7558 implemented in terms of this function.
7559 You normally want to use the various wrapper macros instead: see
7560 C<SvPV_force> and C<SvPV_force_nomg>
7566 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7569 if (SvTHINKFIRST(sv) && !SvROK(sv))
7570 sv_force_normal_flags(sv, 0);
7580 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7581 const char * const ref = sv_reftype(sv,0);
7583 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7584 ref, OP_NAME(PL_op));
7586 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7588 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7589 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7591 s = sv_2pv_flags(sv, &len, flags);
7595 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7598 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7599 SvGROW(sv, len + 1);
7600 Move(s,SvPVX(sv),len,char);
7605 SvPOK_on(sv); /* validate pointer */
7607 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7608 PTR2UV(sv),SvPVX_const(sv)));
7611 return SvPVX_mutable(sv);
7615 =for apidoc sv_pvbyten_force
7617 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7623 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7625 sv_pvn_force(sv,lp);
7626 sv_utf8_downgrade(sv,0);
7632 =for apidoc sv_pvutf8n_force
7634 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7640 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7642 sv_pvn_force(sv,lp);
7643 sv_utf8_upgrade(sv);
7649 =for apidoc sv_reftype
7651 Returns a string describing what the SV is a reference to.
7657 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7659 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7660 inside return suggests a const propagation bug in g++. */
7661 if (ob && SvOBJECT(sv)) {
7662 char * const name = HvNAME_get(SvSTASH(sv));
7663 return name ? name : (char *) "__ANON__";
7666 switch (SvTYPE(sv)) {
7683 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7684 /* tied lvalues should appear to be
7685 * scalars for backwards compatitbility */
7686 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7687 ? "SCALAR" : "LVALUE");
7688 case SVt_PVAV: return "ARRAY";
7689 case SVt_PVHV: return "HASH";
7690 case SVt_PVCV: return "CODE";
7691 case SVt_PVGV: return "GLOB";
7692 case SVt_PVFM: return "FORMAT";
7693 case SVt_PVIO: return "IO";
7694 default: return "UNKNOWN";
7700 =for apidoc sv_isobject
7702 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7703 object. If the SV is not an RV, or if the object is not blessed, then this
7710 Perl_sv_isobject(pTHX_ SV *sv)
7726 Returns a boolean indicating whether the SV is blessed into the specified
7727 class. This does not check for subtypes; use C<sv_derived_from> to verify
7728 an inheritance relationship.
7734 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7745 hvname = HvNAME_get(SvSTASH(sv));
7749 return strEQ(hvname, name);
7755 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7756 it will be upgraded to one. If C<classname> is non-null then the new SV will
7757 be blessed in the specified package. The new SV is returned and its
7758 reference count is 1.
7764 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7771 SV_CHECK_THINKFIRST_COW_DROP(rv);
7774 if (SvTYPE(rv) >= SVt_PVMG) {
7775 const U32 refcnt = SvREFCNT(rv);
7779 SvREFCNT(rv) = refcnt;
7781 sv_upgrade(rv, SVt_RV);
7782 } else if (SvROK(rv)) {
7783 SvREFCNT_dec(SvRV(rv));
7784 } else if (SvTYPE(rv) < SVt_RV)
7785 sv_upgrade(rv, SVt_RV);
7786 else if (SvTYPE(rv) > SVt_RV) {
7797 HV* const stash = gv_stashpv(classname, TRUE);
7798 (void)sv_bless(rv, stash);
7804 =for apidoc sv_setref_pv
7806 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7807 argument will be upgraded to an RV. That RV will be modified to point to
7808 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7809 into the 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.
7813 Do not use with other Perl types such as HV, AV, SV, CV, because those
7814 objects will become corrupted by the pointer copy process.
7816 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7822 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7826 sv_setsv(rv, &PL_sv_undef);
7830 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7835 =for apidoc sv_setref_iv
7837 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7838 argument will be upgraded to an RV. That RV will be modified to point to
7839 the new SV. The C<classname> argument indicates the package for the
7840 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7841 will have a reference count of 1, and the RV will be returned.
7847 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7849 sv_setiv(newSVrv(rv,classname), iv);
7854 =for apidoc sv_setref_uv
7856 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7857 argument will be upgraded to an RV. That RV will be modified to point to
7858 the new SV. The C<classname> argument indicates the package for the
7859 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7860 will have a reference count of 1, and the RV will be returned.
7866 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7868 sv_setuv(newSVrv(rv,classname), uv);
7873 =for apidoc sv_setref_nv
7875 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7876 argument will be upgraded to an RV. That RV will be modified to point to
7877 the new SV. The C<classname> argument indicates the package for the
7878 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7879 will have a reference count of 1, and the RV will be returned.
7885 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7887 sv_setnv(newSVrv(rv,classname), nv);
7892 =for apidoc sv_setref_pvn
7894 Copies a string into a new SV, optionally blessing the SV. The length of the
7895 string must be specified with C<n>. The C<rv> argument will be upgraded to
7896 an RV. That RV will be modified to point to the new SV. The C<classname>
7897 argument indicates the package for the blessing. Set C<classname> to
7898 C<NULL> to avoid the blessing. The new SV will have a reference count
7899 of 1, and the RV will be returned.
7901 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7907 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7909 sv_setpvn(newSVrv(rv,classname), pv, n);
7914 =for apidoc sv_bless
7916 Blesses an SV into a specified package. The SV must be an RV. The package
7917 must be designated by its stash (see C<gv_stashpv()>). The reference count
7918 of the SV is unaffected.
7924 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7929 Perl_croak(aTHX_ "Can't bless non-reference value");
7931 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7932 if (SvREADONLY(tmpRef))
7933 Perl_croak(aTHX_ PL_no_modify);
7934 if (SvOBJECT(tmpRef)) {
7935 if (SvTYPE(tmpRef) != SVt_PVIO)
7937 SvREFCNT_dec(SvSTASH(tmpRef));
7940 SvOBJECT_on(tmpRef);
7941 if (SvTYPE(tmpRef) != SVt_PVIO)
7943 SvUPGRADE(tmpRef, SVt_PVMG);
7944 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7951 if(SvSMAGICAL(tmpRef))
7952 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7960 /* Downgrades a PVGV to a PVMG.
7964 S_sv_unglob(pTHX_ SV *sv)
7968 SV * const temp = sv_newmortal();
7970 assert(SvTYPE(sv) == SVt_PVGV);
7972 gv_efullname3(temp, (GV *) sv, "*");
7978 sv_del_backref((SV*)GvSTASH(sv), sv);
7982 if (GvNAME_HEK(sv)) {
7983 unshare_hek(GvNAME_HEK(sv));
7987 /* need to keep SvANY(sv) in the right arena */
7988 xpvmg = new_XPVMG();
7989 StructCopy(SvANY(sv), xpvmg, XPVMG);
7990 del_XPVGV(SvANY(sv));
7993 SvFLAGS(sv) &= ~SVTYPEMASK;
7994 SvFLAGS(sv) |= SVt_PVMG;
7996 /* Intentionally not calling any local SET magic, as this isn't so much a
7997 set operation as merely an internal storage change. */
7998 sv_setsv_flags(sv, temp, 0);
8002 =for apidoc sv_unref_flags
8004 Unsets the RV status of the SV, and decrements the reference count of
8005 whatever was being referenced by the RV. This can almost be thought of
8006 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8007 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8008 (otherwise the decrementing is conditional on the reference count being
8009 different from one or the reference being a readonly SV).
8016 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8018 SV* const target = SvRV(ref);
8020 if (SvWEAKREF(ref)) {
8021 sv_del_backref(target, ref);
8023 SvRV_set(ref, NULL);
8026 SvRV_set(ref, NULL);
8028 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8029 assigned to as BEGIN {$a = \"Foo"} will fail. */
8030 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8031 SvREFCNT_dec(target);
8032 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8033 sv_2mortal(target); /* Schedule for freeing later */
8037 =for apidoc sv_untaint
8039 Untaint an SV. Use C<SvTAINTED_off> instead.
8044 Perl_sv_untaint(pTHX_ SV *sv)
8046 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8047 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8054 =for apidoc sv_tainted
8056 Test an SV for taintedness. Use C<SvTAINTED> instead.
8061 Perl_sv_tainted(pTHX_ SV *sv)
8063 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8064 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8065 if (mg && (mg->mg_len & 1) )
8072 =for apidoc sv_setpviv
8074 Copies an integer into the given SV, also updating its string value.
8075 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8081 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8083 char buf[TYPE_CHARS(UV)];
8085 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8087 sv_setpvn(sv, ptr, ebuf - ptr);
8091 =for apidoc sv_setpviv_mg
8093 Like C<sv_setpviv>, but also handles 'set' magic.
8099 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8105 #if defined(PERL_IMPLICIT_CONTEXT)
8107 /* pTHX_ magic can't cope with varargs, so this is a no-context
8108 * version of the main function, (which may itself be aliased to us).
8109 * Don't access this version directly.
8113 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8117 va_start(args, pat);
8118 sv_vsetpvf(sv, pat, &args);
8122 /* pTHX_ magic can't cope with varargs, so this is a no-context
8123 * version of the main function, (which may itself be aliased to us).
8124 * Don't access this version directly.
8128 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8132 va_start(args, pat);
8133 sv_vsetpvf_mg(sv, pat, &args);
8139 =for apidoc sv_setpvf
8141 Works like C<sv_catpvf> but copies the text into the SV instead of
8142 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8148 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8151 va_start(args, pat);
8152 sv_vsetpvf(sv, pat, &args);
8157 =for apidoc sv_vsetpvf
8159 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8160 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8162 Usually used via its frontend C<sv_setpvf>.
8168 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8170 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8174 =for apidoc sv_setpvf_mg
8176 Like C<sv_setpvf>, but also handles 'set' magic.
8182 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8185 va_start(args, pat);
8186 sv_vsetpvf_mg(sv, pat, &args);
8191 =for apidoc sv_vsetpvf_mg
8193 Like C<sv_vsetpvf>, but also handles 'set' magic.
8195 Usually used via its frontend C<sv_setpvf_mg>.
8201 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8203 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8207 #if defined(PERL_IMPLICIT_CONTEXT)
8209 /* pTHX_ magic can't cope with varargs, so this is a no-context
8210 * version of the main function, (which may itself be aliased to us).
8211 * Don't access this version directly.
8215 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8219 va_start(args, pat);
8220 sv_vcatpvf(sv, pat, &args);
8224 /* pTHX_ magic can't cope with varargs, so this is a no-context
8225 * version of the main function, (which may itself be aliased to us).
8226 * Don't access this version directly.
8230 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8234 va_start(args, pat);
8235 sv_vcatpvf_mg(sv, pat, &args);
8241 =for apidoc sv_catpvf
8243 Processes its arguments like C<sprintf> and appends the formatted
8244 output to an SV. If the appended data contains "wide" characters
8245 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8246 and characters >255 formatted with %c), the original SV might get
8247 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8248 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8249 valid UTF-8; if the original SV was bytes, the pattern should be too.
8254 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8257 va_start(args, pat);
8258 sv_vcatpvf(sv, pat, &args);
8263 =for apidoc sv_vcatpvf
8265 Processes its arguments like C<vsprintf> and appends the formatted output
8266 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8268 Usually used via its frontend C<sv_catpvf>.
8274 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8276 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8280 =for apidoc sv_catpvf_mg
8282 Like C<sv_catpvf>, but also handles 'set' magic.
8288 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8291 va_start(args, pat);
8292 sv_vcatpvf_mg(sv, pat, &args);
8297 =for apidoc sv_vcatpvf_mg
8299 Like C<sv_vcatpvf>, but also handles 'set' magic.
8301 Usually used via its frontend C<sv_catpvf_mg>.
8307 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8309 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8314 =for apidoc sv_vsetpvfn
8316 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8319 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8325 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8327 sv_setpvn(sv, "", 0);
8328 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8332 S_expect_number(pTHX_ char** pattern)
8336 switch (**pattern) {
8337 case '1': case '2': case '3':
8338 case '4': case '5': case '6':
8339 case '7': case '8': case '9':
8340 var = *(*pattern)++ - '0';
8341 while (isDIGIT(**pattern)) {
8342 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8344 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8352 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8354 const int neg = nv < 0;
8363 if (uv & 1 && uv == nv)
8364 uv--; /* Round to even */
8366 const unsigned dig = uv % 10;
8379 =for apidoc sv_vcatpvfn
8381 Processes its arguments like C<vsprintf> and appends the formatted output
8382 to an SV. Uses an array of SVs if the C style variable argument list is
8383 missing (NULL). When running with taint checks enabled, indicates via
8384 C<maybe_tainted> if results are untrustworthy (often due to the use of
8387 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8393 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8394 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8395 vec_utf8 = DO_UTF8(vecsv);
8397 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8400 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8408 static const char nullstr[] = "(null)";
8410 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8411 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8413 /* Times 4: a decimal digit takes more than 3 binary digits.
8414 * NV_DIG: mantissa takes than many decimal digits.
8415 * Plus 32: Playing safe. */
8416 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8417 /* large enough for "%#.#f" --chip */
8418 /* what about long double NVs? --jhi */
8420 PERL_UNUSED_ARG(maybe_tainted);
8422 /* no matter what, this is a string now */
8423 (void)SvPV_force(sv, origlen);
8425 /* special-case "", "%s", and "%-p" (SVf - see below) */
8428 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8430 const char * const s = va_arg(*args, char*);
8431 sv_catpv(sv, s ? s : nullstr);
8433 else if (svix < svmax) {
8434 sv_catsv(sv, *svargs);
8438 if (args && patlen == 3 && pat[0] == '%' &&
8439 pat[1] == '-' && pat[2] == 'p') {
8440 argsv = va_arg(*args, SV*);
8441 sv_catsv(sv, argsv);
8445 #ifndef USE_LONG_DOUBLE
8446 /* special-case "%.<number>[gf]" */
8447 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8448 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8449 unsigned digits = 0;
8453 while (*pp >= '0' && *pp <= '9')
8454 digits = 10 * digits + (*pp++ - '0');
8455 if (pp - pat == (int)patlen - 1) {
8463 /* Add check for digits != 0 because it seems that some
8464 gconverts are buggy in this case, and we don't yet have
8465 a Configure test for this. */
8466 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8467 /* 0, point, slack */
8468 Gconvert(nv, (int)digits, 0, ebuf);
8470 if (*ebuf) /* May return an empty string for digits==0 */
8473 } else if (!digits) {
8476 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8477 sv_catpvn(sv, p, l);
8483 #endif /* !USE_LONG_DOUBLE */
8485 if (!args && svix < svmax && DO_UTF8(*svargs))
8488 patend = (char*)pat + patlen;
8489 for (p = (char*)pat; p < patend; p = q) {
8492 bool vectorize = FALSE;
8493 bool vectorarg = FALSE;
8494 bool vec_utf8 = FALSE;
8500 bool has_precis = FALSE;
8502 const I32 osvix = svix;
8503 bool is_utf8 = FALSE; /* is this item utf8? */
8504 #ifdef HAS_LDBL_SPRINTF_BUG
8505 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8506 with sfio - Allen <allens@cpan.org> */
8507 bool fix_ldbl_sprintf_bug = FALSE;
8511 U8 utf8buf[UTF8_MAXBYTES+1];
8512 STRLEN esignlen = 0;
8514 const char *eptr = NULL;
8517 const U8 *vecstr = NULL;
8524 /* we need a long double target in case HAS_LONG_DOUBLE but
8527 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8535 const char *dotstr = ".";
8536 STRLEN dotstrlen = 1;
8537 I32 efix = 0; /* explicit format parameter index */
8538 I32 ewix = 0; /* explicit width index */
8539 I32 epix = 0; /* explicit precision index */
8540 I32 evix = 0; /* explicit vector index */
8541 bool asterisk = FALSE;
8543 /* echo everything up to the next format specification */
8544 for (q = p; q < patend && *q != '%'; ++q) ;
8546 if (has_utf8 && !pat_utf8)
8547 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8549 sv_catpvn(sv, p, q - p);
8556 We allow format specification elements in this order:
8557 \d+\$ explicit format parameter index
8559 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8560 0 flag (as above): repeated to allow "v02"
8561 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8562 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8564 [%bcdefginopsuxDFOUX] format (mandatory)
8569 As of perl5.9.3, printf format checking is on by default.
8570 Internally, perl uses %p formats to provide an escape to
8571 some extended formatting. This block deals with those
8572 extensions: if it does not match, (char*)q is reset and
8573 the normal format processing code is used.
8575 Currently defined extensions are:
8576 %p include pointer address (standard)
8577 %-p (SVf) include an SV (previously %_)
8578 %-<num>p include an SV with precision <num>
8579 %1p (VDf) include a v-string (as %vd)
8580 %<num>p reserved for future extensions
8582 Robin Barker 2005-07-14
8589 n = expect_number(&q);
8596 argsv = va_arg(*args, SV*);
8597 eptr = SvPVx_const(argsv, elen);
8603 else if (n == vdNUMBER) { /* VDf */
8610 if (ckWARN_d(WARN_INTERNAL))
8611 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8612 "internal %%<num>p might conflict with future printf extensions");
8618 if ( (width = expect_number(&q)) ) {
8633 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8662 if ( (ewix = expect_number(&q)) )
8671 if ((vectorarg = asterisk)) {
8684 width = expect_number(&q);
8690 vecsv = va_arg(*args, SV*);
8692 vecsv = (evix > 0 && evix <= svmax)
8693 ? svargs[evix-1] : &PL_sv_undef;
8695 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8697 dotstr = SvPV_const(vecsv, dotstrlen);
8698 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8699 bad with tied or overloaded values that return UTF8. */
8702 else if (has_utf8) {
8703 vecsv = sv_mortalcopy(vecsv);
8704 sv_utf8_upgrade(vecsv);
8705 dotstr = SvPV_const(vecsv, dotstrlen);
8712 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8713 vecsv = svargs[efix ? efix-1 : svix++];
8714 vecstr = (U8*)SvPV_const(vecsv,veclen);
8715 vec_utf8 = DO_UTF8(vecsv);
8717 /* if this is a version object, we need to convert
8718 * back into v-string notation and then let the
8719 * vectorize happen normally
8721 if (sv_derived_from(vecsv, "version")) {
8722 char *version = savesvpv(vecsv);
8723 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8724 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8725 "vector argument not supported with alpha versions");
8728 vecsv = sv_newmortal();
8729 /* scan_vstring is expected to be called during
8730 * tokenization, so we need to fake up the end
8731 * of the buffer for it
8733 PL_bufend = version + veclen;
8734 scan_vstring(version, vecsv);
8735 vecstr = (U8*)SvPV_const(vecsv, veclen);
8736 vec_utf8 = DO_UTF8(vecsv);
8748 i = va_arg(*args, int);
8750 i = (ewix ? ewix <= svmax : svix < svmax) ?
8751 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8753 width = (i < 0) ? -i : i;
8763 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8765 /* XXX: todo, support specified precision parameter */
8769 i = va_arg(*args, int);
8771 i = (ewix ? ewix <= svmax : svix < svmax)
8772 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8774 has_precis = !(i < 0);
8779 precis = precis * 10 + (*q++ - '0');
8788 case 'I': /* Ix, I32x, and I64x */
8790 if (q[1] == '6' && q[2] == '4') {
8796 if (q[1] == '3' && q[2] == '2') {
8806 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8817 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8818 if (*(q + 1) == 'l') { /* lld, llf */
8844 if (!vectorize && !args) {
8846 const I32 i = efix-1;
8847 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8849 argsv = (svix >= 0 && svix < svmax)
8850 ? svargs[svix++] : &PL_sv_undef;
8861 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8863 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8865 eptr = (char*)utf8buf;
8866 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8880 eptr = va_arg(*args, char*);
8882 #ifdef MACOS_TRADITIONAL
8883 /* On MacOS, %#s format is used for Pascal strings */
8888 elen = strlen(eptr);
8890 eptr = (char *)nullstr;
8891 elen = sizeof nullstr - 1;
8895 eptr = SvPVx_const(argsv, elen);
8896 if (DO_UTF8(argsv)) {
8897 I32 old_precis = precis;
8898 if (has_precis && precis < elen) {
8900 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8903 if (width) { /* fudge width (can't fudge elen) */
8904 if (has_precis && precis < elen)
8905 width += precis - old_precis;
8907 width += elen - sv_len_utf8(argsv);
8914 if (has_precis && elen > precis)
8921 if (alt || vectorize)
8923 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8944 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8953 esignbuf[esignlen++] = plus;
8957 case 'h': iv = (short)va_arg(*args, int); break;
8958 case 'l': iv = va_arg(*args, long); break;
8959 case 'V': iv = va_arg(*args, IV); break;
8960 default: iv = va_arg(*args, int); break;
8962 case 'q': iv = va_arg(*args, Quad_t); break;
8967 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8969 case 'h': iv = (short)tiv; break;
8970 case 'l': iv = (long)tiv; break;
8972 default: iv = tiv; break;
8974 case 'q': iv = (Quad_t)tiv; break;
8978 if ( !vectorize ) /* we already set uv above */
8983 esignbuf[esignlen++] = plus;
8987 esignbuf[esignlen++] = '-';
9031 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9042 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9043 case 'l': uv = va_arg(*args, unsigned long); break;
9044 case 'V': uv = va_arg(*args, UV); break;
9045 default: uv = va_arg(*args, unsigned); break;
9047 case 'q': uv = va_arg(*args, Uquad_t); break;
9052 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9054 case 'h': uv = (unsigned short)tuv; break;
9055 case 'l': uv = (unsigned long)tuv; break;
9057 default: uv = tuv; break;
9059 case 'q': uv = (Uquad_t)tuv; break;
9066 char *ptr = ebuf + sizeof ebuf;
9067 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9073 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9079 esignbuf[esignlen++] = '0';
9080 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9088 if (alt && *ptr != '0')
9097 esignbuf[esignlen++] = '0';
9098 esignbuf[esignlen++] = c;
9101 default: /* it had better be ten or less */
9105 } while (uv /= base);
9108 elen = (ebuf + sizeof ebuf) - ptr;
9112 zeros = precis - elen;
9113 else if (precis == 0 && elen == 1 && *eptr == '0'
9114 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9117 /* a precision nullifies the 0 flag. */
9124 /* FLOATING POINT */
9127 c = 'f'; /* maybe %F isn't supported here */
9135 /* This is evil, but floating point is even more evil */
9137 /* for SV-style calling, we can only get NV
9138 for C-style calling, we assume %f is double;
9139 for simplicity we allow any of %Lf, %llf, %qf for long double
9143 #if defined(USE_LONG_DOUBLE)
9147 /* [perl #20339] - we should accept and ignore %lf rather than die */
9151 #if defined(USE_LONG_DOUBLE)
9152 intsize = args ? 0 : 'q';
9156 #if defined(HAS_LONG_DOUBLE)
9165 /* now we need (long double) if intsize == 'q', else (double) */
9167 #if LONG_DOUBLESIZE > DOUBLESIZE
9169 va_arg(*args, long double) :
9170 va_arg(*args, double)
9172 va_arg(*args, double)
9177 if (c != 'e' && c != 'E') {
9179 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9180 will cast our (long double) to (double) */
9181 (void)Perl_frexp(nv, &i);
9182 if (i == PERL_INT_MIN)
9183 Perl_die(aTHX_ "panic: frexp");
9185 need = BIT_DIGITS(i);
9187 need += has_precis ? precis : 6; /* known default */
9192 #ifdef HAS_LDBL_SPRINTF_BUG
9193 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9194 with sfio - Allen <allens@cpan.org> */
9197 # define MY_DBL_MAX DBL_MAX
9198 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9199 # if DOUBLESIZE >= 8
9200 # define MY_DBL_MAX 1.7976931348623157E+308L
9202 # define MY_DBL_MAX 3.40282347E+38L
9206 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9207 # define MY_DBL_MAX_BUG 1L
9209 # define MY_DBL_MAX_BUG MY_DBL_MAX
9213 # define MY_DBL_MIN DBL_MIN
9214 # else /* XXX guessing! -Allen */
9215 # if DOUBLESIZE >= 8
9216 # define MY_DBL_MIN 2.2250738585072014E-308L
9218 # define MY_DBL_MIN 1.17549435E-38L
9222 if ((intsize == 'q') && (c == 'f') &&
9223 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9225 /* it's going to be short enough that
9226 * long double precision is not needed */
9228 if ((nv <= 0L) && (nv >= -0L))
9229 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9231 /* would use Perl_fp_class as a double-check but not
9232 * functional on IRIX - see perl.h comments */
9234 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9235 /* It's within the range that a double can represent */
9236 #if defined(DBL_MAX) && !defined(DBL_MIN)
9237 if ((nv >= ((long double)1/DBL_MAX)) ||
9238 (nv <= (-(long double)1/DBL_MAX)))
9240 fix_ldbl_sprintf_bug = TRUE;
9243 if (fix_ldbl_sprintf_bug == TRUE) {
9253 # undef MY_DBL_MAX_BUG
9256 #endif /* HAS_LDBL_SPRINTF_BUG */
9258 need += 20; /* fudge factor */
9259 if (PL_efloatsize < need) {
9260 Safefree(PL_efloatbuf);
9261 PL_efloatsize = need + 20; /* more fudge */
9262 Newx(PL_efloatbuf, PL_efloatsize, char);
9263 PL_efloatbuf[0] = '\0';
9266 if ( !(width || left || plus || alt) && fill != '0'
9267 && has_precis && intsize != 'q' ) { /* Shortcuts */
9268 /* See earlier comment about buggy Gconvert when digits,
9270 if ( c == 'g' && precis) {
9271 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9272 /* May return an empty string for digits==0 */
9273 if (*PL_efloatbuf) {
9274 elen = strlen(PL_efloatbuf);
9275 goto float_converted;
9277 } else if ( c == 'f' && !precis) {
9278 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9283 char *ptr = ebuf + sizeof ebuf;
9286 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9287 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9288 if (intsize == 'q') {
9289 /* Copy the one or more characters in a long double
9290 * format before the 'base' ([efgEFG]) character to
9291 * the format string. */
9292 static char const prifldbl[] = PERL_PRIfldbl;
9293 char const *p = prifldbl + sizeof(prifldbl) - 3;
9294 while (p >= prifldbl) { *--ptr = *p--; }
9299 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9304 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9316 /* No taint. Otherwise we are in the strange situation
9317 * where printf() taints but print($float) doesn't.
9319 #if defined(HAS_LONG_DOUBLE)
9320 elen = ((intsize == 'q')
9321 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9322 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9324 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9328 eptr = PL_efloatbuf;
9336 i = SvCUR(sv) - origlen;
9339 case 'h': *(va_arg(*args, short*)) = i; break;
9340 default: *(va_arg(*args, int*)) = i; break;
9341 case 'l': *(va_arg(*args, long*)) = i; break;
9342 case 'V': *(va_arg(*args, IV*)) = i; break;
9344 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9349 sv_setuv_mg(argsv, (UV)i);
9350 continue; /* not "break" */
9357 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9358 && ckWARN(WARN_PRINTF))
9360 SV * const msg = sv_newmortal();
9361 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9362 (PL_op->op_type == OP_PRTF) ? "" : "s");
9365 Perl_sv_catpvf(aTHX_ msg,
9366 "\"%%%c\"", c & 0xFF);
9368 Perl_sv_catpvf(aTHX_ msg,
9369 "\"%%\\%03"UVof"\"",
9372 sv_catpvs(msg, "end of string");
9373 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9376 /* output mangled stuff ... */
9382 /* ... right here, because formatting flags should not apply */
9383 SvGROW(sv, SvCUR(sv) + elen + 1);
9385 Copy(eptr, p, elen, char);
9388 SvCUR_set(sv, p - SvPVX_const(sv));
9390 continue; /* not "break" */
9393 if (is_utf8 != has_utf8) {
9396 sv_utf8_upgrade(sv);
9399 const STRLEN old_elen = elen;
9400 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9401 sv_utf8_upgrade(nsv);
9402 eptr = SvPVX_const(nsv);
9405 if (width) { /* fudge width (can't fudge elen) */
9406 width += elen - old_elen;
9412 have = esignlen + zeros + elen;
9414 Perl_croak_nocontext(PL_memory_wrap);
9416 need = (have > width ? have : width);
9419 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9420 Perl_croak_nocontext(PL_memory_wrap);
9421 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9423 if (esignlen && fill == '0') {
9425 for (i = 0; i < (int)esignlen; i++)
9429 memset(p, fill, gap);
9432 if (esignlen && fill != '0') {
9434 for (i = 0; i < (int)esignlen; i++)
9439 for (i = zeros; i; i--)
9443 Copy(eptr, p, elen, char);
9447 memset(p, ' ', gap);
9452 Copy(dotstr, p, dotstrlen, char);
9456 vectorize = FALSE; /* done iterating over vecstr */
9463 SvCUR_set(sv, p - SvPVX_const(sv));
9471 /* =========================================================================
9473 =head1 Cloning an interpreter
9475 All the macros and functions in this section are for the private use of
9476 the main function, perl_clone().
9478 The foo_dup() functions make an exact copy of an existing foo thinngy.
9479 During the course of a cloning, a hash table is used to map old addresses
9480 to new addresses. The table is created and manipulated with the
9481 ptr_table_* functions.
9485 ============================================================================*/
9488 #if defined(USE_ITHREADS)
9490 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9491 #ifndef GpREFCNT_inc
9492 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9496 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9497 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9498 If this changes, please unmerge ss_dup. */
9499 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9500 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9501 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9502 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9503 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9504 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9505 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9506 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9507 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9508 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9509 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9510 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9511 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9512 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9515 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9516 regcomp.c. AMS 20010712 */
9519 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9521 return CALLREGDUPE(r,param);
9524 /* duplicate a file handle */
9527 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9531 PERL_UNUSED_ARG(type);
9534 return (PerlIO*)NULL;
9536 /* look for it in the table first */
9537 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9541 /* create anew and remember what it is */
9542 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9543 ptr_table_store(PL_ptr_table, fp, ret);
9547 /* duplicate a directory handle */
9550 Perl_dirp_dup(pTHX_ DIR *dp)
9552 PERL_UNUSED_CONTEXT;
9559 /* duplicate a typeglob */
9562 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9568 /* look for it in the table first */
9569 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9573 /* create anew and remember what it is */
9575 ptr_table_store(PL_ptr_table, gp, ret);
9578 ret->gp_refcnt = 0; /* must be before any other dups! */
9579 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9580 ret->gp_io = io_dup_inc(gp->gp_io, param);
9581 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9582 ret->gp_av = av_dup_inc(gp->gp_av, param);
9583 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9584 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9585 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9586 ret->gp_cvgen = gp->gp_cvgen;
9587 ret->gp_line = gp->gp_line;
9588 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9592 /* duplicate a chain of magic */
9595 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9597 MAGIC *mgprev = (MAGIC*)NULL;
9600 return (MAGIC*)NULL;
9601 /* look for it in the table first */
9602 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9606 for (; mg; mg = mg->mg_moremagic) {
9608 Newxz(nmg, 1, MAGIC);
9610 mgprev->mg_moremagic = nmg;
9613 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9614 nmg->mg_private = mg->mg_private;
9615 nmg->mg_type = mg->mg_type;
9616 nmg->mg_flags = mg->mg_flags;
9617 if (mg->mg_type == PERL_MAGIC_qr) {
9618 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9620 else if(mg->mg_type == PERL_MAGIC_backref) {
9621 /* The backref AV has its reference count deliberately bumped by
9623 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9625 else if (mg->mg_type == PERL_MAGIC_symtab) {
9626 nmg->mg_obj = mg->mg_obj;
9629 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9630 ? sv_dup_inc(mg->mg_obj, param)
9631 : sv_dup(mg->mg_obj, param);
9633 nmg->mg_len = mg->mg_len;
9634 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9635 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9636 if (mg->mg_len > 0) {
9637 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9638 if (mg->mg_type == PERL_MAGIC_overload_table &&
9639 AMT_AMAGIC((AMT*)mg->mg_ptr))
9641 const AMT * const amtp = (AMT*)mg->mg_ptr;
9642 AMT * const namtp = (AMT*)nmg->mg_ptr;
9644 for (i = 1; i < NofAMmeth; i++) {
9645 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9649 else if (mg->mg_len == HEf_SVKEY)
9650 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9652 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9653 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9660 /* create a new pointer-mapping table */
9663 Perl_ptr_table_new(pTHX)
9666 PERL_UNUSED_CONTEXT;
9668 Newxz(tbl, 1, PTR_TBL_t);
9671 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9675 #define PTR_TABLE_HASH(ptr) \
9676 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9679 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9680 following define) and at call to new_body_inline made below in
9681 Perl_ptr_table_store()
9684 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9686 /* map an existing pointer using a table */
9688 STATIC PTR_TBL_ENT_t *
9689 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9690 PTR_TBL_ENT_t *tblent;
9691 const UV hash = PTR_TABLE_HASH(sv);
9693 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9694 for (; tblent; tblent = tblent->next) {
9695 if (tblent->oldval == sv)
9702 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9704 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9705 PERL_UNUSED_CONTEXT;
9706 return tblent ? tblent->newval : NULL;
9709 /* add a new entry to a pointer-mapping table */
9712 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9714 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9715 PERL_UNUSED_CONTEXT;
9718 tblent->newval = newsv;
9720 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9722 new_body_inline(tblent, PTE_SVSLOT);
9724 tblent->oldval = oldsv;
9725 tblent->newval = newsv;
9726 tblent->next = tbl->tbl_ary[entry];
9727 tbl->tbl_ary[entry] = tblent;
9729 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9730 ptr_table_split(tbl);
9734 /* double the hash bucket size of an existing ptr table */
9737 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9739 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9740 const UV oldsize = tbl->tbl_max + 1;
9741 UV newsize = oldsize * 2;
9743 PERL_UNUSED_CONTEXT;
9745 Renew(ary, newsize, PTR_TBL_ENT_t*);
9746 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9747 tbl->tbl_max = --newsize;
9749 for (i=0; i < oldsize; i++, ary++) {
9750 PTR_TBL_ENT_t **curentp, **entp, *ent;
9753 curentp = ary + oldsize;
9754 for (entp = ary, ent = *ary; ent; ent = *entp) {
9755 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9757 ent->next = *curentp;
9767 /* remove all the entries from a ptr table */
9770 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9772 if (tbl && tbl->tbl_items) {
9773 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9774 UV riter = tbl->tbl_max;
9777 PTR_TBL_ENT_t *entry = array[riter];
9780 PTR_TBL_ENT_t * const oentry = entry;
9781 entry = entry->next;
9790 /* clear and free a ptr table */
9793 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9798 ptr_table_clear(tbl);
9799 Safefree(tbl->tbl_ary);
9805 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9808 SvRV_set(dstr, SvWEAKREF(sstr)
9809 ? sv_dup(SvRV(sstr), param)
9810 : sv_dup_inc(SvRV(sstr), param));
9813 else if (SvPVX_const(sstr)) {
9814 /* Has something there */
9816 /* Normal PV - clone whole allocated space */
9817 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9818 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9819 /* Not that normal - actually sstr is copy on write.
9820 But we are a true, independant SV, so: */
9821 SvREADONLY_off(dstr);
9826 /* Special case - not normally malloced for some reason */
9827 if (isGV_with_GP(sstr)) {
9828 /* Don't need to do anything here. */
9830 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9831 /* A "shared" PV - clone it as "shared" PV */
9833 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9837 /* Some other special case - random pointer */
9838 SvPV_set(dstr, SvPVX(sstr));
9844 if (SvTYPE(dstr) == SVt_RV)
9845 SvRV_set(dstr, NULL);
9847 SvPV_set(dstr, NULL);
9851 /* duplicate an SV of any type (including AV, HV etc) */
9854 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9859 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9861 /* look for it in the table first */
9862 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9866 if(param->flags & CLONEf_JOIN_IN) {
9867 /** We are joining here so we don't want do clone
9868 something that is bad **/
9869 if (SvTYPE(sstr) == SVt_PVHV) {
9870 const char * const hvname = HvNAME_get(sstr);
9872 /** don't clone stashes if they already exist **/
9873 return (SV*)gv_stashpv(hvname,0);
9877 /* create anew and remember what it is */
9880 #ifdef DEBUG_LEAKING_SCALARS
9881 dstr->sv_debug_optype = sstr->sv_debug_optype;
9882 dstr->sv_debug_line = sstr->sv_debug_line;
9883 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9884 dstr->sv_debug_cloned = 1;
9885 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9888 ptr_table_store(PL_ptr_table, sstr, dstr);
9891 SvFLAGS(dstr) = SvFLAGS(sstr);
9892 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9893 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9896 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9897 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9898 PL_watch_pvx, SvPVX_const(sstr));
9901 /* don't clone objects whose class has asked us not to */
9902 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9903 SvFLAGS(dstr) &= ~SVTYPEMASK;
9908 switch (SvTYPE(sstr)) {
9913 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9914 SvIV_set(dstr, SvIVX(sstr));
9917 SvANY(dstr) = new_XNV();
9918 SvNV_set(dstr, SvNVX(sstr));
9921 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9922 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9926 /* These are all the types that need complex bodies allocating. */
9928 const svtype sv_type = SvTYPE(sstr);
9929 const struct body_details *const sv_type_details
9930 = bodies_by_type + sv_type;
9934 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9938 if (GvUNIQUE((GV*)sstr)) {
9939 NOOP; /* Do sharing here, and fall through */
9952 assert(sv_type_details->body_size);
9953 if (sv_type_details->arena) {
9954 new_body_inline(new_body, sv_type);
9956 = (void*)((char*)new_body - sv_type_details->offset);
9958 new_body = new_NOARENA(sv_type_details);
9962 SvANY(dstr) = new_body;
9965 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9966 ((char*)SvANY(dstr)) + sv_type_details->offset,
9967 sv_type_details->copy, char);
9969 Copy(((char*)SvANY(sstr)),
9970 ((char*)SvANY(dstr)),
9971 sv_type_details->body_size + sv_type_details->offset, char);
9974 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9975 && !isGV_with_GP(dstr))
9976 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9978 /* The Copy above means that all the source (unduplicated) pointers
9979 are now in the destination. We can check the flags and the
9980 pointers in either, but it's possible that there's less cache
9981 missing by always going for the destination.
9982 FIXME - instrument and check that assumption */
9983 if (sv_type >= SVt_PVMG) {
9984 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9985 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9986 } else if (SvMAGIC(dstr))
9987 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9989 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9992 /* The cast silences a GCC warning about unhandled types. */
9993 switch ((int)sv_type) {
10005 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10006 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10007 LvTARG(dstr) = dstr;
10008 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10009 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10011 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10014 if (GvNAME_HEK(dstr))
10015 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10017 /* Don't call sv_add_backref here as it's going to be created
10018 as part of the magic cloning of the symbol table. */
10019 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10020 if(isGV_with_GP(sstr)) {
10021 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10022 at the point of this comment. */
10023 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10024 (void)GpREFCNT_inc(GvGP(dstr));
10026 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10029 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10030 if (IoOFP(dstr) == IoIFP(sstr))
10031 IoOFP(dstr) = IoIFP(dstr);
10033 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10034 /* PL_rsfp_filters entries have fake IoDIRP() */
10035 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10036 /* I have no idea why fake dirp (rsfps)
10037 should be treated differently but otherwise
10038 we end up with leaks -- sky*/
10039 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10040 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10041 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10043 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10044 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10045 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10046 if (IoDIRP(dstr)) {
10047 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10050 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10053 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10054 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10055 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10058 if (AvARRAY((AV*)sstr)) {
10059 SV **dst_ary, **src_ary;
10060 SSize_t items = AvFILLp((AV*)sstr) + 1;
10062 src_ary = AvARRAY((AV*)sstr);
10063 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10064 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10065 SvPV_set(dstr, (char*)dst_ary);
10066 AvALLOC((AV*)dstr) = dst_ary;
10067 if (AvREAL((AV*)sstr)) {
10068 while (items-- > 0)
10069 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10072 while (items-- > 0)
10073 *dst_ary++ = sv_dup(*src_ary++, param);
10075 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10076 while (items-- > 0) {
10077 *dst_ary++ = &PL_sv_undef;
10081 SvPV_set(dstr, NULL);
10082 AvALLOC((AV*)dstr) = (SV**)NULL;
10086 if (HvARRAY((HV*)sstr)) {
10088 const bool sharekeys = !!HvSHAREKEYS(sstr);
10089 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10090 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10092 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10093 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10095 HvARRAY(dstr) = (HE**)darray;
10096 while (i <= sxhv->xhv_max) {
10097 const HE * const source = HvARRAY(sstr)[i];
10098 HvARRAY(dstr)[i] = source
10099 ? he_dup(source, sharekeys, param) : 0;
10104 const struct xpvhv_aux * const saux = HvAUX(sstr);
10105 struct xpvhv_aux * const daux = HvAUX(dstr);
10106 /* This flag isn't copied. */
10107 /* SvOOK_on(hv) attacks the IV flags. */
10108 SvFLAGS(dstr) |= SVf_OOK;
10110 hvname = saux->xhv_name;
10111 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10113 daux->xhv_riter = saux->xhv_riter;
10114 daux->xhv_eiter = saux->xhv_eiter
10115 ? he_dup(saux->xhv_eiter,
10116 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10117 daux->xhv_backreferences =
10118 saux->xhv_backreferences
10119 ? (AV*) SvREFCNT_inc(
10120 sv_dup((SV*)saux->xhv_backreferences, param))
10122 /* Record stashes for possible cloning in Perl_clone(). */
10124 av_push(param->stashes, dstr);
10128 SvPV_set(dstr, NULL);
10131 if (!(param->flags & CLONEf_COPY_STACKS)) {
10135 /* NOTE: not refcounted */
10136 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10138 if (!CvISXSUB(dstr))
10139 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10141 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10142 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10143 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10144 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10146 /* don't dup if copying back - CvGV isn't refcounted, so the
10147 * duped GV may never be freed. A bit of a hack! DAPM */
10148 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10149 NULL : gv_dup(CvGV(dstr), param) ;
10150 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10152 CvWEAKOUTSIDE(sstr)
10153 ? cv_dup( CvOUTSIDE(dstr), param)
10154 : cv_dup_inc(CvOUTSIDE(dstr), param);
10155 if (!CvISXSUB(dstr))
10156 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10162 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10168 /* duplicate a context */
10171 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10173 PERL_CONTEXT *ncxs;
10176 return (PERL_CONTEXT*)NULL;
10178 /* look for it in the table first */
10179 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10183 /* create anew and remember what it is */
10184 Newxz(ncxs, max + 1, PERL_CONTEXT);
10185 ptr_table_store(PL_ptr_table, cxs, ncxs);
10188 PERL_CONTEXT * const cx = &cxs[ix];
10189 PERL_CONTEXT * const ncx = &ncxs[ix];
10190 ncx->cx_type = cx->cx_type;
10191 if (CxTYPE(cx) == CXt_SUBST) {
10192 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10195 ncx->blk_oldsp = cx->blk_oldsp;
10196 ncx->blk_oldcop = cx->blk_oldcop;
10197 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10198 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10199 ncx->blk_oldpm = cx->blk_oldpm;
10200 ncx->blk_gimme = cx->blk_gimme;
10201 switch (CxTYPE(cx)) {
10203 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10204 ? cv_dup_inc(cx->blk_sub.cv, param)
10205 : cv_dup(cx->blk_sub.cv,param));
10206 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10207 ? av_dup_inc(cx->blk_sub.argarray, param)
10209 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10210 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10211 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10212 ncx->blk_sub.lval = cx->blk_sub.lval;
10213 ncx->blk_sub.retop = cx->blk_sub.retop;
10214 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10215 cx->blk_sub.oldcomppad);
10218 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10219 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10220 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10221 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10222 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10223 ncx->blk_eval.retop = cx->blk_eval.retop;
10226 ncx->blk_loop.label = cx->blk_loop.label;
10227 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10228 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10229 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10230 ? cx->blk_loop.iterdata
10231 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10232 ncx->blk_loop.oldcomppad
10233 = (PAD*)ptr_table_fetch(PL_ptr_table,
10234 cx->blk_loop.oldcomppad);
10235 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10236 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10237 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10238 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10239 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10242 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10243 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10244 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10245 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10246 ncx->blk_sub.retop = cx->blk_sub.retop;
10258 /* duplicate a stack info structure */
10261 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10266 return (PERL_SI*)NULL;
10268 /* look for it in the table first */
10269 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10273 /* create anew and remember what it is */
10274 Newxz(nsi, 1, PERL_SI);
10275 ptr_table_store(PL_ptr_table, si, nsi);
10277 nsi->si_stack = av_dup_inc(si->si_stack, param);
10278 nsi->si_cxix = si->si_cxix;
10279 nsi->si_cxmax = si->si_cxmax;
10280 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10281 nsi->si_type = si->si_type;
10282 nsi->si_prev = si_dup(si->si_prev, param);
10283 nsi->si_next = si_dup(si->si_next, param);
10284 nsi->si_markoff = si->si_markoff;
10289 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10290 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10291 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10292 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10293 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10294 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10295 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10296 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10297 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10298 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10299 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10300 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10301 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10302 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10305 #define pv_dup_inc(p) SAVEPV(p)
10306 #define pv_dup(p) SAVEPV(p)
10307 #define svp_dup_inc(p,pp) any_dup(p,pp)
10309 /* map any object to the new equivent - either something in the
10310 * ptr table, or something in the interpreter structure
10314 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10319 return (void*)NULL;
10321 /* look for it in the table first */
10322 ret = ptr_table_fetch(PL_ptr_table, v);
10326 /* see if it is part of the interpreter structure */
10327 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10328 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10336 /* duplicate the save stack */
10339 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10341 ANY * const ss = proto_perl->Tsavestack;
10342 const I32 max = proto_perl->Tsavestack_max;
10343 I32 ix = proto_perl->Tsavestack_ix;
10356 void (*dptr) (void*);
10357 void (*dxptr) (pTHX_ void*);
10359 Newxz(nss, max, ANY);
10362 const I32 type = POPINT(ss,ix);
10363 TOPINT(nss,ix) = type;
10365 case SAVEt_HELEM: /* hash element */
10366 sv = (SV*)POPPTR(ss,ix);
10367 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10369 case SAVEt_ITEM: /* normal string */
10370 case SAVEt_SV: /* scalar reference */
10371 sv = (SV*)POPPTR(ss,ix);
10372 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10375 case SAVEt_MORTALIZESV:
10376 sv = (SV*)POPPTR(ss,ix);
10377 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10379 case SAVEt_SHARED_PVREF: /* char* in shared space */
10380 c = (char*)POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = savesharedpv(c);
10382 ptr = POPPTR(ss,ix);
10383 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10385 case SAVEt_GENERIC_SVREF: /* generic sv */
10386 case SAVEt_SVREF: /* scalar reference */
10387 sv = (SV*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10389 ptr = POPPTR(ss,ix);
10390 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10392 case SAVEt_HV: /* hash reference */
10393 case SAVEt_AV: /* array reference */
10394 sv = (SV*) POPPTR(ss,ix);
10395 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10397 case SAVEt_COMPPAD:
10399 sv = (SV*) POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = sv_dup(sv, param);
10402 case SAVEt_INT: /* int reference */
10403 ptr = POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10405 intval = (int)POPINT(ss,ix);
10406 TOPINT(nss,ix) = intval;
10408 case SAVEt_LONG: /* long reference */
10409 ptr = POPPTR(ss,ix);
10410 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10412 case SAVEt_CLEARSV:
10413 longval = (long)POPLONG(ss,ix);
10414 TOPLONG(nss,ix) = longval;
10416 case SAVEt_I32: /* I32 reference */
10417 case SAVEt_I16: /* I16 reference */
10418 case SAVEt_I8: /* I8 reference */
10419 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10420 ptr = POPPTR(ss,ix);
10421 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10423 TOPINT(nss,ix) = i;
10425 case SAVEt_IV: /* IV reference */
10426 ptr = POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10429 TOPIV(nss,ix) = iv;
10431 case SAVEt_HPTR: /* HV* reference */
10432 case SAVEt_APTR: /* AV* reference */
10433 case SAVEt_SPTR: /* SV* reference */
10434 ptr = POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10436 sv = (SV*)POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = sv_dup(sv, param);
10439 case SAVEt_VPTR: /* random* reference */
10440 ptr = POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10442 ptr = POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10445 case SAVEt_GENERIC_PVREF: /* generic char* */
10446 case SAVEt_PPTR: /* char* reference */
10447 ptr = POPPTR(ss,ix);
10448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10449 c = (char*)POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = pv_dup(c);
10452 case SAVEt_GP: /* scalar reference */
10453 gp = (GP*)POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10455 (void)GpREFCNT_inc(gp);
10456 gv = (GV*)POPPTR(ss,ix);
10457 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10460 ptr = POPPTR(ss,ix);
10461 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10462 /* these are assumed to be refcounted properly */
10464 switch (((OP*)ptr)->op_type) {
10466 case OP_LEAVESUBLV:
10470 case OP_LEAVEWRITE:
10471 TOPPTR(nss,ix) = ptr;
10476 TOPPTR(nss,ix) = NULL;
10481 TOPPTR(nss,ix) = NULL;
10484 c = (char*)POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = pv_dup_inc(c);
10488 hv = (HV*)POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10490 c = (char*)POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = pv_dup_inc(c);
10493 case SAVEt_STACK_POS: /* Position on Perl stack */
10495 TOPINT(nss,ix) = i;
10497 case SAVEt_DESTRUCTOR:
10498 ptr = POPPTR(ss,ix);
10499 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10500 dptr = POPDPTR(ss,ix);
10501 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10502 any_dup(FPTR2DPTR(void *, dptr),
10505 case SAVEt_DESTRUCTOR_X:
10506 ptr = POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10508 dxptr = POPDXPTR(ss,ix);
10509 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10510 any_dup(FPTR2DPTR(void *, dxptr),
10513 case SAVEt_REGCONTEXT:
10516 TOPINT(nss,ix) = i;
10519 case SAVEt_AELEM: /* array element */
10520 sv = (SV*)POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10523 TOPINT(nss,ix) = i;
10524 av = (AV*)POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = av_dup_inc(av, param);
10528 ptr = POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = ptr;
10533 TOPINT(nss,ix) = i;
10534 ptr = POPPTR(ss,ix);
10537 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10538 HINTS_REFCNT_UNLOCK;
10540 TOPPTR(nss,ix) = ptr;
10541 if (i & HINT_LOCALIZE_HH) {
10542 hv = (HV*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10547 longval = (long)POPLONG(ss,ix);
10548 TOPLONG(nss,ix) = longval;
10549 ptr = POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10551 sv = (SV*)POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = sv_dup(sv, param);
10555 ptr = POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10557 longval = (long)POPBOOL(ss,ix);
10558 TOPBOOL(nss,ix) = (bool)longval;
10560 case SAVEt_SET_SVFLAGS:
10562 TOPINT(nss,ix) = i;
10564 TOPINT(nss,ix) = i;
10565 sv = (SV*)POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = sv_dup(sv, param);
10568 case SAVEt_RE_STATE:
10570 const struct re_save_state *const old_state
10571 = (struct re_save_state *)
10572 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10573 struct re_save_state *const new_state
10574 = (struct re_save_state *)
10575 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10577 Copy(old_state, new_state, 1, struct re_save_state);
10578 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10580 new_state->re_state_bostr
10581 = pv_dup(old_state->re_state_bostr);
10582 new_state->re_state_reginput
10583 = pv_dup(old_state->re_state_reginput);
10584 new_state->re_state_regeol
10585 = pv_dup(old_state->re_state_regeol);
10586 new_state->re_state_regstartp
10587 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10588 new_state->re_state_regendp
10589 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10590 new_state->re_state_reglastparen
10591 = (U32*) any_dup(old_state->re_state_reglastparen,
10593 new_state->re_state_reglastcloseparen
10594 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10596 /* XXX This just has to be broken. The old save_re_context
10597 code did SAVEGENERICPV(PL_reg_start_tmp);
10598 PL_reg_start_tmp is char **.
10599 Look above to what the dup code does for
10600 SAVEt_GENERIC_PVREF
10601 It can never have worked.
10602 So this is merely a faithful copy of the exiting bug: */
10603 new_state->re_state_reg_start_tmp
10604 = (char **) pv_dup((char *)
10605 old_state->re_state_reg_start_tmp);
10606 /* I assume that it only ever "worked" because no-one called
10607 (pseudo)fork while the regexp engine had re-entered itself.
10609 #ifdef PERL_OLD_COPY_ON_WRITE
10610 new_state->re_state_nrs
10611 = sv_dup(old_state->re_state_nrs, param);
10613 new_state->re_state_reg_magic
10614 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10616 new_state->re_state_reg_oldcurpm
10617 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10619 new_state->re_state_reg_curpm
10620 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10622 new_state->re_state_reg_oldsaved
10623 = pv_dup(old_state->re_state_reg_oldsaved);
10624 new_state->re_state_reg_poscache
10625 = pv_dup(old_state->re_state_reg_poscache);
10626 new_state->re_state_reg_starttry
10627 = pv_dup(old_state->re_state_reg_starttry);
10630 case SAVEt_COMPILE_WARNINGS:
10631 ptr = POPPTR(ss,ix);
10632 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10636 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10644 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10645 * flag to the result. This is done for each stash before cloning starts,
10646 * so we know which stashes want their objects cloned */
10649 do_mark_cloneable_stash(pTHX_ SV *sv)
10651 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10653 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10654 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10655 if (cloner && GvCV(cloner)) {
10662 XPUSHs(sv_2mortal(newSVhek(hvname)));
10664 call_sv((SV*)GvCV(cloner), G_SCALAR);
10671 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10679 =for apidoc perl_clone
10681 Create and return a new interpreter by cloning the current one.
10683 perl_clone takes these flags as parameters:
10685 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10686 without it we only clone the data and zero the stacks,
10687 with it we copy the stacks and the new perl interpreter is
10688 ready to run at the exact same point as the previous one.
10689 The pseudo-fork code uses COPY_STACKS while the
10690 threads->new doesn't.
10692 CLONEf_KEEP_PTR_TABLE
10693 perl_clone keeps a ptr_table with the pointer of the old
10694 variable as a key and the new variable as a value,
10695 this allows it to check if something has been cloned and not
10696 clone it again but rather just use the value and increase the
10697 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10698 the ptr_table using the function
10699 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10700 reason to keep it around is if you want to dup some of your own
10701 variable who are outside the graph perl scans, example of this
10702 code is in threads.xs create
10705 This is a win32 thing, it is ignored on unix, it tells perls
10706 win32host code (which is c++) to clone itself, this is needed on
10707 win32 if you want to run two threads at the same time,
10708 if you just want to do some stuff in a separate perl interpreter
10709 and then throw it away and return to the original one,
10710 you don't need to do anything.
10715 /* XXX the above needs expanding by someone who actually understands it ! */
10716 EXTERN_C PerlInterpreter *
10717 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10720 perl_clone(PerlInterpreter *proto_perl, UV flags)
10723 #ifdef PERL_IMPLICIT_SYS
10725 /* perlhost.h so we need to call into it
10726 to clone the host, CPerlHost should have a c interface, sky */
10728 if (flags & CLONEf_CLONE_HOST) {
10729 return perl_clone_host(proto_perl,flags);
10731 return perl_clone_using(proto_perl, flags,
10733 proto_perl->IMemShared,
10734 proto_perl->IMemParse,
10736 proto_perl->IStdIO,
10740 proto_perl->IProc);
10744 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10745 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10746 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10747 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10748 struct IPerlDir* ipD, struct IPerlSock* ipS,
10749 struct IPerlProc* ipP)
10751 /* XXX many of the string copies here can be optimized if they're
10752 * constants; they need to be allocated as common memory and just
10753 * their pointers copied. */
10756 CLONE_PARAMS clone_params;
10757 CLONE_PARAMS* const param = &clone_params;
10759 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10760 /* for each stash, determine whether its objects should be cloned */
10761 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10762 PERL_SET_THX(my_perl);
10765 PoisonNew(my_perl, 1, PerlInterpreter);
10771 PL_savestack_ix = 0;
10772 PL_savestack_max = -1;
10773 PL_sig_pending = 0;
10774 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10775 # else /* !DEBUGGING */
10776 Zero(my_perl, 1, PerlInterpreter);
10777 # endif /* DEBUGGING */
10779 /* host pointers */
10781 PL_MemShared = ipMS;
10782 PL_MemParse = ipMP;
10789 #else /* !PERL_IMPLICIT_SYS */
10791 CLONE_PARAMS clone_params;
10792 CLONE_PARAMS* param = &clone_params;
10793 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10794 /* for each stash, determine whether its objects should be cloned */
10795 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10796 PERL_SET_THX(my_perl);
10799 PoisonNew(my_perl, 1, PerlInterpreter);
10805 PL_savestack_ix = 0;
10806 PL_savestack_max = -1;
10807 PL_sig_pending = 0;
10808 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10809 # else /* !DEBUGGING */
10810 Zero(my_perl, 1, PerlInterpreter);
10811 # endif /* DEBUGGING */
10812 #endif /* PERL_IMPLICIT_SYS */
10813 param->flags = flags;
10814 param->proto_perl = proto_perl;
10816 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10818 PL_body_arenas = NULL;
10819 Zero(&PL_body_roots, 1, PL_body_roots);
10821 PL_nice_chunk = NULL;
10822 PL_nice_chunk_size = 0;
10824 PL_sv_objcount = 0;
10826 PL_sv_arenaroot = NULL;
10828 PL_debug = proto_perl->Idebug;
10830 PL_hash_seed = proto_perl->Ihash_seed;
10831 PL_rehash_seed = proto_perl->Irehash_seed;
10833 #ifdef USE_REENTRANT_API
10834 /* XXX: things like -Dm will segfault here in perlio, but doing
10835 * PERL_SET_CONTEXT(proto_perl);
10836 * breaks too many other things
10838 Perl_reentrant_init(aTHX);
10841 /* create SV map for pointer relocation */
10842 PL_ptr_table = ptr_table_new();
10844 /* initialize these special pointers as early as possible */
10845 SvANY(&PL_sv_undef) = NULL;
10846 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10847 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10848 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10850 SvANY(&PL_sv_no) = new_XPVNV();
10851 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10852 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10853 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10854 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10855 SvCUR_set(&PL_sv_no, 0);
10856 SvLEN_set(&PL_sv_no, 1);
10857 SvIV_set(&PL_sv_no, 0);
10858 SvNV_set(&PL_sv_no, 0);
10859 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10861 SvANY(&PL_sv_yes) = new_XPVNV();
10862 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10863 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10864 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10865 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10866 SvCUR_set(&PL_sv_yes, 1);
10867 SvLEN_set(&PL_sv_yes, 2);
10868 SvIV_set(&PL_sv_yes, 1);
10869 SvNV_set(&PL_sv_yes, 1);
10870 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10872 /* create (a non-shared!) shared string table */
10873 PL_strtab = newHV();
10874 HvSHAREKEYS_off(PL_strtab);
10875 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10876 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10878 PL_compiling = proto_perl->Icompiling;
10880 /* These two PVs will be free'd special way so must set them same way op.c does */
10881 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10882 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10884 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10885 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10887 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10888 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10889 if (PL_compiling.cop_hints_hash) {
10891 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10892 HINTS_REFCNT_UNLOCK;
10894 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10896 /* pseudo environmental stuff */
10897 PL_origargc = proto_perl->Iorigargc;
10898 PL_origargv = proto_perl->Iorigargv;
10900 param->stashes = newAV(); /* Setup array of objects to call clone on */
10902 /* Set tainting stuff before PerlIO_debug can possibly get called */
10903 PL_tainting = proto_perl->Itainting;
10904 PL_taint_warn = proto_perl->Itaint_warn;
10906 #ifdef PERLIO_LAYERS
10907 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10908 PerlIO_clone(aTHX_ proto_perl, param);
10911 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10912 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10913 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10914 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10915 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10916 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10919 PL_minus_c = proto_perl->Iminus_c;
10920 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10921 PL_localpatches = proto_perl->Ilocalpatches;
10922 PL_splitstr = proto_perl->Isplitstr;
10923 PL_preprocess = proto_perl->Ipreprocess;
10924 PL_minus_n = proto_perl->Iminus_n;
10925 PL_minus_p = proto_perl->Iminus_p;
10926 PL_minus_l = proto_perl->Iminus_l;
10927 PL_minus_a = proto_perl->Iminus_a;
10928 PL_minus_E = proto_perl->Iminus_E;
10929 PL_minus_F = proto_perl->Iminus_F;
10930 PL_doswitches = proto_perl->Idoswitches;
10931 PL_dowarn = proto_perl->Idowarn;
10932 PL_doextract = proto_perl->Idoextract;
10933 PL_sawampersand = proto_perl->Isawampersand;
10934 PL_unsafe = proto_perl->Iunsafe;
10935 PL_inplace = SAVEPV(proto_perl->Iinplace);
10936 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10937 PL_perldb = proto_perl->Iperldb;
10938 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10939 PL_exit_flags = proto_perl->Iexit_flags;
10941 /* magical thingies */
10942 /* XXX time(&PL_basetime) when asked for? */
10943 PL_basetime = proto_perl->Ibasetime;
10944 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10946 PL_maxsysfd = proto_perl->Imaxsysfd;
10947 PL_statusvalue = proto_perl->Istatusvalue;
10949 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10951 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10953 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10955 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10956 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10957 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10960 /* RE engine related */
10961 Zero(&PL_reg_state, 1, struct re_save_state);
10962 PL_reginterp_cnt = 0;
10963 PL_regmatch_slab = NULL;
10965 /* Clone the regex array */
10966 PL_regex_padav = newAV();
10968 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10969 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10971 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10972 for(i = 1; i <= len; i++) {
10973 const SV * const regex = regexen[i];
10976 ? sv_dup_inc(regex, param)
10978 newSViv(PTR2IV(re_dup(
10979 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10981 av_push(PL_regex_padav, sv);
10984 PL_regex_pad = AvARRAY(PL_regex_padav);
10986 /* shortcuts to various I/O objects */
10987 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10988 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10989 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10990 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10991 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10992 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10994 /* shortcuts to regexp stuff */
10995 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10997 /* shortcuts to misc objects */
10998 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11000 /* shortcuts to debugging objects */
11001 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11002 PL_DBline = gv_dup(proto_perl->IDBline, param);
11003 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11004 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11005 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11006 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11007 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11008 PL_lineary = av_dup(proto_perl->Ilineary, param);
11009 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11011 /* symbol tables */
11012 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11013 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11014 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11015 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11016 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11018 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11019 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11020 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11021 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11022 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11023 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11024 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11025 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11027 PL_sub_generation = proto_perl->Isub_generation;
11029 /* funky return mechanisms */
11030 PL_forkprocess = proto_perl->Iforkprocess;
11032 /* subprocess state */
11033 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11035 /* internal state */
11036 PL_maxo = proto_perl->Imaxo;
11037 if (proto_perl->Iop_mask)
11038 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11041 /* PL_asserting = proto_perl->Iasserting; */
11043 /* current interpreter roots */
11044 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11045 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11046 PL_main_start = proto_perl->Imain_start;
11047 PL_eval_root = proto_perl->Ieval_root;
11048 PL_eval_start = proto_perl->Ieval_start;
11050 /* runtime control stuff */
11051 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11052 PL_copline = proto_perl->Icopline;
11054 PL_filemode = proto_perl->Ifilemode;
11055 PL_lastfd = proto_perl->Ilastfd;
11056 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11059 PL_gensym = proto_perl->Igensym;
11060 PL_preambled = proto_perl->Ipreambled;
11061 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11062 PL_laststatval = proto_perl->Ilaststatval;
11063 PL_laststype = proto_perl->Ilaststype;
11066 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11068 /* interpreter atexit processing */
11069 PL_exitlistlen = proto_perl->Iexitlistlen;
11070 if (PL_exitlistlen) {
11071 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11072 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11075 PL_exitlist = (PerlExitListEntry*)NULL;
11077 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11078 if (PL_my_cxt_size) {
11079 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11080 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11083 PL_my_cxt_list = (void**)NULL;
11084 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11085 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11086 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11088 PL_profiledata = NULL;
11089 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11090 /* PL_rsfp_filters entries have fake IoDIRP() */
11091 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11093 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11095 PAD_CLONE_VARS(proto_perl, param);
11097 #ifdef HAVE_INTERP_INTERN
11098 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11101 /* more statics moved here */
11102 PL_generation = proto_perl->Igeneration;
11103 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11105 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11106 PL_in_clean_all = proto_perl->Iin_clean_all;
11108 PL_uid = proto_perl->Iuid;
11109 PL_euid = proto_perl->Ieuid;
11110 PL_gid = proto_perl->Igid;
11111 PL_egid = proto_perl->Iegid;
11112 PL_nomemok = proto_perl->Inomemok;
11113 PL_an = proto_perl->Ian;
11114 PL_evalseq = proto_perl->Ievalseq;
11115 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11116 PL_origalen = proto_perl->Iorigalen;
11117 #ifdef PERL_USES_PL_PIDSTATUS
11118 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11120 PL_osname = SAVEPV(proto_perl->Iosname);
11121 PL_sighandlerp = proto_perl->Isighandlerp;
11123 PL_runops = proto_perl->Irunops;
11125 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11128 PL_cshlen = proto_perl->Icshlen;
11129 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11132 PL_lex_state = proto_perl->Ilex_state;
11133 PL_lex_defer = proto_perl->Ilex_defer;
11134 PL_lex_expect = proto_perl->Ilex_expect;
11135 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11136 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11137 PL_lex_starts = proto_perl->Ilex_starts;
11138 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11139 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11140 PL_lex_op = proto_perl->Ilex_op;
11141 PL_lex_inpat = proto_perl->Ilex_inpat;
11142 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11143 PL_lex_brackets = proto_perl->Ilex_brackets;
11144 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11145 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11146 PL_lex_casemods = proto_perl->Ilex_casemods;
11147 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11148 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11151 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11152 PL_lasttoke = proto_perl->Ilasttoke;
11153 PL_realtokenstart = proto_perl->Irealtokenstart;
11154 PL_faketokens = proto_perl->Ifaketokens;
11155 PL_thismad = proto_perl->Ithismad;
11156 PL_thistoken = proto_perl->Ithistoken;
11157 PL_thisopen = proto_perl->Ithisopen;
11158 PL_thisstuff = proto_perl->Ithisstuff;
11159 PL_thisclose = proto_perl->Ithisclose;
11160 PL_thiswhite = proto_perl->Ithiswhite;
11161 PL_nextwhite = proto_perl->Inextwhite;
11162 PL_skipwhite = proto_perl->Iskipwhite;
11163 PL_endwhite = proto_perl->Iendwhite;
11164 PL_curforce = proto_perl->Icurforce;
11166 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11167 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11168 PL_nexttoke = proto_perl->Inexttoke;
11171 /* XXX This is probably masking the deeper issue of why
11172 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11173 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11174 * (A little debugging with a watchpoint on it may help.)
11176 if (SvANY(proto_perl->Ilinestr)) {
11177 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11178 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11179 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11180 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11181 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11182 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11183 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11184 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11185 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11188 PL_linestr = newSV(79);
11189 sv_upgrade(PL_linestr,SVt_PVIV);
11190 sv_setpvn(PL_linestr,"",0);
11191 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11193 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11194 PL_pending_ident = proto_perl->Ipending_ident;
11195 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11197 PL_expect = proto_perl->Iexpect;
11199 PL_multi_start = proto_perl->Imulti_start;
11200 PL_multi_end = proto_perl->Imulti_end;
11201 PL_multi_open = proto_perl->Imulti_open;
11202 PL_multi_close = proto_perl->Imulti_close;
11204 PL_error_count = proto_perl->Ierror_count;
11205 PL_subline = proto_perl->Isubline;
11206 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11208 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11209 if (SvANY(proto_perl->Ilinestr)) {
11210 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11211 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11213 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11214 PL_last_lop_op = proto_perl->Ilast_lop_op;
11217 PL_last_uni = SvPVX(PL_linestr);
11218 PL_last_lop = SvPVX(PL_linestr);
11219 PL_last_lop_op = 0;
11221 PL_in_my = proto_perl->Iin_my;
11222 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11224 PL_cryptseen = proto_perl->Icryptseen;
11227 PL_hints = proto_perl->Ihints;
11229 PL_amagic_generation = proto_perl->Iamagic_generation;
11231 #ifdef USE_LOCALE_COLLATE
11232 PL_collation_ix = proto_perl->Icollation_ix;
11233 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11234 PL_collation_standard = proto_perl->Icollation_standard;
11235 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11236 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11237 #endif /* USE_LOCALE_COLLATE */
11239 #ifdef USE_LOCALE_NUMERIC
11240 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11241 PL_numeric_standard = proto_perl->Inumeric_standard;
11242 PL_numeric_local = proto_perl->Inumeric_local;
11243 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11244 #endif /* !USE_LOCALE_NUMERIC */
11246 /* utf8 character classes */
11247 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11248 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11249 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11250 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11251 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11252 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11253 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11254 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11255 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11256 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11257 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11258 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11259 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11260 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11261 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11262 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11263 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11264 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11265 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11266 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11268 /* Did the locale setup indicate UTF-8? */
11269 PL_utf8locale = proto_perl->Iutf8locale;
11270 /* Unicode features (see perlrun/-C) */
11271 PL_unicode = proto_perl->Iunicode;
11273 /* Pre-5.8 signals control */
11274 PL_signals = proto_perl->Isignals;
11276 /* times() ticks per second */
11277 PL_clocktick = proto_perl->Iclocktick;
11279 /* Recursion stopper for PerlIO_find_layer */
11280 PL_in_load_module = proto_perl->Iin_load_module;
11282 /* sort() routine */
11283 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11285 /* Not really needed/useful since the reenrant_retint is "volatile",
11286 * but do it for consistency's sake. */
11287 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11289 /* Hooks to shared SVs and locks. */
11290 PL_sharehook = proto_perl->Isharehook;
11291 PL_lockhook = proto_perl->Ilockhook;
11292 PL_unlockhook = proto_perl->Iunlockhook;
11293 PL_threadhook = proto_perl->Ithreadhook;
11295 PL_runops_std = proto_perl->Irunops_std;
11296 PL_runops_dbg = proto_perl->Irunops_dbg;
11298 #ifdef THREADS_HAVE_PIDS
11299 PL_ppid = proto_perl->Ippid;
11303 PL_last_swash_hv = NULL; /* reinits on demand */
11304 PL_last_swash_klen = 0;
11305 PL_last_swash_key[0]= '\0';
11306 PL_last_swash_tmps = (U8*)NULL;
11307 PL_last_swash_slen = 0;
11309 PL_glob_index = proto_perl->Iglob_index;
11310 PL_srand_called = proto_perl->Isrand_called;
11311 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11312 PL_bitcount = NULL; /* reinits on demand */
11314 if (proto_perl->Ipsig_pend) {
11315 Newxz(PL_psig_pend, SIG_SIZE, int);
11318 PL_psig_pend = (int*)NULL;
11321 if (proto_perl->Ipsig_ptr) {
11322 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11323 Newxz(PL_psig_name, SIG_SIZE, SV*);
11324 for (i = 1; i < SIG_SIZE; i++) {
11325 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11326 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11330 PL_psig_ptr = (SV**)NULL;
11331 PL_psig_name = (SV**)NULL;
11334 /* thrdvar.h stuff */
11336 if (flags & CLONEf_COPY_STACKS) {
11337 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11338 PL_tmps_ix = proto_perl->Ttmps_ix;
11339 PL_tmps_max = proto_perl->Ttmps_max;
11340 PL_tmps_floor = proto_perl->Ttmps_floor;
11341 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11343 while (i <= PL_tmps_ix) {
11344 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11348 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11349 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11350 Newxz(PL_markstack, i, I32);
11351 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11352 - proto_perl->Tmarkstack);
11353 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11354 - proto_perl->Tmarkstack);
11355 Copy(proto_perl->Tmarkstack, PL_markstack,
11356 PL_markstack_ptr - PL_markstack + 1, I32);
11358 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11359 * NOTE: unlike the others! */
11360 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11361 PL_scopestack_max = proto_perl->Tscopestack_max;
11362 Newxz(PL_scopestack, PL_scopestack_max, I32);
11363 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11365 /* NOTE: si_dup() looks at PL_markstack */
11366 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11368 /* PL_curstack = PL_curstackinfo->si_stack; */
11369 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11370 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11372 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11373 PL_stack_base = AvARRAY(PL_curstack);
11374 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11375 - proto_perl->Tstack_base);
11376 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11378 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11379 * NOTE: unlike the others! */
11380 PL_savestack_ix = proto_perl->Tsavestack_ix;
11381 PL_savestack_max = proto_perl->Tsavestack_max;
11382 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11383 PL_savestack = ss_dup(proto_perl, param);
11387 ENTER; /* perl_destruct() wants to LEAVE; */
11389 /* although we're not duplicating the tmps stack, we should still
11390 * add entries for any SVs on the tmps stack that got cloned by a
11391 * non-refcount means (eg a temp in @_); otherwise they will be
11394 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11395 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11396 proto_perl->Ttmps_stack[i]);
11397 if (nsv && !SvREFCNT(nsv)) {
11399 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11404 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11405 PL_top_env = &PL_start_env;
11407 PL_op = proto_perl->Top;
11410 PL_Xpv = (XPV*)NULL;
11411 PL_na = proto_perl->Tna;
11413 PL_statbuf = proto_perl->Tstatbuf;
11414 PL_statcache = proto_perl->Tstatcache;
11415 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11416 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11418 PL_timesbuf = proto_perl->Ttimesbuf;
11421 PL_tainted = proto_perl->Ttainted;
11422 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11423 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11424 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11425 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11426 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11427 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11428 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11429 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11430 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11432 PL_restartop = proto_perl->Trestartop;
11433 PL_in_eval = proto_perl->Tin_eval;
11434 PL_delaymagic = proto_perl->Tdelaymagic;
11435 PL_dirty = proto_perl->Tdirty;
11436 PL_localizing = proto_perl->Tlocalizing;
11438 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11439 PL_hv_fetch_ent_mh = NULL;
11440 PL_modcount = proto_perl->Tmodcount;
11441 PL_lastgotoprobe = NULL;
11442 PL_dumpindent = proto_perl->Tdumpindent;
11444 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11445 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11446 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11447 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11448 PL_efloatbuf = NULL; /* reinits on demand */
11449 PL_efloatsize = 0; /* reinits on demand */
11453 PL_screamfirst = NULL;
11454 PL_screamnext = NULL;
11455 PL_maxscream = -1; /* reinits on demand */
11456 PL_lastscream = NULL;
11458 PL_watchaddr = NULL;
11461 PL_regdummy = proto_perl->Tregdummy;
11462 PL_colorset = 0; /* reinits PL_colors[] */
11463 /*PL_colors[6] = {0,0,0,0,0,0};*/
11467 /* Pluggable optimizer */
11468 PL_peepp = proto_perl->Tpeepp;
11470 PL_stashcache = newHV();
11472 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11473 ptr_table_free(PL_ptr_table);
11474 PL_ptr_table = NULL;
11477 /* Call the ->CLONE method, if it exists, for each of the stashes
11478 identified by sv_dup() above.
11480 while(av_len(param->stashes) != -1) {
11481 HV* const stash = (HV*) av_shift(param->stashes);
11482 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11483 if (cloner && GvCV(cloner)) {
11488 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11490 call_sv((SV*)GvCV(cloner), G_DISCARD);
11496 SvREFCNT_dec(param->stashes);
11498 /* orphaned? eg threads->new inside BEGIN or use */
11499 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11500 SvREFCNT_inc_simple_void(PL_compcv);
11501 SAVEFREESV(PL_compcv);
11507 #endif /* USE_ITHREADS */
11510 =head1 Unicode Support
11512 =for apidoc sv_recode_to_utf8
11514 The encoding is assumed to be an Encode object, on entry the PV
11515 of the sv is assumed to be octets in that encoding, and the sv
11516 will be converted into Unicode (and UTF-8).
11518 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11519 is not a reference, nothing is done to the sv. If the encoding is not
11520 an C<Encode::XS> Encoding object, bad things will happen.
11521 (See F<lib/encoding.pm> and L<Encode>).
11523 The PV of the sv is returned.
11528 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11531 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11545 Passing sv_yes is wrong - it needs to be or'ed set of constants
11546 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11547 remove converted chars from source.
11549 Both will default the value - let them.
11551 XPUSHs(&PL_sv_yes);
11554 call_method("decode", G_SCALAR);
11558 s = SvPV_const(uni, len);
11559 if (s != SvPVX_const(sv)) {
11560 SvGROW(sv, len + 1);
11561 Move(s, SvPVX(sv), len + 1, char);
11562 SvCUR_set(sv, len);
11569 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11573 =for apidoc sv_cat_decode
11575 The encoding is assumed to be an Encode object, the PV of the ssv is
11576 assumed to be octets in that encoding and decoding the input starts
11577 from the position which (PV + *offset) pointed to. The dsv will be
11578 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11579 when the string tstr appears in decoding output or the input ends on
11580 the PV of the ssv. The value which the offset points will be modified
11581 to the last input position on the ssv.
11583 Returns TRUE if the terminator was found, else returns FALSE.
11588 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11589 SV *ssv, int *offset, char *tstr, int tlen)
11593 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11604 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11605 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11607 call_method("cat_decode", G_SCALAR);
11609 ret = SvTRUE(TOPs);
11610 *offset = SvIV(offsv);
11616 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11621 /* ---------------------------------------------------------------------
11623 * support functions for report_uninit()
11626 /* the maxiumum size of array or hash where we will scan looking
11627 * for the undefined element that triggered the warning */
11629 #define FUV_MAX_SEARCH_SIZE 1000
11631 /* Look for an entry in the hash whose value has the same SV as val;
11632 * If so, return a mortal copy of the key. */
11635 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11638 register HE **array;
11641 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11642 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11645 array = HvARRAY(hv);
11647 for (i=HvMAX(hv); i>0; i--) {
11648 register HE *entry;
11649 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11650 if (HeVAL(entry) != val)
11652 if ( HeVAL(entry) == &PL_sv_undef ||
11653 HeVAL(entry) == &PL_sv_placeholder)
11657 if (HeKLEN(entry) == HEf_SVKEY)
11658 return sv_mortalcopy(HeKEY_sv(entry));
11659 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11665 /* Look for an entry in the array whose value has the same SV as val;
11666 * If so, return the index, otherwise return -1. */
11669 S_find_array_subscript(pTHX_ AV *av, SV* val)
11672 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11673 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11676 if (val != &PL_sv_undef) {
11677 SV ** const svp = AvARRAY(av);
11680 for (i=AvFILLp(av); i>=0; i--)
11687 /* S_varname(): return the name of a variable, optionally with a subscript.
11688 * If gv is non-zero, use the name of that global, along with gvtype (one
11689 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11690 * targ. Depending on the value of the subscript_type flag, return:
11693 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11694 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11695 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11696 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11699 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11700 SV* keyname, I32 aindex, int subscript_type)
11703 SV * const name = sv_newmortal();
11706 buffer[0] = gvtype;
11709 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11711 gv_fullname4(name, gv, buffer, 0);
11713 if ((unsigned int)SvPVX(name)[1] <= 26) {
11715 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11717 /* Swap the 1 unprintable control character for the 2 byte pretty
11718 version - ie substr($name, 1, 1) = $buffer; */
11719 sv_insert(name, 1, 1, buffer, 2);
11724 CV * const cv = find_runcv(&unused);
11728 if (!cv || !CvPADLIST(cv))
11730 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11731 sv = *av_fetch(av, targ, FALSE);
11732 /* SvLEN in a pad name is not to be trusted */
11733 sv_setpv(name, SvPV_nolen_const(sv));
11736 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11737 SV * const sv = newSV(0);
11738 *SvPVX(name) = '$';
11739 Perl_sv_catpvf(aTHX_ name, "{%s}",
11740 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11743 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11744 *SvPVX(name) = '$';
11745 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11747 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11748 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11755 =for apidoc find_uninit_var
11757 Find the name of the undefined variable (if any) that caused the operator o
11758 to issue a "Use of uninitialized value" warning.
11759 If match is true, only return a name if it's value matches uninit_sv.
11760 So roughly speaking, if a unary operator (such as OP_COS) generates a
11761 warning, then following the direct child of the op may yield an
11762 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11763 other hand, with OP_ADD there are two branches to follow, so we only print
11764 the variable name if we get an exact match.
11766 The name is returned as a mortal SV.
11768 Assumes that PL_op is the op that originally triggered the error, and that
11769 PL_comppad/PL_curpad points to the currently executing pad.
11775 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11783 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11784 uninit_sv == &PL_sv_placeholder)))
11787 switch (obase->op_type) {
11794 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11795 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11798 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11800 if (pad) { /* @lex, %lex */
11801 sv = PAD_SVl(obase->op_targ);
11805 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11806 /* @global, %global */
11807 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11810 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11812 else /* @{expr}, %{expr} */
11813 return find_uninit_var(cUNOPx(obase)->op_first,
11817 /* attempt to find a match within the aggregate */
11819 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11821 subscript_type = FUV_SUBSCRIPT_HASH;
11824 index = find_array_subscript((AV*)sv, uninit_sv);
11826 subscript_type = FUV_SUBSCRIPT_ARRAY;
11829 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11832 return varname(gv, hash ? '%' : '@', obase->op_targ,
11833 keysv, index, subscript_type);
11837 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11839 return varname(NULL, '$', obase->op_targ,
11840 NULL, 0, FUV_SUBSCRIPT_NONE);
11843 gv = cGVOPx_gv(obase);
11844 if (!gv || (match && GvSV(gv) != uninit_sv))
11846 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11849 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11852 av = (AV*)PAD_SV(obase->op_targ);
11853 if (!av || SvRMAGICAL(av))
11855 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11856 if (!svp || *svp != uninit_sv)
11859 return varname(NULL, '$', obase->op_targ,
11860 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11863 gv = cGVOPx_gv(obase);
11869 if (!av || SvRMAGICAL(av))
11871 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11872 if (!svp || *svp != uninit_sv)
11875 return varname(gv, '$', 0,
11876 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11881 o = cUNOPx(obase)->op_first;
11882 if (!o || o->op_type != OP_NULL ||
11883 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11885 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11889 if (PL_op == obase)
11890 /* $a[uninit_expr] or $h{uninit_expr} */
11891 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11894 o = cBINOPx(obase)->op_first;
11895 kid = cBINOPx(obase)->op_last;
11897 /* get the av or hv, and optionally the gv */
11899 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11900 sv = PAD_SV(o->op_targ);
11902 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11903 && cUNOPo->op_first->op_type == OP_GV)
11905 gv = cGVOPx_gv(cUNOPo->op_first);
11908 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11913 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11914 /* index is constant */
11918 if (obase->op_type == OP_HELEM) {
11919 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11920 if (!he || HeVAL(he) != uninit_sv)
11924 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11925 if (!svp || *svp != uninit_sv)
11929 if (obase->op_type == OP_HELEM)
11930 return varname(gv, '%', o->op_targ,
11931 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11933 return varname(gv, '@', o->op_targ, NULL,
11934 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11937 /* index is an expression;
11938 * attempt to find a match within the aggregate */
11939 if (obase->op_type == OP_HELEM) {
11940 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11942 return varname(gv, '%', o->op_targ,
11943 keysv, 0, FUV_SUBSCRIPT_HASH);
11946 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11948 return varname(gv, '@', o->op_targ,
11949 NULL, index, FUV_SUBSCRIPT_ARRAY);
11954 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11956 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11961 /* only examine RHS */
11962 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11965 o = cUNOPx(obase)->op_first;
11966 if (o->op_type == OP_PUSHMARK)
11969 if (!o->op_sibling) {
11970 /* one-arg version of open is highly magical */
11972 if (o->op_type == OP_GV) { /* open FOO; */
11974 if (match && GvSV(gv) != uninit_sv)
11976 return varname(gv, '$', 0,
11977 NULL, 0, FUV_SUBSCRIPT_NONE);
11979 /* other possibilities not handled are:
11980 * open $x; or open my $x; should return '${*$x}'
11981 * open expr; should return '$'.expr ideally
11987 /* ops where $_ may be an implicit arg */
11991 if ( !(obase->op_flags & OPf_STACKED)) {
11992 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11993 ? PAD_SVl(obase->op_targ)
11996 sv = sv_newmortal();
11997 sv_setpvn(sv, "$_", 2);
12005 /* skip filehandle as it can't produce 'undef' warning */
12006 o = cUNOPx(obase)->op_first;
12007 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12008 o = o->op_sibling->op_sibling;
12015 match = 1; /* XS or custom code could trigger random warnings */
12020 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12021 return sv_2mortal(newSVpvs("${$/}"));
12026 if (!(obase->op_flags & OPf_KIDS))
12028 o = cUNOPx(obase)->op_first;
12034 /* if all except one arg are constant, or have no side-effects,
12035 * or are optimized away, then it's unambiguous */
12037 for (kid=o; kid; kid = kid->op_sibling) {
12039 const OPCODE type = kid->op_type;
12040 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12041 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12042 || (type == OP_PUSHMARK)
12046 if (o2) { /* more than one found */
12053 return find_uninit_var(o2, uninit_sv, match);
12055 /* scan all args */
12057 sv = find_uninit_var(o, uninit_sv, 1);
12069 =for apidoc report_uninit
12071 Print appropriate "Use of uninitialized variable" warning
12077 Perl_report_uninit(pTHX_ SV* uninit_sv)
12081 SV* varname = NULL;
12083 varname = find_uninit_var(PL_op, uninit_sv,0);
12085 sv_insert(varname, 0, 0, " ", 1);
12087 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12088 varname ? SvPV_nolen_const(varname) : "",
12089 " in ", OP_DESC(PL_op));
12092 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12098 * c-indentation-style: bsd
12099 * c-basic-offset: 4
12100 * indent-tabs-mode: t
12103 * ex: set ts=8 sts=4 sw=4 noet: