3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
1280 if (old_type >= SVt_PVMG) {
1281 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1284 sv->sv_u.svu_array = NULL; /* or svu_hash */
1290 /* XXX Is this still needed? Was it ever needed? Surely as there is
1291 no route from NV to PVIV, NOK can never be true */
1292 assert(!SvNOKp(sv));
1304 assert(new_type_details->body_size);
1305 /* We always allocated the full length item with PURIFY. To do this
1306 we fake things so that arena is false for all 16 types.. */
1307 if(new_type_details->arena) {
1308 /* This points to the start of the allocated area. */
1309 new_body_inline(new_body, new_type);
1310 Zero(new_body, new_type_details->body_size, char);
1311 new_body = ((char *)new_body) - new_type_details->offset;
1313 new_body = new_NOARENAZ(new_type_details);
1315 SvANY(sv) = new_body;
1317 if (old_type_details->copy) {
1318 /* There is now the potential for an upgrade from something without
1319 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1320 int offset = old_type_details->offset;
1321 int length = old_type_details->copy;
1323 if (new_type_details->offset > old_type_details->offset) {
1324 const int difference
1325 = new_type_details->offset - old_type_details->offset;
1326 offset += difference;
1327 length -= difference;
1329 assert (length >= 0);
1331 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1335 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1336 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1337 * correct 0.0 for us. Otherwise, if the old body didn't have an
1338 * NV slot, but the new one does, then we need to initialise the
1339 * freshly created NV slot with whatever the correct bit pattern is
1341 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1345 if (new_type == SVt_PVIO)
1346 IoPAGE_LEN(sv) = 60;
1347 if (old_type < SVt_RV)
1351 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1352 (unsigned long)new_type);
1355 if (old_type_details->arena) {
1356 /* If there was an old body, then we need to free it.
1357 Note that there is an assumption that all bodies of types that
1358 can be upgraded came from arenas. Only the more complex non-
1359 upgradable types are allowed to be directly malloc()ed. */
1361 my_safefree(old_body);
1363 del_body((void*)((char*)old_body + old_type_details->offset),
1364 &PL_body_roots[old_type]);
1370 =for apidoc sv_backoff
1372 Remove any string offset. You should normally use the C<SvOOK_off> macro
1379 Perl_sv_backoff(pTHX_ register SV *sv)
1381 PERL_UNUSED_CONTEXT;
1383 assert(SvTYPE(sv) != SVt_PVHV);
1384 assert(SvTYPE(sv) != SVt_PVAV);
1386 const char * const s = SvPVX_const(sv);
1387 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1388 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1390 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1392 SvFLAGS(sv) &= ~SVf_OOK;
1399 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1400 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1401 Use the C<SvGROW> wrapper instead.
1407 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1411 if (PL_madskills && newlen >= 0x100000) {
1412 PerlIO_printf(Perl_debug_log,
1413 "Allocation too large: %"UVxf"\n", (UV)newlen);
1415 #ifdef HAS_64K_LIMIT
1416 if (newlen >= 0x10000) {
1417 PerlIO_printf(Perl_debug_log,
1418 "Allocation too large: %"UVxf"\n", (UV)newlen);
1421 #endif /* HAS_64K_LIMIT */
1424 if (SvTYPE(sv) < SVt_PV) {
1425 sv_upgrade(sv, SVt_PV);
1426 s = SvPVX_mutable(sv);
1428 else if (SvOOK(sv)) { /* pv is offset? */
1430 s = SvPVX_mutable(sv);
1431 if (newlen > SvLEN(sv))
1432 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1433 #ifdef HAS_64K_LIMIT
1434 if (newlen >= 0x10000)
1439 s = SvPVX_mutable(sv);
1441 if (newlen > SvLEN(sv)) { /* need more room? */
1442 newlen = PERL_STRLEN_ROUNDUP(newlen);
1443 if (SvLEN(sv) && s) {
1445 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1451 s = (char*)saferealloc(s, newlen);
1454 s = (char*)safemalloc(newlen);
1455 if (SvPVX_const(sv) && SvCUR(sv)) {
1456 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1460 SvLEN_set(sv, newlen);
1466 =for apidoc sv_setiv
1468 Copies an integer into the given SV, upgrading first if necessary.
1469 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1475 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1478 SV_CHECK_THINKFIRST_COW_DROP(sv);
1479 switch (SvTYPE(sv)) {
1481 sv_upgrade(sv, SVt_IV);
1484 sv_upgrade(sv, SVt_PVNV);
1488 sv_upgrade(sv, SVt_PVIV);
1497 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1603 (void)SvNOK_only(sv); /* validate number */
1608 =for apidoc sv_setnv_mg
1610 Like C<sv_setnv>, but also handles 'set' magic.
1616 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1622 /* Print an "isn't numeric" warning, using a cleaned-up,
1623 * printable version of the offending string
1627 S_not_a_number(pTHX_ SV *sv)
1635 dsv = sv_2mortal(newSVpvs(""));
1636 pv = sv_uni_display(dsv, sv, 10, 0);
1639 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1640 /* each *s can expand to 4 chars + "...\0",
1641 i.e. need room for 8 chars */
1643 const char *s = SvPVX_const(sv);
1644 const char * const end = s + SvCUR(sv);
1645 for ( ; s < end && d < limit; s++ ) {
1647 if (ch & 128 && !isPRINT_LC(ch)) {
1656 else if (ch == '\r') {
1660 else if (ch == '\f') {
1664 else if (ch == '\\') {
1668 else if (ch == '\0') {
1672 else if (isPRINT_LC(ch))
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric in %s", pv,
1693 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1694 "Argument \"%s\" isn't numeric", pv);
1698 =for apidoc looks_like_number
1700 Test if the content of an SV looks like a number (or is a number).
1701 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1702 non-numeric warning), even if your atof() doesn't grok them.
1708 Perl_looks_like_number(pTHX_ SV *sv)
1710 register const char *sbegin;
1714 sbegin = SvPVX_const(sv);
1717 else if (SvPOKp(sv))
1718 sbegin = SvPV_const(sv, len);
1720 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1721 return grok_number(sbegin, len, NULL);
1725 S_glob_2number(pTHX_ GV * const gv)
1727 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1728 SV *const buffer = sv_newmortal();
1730 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1733 gv_efullname3(buffer, gv, "*");
1734 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1746 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1748 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1749 SV *const buffer = sv_newmortal();
1751 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1754 gv_efullname3(buffer, gv, "*");
1755 SvFLAGS(gv) |= wasfake;
1757 assert(SvPOK(buffer));
1759 *len = SvCUR(buffer);
1761 return SvPVX(buffer);
1764 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1765 until proven guilty, assume that things are not that bad... */
1770 As 64 bit platforms often have an NV that doesn't preserve all bits of
1771 an IV (an assumption perl has been based on to date) it becomes necessary
1772 to remove the assumption that the NV always carries enough precision to
1773 recreate the IV whenever needed, and that the NV is the canonical form.
1774 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1775 precision as a side effect of conversion (which would lead to insanity
1776 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1777 1) to distinguish between IV/UV/NV slots that have cached a valid
1778 conversion where precision was lost and IV/UV/NV slots that have a
1779 valid conversion which has lost no precision
1780 2) to ensure that if a numeric conversion to one form is requested that
1781 would lose precision, the precise conversion (or differently
1782 imprecise conversion) is also performed and cached, to prevent
1783 requests for different numeric formats on the same SV causing
1784 lossy conversion chains. (lossless conversion chains are perfectly
1789 SvIOKp is true if the IV slot contains a valid value
1790 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1791 SvNOKp is true if the NV slot contains a valid value
1792 SvNOK is true only if the NV value is accurate
1795 while converting from PV to NV, check to see if converting that NV to an
1796 IV(or UV) would lose accuracy over a direct conversion from PV to
1797 IV(or UV). If it would, cache both conversions, return NV, but mark
1798 SV as IOK NOKp (ie not NOK).
1800 While converting from PV to IV, check to see if converting that IV to an
1801 NV would lose accuracy over a direct conversion from PV to NV. If it
1802 would, cache both conversions, flag similarly.
1804 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1805 correctly because if IV & NV were set NV *always* overruled.
1806 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1807 changes - now IV and NV together means that the two are interchangeable:
1808 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1810 The benefit of this is that operations such as pp_add know that if
1811 SvIOK is true for both left and right operands, then integer addition
1812 can be used instead of floating point (for cases where the result won't
1813 overflow). Before, floating point was always used, which could lead to
1814 loss of precision compared with integer addition.
1816 * making IV and NV equal status should make maths accurate on 64 bit
1818 * may speed up maths somewhat if pp_add and friends start to use
1819 integers when possible instead of fp. (Hopefully the overhead in
1820 looking for SvIOK and checking for overflow will not outweigh the
1821 fp to integer speedup)
1822 * will slow down integer operations (callers of SvIV) on "inaccurate"
1823 values, as the change from SvIOK to SvIOKp will cause a call into
1824 sv_2iv each time rather than a macro access direct to the IV slot
1825 * should speed up number->string conversion on integers as IV is
1826 favoured when IV and NV are equally accurate
1828 ####################################################################
1829 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1830 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1831 On the other hand, SvUOK is true iff UV.
1832 ####################################################################
1834 Your mileage will vary depending your CPU's relative fp to integer
1838 #ifndef NV_PRESERVES_UV
1839 # define IS_NUMBER_UNDERFLOW_IV 1
1840 # define IS_NUMBER_UNDERFLOW_UV 2
1841 # define IS_NUMBER_IV_AND_UV 2
1842 # define IS_NUMBER_OVERFLOW_IV 4
1843 # define IS_NUMBER_OVERFLOW_UV 5
1845 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1847 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1849 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1852 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1853 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1854 if (SvNVX(sv) < (NV)IV_MIN) {
1855 (void)SvIOKp_on(sv);
1857 SvIV_set(sv, IV_MIN);
1858 return IS_NUMBER_UNDERFLOW_IV;
1860 if (SvNVX(sv) > (NV)UV_MAX) {
1861 (void)SvIOKp_on(sv);
1864 SvUV_set(sv, UV_MAX);
1865 return IS_NUMBER_OVERFLOW_UV;
1867 (void)SvIOKp_on(sv);
1869 /* Can't use strtol etc to convert this string. (See truth table in
1871 if (SvNVX(sv) <= (UV)IV_MAX) {
1872 SvIV_set(sv, I_V(SvNVX(sv)));
1873 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1874 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1876 /* Integer is imprecise. NOK, IOKp */
1878 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1881 SvUV_set(sv, U_V(SvNVX(sv)));
1882 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1883 if (SvUVX(sv) == UV_MAX) {
1884 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1885 possibly be preserved by NV. Hence, it must be overflow.
1887 return IS_NUMBER_OVERFLOW_UV;
1889 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1891 /* Integer is imprecise. NOK, IOKp */
1893 return IS_NUMBER_OVERFLOW_IV;
1895 #endif /* !NV_PRESERVES_UV*/
1898 S_sv_2iuv_common(pTHX_ SV *sv) {
1901 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1902 * without also getting a cached IV/UV from it at the same time
1903 * (ie PV->NV conversion should detect loss of accuracy and cache
1904 * IV or UV at same time to avoid this. */
1905 /* IV-over-UV optimisation - choose to cache IV if possible */
1907 if (SvTYPE(sv) == SVt_NV)
1908 sv_upgrade(sv, SVt_PVNV);
1910 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1911 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1912 certainly cast into the IV range at IV_MAX, whereas the correct
1913 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1915 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1916 if (Perl_isnan(SvNVX(sv))) {
1922 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1923 SvIV_set(sv, I_V(SvNVX(sv)));
1924 if (SvNVX(sv) == (NV) SvIVX(sv)
1925 #ifndef NV_PRESERVES_UV
1926 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1927 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1928 /* Don't flag it as "accurately an integer" if the number
1929 came from a (by definition imprecise) NV operation, and
1930 we're outside the range of NV integer precision */
1933 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1934 DEBUG_c(PerlIO_printf(Perl_debug_log,
1935 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1941 /* IV not precise. No need to convert from PV, as NV
1942 conversion would already have cached IV if it detected
1943 that PV->IV would be better than PV->NV->IV
1944 flags already correct - don't set public IOK. */
1945 DEBUG_c(PerlIO_printf(Perl_debug_log,
1946 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1951 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1952 but the cast (NV)IV_MIN rounds to a the value less (more
1953 negative) than IV_MIN which happens to be equal to SvNVX ??
1954 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1955 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1956 (NV)UVX == NVX are both true, but the values differ. :-(
1957 Hopefully for 2s complement IV_MIN is something like
1958 0x8000000000000000 which will be exact. NWC */
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1963 (SvNVX(sv) == (NV) SvUVX(sv))
1964 #ifndef NV_PRESERVES_UV
1965 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1966 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1967 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1968 /* Don't flag it as "accurately an integer" if the number
1969 came from a (by definition imprecise) NV operation, and
1970 we're outside the range of NV integer precision */
1975 DEBUG_c(PerlIO_printf(Perl_debug_log,
1976 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1982 else if (SvPOKp(sv) && SvLEN(sv)) {
1984 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1985 /* We want to avoid a possible problem when we cache an IV/ a UV which
1986 may be later translated to an NV, and the resulting NV is not
1987 the same as the direct translation of the initial string
1988 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1989 be careful to ensure that the value with the .456 is around if the
1990 NV value is requested in the future).
1992 This means that if we cache such an IV/a UV, we need to cache the
1993 NV as well. Moreover, we trade speed for space, and do not
1994 cache the NV if we are sure it's not needed.
1997 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1998 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1999 == IS_NUMBER_IN_UV) {
2000 /* It's definitely an integer, only upgrade to PVIV */
2001 if (SvTYPE(sv) < SVt_PVIV)
2002 sv_upgrade(sv, SVt_PVIV);
2004 } else if (SvTYPE(sv) < SVt_PVNV)
2005 sv_upgrade(sv, SVt_PVNV);
2007 /* If NVs preserve UVs then we only use the UV value if we know that
2008 we aren't going to call atof() below. If NVs don't preserve UVs
2009 then the value returned may have more precision than atof() will
2010 return, even though value isn't perfectly accurate. */
2011 if ((numtype & (IS_NUMBER_IN_UV
2012 #ifdef NV_PRESERVES_UV
2015 )) == IS_NUMBER_IN_UV) {
2016 /* This won't turn off the public IOK flag if it was set above */
2017 (void)SvIOKp_on(sv);
2019 if (!(numtype & IS_NUMBER_NEG)) {
2021 if (value <= (UV)IV_MAX) {
2022 SvIV_set(sv, (IV)value);
2024 /* it didn't overflow, and it was positive. */
2025 SvUV_set(sv, value);
2029 /* 2s complement assumption */
2030 if (value <= (UV)IV_MIN) {
2031 SvIV_set(sv, -(IV)value);
2033 /* Too negative for an IV. This is a double upgrade, but
2034 I'm assuming it will be rare. */
2035 if (SvTYPE(sv) < SVt_PVNV)
2036 sv_upgrade(sv, SVt_PVNV);
2040 SvNV_set(sv, -(NV)value);
2041 SvIV_set(sv, IV_MIN);
2045 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2046 will be in the previous block to set the IV slot, and the next
2047 block to set the NV slot. So no else here. */
2049 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2050 != IS_NUMBER_IN_UV) {
2051 /* It wasn't an (integer that doesn't overflow the UV). */
2052 SvNV_set(sv, Atof(SvPVX_const(sv)));
2054 if (! numtype && ckWARN(WARN_NUMERIC))
2057 #if defined(USE_LONG_DOUBLE)
2058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2059 PTR2UV(sv), SvNVX(sv)));
2061 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2062 PTR2UV(sv), SvNVX(sv)));
2065 #ifdef NV_PRESERVES_UV
2066 (void)SvIOKp_on(sv);
2068 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2069 SvIV_set(sv, I_V(SvNVX(sv)));
2070 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2073 NOOP; /* Integer is imprecise. NOK, IOKp */
2075 /* UV will not work better than IV */
2077 if (SvNVX(sv) > (NV)UV_MAX) {
2079 /* Integer is inaccurate. NOK, IOKp, is UV */
2080 SvUV_set(sv, UV_MAX);
2082 SvUV_set(sv, U_V(SvNVX(sv)));
2083 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2084 NV preservse UV so can do correct comparison. */
2085 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2088 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2093 #else /* NV_PRESERVES_UV */
2094 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2095 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2096 /* The IV/UV slot will have been set from value returned by
2097 grok_number above. The NV slot has just been set using
2100 assert (SvIOKp(sv));
2102 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2103 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2104 /* Small enough to preserve all bits. */
2105 (void)SvIOKp_on(sv);
2107 SvIV_set(sv, I_V(SvNVX(sv)));
2108 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2110 /* Assumption: first non-preserved integer is < IV_MAX,
2111 this NV is in the preserved range, therefore: */
2112 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2114 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2118 0 0 already failed to read UV.
2119 0 1 already failed to read UV.
2120 1 0 you won't get here in this case. IV/UV
2121 slot set, public IOK, Atof() unneeded.
2122 1 1 already read UV.
2123 so there's no point in sv_2iuv_non_preserve() attempting
2124 to use atol, strtol, strtoul etc. */
2125 sv_2iuv_non_preserve (sv, numtype);
2128 #endif /* NV_PRESERVES_UV */
2132 if (isGV_with_GP(sv))
2133 return glob_2number((GV *)sv);
2135 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2136 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2139 if (SvTYPE(sv) < SVt_IV)
2140 /* Typically the caller expects that sv_any is not NULL now. */
2141 sv_upgrade(sv, SVt_IV);
2142 /* Return 0 from the caller. */
2149 =for apidoc sv_2iv_flags
2151 Return the integer value of an SV, doing any necessary string
2152 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2153 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2159 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2164 if (SvGMAGICAL(sv)) {
2165 if (flags & SV_GMAGIC)
2170 return I_V(SvNVX(sv));
2172 if (SvPOKp(sv) && SvLEN(sv)) {
2175 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2177 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2178 == IS_NUMBER_IN_UV) {
2179 /* It's definitely an integer */
2180 if (numtype & IS_NUMBER_NEG) {
2181 if (value < (UV)IV_MIN)
2184 if (value < (UV)IV_MAX)
2189 if (ckWARN(WARN_NUMERIC))
2192 return I_V(Atof(SvPVX_const(sv)));
2197 assert(SvTYPE(sv) >= SVt_PVMG);
2198 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2199 } else if (SvTHINKFIRST(sv)) {
2203 SV * const tmpstr=AMG_CALLun(sv,numer);
2204 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2205 return SvIV(tmpstr);
2208 return PTR2IV(SvRV(sv));
2211 sv_force_normal_flags(sv, 0);
2213 if (SvREADONLY(sv) && !SvOK(sv)) {
2214 if (ckWARN(WARN_UNINITIALIZED))
2220 if (S_sv_2iuv_common(aTHX_ sv))
2223 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2224 PTR2UV(sv),SvIVX(sv)));
2225 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2229 =for apidoc sv_2uv_flags
2231 Return the unsigned integer value of an SV, doing any necessary string
2232 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2233 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2239 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2244 if (SvGMAGICAL(sv)) {
2245 if (flags & SV_GMAGIC)
2250 return U_V(SvNVX(sv));
2251 if (SvPOKp(sv) && SvLEN(sv)) {
2254 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2256 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2257 == IS_NUMBER_IN_UV) {
2258 /* It's definitely an integer */
2259 if (!(numtype & IS_NUMBER_NEG))
2263 if (ckWARN(WARN_NUMERIC))
2266 return U_V(Atof(SvPVX_const(sv)));
2271 assert(SvTYPE(sv) >= SVt_PVMG);
2272 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2273 } else if (SvTHINKFIRST(sv)) {
2277 SV *const tmpstr = AMG_CALLun(sv,numer);
2278 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2279 return SvUV(tmpstr);
2282 return PTR2UV(SvRV(sv));
2285 sv_force_normal_flags(sv, 0);
2287 if (SvREADONLY(sv) && !SvOK(sv)) {
2288 if (ckWARN(WARN_UNINITIALIZED))
2294 if (S_sv_2iuv_common(aTHX_ sv))
2298 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2299 PTR2UV(sv),SvUVX(sv)));
2300 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2306 Return the num value of an SV, doing any necessary string or integer
2307 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2314 Perl_sv_2nv(pTHX_ register SV *sv)
2319 if (SvGMAGICAL(sv)) {
2323 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2324 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2325 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2327 return Atof(SvPVX_const(sv));
2331 return (NV)SvUVX(sv);
2333 return (NV)SvIVX(sv);
2338 assert(SvTYPE(sv) >= SVt_PVMG);
2339 /* This falls through to the report_uninit near the end of the
2341 } else if (SvTHINKFIRST(sv)) {
2345 SV *const tmpstr = AMG_CALLun(sv,numer);
2346 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2347 return SvNV(tmpstr);
2350 return PTR2NV(SvRV(sv));
2353 sv_force_normal_flags(sv, 0);
2355 if (SvREADONLY(sv) && !SvOK(sv)) {
2356 if (ckWARN(WARN_UNINITIALIZED))
2361 if (SvTYPE(sv) < SVt_NV) {
2362 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2363 sv_upgrade(sv, SVt_NV);
2364 #ifdef USE_LONG_DOUBLE
2366 STORE_NUMERIC_LOCAL_SET_STANDARD();
2367 PerlIO_printf(Perl_debug_log,
2368 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2369 PTR2UV(sv), SvNVX(sv));
2370 RESTORE_NUMERIC_LOCAL();
2374 STORE_NUMERIC_LOCAL_SET_STANDARD();
2375 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2376 PTR2UV(sv), SvNVX(sv));
2377 RESTORE_NUMERIC_LOCAL();
2381 else if (SvTYPE(sv) < SVt_PVNV)
2382 sv_upgrade(sv, SVt_PVNV);
2387 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2388 #ifdef NV_PRESERVES_UV
2391 /* Only set the public NV OK flag if this NV preserves the IV */
2392 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2393 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2394 : (SvIVX(sv) == I_V(SvNVX(sv))))
2400 else if (SvPOKp(sv) && SvLEN(sv)) {
2402 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2403 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2405 #ifdef NV_PRESERVES_UV
2406 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2407 == IS_NUMBER_IN_UV) {
2408 /* It's definitely an integer */
2409 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2411 SvNV_set(sv, Atof(SvPVX_const(sv)));
2414 SvNV_set(sv, Atof(SvPVX_const(sv)));
2415 /* Only set the public NV OK flag if this NV preserves the value in
2416 the PV at least as well as an IV/UV would.
2417 Not sure how to do this 100% reliably. */
2418 /* if that shift count is out of range then Configure's test is
2419 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2421 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2422 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2423 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2424 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2425 /* Can't use strtol etc to convert this string, so don't try.
2426 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2429 /* value has been set. It may not be precise. */
2430 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2431 /* 2s complement assumption for (UV)IV_MIN */
2432 SvNOK_on(sv); /* Integer is too negative. */
2437 if (numtype & IS_NUMBER_NEG) {
2438 SvIV_set(sv, -(IV)value);
2439 } else if (value <= (UV)IV_MAX) {
2440 SvIV_set(sv, (IV)value);
2442 SvUV_set(sv, value);
2446 if (numtype & IS_NUMBER_NOT_INT) {
2447 /* I believe that even if the original PV had decimals,
2448 they are lost beyond the limit of the FP precision.
2449 However, neither is canonical, so both only get p
2450 flags. NWC, 2000/11/25 */
2451 /* Both already have p flags, so do nothing */
2453 const NV nv = SvNVX(sv);
2454 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2455 if (SvIVX(sv) == I_V(nv)) {
2458 /* It had no "." so it must be integer. */
2462 /* between IV_MAX and NV(UV_MAX).
2463 Could be slightly > UV_MAX */
2465 if (numtype & IS_NUMBER_NOT_INT) {
2466 /* UV and NV both imprecise. */
2468 const UV nv_as_uv = U_V(nv);
2470 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2479 #endif /* NV_PRESERVES_UV */
2482 if (isGV_with_GP(sv)) {
2483 glob_2number((GV *)sv);
2487 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2489 assert (SvTYPE(sv) >= SVt_NV);
2490 /* Typically the caller expects that sv_any is not NULL now. */
2491 /* XXX Ilya implies that this is a bug in callers that assume this
2492 and ideally should be fixed. */
2495 #if defined(USE_LONG_DOUBLE)
2497 STORE_NUMERIC_LOCAL_SET_STANDARD();
2498 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2499 PTR2UV(sv), SvNVX(sv));
2500 RESTORE_NUMERIC_LOCAL();
2504 STORE_NUMERIC_LOCAL_SET_STANDARD();
2505 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2506 PTR2UV(sv), SvNVX(sv));
2507 RESTORE_NUMERIC_LOCAL();
2513 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2514 * UV as a string towards the end of buf, and return pointers to start and
2517 * We assume that buf is at least TYPE_CHARS(UV) long.
2521 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2523 char *ptr = buf + TYPE_CHARS(UV);
2524 char * const ebuf = ptr;
2537 *--ptr = '0' + (char)(uv % 10);
2545 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2546 * a regexp to its stringified form.
2550 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2552 const regexp * const re = (regexp *)mg->mg_obj;
2555 const char *fptr = "msix";
2560 bool need_newline = 0;
2561 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2563 while((ch = *fptr++)) {
2565 reflags[left++] = ch;
2568 reflags[right--] = ch;
2573 reflags[left] = '-';
2577 mg->mg_len = re->prelen + 4 + left;
2579 * If /x was used, we have to worry about a regex ending with a
2580 * comment later being embedded within another regex. If so, we don't
2581 * want this regex's "commentization" to leak out to the right part of
2582 * the enclosing regex, we must cap it with a newline.
2584 * So, if /x was used, we scan backwards from the end of the regex. If
2585 * we find a '#' before we find a newline, we need to add a newline
2586 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2587 * we don't need to add anything. -jfriedl
2589 if (PMf_EXTENDED & re->reganch) {
2590 const char *endptr = re->precomp + re->prelen;
2591 while (endptr >= re->precomp) {
2592 const char c = *(endptr--);
2594 break; /* don't need another */
2596 /* we end while in a comment, so we need a newline */
2597 mg->mg_len++; /* save space for it */
2598 need_newline = 1; /* note to add it */
2604 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2605 mg->mg_ptr[0] = '(';
2606 mg->mg_ptr[1] = '?';
2607 Copy(reflags, mg->mg_ptr+2, left, char);
2608 *(mg->mg_ptr+left+2) = ':';
2609 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2611 mg->mg_ptr[mg->mg_len - 2] = '\n';
2612 mg->mg_ptr[mg->mg_len - 1] = ')';
2613 mg->mg_ptr[mg->mg_len] = 0;
2615 PL_reginterp_cnt += re->program[0].next_off;
2617 if (re->reganch & ROPT_UTF8)
2627 =for apidoc sv_2pv_flags
2629 Returns a pointer to the string value of an SV, and sets *lp to its length.
2630 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2632 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2633 usually end up here too.
2639 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2649 if (SvGMAGICAL(sv)) {
2650 if (flags & SV_GMAGIC)
2655 if (flags & SV_MUTABLE_RETURN)
2656 return SvPVX_mutable(sv);
2657 if (flags & SV_CONST_RETURN)
2658 return (char *)SvPVX_const(sv);
2661 if (SvIOKp(sv) || SvNOKp(sv)) {
2662 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2667 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2668 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2670 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2677 #ifdef FIXNEGATIVEZERO
2678 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2684 SvUPGRADE(sv, SVt_PV);
2687 s = SvGROW_mutable(sv, len + 1);
2690 return (char*)memcpy(s, tbuf, len + 1);
2696 assert(SvTYPE(sv) >= SVt_PVMG);
2697 /* This falls through to the report_uninit near the end of the
2699 } else if (SvTHINKFIRST(sv)) {
2703 SV *const tmpstr = AMG_CALLun(sv,string);
2704 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2706 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2710 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2711 if (flags & SV_CONST_RETURN) {
2712 pv = (char *) SvPVX_const(tmpstr);
2714 pv = (flags & SV_MUTABLE_RETURN)
2715 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2718 *lp = SvCUR(tmpstr);
2720 pv = sv_2pv_flags(tmpstr, lp, flags);
2734 const SV *const referent = (SV*)SvRV(sv);
2738 retval = buffer = savepvn("NULLREF", len);
2739 } else if (SvTYPE(referent) == SVt_PVMG
2740 && ((SvFLAGS(referent) &
2741 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2742 == (SVs_OBJECT|SVs_SMG))
2743 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2744 return stringify_regexp(sv, mg, lp);
2746 const char *const typestr = sv_reftype(referent, 0);
2747 const STRLEN typelen = strlen(typestr);
2748 UV addr = PTR2UV(referent);
2749 const char *stashname = NULL;
2750 STRLEN stashnamelen = 0; /* hush, gcc */
2751 const char *buffer_end;
2753 if (SvOBJECT(referent)) {
2754 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2757 stashname = HEK_KEY(name);
2758 stashnamelen = HEK_LEN(name);
2760 if (HEK_UTF8(name)) {
2766 stashname = "__ANON__";
2769 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2770 + 2 * sizeof(UV) + 2 /* )\0 */;
2772 len = typelen + 3 /* (0x */
2773 + 2 * sizeof(UV) + 2 /* )\0 */;
2776 Newx(buffer, len, char);
2777 buffer_end = retval = buffer + len;
2779 /* Working backwards */
2783 *--retval = PL_hexdigit[addr & 15];
2784 } while (addr >>= 4);
2790 memcpy(retval, typestr, typelen);
2794 retval -= stashnamelen;
2795 memcpy(retval, stashname, stashnamelen);
2797 /* retval may not neccesarily have reached the start of the
2799 assert (retval >= buffer);
2801 len = buffer_end - retval - 1; /* -1 for that \0 */
2809 if (SvREADONLY(sv) && !SvOK(sv)) {
2810 if (ckWARN(WARN_UNINITIALIZED))
2817 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2818 /* I'm assuming that if both IV and NV are equally valid then
2819 converting the IV is going to be more efficient */
2820 const U32 isIOK = SvIOK(sv);
2821 const U32 isUIOK = SvIsUV(sv);
2822 char buf[TYPE_CHARS(UV)];
2825 if (SvTYPE(sv) < SVt_PVIV)
2826 sv_upgrade(sv, SVt_PVIV);
2827 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2828 /* inlined from sv_setpvn */
2829 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2830 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2831 SvCUR_set(sv, ebuf - ptr);
2841 else if (SvNOKp(sv)) {
2842 const int olderrno = errno;
2843 if (SvTYPE(sv) < SVt_PVNV)
2844 sv_upgrade(sv, SVt_PVNV);
2845 /* The +20 is pure guesswork. Configure test needed. --jhi */
2846 s = SvGROW_mutable(sv, NV_DIG + 20);
2847 /* some Xenix systems wipe out errno here */
2849 if (SvNVX(sv) == 0.0)
2850 my_strlcpy(s, "0", SvLEN(sv));
2854 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2857 #ifdef FIXNEGATIVEZERO
2858 if (*s == '-' && s[1] == '0' && !s[2])
2859 my_strlcpy(s, "0", SvLEN(s));
2868 if (isGV_with_GP(sv))
2869 return glob_2pv((GV *)sv, lp);
2871 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2875 if (SvTYPE(sv) < SVt_PV)
2876 /* Typically the caller expects that sv_any is not NULL now. */
2877 sv_upgrade(sv, SVt_PV);
2881 const STRLEN len = s - SvPVX_const(sv);
2887 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2888 PTR2UV(sv),SvPVX_const(sv)));
2889 if (flags & SV_CONST_RETURN)
2890 return (char *)SvPVX_const(sv);
2891 if (flags & SV_MUTABLE_RETURN)
2892 return SvPVX_mutable(sv);
2897 =for apidoc sv_copypv
2899 Copies a stringified representation of the source SV into the
2900 destination SV. Automatically performs any necessary mg_get and
2901 coercion of numeric values into strings. Guaranteed to preserve
2902 UTF-8 flag even from overloaded objects. Similar in nature to
2903 sv_2pv[_flags] but operates directly on an SV instead of just the
2904 string. Mostly uses sv_2pv_flags to do its work, except when that
2905 would lose the UTF-8'ness of the PV.
2911 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2914 const char * const s = SvPV_const(ssv,len);
2915 sv_setpvn(dsv,s,len);
2923 =for apidoc sv_2pvbyte
2925 Return a pointer to the byte-encoded representation of the SV, and set *lp
2926 to its length. May cause the SV to be downgraded from UTF-8 as a
2929 Usually accessed via the C<SvPVbyte> macro.
2935 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2937 sv_utf8_downgrade(sv,0);
2938 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2942 =for apidoc sv_2pvutf8
2944 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2945 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2947 Usually accessed via the C<SvPVutf8> macro.
2953 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2955 sv_utf8_upgrade(sv);
2956 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2961 =for apidoc sv_2bool
2963 This function is only called on magical items, and is only used by
2964 sv_true() or its macro equivalent.
2970 Perl_sv_2bool(pTHX_ register SV *sv)
2979 SV * const tmpsv = AMG_CALLun(sv,bool_);
2980 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2981 return (bool)SvTRUE(tmpsv);
2983 return SvRV(sv) != 0;
2986 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2988 (*sv->sv_u.svu_pv > '0' ||
2989 Xpvtmp->xpv_cur > 1 ||
2990 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2997 return SvIVX(sv) != 0;
3000 return SvNVX(sv) != 0.0;
3002 if (isGV_with_GP(sv))
3012 =for apidoc sv_utf8_upgrade
3014 Converts the PV of an SV to its UTF-8-encoded form.
3015 Forces the SV to string form if it is not already.
3016 Always sets the SvUTF8 flag to avoid future validity checks even
3017 if all the bytes have hibit clear.
3019 This is not as a general purpose byte encoding to Unicode interface:
3020 use the Encode extension for that.
3022 =for apidoc sv_utf8_upgrade_flags
3024 Converts the PV of an SV to its UTF-8-encoded form.
3025 Forces the SV to string form if it is not already.
3026 Always sets the SvUTF8 flag to avoid future validity checks even
3027 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3028 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3029 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3031 This is not as a general purpose byte encoding to Unicode interface:
3032 use the Encode extension for that.
3038 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3041 if (sv == &PL_sv_undef)
3045 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3046 (void) sv_2pv_flags(sv,&len, flags);
3050 (void) SvPV_force(sv,len);
3059 sv_force_normal_flags(sv, 0);
3062 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3063 sv_recode_to_utf8(sv, PL_encoding);
3064 else { /* Assume Latin-1/EBCDIC */
3065 /* This function could be much more efficient if we
3066 * had a FLAG in SVs to signal if there are any hibit
3067 * chars in the PV. Given that there isn't such a flag
3068 * make the loop as fast as possible. */
3069 const U8 * const s = (U8 *) SvPVX_const(sv);
3070 const U8 * const e = (U8 *) SvEND(sv);
3075 /* Check for hi bit */
3076 if (!NATIVE_IS_INVARIANT(ch)) {
3077 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3078 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3080 SvPV_free(sv); /* No longer using what was there before. */
3081 SvPV_set(sv, (char*)recoded);
3082 SvCUR_set(sv, len - 1);
3083 SvLEN_set(sv, len); /* No longer know the real size. */
3087 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3094 =for apidoc sv_utf8_downgrade
3096 Attempts to convert the PV of an SV from characters to bytes.
3097 If the PV contains a character beyond byte, this conversion will fail;
3098 in this case, either returns false or, if C<fail_ok> is not
3101 This is not as a general purpose Unicode to byte encoding interface:
3102 use the Encode extension for that.
3108 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3111 if (SvPOKp(sv) && SvUTF8(sv)) {
3117 sv_force_normal_flags(sv, 0);
3119 s = (U8 *) SvPV(sv, len);
3120 if (!utf8_to_bytes(s, &len)) {
3125 Perl_croak(aTHX_ "Wide character in %s",
3128 Perl_croak(aTHX_ "Wide character");
3139 =for apidoc sv_utf8_encode
3141 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3142 flag off so that it looks like octets again.
3148 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3151 sv_force_normal_flags(sv, 0);
3153 if (SvREADONLY(sv)) {
3154 Perl_croak(aTHX_ PL_no_modify);
3156 (void) sv_utf8_upgrade(sv);
3161 =for apidoc sv_utf8_decode
3163 If the PV of the SV is an octet sequence in UTF-8
3164 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3165 so that it looks like a character. If the PV contains only single-byte
3166 characters, the C<SvUTF8> flag stays being off.
3167 Scans PV for validity and returns false if the PV is invalid UTF-8.
3173 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3179 /* The octets may have got themselves encoded - get them back as
3182 if (!sv_utf8_downgrade(sv, TRUE))
3185 /* it is actually just a matter of turning the utf8 flag on, but
3186 * we want to make sure everything inside is valid utf8 first.
3188 c = (const U8 *) SvPVX_const(sv);
3189 if (!is_utf8_string(c, SvCUR(sv)+1))
3191 e = (const U8 *) SvEND(sv);
3194 if (!UTF8_IS_INVARIANT(ch)) {
3204 =for apidoc sv_setsv
3206 Copies the contents of the source SV C<ssv> into the destination SV
3207 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3208 function if the source SV needs to be reused. Does not handle 'set' magic.
3209 Loosely speaking, it performs a copy-by-value, obliterating any previous
3210 content of the destination.
3212 You probably want to use one of the assortment of wrappers, such as
3213 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3214 C<SvSetMagicSV_nosteal>.
3216 =for apidoc sv_setsv_flags
3218 Copies the contents of the source SV C<ssv> into the destination SV
3219 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3220 function if the source SV needs to be reused. Does not handle 'set' magic.
3221 Loosely speaking, it performs a copy-by-value, obliterating any previous
3222 content of the destination.
3223 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3224 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3225 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3226 and C<sv_setsv_nomg> are implemented in terms of this function.
3228 You probably want to use one of the assortment of wrappers, such as
3229 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3230 C<SvSetMagicSV_nosteal>.
3232 This is the primary function for copying scalars, and most other
3233 copy-ish functions and macros use this underneath.
3239 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3241 if (dtype != SVt_PVGV) {
3242 const char * const name = GvNAME(sstr);
3243 const STRLEN len = GvNAMELEN(sstr);
3244 /* don't upgrade SVt_PVLV: it can hold a glob */
3245 if (dtype != SVt_PVLV) {
3246 if (dtype >= SVt_PV) {
3252 sv_upgrade(dstr, SVt_PVGV);
3253 (void)SvOK_off(dstr);
3256 GvSTASH(dstr) = GvSTASH(sstr);
3258 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3259 gv_name_set((GV *)dstr, name, len, GV_ADD);
3260 SvFAKE_on(dstr); /* can coerce to non-glob */
3263 #ifdef GV_UNIQUE_CHECK
3264 if (GvUNIQUE((GV*)dstr)) {
3265 Perl_croak(aTHX_ PL_no_modify);
3271 (void)SvOK_off(dstr);
3273 GvINTRO_off(dstr); /* one-shot flag */
3274 GvGP(dstr) = gp_ref(GvGP(sstr));
3275 if (SvTAINTED(sstr))
3277 if (GvIMPORTED(dstr) != GVf_IMPORTED
3278 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3280 GvIMPORTED_on(dstr);
3287 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3288 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3290 const int intro = GvINTRO(dstr);
3293 const U32 stype = SvTYPE(sref);
3296 #ifdef GV_UNIQUE_CHECK
3297 if (GvUNIQUE((GV*)dstr)) {
3298 Perl_croak(aTHX_ PL_no_modify);
3303 GvINTRO_off(dstr); /* one-shot flag */
3304 GvLINE(dstr) = CopLINE(PL_curcop);
3305 GvEGV(dstr) = (GV*)dstr;
3310 location = (SV **) &GvCV(dstr);
3311 import_flag = GVf_IMPORTED_CV;
3314 location = (SV **) &GvHV(dstr);
3315 import_flag = GVf_IMPORTED_HV;
3318 location = (SV **) &GvAV(dstr);
3319 import_flag = GVf_IMPORTED_AV;
3322 location = (SV **) &GvIOp(dstr);
3325 location = (SV **) &GvFORM(dstr);
3327 location = &GvSV(dstr);
3328 import_flag = GVf_IMPORTED_SV;
3331 if (stype == SVt_PVCV) {
3332 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3333 SvREFCNT_dec(GvCV(dstr));
3335 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3336 PL_sub_generation++;
3339 SAVEGENERICSV(*location);
3343 if (stype == SVt_PVCV && *location != sref) {
3344 CV* const cv = (CV*)*location;
3346 if (!GvCVGEN((GV*)dstr) &&
3347 (CvROOT(cv) || CvXSUB(cv)))
3349 /* Redefining a sub - warning is mandatory if
3350 it was a const and its value changed. */
3351 if (CvCONST(cv) && CvCONST((CV*)sref)
3352 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3354 /* They are 2 constant subroutines generated from
3355 the same constant. This probably means that
3356 they are really the "same" proxy subroutine
3357 instantiated in 2 places. Most likely this is
3358 when a constant is exported twice. Don't warn.
3361 else if (ckWARN(WARN_REDEFINE)
3363 && (!CvCONST((CV*)sref)
3364 || sv_cmp(cv_const_sv(cv),
3365 cv_const_sv((CV*)sref))))) {
3366 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3369 ? "Constant subroutine %s::%s redefined"
3370 : "Subroutine %s::%s redefined"),
3371 HvNAME_get(GvSTASH((GV*)dstr)),
3372 GvENAME((GV*)dstr));
3376 cv_ckproto_len(cv, (GV*)dstr,
3377 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3378 SvPOK(sref) ? SvCUR(sref) : 0);
3380 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3381 GvASSUMECV_on(dstr);
3382 PL_sub_generation++;
3385 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3386 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3387 GvFLAGS(dstr) |= import_flag;
3392 if (SvTAINTED(sstr))
3398 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3401 register U32 sflags;
3403 register svtype stype;
3408 if (SvIS_FREED(dstr)) {
3409 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3410 " to a freed scalar %p", sstr, dstr);
3412 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3414 sstr = &PL_sv_undef;
3415 if (SvIS_FREED(sstr)) {
3416 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3419 stype = SvTYPE(sstr);
3420 dtype = SvTYPE(dstr);
3425 /* need to nuke the magic */
3427 SvRMAGICAL_off(dstr);
3430 /* There's a lot of redundancy below but we're going for speed here */
3435 if (dtype != SVt_PVGV) {
3436 (void)SvOK_off(dstr);
3444 sv_upgrade(dstr, SVt_IV);
3449 sv_upgrade(dstr, SVt_PVIV);
3452 (void)SvIOK_only(dstr);
3453 SvIV_set(dstr, SvIVX(sstr));
3456 /* SvTAINTED can only be true if the SV has taint magic, which in
3457 turn means that the SV type is PVMG (or greater). This is the
3458 case statement for SVt_IV, so this cannot be true (whatever gcov
3460 assert(!SvTAINTED(sstr));
3470 sv_upgrade(dstr, SVt_NV);
3475 sv_upgrade(dstr, SVt_PVNV);
3478 SvNV_set(dstr, SvNVX(sstr));
3479 (void)SvNOK_only(dstr);
3480 /* SvTAINTED can only be true if the SV has taint magic, which in
3481 turn means that the SV type is PVMG (or greater). This is the
3482 case statement for SVt_NV, so this cannot be true (whatever gcov
3484 assert(!SvTAINTED(sstr));
3491 sv_upgrade(dstr, SVt_RV);
3494 #ifdef PERL_OLD_COPY_ON_WRITE
3495 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3496 if (dtype < SVt_PVIV)
3497 sv_upgrade(dstr, SVt_PVIV);
3504 sv_upgrade(dstr, SVt_PV);
3507 if (dtype < SVt_PVIV)
3508 sv_upgrade(dstr, SVt_PVIV);
3511 if (dtype < SVt_PVNV)
3512 sv_upgrade(dstr, SVt_PVNV);
3516 const char * const type = sv_reftype(sstr,0);
3518 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3520 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3525 if (dtype <= SVt_PVGV) {
3526 glob_assign_glob(dstr, sstr, dtype);
3534 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3536 if (SvTYPE(sstr) != stype) {
3537 stype = SvTYPE(sstr);
3538 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3539 glob_assign_glob(dstr, sstr, dtype);
3544 if (stype == SVt_PVLV)
3545 SvUPGRADE(dstr, SVt_PVNV);
3547 SvUPGRADE(dstr, (svtype)stype);
3550 /* dstr may have been upgraded. */
3551 dtype = SvTYPE(dstr);
3552 sflags = SvFLAGS(sstr);
3554 if (sflags & SVf_ROK) {
3555 if (dtype == SVt_PVGV &&
3556 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3559 if (GvIMPORTED(dstr) != GVf_IMPORTED
3560 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3562 GvIMPORTED_on(dstr);
3567 glob_assign_glob(dstr, sstr, dtype);
3571 if (dtype >= SVt_PV) {
3572 if (dtype == SVt_PVGV) {
3573 glob_assign_ref(dstr, sstr);
3576 if (SvPVX_const(dstr)) {
3582 (void)SvOK_off(dstr);
3583 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3584 SvFLAGS(dstr) |= sflags & SVf_ROK;
3585 assert(!(sflags & SVp_NOK));
3586 assert(!(sflags & SVp_IOK));
3587 assert(!(sflags & SVf_NOK));
3588 assert(!(sflags & SVf_IOK));
3590 else if (dtype == SVt_PVGV) {
3591 if (!(sflags & SVf_OK)) {
3592 if (ckWARN(WARN_MISC))
3593 Perl_warner(aTHX_ packWARN(WARN_MISC),
3594 "Undefined value assigned to typeglob");
3597 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3598 if (dstr != (SV*)gv) {
3601 GvGP(dstr) = gp_ref(GvGP(gv));
3605 else if (sflags & SVp_POK) {
3609 * Check to see if we can just swipe the string. If so, it's a
3610 * possible small lose on short strings, but a big win on long ones.
3611 * It might even be a win on short strings if SvPVX_const(dstr)
3612 * has to be allocated and SvPVX_const(sstr) has to be freed.
3615 /* Whichever path we take through the next code, we want this true,
3616 and doing it now facilitates the COW check. */
3617 (void)SvPOK_only(dstr);
3620 /* We're not already COW */
3621 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3622 #ifndef PERL_OLD_COPY_ON_WRITE
3623 /* or we are, but dstr isn't a suitable target. */
3624 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3629 (sflags & SVs_TEMP) && /* slated for free anyway? */
3630 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3631 (!(flags & SV_NOSTEAL)) &&
3632 /* and we're allowed to steal temps */
3633 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3634 SvLEN(sstr) && /* and really is a string */
3635 /* and won't be needed again, potentially */
3636 !(PL_op && PL_op->op_type == OP_AASSIGN))
3637 #ifdef PERL_OLD_COPY_ON_WRITE
3638 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3639 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3640 && SvTYPE(sstr) >= SVt_PVIV)
3643 /* Failed the swipe test, and it's not a shared hash key either.
3644 Have to copy the string. */
3645 STRLEN len = SvCUR(sstr);
3646 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3647 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3648 SvCUR_set(dstr, len);
3649 *SvEND(dstr) = '\0';
3651 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3653 /* Either it's a shared hash key, or it's suitable for
3654 copy-on-write or we can swipe the string. */
3656 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3660 #ifdef PERL_OLD_COPY_ON_WRITE
3662 /* I believe I should acquire a global SV mutex if
3663 it's a COW sv (not a shared hash key) to stop
3664 it going un copy-on-write.
3665 If the source SV has gone un copy on write between up there
3666 and down here, then (assert() that) it is of the correct
3667 form to make it copy on write again */
3668 if ((sflags & (SVf_FAKE | SVf_READONLY))
3669 != (SVf_FAKE | SVf_READONLY)) {
3670 SvREADONLY_on(sstr);
3672 /* Make the source SV into a loop of 1.
3673 (about to become 2) */
3674 SV_COW_NEXT_SV_SET(sstr, sstr);
3678 /* Initial code is common. */
3679 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3684 /* making another shared SV. */
3685 STRLEN cur = SvCUR(sstr);
3686 STRLEN len = SvLEN(sstr);
3687 #ifdef PERL_OLD_COPY_ON_WRITE
3689 assert (SvTYPE(dstr) >= SVt_PVIV);
3690 /* SvIsCOW_normal */
3691 /* splice us in between source and next-after-source. */
3692 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3693 SV_COW_NEXT_SV_SET(sstr, dstr);
3694 SvPV_set(dstr, SvPVX_mutable(sstr));
3698 /* SvIsCOW_shared_hash */
3699 DEBUG_C(PerlIO_printf(Perl_debug_log,
3700 "Copy on write: Sharing hash\n"));
3702 assert (SvTYPE(dstr) >= SVt_PV);
3704 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3706 SvLEN_set(dstr, len);
3707 SvCUR_set(dstr, cur);
3708 SvREADONLY_on(dstr);
3710 /* Relesase a global SV mutex. */
3713 { /* Passes the swipe test. */
3714 SvPV_set(dstr, SvPVX_mutable(sstr));
3715 SvLEN_set(dstr, SvLEN(sstr));
3716 SvCUR_set(dstr, SvCUR(sstr));
3719 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3720 SvPV_set(sstr, NULL);
3726 if (sflags & SVp_NOK) {
3727 SvNV_set(dstr, SvNVX(sstr));
3729 if (sflags & SVp_IOK) {
3730 SvRELEASE_IVX(dstr);
3731 SvIV_set(dstr, SvIVX(sstr));
3732 /* Must do this otherwise some other overloaded use of 0x80000000
3733 gets confused. I guess SVpbm_VALID */
3734 if (sflags & SVf_IVisUV)
3737 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3739 const MAGIC * const smg = SvVSTRING_mg(sstr);
3741 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3742 smg->mg_ptr, smg->mg_len);
3743 SvRMAGICAL_on(dstr);
3747 else if (sflags & (SVp_IOK|SVp_NOK)) {
3748 (void)SvOK_off(dstr);
3749 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3750 if (sflags & SVp_IOK) {
3751 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3752 SvIV_set(dstr, SvIVX(sstr));
3754 if (sflags & SVp_NOK) {
3755 SvNV_set(dstr, SvNVX(sstr));
3759 if (isGV_with_GP(sstr)) {
3760 /* This stringification rule for globs is spread in 3 places.
3761 This feels bad. FIXME. */
3762 const U32 wasfake = sflags & SVf_FAKE;
3764 /* FAKE globs can get coerced, so need to turn this off
3765 temporarily if it is on. */
3767 gv_efullname3(dstr, (GV *)sstr, "*");
3768 SvFLAGS(sstr) |= wasfake;
3771 (void)SvOK_off(dstr);
3773 if (SvTAINTED(sstr))
3778 =for apidoc sv_setsv_mg
3780 Like C<sv_setsv>, but also handles 'set' magic.
3786 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3788 sv_setsv(dstr,sstr);
3792 #ifdef PERL_OLD_COPY_ON_WRITE
3794 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3796 STRLEN cur = SvCUR(sstr);
3797 STRLEN len = SvLEN(sstr);
3798 register char *new_pv;
3801 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3809 if (SvTHINKFIRST(dstr))
3810 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3811 else if (SvPVX_const(dstr))
3812 Safefree(SvPVX_const(dstr));
3816 SvUPGRADE(dstr, SVt_PVIV);
3818 assert (SvPOK(sstr));
3819 assert (SvPOKp(sstr));
3820 assert (!SvIOK(sstr));
3821 assert (!SvIOKp(sstr));
3822 assert (!SvNOK(sstr));
3823 assert (!SvNOKp(sstr));
3825 if (SvIsCOW(sstr)) {
3827 if (SvLEN(sstr) == 0) {
3828 /* source is a COW shared hash key. */
3829 DEBUG_C(PerlIO_printf(Perl_debug_log,
3830 "Fast copy on write: Sharing hash\n"));
3831 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3834 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3836 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3837 SvUPGRADE(sstr, SVt_PVIV);
3838 SvREADONLY_on(sstr);
3840 DEBUG_C(PerlIO_printf(Perl_debug_log,
3841 "Fast copy on write: Converting sstr to COW\n"));
3842 SV_COW_NEXT_SV_SET(dstr, sstr);
3844 SV_COW_NEXT_SV_SET(sstr, dstr);
3845 new_pv = SvPVX_mutable(sstr);
3848 SvPV_set(dstr, new_pv);
3849 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3852 SvLEN_set(dstr, len);
3853 SvCUR_set(dstr, cur);
3862 =for apidoc sv_setpvn
3864 Copies a string into an SV. The C<len> parameter indicates the number of
3865 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3866 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3872 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3875 register char *dptr;
3877 SV_CHECK_THINKFIRST_COW_DROP(sv);
3883 /* len is STRLEN which is unsigned, need to copy to signed */
3886 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3888 SvUPGRADE(sv, SVt_PV);
3890 dptr = SvGROW(sv, len + 1);
3891 Move(ptr,dptr,len,char);
3894 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3899 =for apidoc sv_setpvn_mg
3901 Like C<sv_setpvn>, but also handles 'set' magic.
3907 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3909 sv_setpvn(sv,ptr,len);
3914 =for apidoc sv_setpv
3916 Copies a string into an SV. The string must be null-terminated. Does not
3917 handle 'set' magic. See C<sv_setpv_mg>.
3923 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3926 register STRLEN len;
3928 SV_CHECK_THINKFIRST_COW_DROP(sv);
3934 SvUPGRADE(sv, SVt_PV);
3936 SvGROW(sv, len + 1);
3937 Move(ptr,SvPVX(sv),len+1,char);
3939 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3944 =for apidoc sv_setpv_mg
3946 Like C<sv_setpv>, but also handles 'set' magic.
3952 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3959 =for apidoc sv_usepvn_flags
3961 Tells an SV to use C<ptr> to find its string value. Normally the
3962 string is stored inside the SV but sv_usepvn allows the SV to use an
3963 outside string. The C<ptr> should point to memory that was allocated
3964 by C<malloc>. The string length, C<len>, must be supplied. By default
3965 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3966 so that pointer should not be freed or used by the programmer after
3967 giving it to sv_usepvn, and neither should any pointers from "behind"
3968 that pointer (e.g. ptr + 1) be used.
3970 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3971 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3972 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3973 C<len>, and already meets the requirements for storing in C<SvPVX>)
3979 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3983 SV_CHECK_THINKFIRST_COW_DROP(sv);
3984 SvUPGRADE(sv, SVt_PV);
3987 if (flags & SV_SMAGIC)
3991 if (SvPVX_const(sv))
3995 if (flags & SV_HAS_TRAILING_NUL)
3996 assert(ptr[len] == '\0');
3999 allocate = (flags & SV_HAS_TRAILING_NUL)
4000 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4001 if (flags & SV_HAS_TRAILING_NUL) {
4002 /* It's long enough - do nothing.
4003 Specfically Perl_newCONSTSUB is relying on this. */
4006 /* Force a move to shake out bugs in callers. */
4007 char *new_ptr = (char*)safemalloc(allocate);
4008 Copy(ptr, new_ptr, len, char);
4009 PoisonFree(ptr,len,char);
4013 ptr = (char*) saferealloc (ptr, allocate);
4018 SvLEN_set(sv, allocate);
4019 if (!(flags & SV_HAS_TRAILING_NUL)) {
4022 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4024 if (flags & SV_SMAGIC)
4028 #ifdef PERL_OLD_COPY_ON_WRITE
4029 /* Need to do this *after* making the SV normal, as we need the buffer
4030 pointer to remain valid until after we've copied it. If we let go too early,
4031 another thread could invalidate it by unsharing last of the same hash key
4032 (which it can do by means other than releasing copy-on-write Svs)
4033 or by changing the other copy-on-write SVs in the loop. */
4035 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4037 if (len) { /* this SV was SvIsCOW_normal(sv) */
4038 /* we need to find the SV pointing to us. */
4039 SV *current = SV_COW_NEXT_SV(after);
4041 if (current == sv) {
4042 /* The SV we point to points back to us (there were only two of us
4044 Hence other SV is no longer copy on write either. */
4046 SvREADONLY_off(after);
4048 /* We need to follow the pointers around the loop. */
4050 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4053 /* don't loop forever if the structure is bust, and we have
4054 a pointer into a closed loop. */
4055 assert (current != after);
4056 assert (SvPVX_const(current) == pvx);
4058 /* Make the SV before us point to the SV after us. */
4059 SV_COW_NEXT_SV_SET(current, after);
4062 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4067 Perl_sv_release_IVX(pTHX_ register SV *sv)
4070 sv_force_normal_flags(sv, 0);
4076 =for apidoc sv_force_normal_flags
4078 Undo various types of fakery on an SV: if the PV is a shared string, make
4079 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4080 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4081 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4082 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4083 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4084 set to some other value.) In addition, the C<flags> parameter gets passed to
4085 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4086 with flags set to 0.
4092 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4095 #ifdef PERL_OLD_COPY_ON_WRITE
4096 if (SvREADONLY(sv)) {
4097 /* At this point I believe I should acquire a global SV mutex. */
4099 const char * const pvx = SvPVX_const(sv);
4100 const STRLEN len = SvLEN(sv);
4101 const STRLEN cur = SvCUR(sv);
4102 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4104 PerlIO_printf(Perl_debug_log,
4105 "Copy on write: Force normal %ld\n",
4111 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4114 if (flags & SV_COW_DROP_PV) {
4115 /* OK, so we don't need to copy our buffer. */
4118 SvGROW(sv, cur + 1);
4119 Move(pvx,SvPVX(sv),cur,char);
4123 sv_release_COW(sv, pvx, len, next);
4128 else if (IN_PERL_RUNTIME)
4129 Perl_croak(aTHX_ PL_no_modify);
4130 /* At this point I believe that I can drop the global SV mutex. */
4133 if (SvREADONLY(sv)) {
4135 const char * const pvx = SvPVX_const(sv);
4136 const STRLEN len = SvCUR(sv);
4141 SvGROW(sv, len + 1);
4142 Move(pvx,SvPVX(sv),len,char);
4144 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4146 else if (IN_PERL_RUNTIME)
4147 Perl_croak(aTHX_ PL_no_modify);
4151 sv_unref_flags(sv, flags);
4152 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4159 Efficient removal of characters from the beginning of the string buffer.
4160 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4161 the string buffer. The C<ptr> becomes the first character of the adjusted
4162 string. Uses the "OOK hack".
4163 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4164 refer to the same chunk of data.
4170 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4172 register STRLEN delta;
4173 if (!ptr || !SvPOKp(sv))
4175 delta = ptr - SvPVX_const(sv);
4176 SV_CHECK_THINKFIRST(sv);
4177 if (SvTYPE(sv) < SVt_PVIV)
4178 sv_upgrade(sv,SVt_PVIV);
4181 if (!SvLEN(sv)) { /* make copy of shared string */
4182 const char *pvx = SvPVX_const(sv);
4183 const STRLEN len = SvCUR(sv);
4184 SvGROW(sv, len + 1);
4185 Move(pvx,SvPVX(sv),len,char);
4189 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4190 and we do that anyway inside the SvNIOK_off
4192 SvFLAGS(sv) |= SVf_OOK;
4195 SvLEN_set(sv, SvLEN(sv) - delta);
4196 SvCUR_set(sv, SvCUR(sv) - delta);
4197 SvPV_set(sv, SvPVX(sv) + delta);
4198 SvIV_set(sv, SvIVX(sv) + delta);
4202 =for apidoc sv_catpvn
4204 Concatenates the string onto the end of the string which is in the SV. The
4205 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4206 status set, then the bytes appended should be valid UTF-8.
4207 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4209 =for apidoc sv_catpvn_flags
4211 Concatenates the string onto the end of the string which is in the SV. The
4212 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4213 status set, then the bytes appended should be valid UTF-8.
4214 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4215 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4216 in terms of this function.
4222 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4226 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4228 SvGROW(dsv, dlen + slen + 1);
4230 sstr = SvPVX_const(dsv);
4231 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4232 SvCUR_set(dsv, SvCUR(dsv) + slen);
4234 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4236 if (flags & SV_SMAGIC)
4241 =for apidoc sv_catsv
4243 Concatenates the string from SV C<ssv> onto the end of the string in
4244 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4245 not 'set' magic. See C<sv_catsv_mg>.
4247 =for apidoc sv_catsv_flags
4249 Concatenates the string from SV C<ssv> onto the end of the string in
4250 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4251 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4252 and C<sv_catsv_nomg> are implemented in terms of this function.
4257 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4262 const char *spv = SvPV_const(ssv, slen);
4264 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4265 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4266 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4267 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4268 dsv->sv_flags doesn't have that bit set.
4269 Andy Dougherty 12 Oct 2001
4271 const I32 sutf8 = DO_UTF8(ssv);
4274 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4276 dutf8 = DO_UTF8(dsv);
4278 if (dutf8 != sutf8) {
4280 /* Not modifying source SV, so taking a temporary copy. */
4281 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4283 sv_utf8_upgrade(csv);
4284 spv = SvPV_const(csv, slen);
4287 sv_utf8_upgrade_nomg(dsv);
4289 sv_catpvn_nomg(dsv, spv, slen);
4292 if (flags & SV_SMAGIC)
4297 =for apidoc sv_catpv
4299 Concatenates the string onto the end of the string which is in the SV.
4300 If the SV has the UTF-8 status set, then the bytes appended should be
4301 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4306 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4309 register STRLEN len;
4315 junk = SvPV_force(sv, tlen);
4317 SvGROW(sv, tlen + len + 1);
4319 ptr = SvPVX_const(sv);
4320 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4321 SvCUR_set(sv, SvCUR(sv) + len);
4322 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4327 =for apidoc sv_catpv_mg
4329 Like C<sv_catpv>, but also handles 'set' magic.
4335 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4344 Creates a new SV. A non-zero C<len> parameter indicates the number of
4345 bytes of preallocated string space the SV should have. An extra byte for a
4346 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4347 space is allocated.) The reference count for the new SV is set to 1.
4349 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4350 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4351 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4352 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4353 modules supporting older perls.
4359 Perl_newSV(pTHX_ STRLEN len)
4366 sv_upgrade(sv, SVt_PV);
4367 SvGROW(sv, len + 1);
4372 =for apidoc sv_magicext
4374 Adds magic to an SV, upgrading it if necessary. Applies the
4375 supplied vtable and returns a pointer to the magic added.
4377 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4378 In particular, you can add magic to SvREADONLY SVs, and add more than
4379 one instance of the same 'how'.
4381 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4382 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4383 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4384 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4386 (This is now used as a subroutine by C<sv_magic>.)
4391 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4392 const char* name, I32 namlen)
4397 if (SvTYPE(sv) < SVt_PVMG) {
4398 SvUPGRADE(sv, SVt_PVMG);
4400 Newxz(mg, 1, MAGIC);
4401 mg->mg_moremagic = SvMAGIC(sv);
4402 SvMAGIC_set(sv, mg);
4404 /* Sometimes a magic contains a reference loop, where the sv and
4405 object refer to each other. To prevent a reference loop that
4406 would prevent such objects being freed, we look for such loops
4407 and if we find one we avoid incrementing the object refcount.
4409 Note we cannot do this to avoid self-tie loops as intervening RV must
4410 have its REFCNT incremented to keep it in existence.
4413 if (!obj || obj == sv ||
4414 how == PERL_MAGIC_arylen ||
4415 how == PERL_MAGIC_qr ||
4416 how == PERL_MAGIC_symtab ||
4417 (SvTYPE(obj) == SVt_PVGV &&
4418 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4419 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4420 GvFORM(obj) == (CV*)sv)))
4425 mg->mg_obj = SvREFCNT_inc_simple(obj);
4426 mg->mg_flags |= MGf_REFCOUNTED;
4429 /* Normal self-ties simply pass a null object, and instead of
4430 using mg_obj directly, use the SvTIED_obj macro to produce a
4431 new RV as needed. For glob "self-ties", we are tieing the PVIO
4432 with an RV obj pointing to the glob containing the PVIO. In
4433 this case, to avoid a reference loop, we need to weaken the
4437 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4438 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4444 mg->mg_len = namlen;
4447 mg->mg_ptr = savepvn(name, namlen);
4448 else if (namlen == HEf_SVKEY)
4449 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4451 mg->mg_ptr = (char *) name;
4453 mg->mg_virtual = vtable;
4457 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4462 =for apidoc sv_magic
4464 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4465 then adds a new magic item of type C<how> to the head of the magic list.
4467 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4468 handling of the C<name> and C<namlen> arguments.
4470 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4471 to add more than one instance of the same 'how'.
4477 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4483 #ifdef PERL_OLD_COPY_ON_WRITE
4485 sv_force_normal_flags(sv, 0);
4487 if (SvREADONLY(sv)) {
4489 /* its okay to attach magic to shared strings; the subsequent
4490 * upgrade to PVMG will unshare the string */
4491 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4494 && how != PERL_MAGIC_regex_global
4495 && how != PERL_MAGIC_bm
4496 && how != PERL_MAGIC_fm
4497 && how != PERL_MAGIC_sv
4498 && how != PERL_MAGIC_backref
4501 Perl_croak(aTHX_ PL_no_modify);
4504 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4505 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4506 /* sv_magic() refuses to add a magic of the same 'how' as an
4509 if (how == PERL_MAGIC_taint) {
4511 /* Any scalar which already had taint magic on which someone
4512 (erroneously?) did SvIOK_on() or similar will now be
4513 incorrectly sporting public "OK" flags. */
4514 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4522 vtable = &PL_vtbl_sv;
4524 case PERL_MAGIC_overload:
4525 vtable = &PL_vtbl_amagic;
4527 case PERL_MAGIC_overload_elem:
4528 vtable = &PL_vtbl_amagicelem;
4530 case PERL_MAGIC_overload_table:
4531 vtable = &PL_vtbl_ovrld;
4534 vtable = &PL_vtbl_bm;
4536 case PERL_MAGIC_regdata:
4537 vtable = &PL_vtbl_regdata;
4539 case PERL_MAGIC_regdata_names:
4540 vtable = &PL_vtbl_regdata_names;
4542 case PERL_MAGIC_regdatum:
4543 vtable = &PL_vtbl_regdatum;
4545 case PERL_MAGIC_env:
4546 vtable = &PL_vtbl_env;
4549 vtable = &PL_vtbl_fm;
4551 case PERL_MAGIC_envelem:
4552 vtable = &PL_vtbl_envelem;
4554 case PERL_MAGIC_regex_global:
4555 vtable = &PL_vtbl_mglob;
4557 case PERL_MAGIC_isa:
4558 vtable = &PL_vtbl_isa;
4560 case PERL_MAGIC_isaelem:
4561 vtable = &PL_vtbl_isaelem;
4563 case PERL_MAGIC_nkeys:
4564 vtable = &PL_vtbl_nkeys;
4566 case PERL_MAGIC_dbfile:
4569 case PERL_MAGIC_dbline:
4570 vtable = &PL_vtbl_dbline;
4572 #ifdef USE_LOCALE_COLLATE
4573 case PERL_MAGIC_collxfrm:
4574 vtable = &PL_vtbl_collxfrm;
4576 #endif /* USE_LOCALE_COLLATE */
4577 case PERL_MAGIC_tied:
4578 vtable = &PL_vtbl_pack;
4580 case PERL_MAGIC_tiedelem:
4581 case PERL_MAGIC_tiedscalar:
4582 vtable = &PL_vtbl_packelem;
4585 vtable = &PL_vtbl_regexp;
4587 case PERL_MAGIC_hints:
4588 /* As this vtable is all NULL, we can reuse it. */
4589 case PERL_MAGIC_sig:
4590 vtable = &PL_vtbl_sig;
4592 case PERL_MAGIC_sigelem:
4593 vtable = &PL_vtbl_sigelem;
4595 case PERL_MAGIC_taint:
4596 vtable = &PL_vtbl_taint;
4598 case PERL_MAGIC_uvar:
4599 vtable = &PL_vtbl_uvar;
4601 case PERL_MAGIC_vec:
4602 vtable = &PL_vtbl_vec;
4604 case PERL_MAGIC_arylen_p:
4605 case PERL_MAGIC_rhash:
4606 case PERL_MAGIC_symtab:
4607 case PERL_MAGIC_vstring:
4610 case PERL_MAGIC_utf8:
4611 vtable = &PL_vtbl_utf8;
4613 case PERL_MAGIC_substr:
4614 vtable = &PL_vtbl_substr;
4616 case PERL_MAGIC_defelem:
4617 vtable = &PL_vtbl_defelem;
4619 case PERL_MAGIC_arylen:
4620 vtable = &PL_vtbl_arylen;
4622 case PERL_MAGIC_pos:
4623 vtable = &PL_vtbl_pos;
4625 case PERL_MAGIC_backref:
4626 vtable = &PL_vtbl_backref;
4628 case PERL_MAGIC_hintselem:
4629 vtable = &PL_vtbl_hintselem;
4631 case PERL_MAGIC_ext:
4632 /* Reserved for use by extensions not perl internals. */
4633 /* Useful for attaching extension internal data to perl vars. */
4634 /* Note that multiple extensions may clash if magical scalars */
4635 /* etc holding private data from one are passed to another. */
4639 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4642 /* Rest of work is done else where */
4643 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4646 case PERL_MAGIC_taint:
4649 case PERL_MAGIC_ext:
4650 case PERL_MAGIC_dbfile:
4657 =for apidoc sv_unmagic
4659 Removes all magic of type C<type> from an SV.
4665 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4669 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4671 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4672 for (mg = *mgp; mg; mg = *mgp) {
4673 if (mg->mg_type == type) {
4674 const MGVTBL* const vtbl = mg->mg_virtual;
4675 *mgp = mg->mg_moremagic;
4676 if (vtbl && vtbl->svt_free)
4677 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4678 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4680 Safefree(mg->mg_ptr);
4681 else if (mg->mg_len == HEf_SVKEY)
4682 SvREFCNT_dec((SV*)mg->mg_ptr);
4683 else if (mg->mg_type == PERL_MAGIC_utf8)
4684 Safefree(mg->mg_ptr);
4686 if (mg->mg_flags & MGf_REFCOUNTED)
4687 SvREFCNT_dec(mg->mg_obj);
4691 mgp = &mg->mg_moremagic;
4695 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4696 SvMAGIC_set(sv, NULL);
4703 =for apidoc sv_rvweaken
4705 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4706 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4707 push a back-reference to this RV onto the array of backreferences
4708 associated with that magic. If the RV is magical, set magic will be
4709 called after the RV is cleared.
4715 Perl_sv_rvweaken(pTHX_ SV *sv)
4718 if (!SvOK(sv)) /* let undefs pass */
4721 Perl_croak(aTHX_ "Can't weaken a nonreference");
4722 else if (SvWEAKREF(sv)) {
4723 if (ckWARN(WARN_MISC))
4724 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4728 Perl_sv_add_backref(aTHX_ tsv, sv);
4734 /* Give tsv backref magic if it hasn't already got it, then push a
4735 * back-reference to sv onto the array associated with the backref magic.
4739 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4744 if (SvTYPE(tsv) == SVt_PVHV) {
4745 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4749 /* There is no AV in the offical place - try a fixup. */
4750 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4753 /* Aha. They've got it stowed in magic. Bring it back. */
4754 av = (AV*)mg->mg_obj;
4755 /* Stop mg_free decreasing the refernce count. */
4757 /* Stop mg_free even calling the destructor, given that
4758 there's no AV to free up. */
4760 sv_unmagic(tsv, PERL_MAGIC_backref);
4764 SvREFCNT_inc_simple_void(av);
4769 const MAGIC *const mg
4770 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4772 av = (AV*)mg->mg_obj;
4776 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4777 /* av now has a refcnt of 2, which avoids it getting freed
4778 * before us during global cleanup. The extra ref is removed
4779 * by magic_killbackrefs() when tsv is being freed */
4782 if (AvFILLp(av) >= AvMAX(av)) {
4783 av_extend(av, AvFILLp(av)+1);
4785 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4788 /* delete a back-reference to ourselves from the backref magic associated
4789 * with the SV we point to.
4793 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4800 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4801 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4802 /* We mustn't attempt to "fix up" the hash here by moving the
4803 backreference array back to the hv_aux structure, as that is stored
4804 in the main HvARRAY(), and hfreentries assumes that no-one
4805 reallocates HvARRAY() while it is running. */
4808 const MAGIC *const mg
4809 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4811 av = (AV *)mg->mg_obj;
4814 if (PL_in_clean_all)
4816 Perl_croak(aTHX_ "panic: del_backref");
4823 /* We shouldn't be in here more than once, but for paranoia reasons lets
4825 for (i = AvFILLp(av); i >= 0; i--) {
4827 const SSize_t fill = AvFILLp(av);
4829 /* We weren't the last entry.
4830 An unordered list has this property that you can take the
4831 last element off the end to fill the hole, and it's still
4832 an unordered list :-)
4837 AvFILLp(av) = fill - 1;
4843 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4845 SV **svp = AvARRAY(av);
4847 PERL_UNUSED_ARG(sv);
4849 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4850 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4851 if (svp && !SvIS_FREED(av)) {
4852 SV *const *const last = svp + AvFILLp(av);
4854 while (svp <= last) {
4856 SV *const referrer = *svp;
4857 if (SvWEAKREF(referrer)) {
4858 /* XXX Should we check that it hasn't changed? */
4859 SvRV_set(referrer, 0);
4861 SvWEAKREF_off(referrer);
4862 SvSETMAGIC(referrer);
4863 } else if (SvTYPE(referrer) == SVt_PVGV ||
4864 SvTYPE(referrer) == SVt_PVLV) {
4865 /* You lookin' at me? */
4866 assert(GvSTASH(referrer));
4867 assert(GvSTASH(referrer) == (HV*)sv);
4868 GvSTASH(referrer) = 0;
4871 "panic: magic_killbackrefs (flags=%"UVxf")",
4872 (UV)SvFLAGS(referrer));
4880 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4885 =for apidoc sv_insert
4887 Inserts a string at the specified offset/length within the SV. Similar to
4888 the Perl substr() function.
4894 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4899 register char *midend;
4900 register char *bigend;
4906 Perl_croak(aTHX_ "Can't modify non-existent substring");
4907 SvPV_force(bigstr, curlen);
4908 (void)SvPOK_only_UTF8(bigstr);
4909 if (offset + len > curlen) {
4910 SvGROW(bigstr, offset+len+1);
4911 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4912 SvCUR_set(bigstr, offset+len);
4916 i = littlelen - len;
4917 if (i > 0) { /* string might grow */
4918 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4919 mid = big + offset + len;
4920 midend = bigend = big + SvCUR(bigstr);
4923 while (midend > mid) /* shove everything down */
4924 *--bigend = *--midend;
4925 Move(little,big+offset,littlelen,char);
4926 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4931 Move(little,SvPVX(bigstr)+offset,len,char);
4936 big = SvPVX(bigstr);
4939 bigend = big + SvCUR(bigstr);
4941 if (midend > bigend)
4942 Perl_croak(aTHX_ "panic: sv_insert");
4944 if (mid - big > bigend - midend) { /* faster to shorten from end */
4946 Move(little, mid, littlelen,char);
4949 i = bigend - midend;
4951 Move(midend, mid, i,char);
4955 SvCUR_set(bigstr, mid - big);
4957 else if ((i = mid - big)) { /* faster from front */
4958 midend -= littlelen;
4960 sv_chop(bigstr,midend-i);
4965 Move(little, mid, littlelen,char);
4967 else if (littlelen) {
4968 midend -= littlelen;
4969 sv_chop(bigstr,midend);
4970 Move(little,midend,littlelen,char);
4973 sv_chop(bigstr,midend);
4979 =for apidoc sv_replace
4981 Make the first argument a copy of the second, then delete the original.
4982 The target SV physically takes over ownership of the body of the source SV
4983 and inherits its flags; however, the target keeps any magic it owns,
4984 and any magic in the source is discarded.
4985 Note that this is a rather specialist SV copying operation; most of the
4986 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4992 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4995 const U32 refcnt = SvREFCNT(sv);
4996 SV_CHECK_THINKFIRST_COW_DROP(sv);
4997 if (SvREFCNT(nsv) != 1) {
4998 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4999 UVuf " != 1)", (UV) SvREFCNT(nsv));
5001 if (SvMAGICAL(sv)) {
5005 sv_upgrade(nsv, SVt_PVMG);
5006 SvMAGIC_set(nsv, SvMAGIC(sv));
5007 SvFLAGS(nsv) |= SvMAGICAL(sv);
5009 SvMAGIC_set(sv, NULL);
5013 assert(!SvREFCNT(sv));
5014 #ifdef DEBUG_LEAKING_SCALARS
5015 sv->sv_flags = nsv->sv_flags;
5016 sv->sv_any = nsv->sv_any;
5017 sv->sv_refcnt = nsv->sv_refcnt;
5018 sv->sv_u = nsv->sv_u;
5020 StructCopy(nsv,sv,SV);
5022 /* Currently could join these into one piece of pointer arithmetic, but
5023 it would be unclear. */
5024 if(SvTYPE(sv) == SVt_IV)
5026 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5027 else if (SvTYPE(sv) == SVt_RV) {
5028 SvANY(sv) = &sv->sv_u.svu_rv;
5032 #ifdef PERL_OLD_COPY_ON_WRITE
5033 if (SvIsCOW_normal(nsv)) {
5034 /* We need to follow the pointers around the loop to make the
5035 previous SV point to sv, rather than nsv. */
5038 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5041 assert(SvPVX_const(current) == SvPVX_const(nsv));
5043 /* Make the SV before us point to the SV after us. */
5045 PerlIO_printf(Perl_debug_log, "previous is\n");
5047 PerlIO_printf(Perl_debug_log,
5048 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5049 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5051 SV_COW_NEXT_SV_SET(current, sv);
5054 SvREFCNT(sv) = refcnt;
5055 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5061 =for apidoc sv_clear
5063 Clear an SV: call any destructors, free up any memory used by the body,
5064 and free the body itself. The SV's head is I<not> freed, although
5065 its type is set to all 1's so that it won't inadvertently be assumed
5066 to be live during global destruction etc.
5067 This function should only be called when REFCNT is zero. Most of the time
5068 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5075 Perl_sv_clear(pTHX_ register SV *sv)
5078 const U32 type = SvTYPE(sv);
5079 const struct body_details *const sv_type_details
5080 = bodies_by_type + type;
5083 assert(SvREFCNT(sv) == 0);
5085 if (type <= SVt_IV) {
5086 /* See the comment in sv.h about the collusion between this early
5087 return and the overloading of the NULL and IV slots in the size
5093 if (PL_defstash) { /* Still have a symbol table? */
5098 stash = SvSTASH(sv);
5099 destructor = StashHANDLER(stash,DESTROY);
5101 SV* const tmpref = newRV(sv);
5102 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5104 PUSHSTACKi(PERLSI_DESTROY);
5109 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5115 if(SvREFCNT(tmpref) < 2) {
5116 /* tmpref is not kept alive! */
5118 SvRV_set(tmpref, NULL);
5121 SvREFCNT_dec(tmpref);
5123 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5127 if (PL_in_clean_objs)
5128 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5130 /* DESTROY gave object new lease on life */
5136 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5137 SvOBJECT_off(sv); /* Curse the object. */
5138 if (type != SVt_PVIO)
5139 --PL_sv_objcount; /* XXX Might want something more general */
5142 if (type >= SVt_PVMG) {
5143 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5144 SvREFCNT_dec(OURSTASH(sv));
5145 } else if (SvMAGIC(sv))
5147 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5148 SvREFCNT_dec(SvSTASH(sv));
5153 IoIFP(sv) != PerlIO_stdin() &&
5154 IoIFP(sv) != PerlIO_stdout() &&
5155 IoIFP(sv) != PerlIO_stderr())
5157 io_close((IO*)sv, FALSE);
5159 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5160 PerlDir_close(IoDIRP(sv));
5161 IoDIRP(sv) = (DIR*)NULL;
5162 Safefree(IoTOP_NAME(sv));
5163 Safefree(IoFMT_NAME(sv));
5164 Safefree(IoBOTTOM_NAME(sv));
5173 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5180 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5181 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5182 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5183 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5185 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5186 SvREFCNT_dec(LvTARG(sv));
5190 if (GvNAME_HEK(sv)) {
5191 unshare_hek(GvNAME_HEK(sv));
5193 /* If we're in a stash, we don't own a reference to it. However it does
5194 have a back reference to us, which needs to be cleared. */
5196 sv_del_backref((SV*)GvSTASH(sv), sv);
5201 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5203 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5204 /* Don't even bother with turning off the OOK flag. */
5209 SV * const target = SvRV(sv);
5211 sv_del_backref(target, sv);
5213 SvREFCNT_dec(target);
5215 #ifdef PERL_OLD_COPY_ON_WRITE
5216 else if (SvPVX_const(sv)) {
5218 /* I believe I need to grab the global SV mutex here and
5219 then recheck the COW status. */
5221 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5224 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5225 SV_COW_NEXT_SV(sv));
5226 /* And drop it here. */
5228 } else if (SvLEN(sv)) {
5229 Safefree(SvPVX_const(sv));
5233 else if (SvPVX_const(sv) && SvLEN(sv))
5234 Safefree(SvPVX_mutable(sv));
5235 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5236 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5245 SvFLAGS(sv) &= SVf_BREAK;
5246 SvFLAGS(sv) |= SVTYPEMASK;
5248 if (sv_type_details->arena) {
5249 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5250 &PL_body_roots[type]);
5252 else if (sv_type_details->body_size) {
5253 my_safefree(SvANY(sv));
5258 =for apidoc sv_newref
5260 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5267 Perl_sv_newref(pTHX_ SV *sv)
5269 PERL_UNUSED_CONTEXT;
5278 Decrement an SV's reference count, and if it drops to zero, call
5279 C<sv_clear> to invoke destructors and free up any memory used by
5280 the body; finally, deallocate the SV's head itself.
5281 Normally called via a wrapper macro C<SvREFCNT_dec>.
5287 Perl_sv_free(pTHX_ SV *sv)
5292 if (SvREFCNT(sv) == 0) {
5293 if (SvFLAGS(sv) & SVf_BREAK)
5294 /* this SV's refcnt has been artificially decremented to
5295 * trigger cleanup */
5297 if (PL_in_clean_all) /* All is fair */
5299 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5300 /* make sure SvREFCNT(sv)==0 happens very seldom */
5301 SvREFCNT(sv) = (~(U32)0)/2;
5304 if (ckWARN_d(WARN_INTERNAL)) {
5305 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5306 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5307 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5308 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5309 Perl_dump_sv_child(aTHX_ sv);
5314 if (--(SvREFCNT(sv)) > 0)
5316 Perl_sv_free2(aTHX_ sv);
5320 Perl_sv_free2(pTHX_ SV *sv)
5325 if (ckWARN_d(WARN_DEBUGGING))
5326 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5327 "Attempt to free temp prematurely: SV 0x%"UVxf
5328 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5332 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5333 /* make sure SvREFCNT(sv)==0 happens very seldom */
5334 SvREFCNT(sv) = (~(U32)0)/2;
5345 Returns the length of the string in the SV. Handles magic and type
5346 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5352 Perl_sv_len(pTHX_ register SV *sv)
5360 len = mg_length(sv);
5362 (void)SvPV_const(sv, len);
5367 =for apidoc sv_len_utf8
5369 Returns the number of characters in the string in an SV, counting wide
5370 UTF-8 bytes as a single character. Handles magic and type coercion.
5376 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5377 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5378 * (Note that the mg_len is not the length of the mg_ptr field.
5379 * This allows the cache to store the character length of the string without
5380 * needing to malloc() extra storage to attach to the mg_ptr.)
5385 Perl_sv_len_utf8(pTHX_ register SV *sv)
5391 return mg_length(sv);
5395 const U8 *s = (U8*)SvPV_const(sv, len);
5399 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5401 if (mg && mg->mg_len != -1) {
5403 if (PL_utf8cache < 0) {
5404 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5406 /* Need to turn the assertions off otherwise we may
5407 recurse infinitely while printing error messages.
5409 SAVEI8(PL_utf8cache);
5411 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5412 " real %"UVuf" for %"SVf,
5413 (UV) ulen, (UV) real, (void*)sv);
5418 ulen = Perl_utf8_length(aTHX_ s, s + len);
5419 if (!SvREADONLY(sv)) {
5421 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5422 &PL_vtbl_utf8, 0, 0);
5430 return Perl_utf8_length(aTHX_ s, s + len);
5434 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5437 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5440 const U8 *s = start;
5442 while (s < send && uoffset--)
5445 /* This is the existing behaviour. Possibly it should be a croak, as
5446 it's actually a bounds error */
5452 /* Given the length of the string in both bytes and UTF-8 characters, decide
5453 whether to walk forwards or backwards to find the byte corresponding to
5454 the passed in UTF-8 offset. */
5456 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5457 STRLEN uoffset, STRLEN uend)
5459 STRLEN backw = uend - uoffset;
5460 if (uoffset < 2 * backw) {
5461 /* The assumption is that going forwards is twice the speed of going
5462 forward (that's where the 2 * backw comes from).
5463 (The real figure of course depends on the UTF-8 data.) */
5464 return sv_pos_u2b_forwards(start, send, uoffset);
5469 while (UTF8_IS_CONTINUATION(*send))
5472 return send - start;
5475 /* For the string representation of the given scalar, find the byte
5476 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5477 give another position in the string, *before* the sought offset, which
5478 (which is always true, as 0, 0 is a valid pair of positions), which should
5479 help reduce the amount of linear searching.
5480 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5481 will be used to reduce the amount of linear searching. The cache will be
5482 created if necessary, and the found value offered to it for update. */
5484 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5485 const U8 *const send, STRLEN uoffset,
5486 STRLEN uoffset0, STRLEN boffset0) {
5487 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5490 assert (uoffset >= uoffset0);
5492 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5493 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5494 if ((*mgp)->mg_ptr) {
5495 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5496 if (cache[0] == uoffset) {
5497 /* An exact match. */
5500 if (cache[2] == uoffset) {
5501 /* An exact match. */
5505 if (cache[0] < uoffset) {
5506 /* The cache already knows part of the way. */
5507 if (cache[0] > uoffset0) {
5508 /* The cache knows more than the passed in pair */
5509 uoffset0 = cache[0];
5510 boffset0 = cache[1];
5512 if ((*mgp)->mg_len != -1) {
5513 /* And we know the end too. */
5515 + sv_pos_u2b_midway(start + boffset0, send,
5517 (*mgp)->mg_len - uoffset0);
5520 + sv_pos_u2b_forwards(start + boffset0,
5521 send, uoffset - uoffset0);
5524 else if (cache[2] < uoffset) {
5525 /* We're between the two cache entries. */
5526 if (cache[2] > uoffset0) {
5527 /* and the cache knows more than the passed in pair */
5528 uoffset0 = cache[2];
5529 boffset0 = cache[3];
5533 + sv_pos_u2b_midway(start + boffset0,
5536 cache[0] - uoffset0);
5539 + sv_pos_u2b_midway(start + boffset0,
5542 cache[2] - uoffset0);
5546 else if ((*mgp)->mg_len != -1) {
5547 /* If we can take advantage of a passed in offset, do so. */
5548 /* In fact, offset0 is either 0, or less than offset, so don't
5549 need to worry about the other possibility. */
5551 + sv_pos_u2b_midway(start + boffset0, send,
5553 (*mgp)->mg_len - uoffset0);
5558 if (!found || PL_utf8cache < 0) {
5559 const STRLEN real_boffset
5560 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5561 send, uoffset - uoffset0);
5563 if (found && PL_utf8cache < 0) {
5564 if (real_boffset != boffset) {
5565 /* Need to turn the assertions off otherwise we may recurse
5566 infinitely while printing error messages. */
5567 SAVEI8(PL_utf8cache);
5569 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5570 " real %"UVuf" for %"SVf,
5571 (UV) boffset, (UV) real_boffset, (void*)sv);
5574 boffset = real_boffset;
5577 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5583 =for apidoc sv_pos_u2b
5585 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5586 the start of the string, to a count of the equivalent number of bytes; if
5587 lenp is non-zero, it does the same to lenp, but this time starting from
5588 the offset, rather than from the start of the string. Handles magic and
5595 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5596 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5597 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5602 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5610 start = (U8*)SvPV_const(sv, len);
5612 STRLEN uoffset = (STRLEN) *offsetp;
5613 const U8 * const send = start + len;
5615 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5618 *offsetp = (I32) boffset;
5621 /* Convert the relative offset to absolute. */
5622 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5623 const STRLEN boffset2
5624 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5625 uoffset, boffset) - boffset;
5639 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5640 byte length pairing. The (byte) length of the total SV is passed in too,
5641 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5642 may not have updated SvCUR, so we can't rely on reading it directly.
5644 The proffered utf8/byte length pairing isn't used if the cache already has
5645 two pairs, and swapping either for the proffered pair would increase the
5646 RMS of the intervals between known byte offsets.
5648 The cache itself consists of 4 STRLEN values
5649 0: larger UTF-8 offset
5650 1: corresponding byte offset
5651 2: smaller UTF-8 offset
5652 3: corresponding byte offset
5654 Unused cache pairs have the value 0, 0.
5655 Keeping the cache "backwards" means that the invariant of
5656 cache[0] >= cache[2] is maintained even with empty slots, which means that
5657 the code that uses it doesn't need to worry if only 1 entry has actually
5658 been set to non-zero. It also makes the "position beyond the end of the
5659 cache" logic much simpler, as the first slot is always the one to start
5663 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5671 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5673 (*mgp)->mg_len = -1;
5677 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5678 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5679 (*mgp)->mg_ptr = (char *) cache;
5683 if (PL_utf8cache < 0) {
5684 const U8 *start = (const U8 *) SvPVX_const(sv);
5685 const STRLEN realutf8 = utf8_length(start, start + byte);
5687 if (realutf8 != utf8) {
5688 /* Need to turn the assertions off otherwise we may recurse
5689 infinitely while printing error messages. */
5690 SAVEI8(PL_utf8cache);
5692 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5693 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5697 /* Cache is held with the later position first, to simplify the code
5698 that deals with unbounded ends. */
5700 ASSERT_UTF8_CACHE(cache);
5701 if (cache[1] == 0) {
5702 /* Cache is totally empty */
5705 } else if (cache[3] == 0) {
5706 if (byte > cache[1]) {
5707 /* New one is larger, so goes first. */
5708 cache[2] = cache[0];
5709 cache[3] = cache[1];
5717 #define THREEWAY_SQUARE(a,b,c,d) \
5718 ((float)((d) - (c))) * ((float)((d) - (c))) \
5719 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5720 + ((float)((b) - (a))) * ((float)((b) - (a)))
5722 /* Cache has 2 slots in use, and we know three potential pairs.
5723 Keep the two that give the lowest RMS distance. Do the
5724 calcualation in bytes simply because we always know the byte
5725 length. squareroot has the same ordering as the positive value,
5726 so don't bother with the actual square root. */
5727 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5728 if (byte > cache[1]) {
5729 /* New position is after the existing pair of pairs. */
5730 const float keep_earlier
5731 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5732 const float keep_later
5733 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5735 if (keep_later < keep_earlier) {
5736 if (keep_later < existing) {
5737 cache[2] = cache[0];
5738 cache[3] = cache[1];
5744 if (keep_earlier < existing) {
5750 else if (byte > cache[3]) {
5751 /* New position is between the existing pair of pairs. */
5752 const float keep_earlier
5753 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5754 const float keep_later
5755 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5757 if (keep_later < keep_earlier) {
5758 if (keep_later < existing) {
5764 if (keep_earlier < existing) {
5771 /* New position is before the existing pair of pairs. */
5772 const float keep_earlier
5773 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5774 const float keep_later
5775 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5777 if (keep_later < keep_earlier) {
5778 if (keep_later < existing) {
5784 if (keep_earlier < existing) {
5785 cache[0] = cache[2];
5786 cache[1] = cache[3];
5793 ASSERT_UTF8_CACHE(cache);
5796 /* We already know all of the way, now we may be able to walk back. The same
5797 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5798 backward is half the speed of walking forward. */
5800 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5803 const STRLEN forw = target - s;
5804 STRLEN backw = end - target;
5806 if (forw < 2 * backw) {
5807 return utf8_length(s, target);
5810 while (end > target) {
5812 while (UTF8_IS_CONTINUATION(*end)) {
5821 =for apidoc sv_pos_b2u
5823 Converts the value pointed to by offsetp from a count of bytes from the
5824 start of the string, to a count of the equivalent number of UTF-8 chars.
5825 Handles magic and type coercion.
5831 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5832 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5837 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5840 const STRLEN byte = *offsetp;
5841 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5850 s = (const U8*)SvPV_const(sv, blen);
5853 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5857 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5858 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5860 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5861 if (cache[1] == byte) {
5862 /* An exact match. */
5863 *offsetp = cache[0];
5866 if (cache[3] == byte) {
5867 /* An exact match. */
5868 *offsetp = cache[2];
5872 if (cache[1] < byte) {
5873 /* We already know part of the way. */
5874 if (mg->mg_len != -1) {
5875 /* Actually, we know the end too. */
5877 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5878 s + blen, mg->mg_len - cache[0]);
5880 len = cache[0] + utf8_length(s + cache[1], send);
5883 else if (cache[3] < byte) {
5884 /* We're between the two cached pairs, so we do the calculation
5885 offset by the byte/utf-8 positions for the earlier pair,
5886 then add the utf-8 characters from the string start to
5888 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5889 s + cache[1], cache[0] - cache[2])
5893 else { /* cache[3] > byte */
5894 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5898 ASSERT_UTF8_CACHE(cache);
5900 } else if (mg->mg_len != -1) {
5901 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5905 if (!found || PL_utf8cache < 0) {
5906 const STRLEN real_len = utf8_length(s, send);
5908 if (found && PL_utf8cache < 0) {
5909 if (len != real_len) {
5910 /* Need to turn the assertions off otherwise we may recurse
5911 infinitely while printing error messages. */
5912 SAVEI8(PL_utf8cache);
5914 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5915 " real %"UVuf" for %"SVf,
5916 (UV) len, (UV) real_len, (void*)sv);
5923 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5929 Returns a boolean indicating whether the strings in the two SVs are
5930 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5931 coerce its args to strings if necessary.
5937 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5946 SV* svrecode = NULL;
5953 /* if pv1 and pv2 are the same, second SvPV_const call may
5954 * invalidate pv1, so we may need to make a copy */
5955 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5956 pv1 = SvPV_const(sv1, cur1);
5957 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5958 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5960 pv1 = SvPV_const(sv1, cur1);
5968 pv2 = SvPV_const(sv2, cur2);
5970 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5971 /* Differing utf8ness.
5972 * Do not UTF8size the comparands as a side-effect. */
5975 svrecode = newSVpvn(pv2, cur2);
5976 sv_recode_to_utf8(svrecode, PL_encoding);
5977 pv2 = SvPV_const(svrecode, cur2);
5980 svrecode = newSVpvn(pv1, cur1);
5981 sv_recode_to_utf8(svrecode, PL_encoding);
5982 pv1 = SvPV_const(svrecode, cur1);
5984 /* Now both are in UTF-8. */
5986 SvREFCNT_dec(svrecode);
5991 bool is_utf8 = TRUE;
5994 /* sv1 is the UTF-8 one,
5995 * if is equal it must be downgrade-able */
5996 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6002 /* sv2 is the UTF-8 one,
6003 * if is equal it must be downgrade-able */
6004 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6010 /* Downgrade not possible - cannot be eq */
6018 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6020 SvREFCNT_dec(svrecode);
6030 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6031 string in C<sv1> is less than, equal to, or greater than the string in
6032 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6033 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6039 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6043 const char *pv1, *pv2;
6046 SV *svrecode = NULL;
6053 pv1 = SvPV_const(sv1, cur1);
6060 pv2 = SvPV_const(sv2, cur2);
6062 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6063 /* Differing utf8ness.
6064 * Do not UTF8size the comparands as a side-effect. */
6067 svrecode = newSVpvn(pv2, cur2);
6068 sv_recode_to_utf8(svrecode, PL_encoding);
6069 pv2 = SvPV_const(svrecode, cur2);
6072 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6077 svrecode = newSVpvn(pv1, cur1);
6078 sv_recode_to_utf8(svrecode, PL_encoding);
6079 pv1 = SvPV_const(svrecode, cur1);
6082 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6088 cmp = cur2 ? -1 : 0;
6092 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6095 cmp = retval < 0 ? -1 : 1;
6096 } else if (cur1 == cur2) {
6099 cmp = cur1 < cur2 ? -1 : 1;
6103 SvREFCNT_dec(svrecode);
6111 =for apidoc sv_cmp_locale
6113 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6114 'use bytes' aware, handles get magic, and will coerce its args to strings
6115 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6121 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6124 #ifdef USE_LOCALE_COLLATE
6130 if (PL_collation_standard)
6134 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6136 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6138 if (!pv1 || !len1) {
6149 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6152 return retval < 0 ? -1 : 1;
6155 * When the result of collation is equality, that doesn't mean
6156 * that there are no differences -- some locales exclude some
6157 * characters from consideration. So to avoid false equalities,
6158 * we use the raw string as a tiebreaker.
6164 #endif /* USE_LOCALE_COLLATE */
6166 return sv_cmp(sv1, sv2);
6170 #ifdef USE_LOCALE_COLLATE
6173 =for apidoc sv_collxfrm
6175 Add Collate Transform magic to an SV if it doesn't already have it.
6177 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6178 scalar data of the variable, but transformed to such a format that a normal
6179 memory comparison can be used to compare the data according to the locale
6186 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6191 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6192 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6198 Safefree(mg->mg_ptr);
6199 s = SvPV_const(sv, len);
6200 if ((xf = mem_collxfrm(s, len, &xlen))) {
6201 if (SvREADONLY(sv)) {
6204 return xf + sizeof(PL_collation_ix);
6207 #ifdef PERL_OLD_COPY_ON_WRITE
6209 sv_force_normal_flags(sv, 0);
6211 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6225 if (mg && mg->mg_ptr) {
6227 return mg->mg_ptr + sizeof(PL_collation_ix);
6235 #endif /* USE_LOCALE_COLLATE */
6240 Get a line from the filehandle and store it into the SV, optionally
6241 appending to the currently-stored string.
6247 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6252 register STDCHAR rslast;
6253 register STDCHAR *bp;
6258 if (SvTHINKFIRST(sv))
6259 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6260 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6262 However, perlbench says it's slower, because the existing swipe code
6263 is faster than copy on write.
6264 Swings and roundabouts. */
6265 SvUPGRADE(sv, SVt_PV);
6270 if (PerlIO_isutf8(fp)) {
6272 sv_utf8_upgrade_nomg(sv);
6273 sv_pos_u2b(sv,&append,0);
6275 } else if (SvUTF8(sv)) {
6276 SV * const tsv = newSV(0);
6277 sv_gets(tsv, fp, 0);
6278 sv_utf8_upgrade_nomg(tsv);
6279 SvCUR_set(sv,append);
6282 goto return_string_or_null;
6287 if (PerlIO_isutf8(fp))
6290 if (IN_PERL_COMPILETIME) {
6291 /* we always read code in line mode */
6295 else if (RsSNARF(PL_rs)) {
6296 /* If it is a regular disk file use size from stat() as estimate
6297 of amount we are going to read -- may result in mallocing
6298 more memory than we really need if the layers below reduce
6299 the size we read (e.g. CRLF or a gzip layer).
6302 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6303 const Off_t offset = PerlIO_tell(fp);
6304 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6305 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6311 else if (RsRECORD(PL_rs)) {
6316 /* Grab the size of the record we're getting */
6317 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6318 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6321 /* VMS wants read instead of fread, because fread doesn't respect */
6322 /* RMS record boundaries. This is not necessarily a good thing to be */
6323 /* doing, but we've got no other real choice - except avoid stdio
6324 as implementation - perhaps write a :vms layer ?
6326 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6328 bytesread = PerlIO_read(fp, buffer, recsize);
6332 SvCUR_set(sv, bytesread += append);
6333 buffer[bytesread] = '\0';
6334 goto return_string_or_null;
6336 else if (RsPARA(PL_rs)) {
6342 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6343 if (PerlIO_isutf8(fp)) {
6344 rsptr = SvPVutf8(PL_rs, rslen);
6347 if (SvUTF8(PL_rs)) {
6348 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6349 Perl_croak(aTHX_ "Wide character in $/");
6352 rsptr = SvPV_const(PL_rs, rslen);
6356 rslast = rslen ? rsptr[rslen - 1] : '\0';
6358 if (rspara) { /* have to do this both before and after */
6359 do { /* to make sure file boundaries work right */
6362 i = PerlIO_getc(fp);
6366 PerlIO_ungetc(fp,i);
6372 /* See if we know enough about I/O mechanism to cheat it ! */
6374 /* This used to be #ifdef test - it is made run-time test for ease
6375 of abstracting out stdio interface. One call should be cheap
6376 enough here - and may even be a macro allowing compile
6380 if (PerlIO_fast_gets(fp)) {
6383 * We're going to steal some values from the stdio struct
6384 * and put EVERYTHING in the innermost loop into registers.
6386 register STDCHAR *ptr;
6390 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6391 /* An ungetc()d char is handled separately from the regular
6392 * buffer, so we getc() it back out and stuff it in the buffer.
6394 i = PerlIO_getc(fp);
6395 if (i == EOF) return 0;
6396 *(--((*fp)->_ptr)) = (unsigned char) i;
6400 /* Here is some breathtakingly efficient cheating */
6402 cnt = PerlIO_get_cnt(fp); /* get count into register */
6403 /* make sure we have the room */
6404 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6405 /* Not room for all of it
6406 if we are looking for a separator and room for some
6408 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6409 /* just process what we have room for */
6410 shortbuffered = cnt - SvLEN(sv) + append + 1;
6411 cnt -= shortbuffered;
6415 /* remember that cnt can be negative */
6416 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6421 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6422 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6423 DEBUG_P(PerlIO_printf(Perl_debug_log,
6424 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6425 DEBUG_P(PerlIO_printf(Perl_debug_log,
6426 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6427 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6428 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6433 while (cnt > 0) { /* this | eat */
6435 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6436 goto thats_all_folks; /* screams | sed :-) */
6440 Copy(ptr, bp, cnt, char); /* this | eat */
6441 bp += cnt; /* screams | dust */
6442 ptr += cnt; /* louder | sed :-) */
6447 if (shortbuffered) { /* oh well, must extend */
6448 cnt = shortbuffered;
6450 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6452 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6453 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6457 DEBUG_P(PerlIO_printf(Perl_debug_log,
6458 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6459 PTR2UV(ptr),(long)cnt));
6460 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6462 DEBUG_P(PerlIO_printf(Perl_debug_log,
6463 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6464 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6465 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6467 /* This used to call 'filbuf' in stdio form, but as that behaves like
6468 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6469 another abstraction. */
6470 i = PerlIO_getc(fp); /* get more characters */
6472 DEBUG_P(PerlIO_printf(Perl_debug_log,
6473 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6474 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6475 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6477 cnt = PerlIO_get_cnt(fp);
6478 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6479 DEBUG_P(PerlIO_printf(Perl_debug_log,
6480 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6482 if (i == EOF) /* all done for ever? */
6483 goto thats_really_all_folks;
6485 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6487 SvGROW(sv, bpx + cnt + 2);
6488 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6490 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6492 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6493 goto thats_all_folks;
6497 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6498 memNE((char*)bp - rslen, rsptr, rslen))
6499 goto screamer; /* go back to the fray */
6500 thats_really_all_folks:
6502 cnt += shortbuffered;
6503 DEBUG_P(PerlIO_printf(Perl_debug_log,
6504 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6505 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6506 DEBUG_P(PerlIO_printf(Perl_debug_log,
6507 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6508 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6509 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6511 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6512 DEBUG_P(PerlIO_printf(Perl_debug_log,
6513 "Screamer: done, len=%ld, string=|%.*s|\n",
6514 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6518 /*The big, slow, and stupid way. */
6519 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6520 STDCHAR *buf = NULL;
6521 Newx(buf, 8192, STDCHAR);
6529 register const STDCHAR * const bpe = buf + sizeof(buf);
6531 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6532 ; /* keep reading */
6536 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6537 /* Accomodate broken VAXC compiler, which applies U8 cast to
6538 * both args of ?: operator, causing EOF to change into 255
6541 i = (U8)buf[cnt - 1];
6547 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6549 sv_catpvn(sv, (char *) buf, cnt);
6551 sv_setpvn(sv, (char *) buf, cnt);
6553 if (i != EOF && /* joy */
6555 SvCUR(sv) < rslen ||
6556 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6560 * If we're reading from a TTY and we get a short read,
6561 * indicating that the user hit his EOF character, we need
6562 * to notice it now, because if we try to read from the TTY
6563 * again, the EOF condition will disappear.
6565 * The comparison of cnt to sizeof(buf) is an optimization
6566 * that prevents unnecessary calls to feof().
6570 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6574 #ifdef USE_HEAP_INSTEAD_OF_STACK
6579 if (rspara) { /* have to do this both before and after */
6580 while (i != EOF) { /* to make sure file boundaries work right */
6581 i = PerlIO_getc(fp);
6583 PerlIO_ungetc(fp,i);
6589 return_string_or_null:
6590 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6596 Auto-increment of the value in the SV, doing string to numeric conversion
6597 if necessary. Handles 'get' magic.
6603 Perl_sv_inc(pTHX_ register SV *sv)
6612 if (SvTHINKFIRST(sv)) {
6614 sv_force_normal_flags(sv, 0);
6615 if (SvREADONLY(sv)) {
6616 if (IN_PERL_RUNTIME)
6617 Perl_croak(aTHX_ PL_no_modify);
6621 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6623 i = PTR2IV(SvRV(sv));
6628 flags = SvFLAGS(sv);
6629 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6630 /* It's (privately or publicly) a float, but not tested as an
6631 integer, so test it to see. */
6633 flags = SvFLAGS(sv);
6635 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6636 /* It's publicly an integer, or privately an integer-not-float */
6637 #ifdef PERL_PRESERVE_IVUV
6641 if (SvUVX(sv) == UV_MAX)
6642 sv_setnv(sv, UV_MAX_P1);
6644 (void)SvIOK_only_UV(sv);
6645 SvUV_set(sv, SvUVX(sv) + 1);
6647 if (SvIVX(sv) == IV_MAX)
6648 sv_setuv(sv, (UV)IV_MAX + 1);
6650 (void)SvIOK_only(sv);
6651 SvIV_set(sv, SvIVX(sv) + 1);
6656 if (flags & SVp_NOK) {
6657 (void)SvNOK_only(sv);
6658 SvNV_set(sv, SvNVX(sv) + 1.0);
6662 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6663 if ((flags & SVTYPEMASK) < SVt_PVIV)
6664 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6665 (void)SvIOK_only(sv);
6670 while (isALPHA(*d)) d++;
6671 while (isDIGIT(*d)) d++;
6673 #ifdef PERL_PRESERVE_IVUV
6674 /* Got to punt this as an integer if needs be, but we don't issue
6675 warnings. Probably ought to make the sv_iv_please() that does
6676 the conversion if possible, and silently. */
6677 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6678 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6679 /* Need to try really hard to see if it's an integer.
6680 9.22337203685478e+18 is an integer.
6681 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6682 so $a="9.22337203685478e+18"; $a+0; $a++
6683 needs to be the same as $a="9.22337203685478e+18"; $a++
6690 /* sv_2iv *should* have made this an NV */
6691 if (flags & SVp_NOK) {
6692 (void)SvNOK_only(sv);
6693 SvNV_set(sv, SvNVX(sv) + 1.0);
6696 /* I don't think we can get here. Maybe I should assert this
6697 And if we do get here I suspect that sv_setnv will croak. NWC
6699 #if defined(USE_LONG_DOUBLE)
6700 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",
6701 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6703 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6704 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6707 #endif /* PERL_PRESERVE_IVUV */
6708 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6712 while (d >= SvPVX_const(sv)) {
6720 /* MKS: The original code here died if letters weren't consecutive.
6721 * at least it didn't have to worry about non-C locales. The
6722 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6723 * arranged in order (although not consecutively) and that only
6724 * [A-Za-z] are accepted by isALPHA in the C locale.
6726 if (*d != 'z' && *d != 'Z') {
6727 do { ++*d; } while (!isALPHA(*d));
6730 *(d--) -= 'z' - 'a';
6735 *(d--) -= 'z' - 'a' + 1;
6739 /* oh,oh, the number grew */
6740 SvGROW(sv, SvCUR(sv) + 2);
6741 SvCUR_set(sv, SvCUR(sv) + 1);
6742 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6753 Auto-decrement of the value in the SV, doing string to numeric conversion
6754 if necessary. Handles 'get' magic.
6760 Perl_sv_dec(pTHX_ register SV *sv)
6768 if (SvTHINKFIRST(sv)) {
6770 sv_force_normal_flags(sv, 0);
6771 if (SvREADONLY(sv)) {
6772 if (IN_PERL_RUNTIME)
6773 Perl_croak(aTHX_ PL_no_modify);
6777 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6779 i = PTR2IV(SvRV(sv));
6784 /* Unlike sv_inc we don't have to worry about string-never-numbers
6785 and keeping them magic. But we mustn't warn on punting */
6786 flags = SvFLAGS(sv);
6787 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6788 /* It's publicly an integer, or privately an integer-not-float */
6789 #ifdef PERL_PRESERVE_IVUV
6793 if (SvUVX(sv) == 0) {
6794 (void)SvIOK_only(sv);
6798 (void)SvIOK_only_UV(sv);
6799 SvUV_set(sv, SvUVX(sv) - 1);
6802 if (SvIVX(sv) == IV_MIN)
6803 sv_setnv(sv, (NV)IV_MIN - 1.0);
6805 (void)SvIOK_only(sv);
6806 SvIV_set(sv, SvIVX(sv) - 1);
6811 if (flags & SVp_NOK) {
6812 SvNV_set(sv, SvNVX(sv) - 1.0);
6813 (void)SvNOK_only(sv);
6816 if (!(flags & SVp_POK)) {
6817 if ((flags & SVTYPEMASK) < SVt_PVIV)
6818 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6820 (void)SvIOK_only(sv);
6823 #ifdef PERL_PRESERVE_IVUV
6825 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6826 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6827 /* Need to try really hard to see if it's an integer.
6828 9.22337203685478e+18 is an integer.
6829 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6830 so $a="9.22337203685478e+18"; $a+0; $a--
6831 needs to be the same as $a="9.22337203685478e+18"; $a--
6838 /* sv_2iv *should* have made this an NV */
6839 if (flags & SVp_NOK) {
6840 (void)SvNOK_only(sv);
6841 SvNV_set(sv, SvNVX(sv) - 1.0);
6844 /* I don't think we can get here. Maybe I should assert this
6845 And if we do get here I suspect that sv_setnv will croak. NWC
6847 #if defined(USE_LONG_DOUBLE)
6848 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",
6849 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6851 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6852 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6856 #endif /* PERL_PRESERVE_IVUV */
6857 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6861 =for apidoc sv_mortalcopy
6863 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6864 The new SV is marked as mortal. It will be destroyed "soon", either by an
6865 explicit call to FREETMPS, or by an implicit call at places such as
6866 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6871 /* Make a string that will exist for the duration of the expression
6872 * evaluation. Actually, it may have to last longer than that, but
6873 * hopefully we won't free it until it has been assigned to a
6874 * permanent location. */
6877 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6883 sv_setsv(sv,oldstr);
6885 PL_tmps_stack[++PL_tmps_ix] = sv;
6891 =for apidoc sv_newmortal
6893 Creates a new null SV which is mortal. The reference count of the SV is
6894 set to 1. It will be destroyed "soon", either by an explicit call to
6895 FREETMPS, or by an implicit call at places such as statement boundaries.
6896 See also C<sv_mortalcopy> and C<sv_2mortal>.
6902 Perl_sv_newmortal(pTHX)
6908 SvFLAGS(sv) = SVs_TEMP;
6910 PL_tmps_stack[++PL_tmps_ix] = sv;
6915 =for apidoc sv_2mortal
6917 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6918 by an explicit call to FREETMPS, or by an implicit call at places such as
6919 statement boundaries. SvTEMP() is turned on which means that the SV's
6920 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6921 and C<sv_mortalcopy>.
6927 Perl_sv_2mortal(pTHX_ register SV *sv)
6932 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6935 PL_tmps_stack[++PL_tmps_ix] = sv;
6943 Creates a new SV and copies a string into it. The reference count for the
6944 SV is set to 1. If C<len> is zero, Perl will compute the length using
6945 strlen(). For efficiency, consider using C<newSVpvn> instead.
6951 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6957 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6962 =for apidoc newSVpvn
6964 Creates a new SV and copies a string into it. The reference count for the
6965 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6966 string. You are responsible for ensuring that the source string is at least
6967 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6973 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6979 sv_setpvn(sv,s,len);
6985 =for apidoc newSVhek
6987 Creates a new SV from the hash key structure. It will generate scalars that
6988 point to the shared string table where possible. Returns a new (undefined)
6989 SV if the hek is NULL.
6995 Perl_newSVhek(pTHX_ const HEK *hek)
7005 if (HEK_LEN(hek) == HEf_SVKEY) {
7006 return newSVsv(*(SV**)HEK_KEY(hek));
7008 const int flags = HEK_FLAGS(hek);
7009 if (flags & HVhek_WASUTF8) {
7011 Andreas would like keys he put in as utf8 to come back as utf8
7013 STRLEN utf8_len = HEK_LEN(hek);
7014 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7015 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7018 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7020 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7021 /* We don't have a pointer to the hv, so we have to replicate the
7022 flag into every HEK. This hv is using custom a hasing
7023 algorithm. Hence we can't return a shared string scalar, as
7024 that would contain the (wrong) hash value, and might get passed
7025 into an hv routine with a regular hash.
7026 Similarly, a hash that isn't using shared hash keys has to have
7027 the flag in every key so that we know not to try to call
7028 share_hek_kek on it. */
7030 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7035 /* This will be overwhelminly the most common case. */
7037 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7038 more efficient than sharepvn(). */
7042 sv_upgrade(sv, SVt_PV);
7043 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7044 SvCUR_set(sv, HEK_LEN(hek));
7057 =for apidoc newSVpvn_share
7059 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7060 table. If the string does not already exist in the table, it is created
7061 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7062 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7063 otherwise the hash is computed. The idea here is that as the string table
7064 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7065 hash lookup will avoid string compare.
7071 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7075 bool is_utf8 = FALSE;
7076 const char *const orig_src = src;
7079 STRLEN tmplen = -len;
7081 /* See the note in hv.c:hv_fetch() --jhi */
7082 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7086 PERL_HASH(hash, src, len);
7088 sv_upgrade(sv, SVt_PV);
7089 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7097 if (src != orig_src)
7103 #if defined(PERL_IMPLICIT_CONTEXT)
7105 /* pTHX_ magic can't cope with varargs, so this is a no-context
7106 * version of the main function, (which may itself be aliased to us).
7107 * Don't access this version directly.
7111 Perl_newSVpvf_nocontext(const char* pat, ...)
7116 va_start(args, pat);
7117 sv = vnewSVpvf(pat, &args);
7124 =for apidoc newSVpvf
7126 Creates a new SV and initializes it with the string formatted like
7133 Perl_newSVpvf(pTHX_ const char* pat, ...)
7137 va_start(args, pat);
7138 sv = vnewSVpvf(pat, &args);
7143 /* backend for newSVpvf() and newSVpvf_nocontext() */
7146 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7151 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7158 Creates a new SV and copies a floating point value into it.
7159 The reference count for the SV is set to 1.
7165 Perl_newSVnv(pTHX_ NV n)
7178 Creates a new SV and copies an integer into it. The reference count for the
7185 Perl_newSViv(pTHX_ IV i)
7198 Creates a new SV and copies an unsigned integer into it.
7199 The reference count for the SV is set to 1.
7205 Perl_newSVuv(pTHX_ UV u)
7216 =for apidoc newRV_noinc
7218 Creates an RV wrapper for an SV. The reference count for the original
7219 SV is B<not> incremented.
7225 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7231 sv_upgrade(sv, SVt_RV);
7233 SvRV_set(sv, tmpRef);
7238 /* newRV_inc is the official function name to use now.
7239 * newRV_inc is in fact #defined to newRV in sv.h
7243 Perl_newRV(pTHX_ SV *sv)
7246 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7252 Creates a new SV which is an exact duplicate of the original SV.
7259 Perl_newSVsv(pTHX_ register SV *old)
7266 if (SvTYPE(old) == SVTYPEMASK) {
7267 if (ckWARN_d(WARN_INTERNAL))
7268 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7272 /* SV_GMAGIC is the default for sv_setv()
7273 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7274 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7275 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7280 =for apidoc sv_reset
7282 Underlying implementation for the C<reset> Perl function.
7283 Note that the perl-level function is vaguely deprecated.
7289 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7292 char todo[PERL_UCHAR_MAX+1];
7297 if (!*s) { /* reset ?? searches */
7298 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7300 PMOP *pm = (PMOP *) mg->mg_obj;
7302 pm->op_pmdynflags &= ~PMdf_USED;
7309 /* reset variables */
7311 if (!HvARRAY(stash))
7314 Zero(todo, 256, char);
7317 I32 i = (unsigned char)*s;
7321 max = (unsigned char)*s++;
7322 for ( ; i <= max; i++) {
7325 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7327 for (entry = HvARRAY(stash)[i];
7329 entry = HeNEXT(entry))
7334 if (!todo[(U8)*HeKEY(entry)])
7336 gv = (GV*)HeVAL(entry);
7339 if (SvTHINKFIRST(sv)) {
7340 if (!SvREADONLY(sv) && SvROK(sv))
7342 /* XXX Is this continue a bug? Why should THINKFIRST
7343 exempt us from resetting arrays and hashes? */
7347 if (SvTYPE(sv) >= SVt_PV) {
7349 if (SvPVX_const(sv) != NULL)
7357 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7359 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7362 # if defined(USE_ENVIRON_ARRAY)
7365 # endif /* USE_ENVIRON_ARRAY */
7376 Using various gambits, try to get an IO from an SV: the IO slot if its a
7377 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7378 named after the PV if we're a string.
7384 Perl_sv_2io(pTHX_ SV *sv)
7389 switch (SvTYPE(sv)) {
7397 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7401 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7403 return sv_2io(SvRV(sv));
7404 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7410 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7419 Using various gambits, try to get a CV from an SV; in addition, try if
7420 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7421 The flags in C<lref> are passed to sv_fetchsv.
7427 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7438 switch (SvTYPE(sv)) {
7457 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7458 tryAMAGICunDEREF(to_cv);
7461 if (SvTYPE(sv) == SVt_PVCV) {
7470 Perl_croak(aTHX_ "Not a subroutine reference");
7475 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7481 /* Some flags to gv_fetchsv mean don't really create the GV */
7482 if (SvTYPE(gv) != SVt_PVGV) {
7488 if (lref && !GvCVu(gv)) {
7492 gv_efullname3(tmpsv, gv, NULL);
7493 /* XXX this is probably not what they think they're getting.
7494 * It has the same effect as "sub name;", i.e. just a forward
7496 newSUB(start_subparse(FALSE, 0),
7497 newSVOP(OP_CONST, 0, tmpsv),
7501 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7511 Returns true if the SV has a true value by Perl's rules.
7512 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7513 instead use an in-line version.
7519 Perl_sv_true(pTHX_ register SV *sv)
7524 register const XPV* const tXpv = (XPV*)SvANY(sv);
7526 (tXpv->xpv_cur > 1 ||
7527 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7534 return SvIVX(sv) != 0;
7537 return SvNVX(sv) != 0.0;
7539 return sv_2bool(sv);
7545 =for apidoc sv_pvn_force
7547 Get a sensible string out of the SV somehow.
7548 A private implementation of the C<SvPV_force> macro for compilers which
7549 can't cope with complex macro expressions. Always use the macro instead.
7551 =for apidoc sv_pvn_force_flags
7553 Get a sensible string out of the SV somehow.
7554 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7555 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7556 implemented in terms of this function.
7557 You normally want to use the various wrapper macros instead: see
7558 C<SvPV_force> and C<SvPV_force_nomg>
7564 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7567 if (SvTHINKFIRST(sv) && !SvROK(sv))
7568 sv_force_normal_flags(sv, 0);
7578 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7579 const char * const ref = sv_reftype(sv,0);
7581 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7582 ref, OP_NAME(PL_op));
7584 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7586 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7587 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7589 s = sv_2pv_flags(sv, &len, flags);
7593 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7596 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7597 SvGROW(sv, len + 1);
7598 Move(s,SvPVX(sv),len,char);
7603 SvPOK_on(sv); /* validate pointer */
7605 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7606 PTR2UV(sv),SvPVX_const(sv)));
7609 return SvPVX_mutable(sv);
7613 =for apidoc sv_pvbyten_force
7615 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7621 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7623 sv_pvn_force(sv,lp);
7624 sv_utf8_downgrade(sv,0);
7630 =for apidoc sv_pvutf8n_force
7632 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7638 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7640 sv_pvn_force(sv,lp);
7641 sv_utf8_upgrade(sv);
7647 =for apidoc sv_reftype
7649 Returns a string describing what the SV is a reference to.
7655 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7657 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7658 inside return suggests a const propagation bug in g++. */
7659 if (ob && SvOBJECT(sv)) {
7660 char * const name = HvNAME_get(SvSTASH(sv));
7661 return name ? name : (char *) "__ANON__";
7664 switch (SvTYPE(sv)) {
7681 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7682 /* tied lvalues should appear to be
7683 * scalars for backwards compatitbility */
7684 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7685 ? "SCALAR" : "LVALUE");
7686 case SVt_PVAV: return "ARRAY";
7687 case SVt_PVHV: return "HASH";
7688 case SVt_PVCV: return "CODE";
7689 case SVt_PVGV: return "GLOB";
7690 case SVt_PVFM: return "FORMAT";
7691 case SVt_PVIO: return "IO";
7692 default: return "UNKNOWN";
7698 =for apidoc sv_isobject
7700 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7701 object. If the SV is not an RV, or if the object is not blessed, then this
7708 Perl_sv_isobject(pTHX_ SV *sv)
7724 Returns a boolean indicating whether the SV is blessed into the specified
7725 class. This does not check for subtypes; use C<sv_derived_from> to verify
7726 an inheritance relationship.
7732 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7743 hvname = HvNAME_get(SvSTASH(sv));
7747 return strEQ(hvname, name);
7753 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7754 it will be upgraded to one. If C<classname> is non-null then the new SV will
7755 be blessed in the specified package. The new SV is returned and its
7756 reference count is 1.
7762 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7769 SV_CHECK_THINKFIRST_COW_DROP(rv);
7772 if (SvTYPE(rv) >= SVt_PVMG) {
7773 const U32 refcnt = SvREFCNT(rv);
7777 SvREFCNT(rv) = refcnt;
7779 sv_upgrade(rv, SVt_RV);
7780 } else if (SvROK(rv)) {
7781 SvREFCNT_dec(SvRV(rv));
7782 } else if (SvTYPE(rv) < SVt_RV)
7783 sv_upgrade(rv, SVt_RV);
7784 else if (SvTYPE(rv) > SVt_RV) {
7795 HV* const stash = gv_stashpv(classname, TRUE);
7796 (void)sv_bless(rv, stash);
7802 =for apidoc sv_setref_pv
7804 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7805 argument will be upgraded to an RV. That RV will be modified to point to
7806 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7807 into the SV. The C<classname> argument indicates the package for the
7808 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7809 will have a reference count of 1, and the RV will be returned.
7811 Do not use with other Perl types such as HV, AV, SV, CV, because those
7812 objects will become corrupted by the pointer copy process.
7814 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7820 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7824 sv_setsv(rv, &PL_sv_undef);
7828 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7833 =for apidoc sv_setref_iv
7835 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7836 argument will be upgraded to an RV. That RV will be modified to point to
7837 the new SV. The C<classname> argument indicates the package for the
7838 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7839 will have a reference count of 1, and the RV will be returned.
7845 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7847 sv_setiv(newSVrv(rv,classname), iv);
7852 =for apidoc sv_setref_uv
7854 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7855 argument will be upgraded to an RV. That RV will be modified to point to
7856 the new SV. The C<classname> argument indicates the package for the
7857 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7858 will have a reference count of 1, and the RV will be returned.
7864 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7866 sv_setuv(newSVrv(rv,classname), uv);
7871 =for apidoc sv_setref_nv
7873 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7874 argument will be upgraded to an RV. That RV will be modified to point to
7875 the new SV. The C<classname> argument indicates the package for the
7876 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7877 will have a reference count of 1, and the RV will be returned.
7883 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7885 sv_setnv(newSVrv(rv,classname), nv);
7890 =for apidoc sv_setref_pvn
7892 Copies a string into a new SV, optionally blessing the SV. The length of the
7893 string must be specified with C<n>. The C<rv> argument will be upgraded to
7894 an RV. That RV will be modified to point to the new SV. The C<classname>
7895 argument indicates the package for the blessing. Set C<classname> to
7896 C<NULL> to avoid the blessing. The new SV will have a reference count
7897 of 1, and the RV will be returned.
7899 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7905 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7907 sv_setpvn(newSVrv(rv,classname), pv, n);
7912 =for apidoc sv_bless
7914 Blesses an SV into a specified package. The SV must be an RV. The package
7915 must be designated by its stash (see C<gv_stashpv()>). The reference count
7916 of the SV is unaffected.
7922 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7927 Perl_croak(aTHX_ "Can't bless non-reference value");
7929 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7930 if (SvREADONLY(tmpRef))
7931 Perl_croak(aTHX_ PL_no_modify);
7932 if (SvOBJECT(tmpRef)) {
7933 if (SvTYPE(tmpRef) != SVt_PVIO)
7935 SvREFCNT_dec(SvSTASH(tmpRef));
7938 SvOBJECT_on(tmpRef);
7939 if (SvTYPE(tmpRef) != SVt_PVIO)
7941 SvUPGRADE(tmpRef, SVt_PVMG);
7942 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7949 if(SvSMAGICAL(tmpRef))
7950 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7958 /* Downgrades a PVGV to a PVMG.
7962 S_sv_unglob(pTHX_ SV *sv)
7966 SV * const temp = sv_newmortal();
7968 assert(SvTYPE(sv) == SVt_PVGV);
7970 gv_efullname3(temp, (GV *) sv, "*");
7976 sv_del_backref((SV*)GvSTASH(sv), sv);
7980 if (GvNAME_HEK(sv)) {
7981 unshare_hek(GvNAME_HEK(sv));
7985 /* need to keep SvANY(sv) in the right arena */
7986 xpvmg = new_XPVMG();
7987 StructCopy(SvANY(sv), xpvmg, XPVMG);
7988 del_XPVGV(SvANY(sv));
7991 SvFLAGS(sv) &= ~SVTYPEMASK;
7992 SvFLAGS(sv) |= SVt_PVMG;
7994 /* Intentionally not calling any local SET magic, as this isn't so much a
7995 set operation as merely an internal storage change. */
7996 sv_setsv_flags(sv, temp, 0);
8000 =for apidoc sv_unref_flags
8002 Unsets the RV status of the SV, and decrements the reference count of
8003 whatever was being referenced by the RV. This can almost be thought of
8004 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8005 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8006 (otherwise the decrementing is conditional on the reference count being
8007 different from one or the reference being a readonly SV).
8014 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8016 SV* const target = SvRV(ref);
8018 if (SvWEAKREF(ref)) {
8019 sv_del_backref(target, ref);
8021 SvRV_set(ref, NULL);
8024 SvRV_set(ref, NULL);
8026 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8027 assigned to as BEGIN {$a = \"Foo"} will fail. */
8028 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8029 SvREFCNT_dec(target);
8030 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8031 sv_2mortal(target); /* Schedule for freeing later */
8035 =for apidoc sv_untaint
8037 Untaint an SV. Use C<SvTAINTED_off> instead.
8042 Perl_sv_untaint(pTHX_ SV *sv)
8044 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8045 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8052 =for apidoc sv_tainted
8054 Test an SV for taintedness. Use C<SvTAINTED> instead.
8059 Perl_sv_tainted(pTHX_ SV *sv)
8061 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8062 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8063 if (mg && (mg->mg_len & 1) )
8070 =for apidoc sv_setpviv
8072 Copies an integer into the given SV, also updating its string value.
8073 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8079 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8081 char buf[TYPE_CHARS(UV)];
8083 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8085 sv_setpvn(sv, ptr, ebuf - ptr);
8089 =for apidoc sv_setpviv_mg
8091 Like C<sv_setpviv>, but also handles 'set' magic.
8097 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8103 #if defined(PERL_IMPLICIT_CONTEXT)
8105 /* pTHX_ magic can't cope with varargs, so this is a no-context
8106 * version of the main function, (which may itself be aliased to us).
8107 * Don't access this version directly.
8111 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8115 va_start(args, pat);
8116 sv_vsetpvf(sv, pat, &args);
8120 /* pTHX_ magic can't cope with varargs, so this is a no-context
8121 * version of the main function, (which may itself be aliased to us).
8122 * Don't access this version directly.
8126 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8130 va_start(args, pat);
8131 sv_vsetpvf_mg(sv, pat, &args);
8137 =for apidoc sv_setpvf
8139 Works like C<sv_catpvf> but copies the text into the SV instead of
8140 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8146 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8149 va_start(args, pat);
8150 sv_vsetpvf(sv, pat, &args);
8155 =for apidoc sv_vsetpvf
8157 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8158 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8160 Usually used via its frontend C<sv_setpvf>.
8166 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8168 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8172 =for apidoc sv_setpvf_mg
8174 Like C<sv_setpvf>, but also handles 'set' magic.
8180 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8183 va_start(args, pat);
8184 sv_vsetpvf_mg(sv, pat, &args);
8189 =for apidoc sv_vsetpvf_mg
8191 Like C<sv_vsetpvf>, but also handles 'set' magic.
8193 Usually used via its frontend C<sv_setpvf_mg>.
8199 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8201 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8205 #if defined(PERL_IMPLICIT_CONTEXT)
8207 /* pTHX_ magic can't cope with varargs, so this is a no-context
8208 * version of the main function, (which may itself be aliased to us).
8209 * Don't access this version directly.
8213 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8217 va_start(args, pat);
8218 sv_vcatpvf(sv, pat, &args);
8222 /* pTHX_ magic can't cope with varargs, so this is a no-context
8223 * version of the main function, (which may itself be aliased to us).
8224 * Don't access this version directly.
8228 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8232 va_start(args, pat);
8233 sv_vcatpvf_mg(sv, pat, &args);
8239 =for apidoc sv_catpvf
8241 Processes its arguments like C<sprintf> and appends the formatted
8242 output to an SV. If the appended data contains "wide" characters
8243 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8244 and characters >255 formatted with %c), the original SV might get
8245 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8246 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8247 valid UTF-8; if the original SV was bytes, the pattern should be too.
8252 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8255 va_start(args, pat);
8256 sv_vcatpvf(sv, pat, &args);
8261 =for apidoc sv_vcatpvf
8263 Processes its arguments like C<vsprintf> and appends the formatted output
8264 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8266 Usually used via its frontend C<sv_catpvf>.
8272 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8274 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8278 =for apidoc sv_catpvf_mg
8280 Like C<sv_catpvf>, but also handles 'set' magic.
8286 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8289 va_start(args, pat);
8290 sv_vcatpvf_mg(sv, pat, &args);
8295 =for apidoc sv_vcatpvf_mg
8297 Like C<sv_vcatpvf>, but also handles 'set' magic.
8299 Usually used via its frontend C<sv_catpvf_mg>.
8305 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8307 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8312 =for apidoc sv_vsetpvfn
8314 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8317 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8323 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8325 sv_setpvn(sv, "", 0);
8326 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8330 S_expect_number(pTHX_ char** pattern)
8334 switch (**pattern) {
8335 case '1': case '2': case '3':
8336 case '4': case '5': case '6':
8337 case '7': case '8': case '9':
8338 var = *(*pattern)++ - '0';
8339 while (isDIGIT(**pattern)) {
8340 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8342 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8350 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8352 const int neg = nv < 0;
8361 if (uv & 1 && uv == nv)
8362 uv--; /* Round to even */
8364 const unsigned dig = uv % 10;
8377 =for apidoc sv_vcatpvfn
8379 Processes its arguments like C<vsprintf> and appends the formatted output
8380 to an SV. Uses an array of SVs if the C style variable argument list is
8381 missing (NULL). When running with taint checks enabled, indicates via
8382 C<maybe_tainted> if results are untrustworthy (often due to the use of
8385 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8391 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8392 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8393 vec_utf8 = DO_UTF8(vecsv);
8395 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8398 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8406 static const char nullstr[] = "(null)";
8408 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8409 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8411 /* Times 4: a decimal digit takes more than 3 binary digits.
8412 * NV_DIG: mantissa takes than many decimal digits.
8413 * Plus 32: Playing safe. */
8414 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8415 /* large enough for "%#.#f" --chip */
8416 /* what about long double NVs? --jhi */
8418 PERL_UNUSED_ARG(maybe_tainted);
8420 /* no matter what, this is a string now */
8421 (void)SvPV_force(sv, origlen);
8423 /* special-case "", "%s", and "%-p" (SVf - see below) */
8426 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8428 const char * const s = va_arg(*args, char*);
8429 sv_catpv(sv, s ? s : nullstr);
8431 else if (svix < svmax) {
8432 sv_catsv(sv, *svargs);
8436 if (args && patlen == 3 && pat[0] == '%' &&
8437 pat[1] == '-' && pat[2] == 'p') {
8438 argsv = va_arg(*args, SV*);
8439 sv_catsv(sv, argsv);
8443 #ifndef USE_LONG_DOUBLE
8444 /* special-case "%.<number>[gf]" */
8445 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8446 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8447 unsigned digits = 0;
8451 while (*pp >= '0' && *pp <= '9')
8452 digits = 10 * digits + (*pp++ - '0');
8453 if (pp - pat == (int)patlen - 1) {
8461 /* Add check for digits != 0 because it seems that some
8462 gconverts are buggy in this case, and we don't yet have
8463 a Configure test for this. */
8464 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8465 /* 0, point, slack */
8466 Gconvert(nv, (int)digits, 0, ebuf);
8468 if (*ebuf) /* May return an empty string for digits==0 */
8471 } else if (!digits) {
8474 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8475 sv_catpvn(sv, p, l);
8481 #endif /* !USE_LONG_DOUBLE */
8483 if (!args && svix < svmax && DO_UTF8(*svargs))
8486 patend = (char*)pat + patlen;
8487 for (p = (char*)pat; p < patend; p = q) {
8490 bool vectorize = FALSE;
8491 bool vectorarg = FALSE;
8492 bool vec_utf8 = FALSE;
8498 bool has_precis = FALSE;
8500 const I32 osvix = svix;
8501 bool is_utf8 = FALSE; /* is this item utf8? */
8502 #ifdef HAS_LDBL_SPRINTF_BUG
8503 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8504 with sfio - Allen <allens@cpan.org> */
8505 bool fix_ldbl_sprintf_bug = FALSE;
8509 U8 utf8buf[UTF8_MAXBYTES+1];
8510 STRLEN esignlen = 0;
8512 const char *eptr = NULL;
8515 const U8 *vecstr = NULL;
8522 /* we need a long double target in case HAS_LONG_DOUBLE but
8525 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8533 const char *dotstr = ".";
8534 STRLEN dotstrlen = 1;
8535 I32 efix = 0; /* explicit format parameter index */
8536 I32 ewix = 0; /* explicit width index */
8537 I32 epix = 0; /* explicit precision index */
8538 I32 evix = 0; /* explicit vector index */
8539 bool asterisk = FALSE;
8541 /* echo everything up to the next format specification */
8542 for (q = p; q < patend && *q != '%'; ++q) ;
8544 if (has_utf8 && !pat_utf8)
8545 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8547 sv_catpvn(sv, p, q - p);
8554 We allow format specification elements in this order:
8555 \d+\$ explicit format parameter index
8557 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8558 0 flag (as above): repeated to allow "v02"
8559 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8560 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8562 [%bcdefginopsuxDFOUX] format (mandatory)
8567 As of perl5.9.3, printf format checking is on by default.
8568 Internally, perl uses %p formats to provide an escape to
8569 some extended formatting. This block deals with those
8570 extensions: if it does not match, (char*)q is reset and
8571 the normal format processing code is used.
8573 Currently defined extensions are:
8574 %p include pointer address (standard)
8575 %-p (SVf) include an SV (previously %_)
8576 %-<num>p include an SV with precision <num>
8577 %1p (VDf) include a v-string (as %vd)
8578 %<num>p reserved for future extensions
8580 Robin Barker 2005-07-14
8587 n = expect_number(&q);
8594 argsv = va_arg(*args, SV*);
8595 eptr = SvPVx_const(argsv, elen);
8601 else if (n == vdNUMBER) { /* VDf */
8608 if (ckWARN_d(WARN_INTERNAL))
8609 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8610 "internal %%<num>p might conflict with future printf extensions");
8616 if ( (width = expect_number(&q)) ) {
8631 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8660 if ( (ewix = expect_number(&q)) )
8669 if ((vectorarg = asterisk)) {
8682 width = expect_number(&q);
8688 vecsv = va_arg(*args, SV*);
8690 vecsv = (evix > 0 && evix <= svmax)
8691 ? svargs[evix-1] : &PL_sv_undef;
8693 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8695 dotstr = SvPV_const(vecsv, dotstrlen);
8696 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8697 bad with tied or overloaded values that return UTF8. */
8700 else if (has_utf8) {
8701 vecsv = sv_mortalcopy(vecsv);
8702 sv_utf8_upgrade(vecsv);
8703 dotstr = SvPV_const(vecsv, dotstrlen);
8710 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8711 vecsv = svargs[efix ? efix-1 : svix++];
8712 vecstr = (U8*)SvPV_const(vecsv,veclen);
8713 vec_utf8 = DO_UTF8(vecsv);
8715 /* if this is a version object, we need to convert
8716 * back into v-string notation and then let the
8717 * vectorize happen normally
8719 if (sv_derived_from(vecsv, "version")) {
8720 char *version = savesvpv(vecsv);
8721 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8722 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8723 "vector argument not supported with alpha versions");
8726 vecsv = sv_newmortal();
8727 /* scan_vstring is expected to be called during
8728 * tokenization, so we need to fake up the end
8729 * of the buffer for it
8731 PL_bufend = version + veclen;
8732 scan_vstring(version, vecsv);
8733 vecstr = (U8*)SvPV_const(vecsv, veclen);
8734 vec_utf8 = DO_UTF8(vecsv);
8746 i = va_arg(*args, int);
8748 i = (ewix ? ewix <= svmax : svix < svmax) ?
8749 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8751 width = (i < 0) ? -i : i;
8761 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8763 /* XXX: todo, support specified precision parameter */
8767 i = va_arg(*args, int);
8769 i = (ewix ? ewix <= svmax : svix < svmax)
8770 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8772 has_precis = !(i < 0);
8777 precis = precis * 10 + (*q++ - '0');
8786 case 'I': /* Ix, I32x, and I64x */
8788 if (q[1] == '6' && q[2] == '4') {
8794 if (q[1] == '3' && q[2] == '2') {
8804 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8815 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8816 if (*(q + 1) == 'l') { /* lld, llf */
8842 if (!vectorize && !args) {
8844 const I32 i = efix-1;
8845 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8847 argsv = (svix >= 0 && svix < svmax)
8848 ? svargs[svix++] : &PL_sv_undef;
8859 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8861 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8863 eptr = (char*)utf8buf;
8864 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8878 eptr = va_arg(*args, char*);
8880 #ifdef MACOS_TRADITIONAL
8881 /* On MacOS, %#s format is used for Pascal strings */
8886 elen = strlen(eptr);
8888 eptr = (char *)nullstr;
8889 elen = sizeof nullstr - 1;
8893 eptr = SvPVx_const(argsv, elen);
8894 if (DO_UTF8(argsv)) {
8895 I32 old_precis = precis;
8896 if (has_precis && precis < elen) {
8898 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8901 if (width) { /* fudge width (can't fudge elen) */
8902 if (has_precis && precis < elen)
8903 width += precis - old_precis;
8905 width += elen - sv_len_utf8(argsv);
8912 if (has_precis && elen > precis)
8919 if (alt || vectorize)
8921 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8942 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8951 esignbuf[esignlen++] = plus;
8955 case 'h': iv = (short)va_arg(*args, int); break;
8956 case 'l': iv = va_arg(*args, long); break;
8957 case 'V': iv = va_arg(*args, IV); break;
8958 default: iv = va_arg(*args, int); break;
8960 case 'q': iv = va_arg(*args, Quad_t); break;
8965 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8967 case 'h': iv = (short)tiv; break;
8968 case 'l': iv = (long)tiv; break;
8970 default: iv = tiv; break;
8972 case 'q': iv = (Quad_t)tiv; break;
8976 if ( !vectorize ) /* we already set uv above */
8981 esignbuf[esignlen++] = plus;
8985 esignbuf[esignlen++] = '-';
9029 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9040 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9041 case 'l': uv = va_arg(*args, unsigned long); break;
9042 case 'V': uv = va_arg(*args, UV); break;
9043 default: uv = va_arg(*args, unsigned); break;
9045 case 'q': uv = va_arg(*args, Uquad_t); break;
9050 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9052 case 'h': uv = (unsigned short)tuv; break;
9053 case 'l': uv = (unsigned long)tuv; break;
9055 default: uv = tuv; break;
9057 case 'q': uv = (Uquad_t)tuv; break;
9064 char *ptr = ebuf + sizeof ebuf;
9065 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9071 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9077 esignbuf[esignlen++] = '0';
9078 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9086 if (alt && *ptr != '0')
9095 esignbuf[esignlen++] = '0';
9096 esignbuf[esignlen++] = c;
9099 default: /* it had better be ten or less */
9103 } while (uv /= base);
9106 elen = (ebuf + sizeof ebuf) - ptr;
9110 zeros = precis - elen;
9111 else if (precis == 0 && elen == 1 && *eptr == '0'
9112 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9115 /* a precision nullifies the 0 flag. */
9122 /* FLOATING POINT */
9125 c = 'f'; /* maybe %F isn't supported here */
9133 /* This is evil, but floating point is even more evil */
9135 /* for SV-style calling, we can only get NV
9136 for C-style calling, we assume %f is double;
9137 for simplicity we allow any of %Lf, %llf, %qf for long double
9141 #if defined(USE_LONG_DOUBLE)
9145 /* [perl #20339] - we should accept and ignore %lf rather than die */
9149 #if defined(USE_LONG_DOUBLE)
9150 intsize = args ? 0 : 'q';
9154 #if defined(HAS_LONG_DOUBLE)
9163 /* now we need (long double) if intsize == 'q', else (double) */
9165 #if LONG_DOUBLESIZE > DOUBLESIZE
9167 va_arg(*args, long double) :
9168 va_arg(*args, double)
9170 va_arg(*args, double)
9175 if (c != 'e' && c != 'E') {
9177 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9178 will cast our (long double) to (double) */
9179 (void)Perl_frexp(nv, &i);
9180 if (i == PERL_INT_MIN)
9181 Perl_die(aTHX_ "panic: frexp");
9183 need = BIT_DIGITS(i);
9185 need += has_precis ? precis : 6; /* known default */
9190 #ifdef HAS_LDBL_SPRINTF_BUG
9191 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9192 with sfio - Allen <allens@cpan.org> */
9195 # define MY_DBL_MAX DBL_MAX
9196 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9197 # if DOUBLESIZE >= 8
9198 # define MY_DBL_MAX 1.7976931348623157E+308L
9200 # define MY_DBL_MAX 3.40282347E+38L
9204 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9205 # define MY_DBL_MAX_BUG 1L
9207 # define MY_DBL_MAX_BUG MY_DBL_MAX
9211 # define MY_DBL_MIN DBL_MIN
9212 # else /* XXX guessing! -Allen */
9213 # if DOUBLESIZE >= 8
9214 # define MY_DBL_MIN 2.2250738585072014E-308L
9216 # define MY_DBL_MIN 1.17549435E-38L
9220 if ((intsize == 'q') && (c == 'f') &&
9221 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9223 /* it's going to be short enough that
9224 * long double precision is not needed */
9226 if ((nv <= 0L) && (nv >= -0L))
9227 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9229 /* would use Perl_fp_class as a double-check but not
9230 * functional on IRIX - see perl.h comments */
9232 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9233 /* It's within the range that a double can represent */
9234 #if defined(DBL_MAX) && !defined(DBL_MIN)
9235 if ((nv >= ((long double)1/DBL_MAX)) ||
9236 (nv <= (-(long double)1/DBL_MAX)))
9238 fix_ldbl_sprintf_bug = TRUE;
9241 if (fix_ldbl_sprintf_bug == TRUE) {
9251 # undef MY_DBL_MAX_BUG
9254 #endif /* HAS_LDBL_SPRINTF_BUG */
9256 need += 20; /* fudge factor */
9257 if (PL_efloatsize < need) {
9258 Safefree(PL_efloatbuf);
9259 PL_efloatsize = need + 20; /* more fudge */
9260 Newx(PL_efloatbuf, PL_efloatsize, char);
9261 PL_efloatbuf[0] = '\0';
9264 if ( !(width || left || plus || alt) && fill != '0'
9265 && has_precis && intsize != 'q' ) { /* Shortcuts */
9266 /* See earlier comment about buggy Gconvert when digits,
9268 if ( c == 'g' && precis) {
9269 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9270 /* May return an empty string for digits==0 */
9271 if (*PL_efloatbuf) {
9272 elen = strlen(PL_efloatbuf);
9273 goto float_converted;
9275 } else if ( c == 'f' && !precis) {
9276 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9281 char *ptr = ebuf + sizeof ebuf;
9284 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9285 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9286 if (intsize == 'q') {
9287 /* Copy the one or more characters in a long double
9288 * format before the 'base' ([efgEFG]) character to
9289 * the format string. */
9290 static char const prifldbl[] = PERL_PRIfldbl;
9291 char const *p = prifldbl + sizeof(prifldbl) - 3;
9292 while (p >= prifldbl) { *--ptr = *p--; }
9297 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9302 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9314 /* No taint. Otherwise we are in the strange situation
9315 * where printf() taints but print($float) doesn't.
9317 #if defined(HAS_LONG_DOUBLE)
9318 elen = ((intsize == 'q')
9319 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9320 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9322 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9326 eptr = PL_efloatbuf;
9334 i = SvCUR(sv) - origlen;
9337 case 'h': *(va_arg(*args, short*)) = i; break;
9338 default: *(va_arg(*args, int*)) = i; break;
9339 case 'l': *(va_arg(*args, long*)) = i; break;
9340 case 'V': *(va_arg(*args, IV*)) = i; break;
9342 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9347 sv_setuv_mg(argsv, (UV)i);
9348 continue; /* not "break" */
9355 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9356 && ckWARN(WARN_PRINTF))
9358 SV * const msg = sv_newmortal();
9359 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9360 (PL_op->op_type == OP_PRTF) ? "" : "s");
9363 Perl_sv_catpvf(aTHX_ msg,
9364 "\"%%%c\"", c & 0xFF);
9366 Perl_sv_catpvf(aTHX_ msg,
9367 "\"%%\\%03"UVof"\"",
9370 sv_catpvs(msg, "end of string");
9371 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9374 /* output mangled stuff ... */
9380 /* ... right here, because formatting flags should not apply */
9381 SvGROW(sv, SvCUR(sv) + elen + 1);
9383 Copy(eptr, p, elen, char);
9386 SvCUR_set(sv, p - SvPVX_const(sv));
9388 continue; /* not "break" */
9391 if (is_utf8 != has_utf8) {
9394 sv_utf8_upgrade(sv);
9397 const STRLEN old_elen = elen;
9398 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9399 sv_utf8_upgrade(nsv);
9400 eptr = SvPVX_const(nsv);
9403 if (width) { /* fudge width (can't fudge elen) */
9404 width += elen - old_elen;
9410 have = esignlen + zeros + elen;
9412 Perl_croak_nocontext(PL_memory_wrap);
9414 need = (have > width ? have : width);
9417 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9418 Perl_croak_nocontext(PL_memory_wrap);
9419 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9421 if (esignlen && fill == '0') {
9423 for (i = 0; i < (int)esignlen; i++)
9427 memset(p, fill, gap);
9430 if (esignlen && fill != '0') {
9432 for (i = 0; i < (int)esignlen; i++)
9437 for (i = zeros; i; i--)
9441 Copy(eptr, p, elen, char);
9445 memset(p, ' ', gap);
9450 Copy(dotstr, p, dotstrlen, char);
9454 vectorize = FALSE; /* done iterating over vecstr */
9461 SvCUR_set(sv, p - SvPVX_const(sv));
9469 /* =========================================================================
9471 =head1 Cloning an interpreter
9473 All the macros and functions in this section are for the private use of
9474 the main function, perl_clone().
9476 The foo_dup() functions make an exact copy of an existing foo thinngy.
9477 During the course of a cloning, a hash table is used to map old addresses
9478 to new addresses. The table is created and manipulated with the
9479 ptr_table_* functions.
9483 ============================================================================*/
9486 #if defined(USE_ITHREADS)
9488 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9489 #ifndef GpREFCNT_inc
9490 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9494 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9495 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9496 If this changes, please unmerge ss_dup. */
9497 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9498 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9499 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9500 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9501 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9502 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9503 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9504 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9505 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9506 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9507 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9508 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9509 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9510 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9513 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9514 regcomp.c. AMS 20010712 */
9517 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9519 return CALLREGDUPE(r,param);
9522 /* duplicate a file handle */
9525 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9529 PERL_UNUSED_ARG(type);
9532 return (PerlIO*)NULL;
9534 /* look for it in the table first */
9535 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9539 /* create anew and remember what it is */
9540 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9541 ptr_table_store(PL_ptr_table, fp, ret);
9545 /* duplicate a directory handle */
9548 Perl_dirp_dup(pTHX_ DIR *dp)
9550 PERL_UNUSED_CONTEXT;
9557 /* duplicate a typeglob */
9560 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9566 /* look for it in the table first */
9567 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9571 /* create anew and remember what it is */
9573 ptr_table_store(PL_ptr_table, gp, ret);
9576 ret->gp_refcnt = 0; /* must be before any other dups! */
9577 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9578 ret->gp_io = io_dup_inc(gp->gp_io, param);
9579 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9580 ret->gp_av = av_dup_inc(gp->gp_av, param);
9581 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9582 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9583 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9584 ret->gp_cvgen = gp->gp_cvgen;
9585 ret->gp_line = gp->gp_line;
9586 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9590 /* duplicate a chain of magic */
9593 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9595 MAGIC *mgprev = (MAGIC*)NULL;
9598 return (MAGIC*)NULL;
9599 /* look for it in the table first */
9600 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9604 for (; mg; mg = mg->mg_moremagic) {
9606 Newxz(nmg, 1, MAGIC);
9608 mgprev->mg_moremagic = nmg;
9611 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9612 nmg->mg_private = mg->mg_private;
9613 nmg->mg_type = mg->mg_type;
9614 nmg->mg_flags = mg->mg_flags;
9615 if (mg->mg_type == PERL_MAGIC_qr) {
9616 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9618 else if(mg->mg_type == PERL_MAGIC_backref) {
9619 /* The backref AV has its reference count deliberately bumped by
9621 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9623 else if (mg->mg_type == PERL_MAGIC_symtab) {
9624 nmg->mg_obj = mg->mg_obj;
9627 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9628 ? sv_dup_inc(mg->mg_obj, param)
9629 : sv_dup(mg->mg_obj, param);
9631 nmg->mg_len = mg->mg_len;
9632 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9633 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9634 if (mg->mg_len > 0) {
9635 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9636 if (mg->mg_type == PERL_MAGIC_overload_table &&
9637 AMT_AMAGIC((AMT*)mg->mg_ptr))
9639 const AMT * const amtp = (AMT*)mg->mg_ptr;
9640 AMT * const namtp = (AMT*)nmg->mg_ptr;
9642 for (i = 1; i < NofAMmeth; i++) {
9643 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9647 else if (mg->mg_len == HEf_SVKEY)
9648 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9650 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9651 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9658 /* create a new pointer-mapping table */
9661 Perl_ptr_table_new(pTHX)
9664 PERL_UNUSED_CONTEXT;
9666 Newxz(tbl, 1, PTR_TBL_t);
9669 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9673 #define PTR_TABLE_HASH(ptr) \
9674 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9677 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9678 following define) and at call to new_body_inline made below in
9679 Perl_ptr_table_store()
9682 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9684 /* map an existing pointer using a table */
9686 STATIC PTR_TBL_ENT_t *
9687 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9688 PTR_TBL_ENT_t *tblent;
9689 const UV hash = PTR_TABLE_HASH(sv);
9691 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9692 for (; tblent; tblent = tblent->next) {
9693 if (tblent->oldval == sv)
9700 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9702 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9703 PERL_UNUSED_CONTEXT;
9704 return tblent ? tblent->newval : NULL;
9707 /* add a new entry to a pointer-mapping table */
9710 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9712 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9713 PERL_UNUSED_CONTEXT;
9716 tblent->newval = newsv;
9718 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9720 new_body_inline(tblent, PTE_SVSLOT);
9722 tblent->oldval = oldsv;
9723 tblent->newval = newsv;
9724 tblent->next = tbl->tbl_ary[entry];
9725 tbl->tbl_ary[entry] = tblent;
9727 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9728 ptr_table_split(tbl);
9732 /* double the hash bucket size of an existing ptr table */
9735 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9737 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9738 const UV oldsize = tbl->tbl_max + 1;
9739 UV newsize = oldsize * 2;
9741 PERL_UNUSED_CONTEXT;
9743 Renew(ary, newsize, PTR_TBL_ENT_t*);
9744 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9745 tbl->tbl_max = --newsize;
9747 for (i=0; i < oldsize; i++, ary++) {
9748 PTR_TBL_ENT_t **curentp, **entp, *ent;
9751 curentp = ary + oldsize;
9752 for (entp = ary, ent = *ary; ent; ent = *entp) {
9753 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9755 ent->next = *curentp;
9765 /* remove all the entries from a ptr table */
9768 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9770 if (tbl && tbl->tbl_items) {
9771 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9772 UV riter = tbl->tbl_max;
9775 PTR_TBL_ENT_t *entry = array[riter];
9778 PTR_TBL_ENT_t * const oentry = entry;
9779 entry = entry->next;
9788 /* clear and free a ptr table */
9791 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9796 ptr_table_clear(tbl);
9797 Safefree(tbl->tbl_ary);
9803 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9806 SvRV_set(dstr, SvWEAKREF(sstr)
9807 ? sv_dup(SvRV(sstr), param)
9808 : sv_dup_inc(SvRV(sstr), param));
9811 else if (SvPVX_const(sstr)) {
9812 /* Has something there */
9814 /* Normal PV - clone whole allocated space */
9815 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9816 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9817 /* Not that normal - actually sstr is copy on write.
9818 But we are a true, independant SV, so: */
9819 SvREADONLY_off(dstr);
9824 /* Special case - not normally malloced for some reason */
9825 if (isGV_with_GP(sstr)) {
9826 /* Don't need to do anything here. */
9828 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9829 /* A "shared" PV - clone it as "shared" PV */
9831 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9835 /* Some other special case - random pointer */
9836 SvPV_set(dstr, SvPVX(sstr));
9842 if (SvTYPE(dstr) == SVt_RV)
9843 SvRV_set(dstr, NULL);
9845 SvPV_set(dstr, NULL);
9849 /* duplicate an SV of any type (including AV, HV etc) */
9852 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9857 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9859 /* look for it in the table first */
9860 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9864 if(param->flags & CLONEf_JOIN_IN) {
9865 /** We are joining here so we don't want do clone
9866 something that is bad **/
9867 if (SvTYPE(sstr) == SVt_PVHV) {
9868 const char * const hvname = HvNAME_get(sstr);
9870 /** don't clone stashes if they already exist **/
9871 return (SV*)gv_stashpv(hvname,0);
9875 /* create anew and remember what it is */
9878 #ifdef DEBUG_LEAKING_SCALARS
9879 dstr->sv_debug_optype = sstr->sv_debug_optype;
9880 dstr->sv_debug_line = sstr->sv_debug_line;
9881 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9882 dstr->sv_debug_cloned = 1;
9883 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9886 ptr_table_store(PL_ptr_table, sstr, dstr);
9889 SvFLAGS(dstr) = SvFLAGS(sstr);
9890 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9891 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9894 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9895 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9896 PL_watch_pvx, SvPVX_const(sstr));
9899 /* don't clone objects whose class has asked us not to */
9900 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9901 SvFLAGS(dstr) &= ~SVTYPEMASK;
9906 switch (SvTYPE(sstr)) {
9911 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9912 SvIV_set(dstr, SvIVX(sstr));
9915 SvANY(dstr) = new_XNV();
9916 SvNV_set(dstr, SvNVX(sstr));
9919 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9920 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9924 /* These are all the types that need complex bodies allocating. */
9926 const svtype sv_type = SvTYPE(sstr);
9927 const struct body_details *const sv_type_details
9928 = bodies_by_type + sv_type;
9932 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9936 if (GvUNIQUE((GV*)sstr)) {
9937 NOOP; /* Do sharing here, and fall through */
9950 assert(sv_type_details->body_size);
9951 if (sv_type_details->arena) {
9952 new_body_inline(new_body, sv_type);
9954 = (void*)((char*)new_body - sv_type_details->offset);
9956 new_body = new_NOARENA(sv_type_details);
9960 SvANY(dstr) = new_body;
9963 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9964 ((char*)SvANY(dstr)) + sv_type_details->offset,
9965 sv_type_details->copy, char);
9967 Copy(((char*)SvANY(sstr)),
9968 ((char*)SvANY(dstr)),
9969 sv_type_details->body_size + sv_type_details->offset, char);
9972 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9973 && !isGV_with_GP(dstr))
9974 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9976 /* The Copy above means that all the source (unduplicated) pointers
9977 are now in the destination. We can check the flags and the
9978 pointers in either, but it's possible that there's less cache
9979 missing by always going for the destination.
9980 FIXME - instrument and check that assumption */
9981 if (sv_type >= SVt_PVMG) {
9982 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9983 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9984 } else if (SvMAGIC(dstr))
9985 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9987 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9990 /* The cast silences a GCC warning about unhandled types. */
9991 switch ((int)sv_type) {
10003 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10004 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10005 LvTARG(dstr) = dstr;
10006 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10007 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10009 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10012 if (GvNAME_HEK(dstr))
10013 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10015 /* Don't call sv_add_backref here as it's going to be created
10016 as part of the magic cloning of the symbol table. */
10017 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10018 if(isGV_with_GP(sstr)) {
10019 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10020 at the point of this comment. */
10021 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10022 (void)GpREFCNT_inc(GvGP(dstr));
10024 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10027 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10028 if (IoOFP(dstr) == IoIFP(sstr))
10029 IoOFP(dstr) = IoIFP(dstr);
10031 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10032 /* PL_rsfp_filters entries have fake IoDIRP() */
10033 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10034 /* I have no idea why fake dirp (rsfps)
10035 should be treated differently but otherwise
10036 we end up with leaks -- sky*/
10037 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10038 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10039 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10041 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10042 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10043 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10044 if (IoDIRP(dstr)) {
10045 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10048 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10051 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10052 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10053 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10056 if (AvARRAY((AV*)sstr)) {
10057 SV **dst_ary, **src_ary;
10058 SSize_t items = AvFILLp((AV*)sstr) + 1;
10060 src_ary = AvARRAY((AV*)sstr);
10061 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10062 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10063 AvARRAY((AV*)dstr) = dst_ary;
10064 AvALLOC((AV*)dstr) = dst_ary;
10065 if (AvREAL((AV*)sstr)) {
10066 while (items-- > 0)
10067 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10070 while (items-- > 0)
10071 *dst_ary++ = sv_dup(*src_ary++, param);
10073 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10074 while (items-- > 0) {
10075 *dst_ary++ = &PL_sv_undef;
10079 AvARRAY((AV*)dstr) = NULL;
10080 AvALLOC((AV*)dstr) = (SV**)NULL;
10084 if (HvARRAY((HV*)sstr)) {
10086 const bool sharekeys = !!HvSHAREKEYS(sstr);
10087 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10088 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10090 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10091 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10093 HvARRAY(dstr) = (HE**)darray;
10094 while (i <= sxhv->xhv_max) {
10095 const HE * const source = HvARRAY(sstr)[i];
10096 HvARRAY(dstr)[i] = source
10097 ? he_dup(source, sharekeys, param) : 0;
10102 const struct xpvhv_aux * const saux = HvAUX(sstr);
10103 struct xpvhv_aux * const daux = HvAUX(dstr);
10104 /* This flag isn't copied. */
10105 /* SvOOK_on(hv) attacks the IV flags. */
10106 SvFLAGS(dstr) |= SVf_OOK;
10108 hvname = saux->xhv_name;
10109 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10111 daux->xhv_riter = saux->xhv_riter;
10112 daux->xhv_eiter = saux->xhv_eiter
10113 ? he_dup(saux->xhv_eiter,
10114 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10115 daux->xhv_backreferences =
10116 saux->xhv_backreferences
10117 ? (AV*) SvREFCNT_inc(
10118 sv_dup((SV*)saux->xhv_backreferences, param))
10120 /* Record stashes for possible cloning in Perl_clone(). */
10122 av_push(param->stashes, dstr);
10126 HvARRAY((HV*)dstr) = NULL;
10129 if (!(param->flags & CLONEf_COPY_STACKS)) {
10133 /* NOTE: not refcounted */
10134 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10136 if (!CvISXSUB(dstr))
10137 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10139 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10140 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10141 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10142 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10144 /* don't dup if copying back - CvGV isn't refcounted, so the
10145 * duped GV may never be freed. A bit of a hack! DAPM */
10146 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10147 NULL : gv_dup(CvGV(dstr), param) ;
10148 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10150 CvWEAKOUTSIDE(sstr)
10151 ? cv_dup( CvOUTSIDE(dstr), param)
10152 : cv_dup_inc(CvOUTSIDE(dstr), param);
10153 if (!CvISXSUB(dstr))
10154 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10160 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10166 /* duplicate a context */
10169 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10171 PERL_CONTEXT *ncxs;
10174 return (PERL_CONTEXT*)NULL;
10176 /* look for it in the table first */
10177 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10181 /* create anew and remember what it is */
10182 Newxz(ncxs, max + 1, PERL_CONTEXT);
10183 ptr_table_store(PL_ptr_table, cxs, ncxs);
10186 PERL_CONTEXT * const cx = &cxs[ix];
10187 PERL_CONTEXT * const ncx = &ncxs[ix];
10188 ncx->cx_type = cx->cx_type;
10189 if (CxTYPE(cx) == CXt_SUBST) {
10190 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10193 ncx->blk_oldsp = cx->blk_oldsp;
10194 ncx->blk_oldcop = cx->blk_oldcop;
10195 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10196 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10197 ncx->blk_oldpm = cx->blk_oldpm;
10198 ncx->blk_gimme = cx->blk_gimme;
10199 switch (CxTYPE(cx)) {
10201 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10202 ? cv_dup_inc(cx->blk_sub.cv, param)
10203 : cv_dup(cx->blk_sub.cv,param));
10204 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10205 ? av_dup_inc(cx->blk_sub.argarray, param)
10207 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10208 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10209 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10210 ncx->blk_sub.lval = cx->blk_sub.lval;
10211 ncx->blk_sub.retop = cx->blk_sub.retop;
10212 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10213 cx->blk_sub.oldcomppad);
10216 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10217 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10218 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10219 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10220 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10221 ncx->blk_eval.retop = cx->blk_eval.retop;
10224 ncx->blk_loop.label = cx->blk_loop.label;
10225 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10226 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10227 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10228 ? cx->blk_loop.iterdata
10229 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10230 ncx->blk_loop.oldcomppad
10231 = (PAD*)ptr_table_fetch(PL_ptr_table,
10232 cx->blk_loop.oldcomppad);
10233 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10234 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10235 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10236 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10237 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10240 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10241 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10242 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10243 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10244 ncx->blk_sub.retop = cx->blk_sub.retop;
10256 /* duplicate a stack info structure */
10259 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10264 return (PERL_SI*)NULL;
10266 /* look for it in the table first */
10267 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10271 /* create anew and remember what it is */
10272 Newxz(nsi, 1, PERL_SI);
10273 ptr_table_store(PL_ptr_table, si, nsi);
10275 nsi->si_stack = av_dup_inc(si->si_stack, param);
10276 nsi->si_cxix = si->si_cxix;
10277 nsi->si_cxmax = si->si_cxmax;
10278 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10279 nsi->si_type = si->si_type;
10280 nsi->si_prev = si_dup(si->si_prev, param);
10281 nsi->si_next = si_dup(si->si_next, param);
10282 nsi->si_markoff = si->si_markoff;
10287 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10288 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10289 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10290 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10291 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10292 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10293 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10294 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10295 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10296 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10297 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10298 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10299 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10300 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10303 #define pv_dup_inc(p) SAVEPV(p)
10304 #define pv_dup(p) SAVEPV(p)
10305 #define svp_dup_inc(p,pp) any_dup(p,pp)
10307 /* map any object to the new equivent - either something in the
10308 * ptr table, or something in the interpreter structure
10312 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10317 return (void*)NULL;
10319 /* look for it in the table first */
10320 ret = ptr_table_fetch(PL_ptr_table, v);
10324 /* see if it is part of the interpreter structure */
10325 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10326 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10334 /* duplicate the save stack */
10337 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10339 ANY * const ss = proto_perl->Tsavestack;
10340 const I32 max = proto_perl->Tsavestack_max;
10341 I32 ix = proto_perl->Tsavestack_ix;
10354 void (*dptr) (void*);
10355 void (*dxptr) (pTHX_ void*);
10357 Newxz(nss, max, ANY);
10360 const I32 type = POPINT(ss,ix);
10361 TOPINT(nss,ix) = type;
10363 case SAVEt_HELEM: /* hash element */
10364 sv = (SV*)POPPTR(ss,ix);
10365 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10367 case SAVEt_ITEM: /* normal string */
10368 case SAVEt_SV: /* scalar reference */
10369 sv = (SV*)POPPTR(ss,ix);
10370 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10373 case SAVEt_MORTALIZESV:
10374 sv = (SV*)POPPTR(ss,ix);
10375 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10377 case SAVEt_SHARED_PVREF: /* char* in shared space */
10378 c = (char*)POPPTR(ss,ix);
10379 TOPPTR(nss,ix) = savesharedpv(c);
10380 ptr = POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10383 case SAVEt_GENERIC_SVREF: /* generic sv */
10384 case SAVEt_SVREF: /* scalar reference */
10385 sv = (SV*)POPPTR(ss,ix);
10386 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10387 ptr = POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10390 case SAVEt_HV: /* hash reference */
10391 case SAVEt_AV: /* array reference */
10392 sv = (SV*) POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10395 case SAVEt_COMPPAD:
10397 sv = (SV*) POPPTR(ss,ix);
10398 TOPPTR(nss,ix) = sv_dup(sv, param);
10400 case SAVEt_INT: /* int reference */
10401 ptr = POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10403 intval = (int)POPINT(ss,ix);
10404 TOPINT(nss,ix) = intval;
10406 case SAVEt_LONG: /* long reference */
10407 ptr = POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10410 case SAVEt_CLEARSV:
10411 longval = (long)POPLONG(ss,ix);
10412 TOPLONG(nss,ix) = longval;
10414 case SAVEt_I32: /* I32 reference */
10415 case SAVEt_I16: /* I16 reference */
10416 case SAVEt_I8: /* I8 reference */
10417 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10418 ptr = POPPTR(ss,ix);
10419 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10421 TOPINT(nss,ix) = i;
10423 case SAVEt_IV: /* IV reference */
10424 ptr = POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10427 TOPIV(nss,ix) = iv;
10429 case SAVEt_HPTR: /* HV* reference */
10430 case SAVEt_APTR: /* AV* reference */
10431 case SAVEt_SPTR: /* SV* reference */
10432 ptr = POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10434 sv = (SV*)POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = sv_dup(sv, param);
10437 case SAVEt_VPTR: /* random* reference */
10438 ptr = POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10440 ptr = POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10443 case SAVEt_GENERIC_PVREF: /* generic char* */
10444 case SAVEt_PPTR: /* char* reference */
10445 ptr = POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10447 c = (char*)POPPTR(ss,ix);
10448 TOPPTR(nss,ix) = pv_dup(c);
10450 case SAVEt_GP: /* scalar reference */
10451 gp = (GP*)POPPTR(ss,ix);
10452 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10453 (void)GpREFCNT_inc(gp);
10454 gv = (GV*)POPPTR(ss,ix);
10455 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10458 ptr = POPPTR(ss,ix);
10459 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10460 /* these are assumed to be refcounted properly */
10462 switch (((OP*)ptr)->op_type) {
10464 case OP_LEAVESUBLV:
10468 case OP_LEAVEWRITE:
10469 TOPPTR(nss,ix) = ptr;
10474 TOPPTR(nss,ix) = NULL;
10479 TOPPTR(nss,ix) = NULL;
10482 c = (char*)POPPTR(ss,ix);
10483 TOPPTR(nss,ix) = pv_dup_inc(c);
10486 hv = (HV*)POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10488 c = (char*)POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = pv_dup_inc(c);
10491 case SAVEt_STACK_POS: /* Position on Perl stack */
10493 TOPINT(nss,ix) = i;
10495 case SAVEt_DESTRUCTOR:
10496 ptr = POPPTR(ss,ix);
10497 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10498 dptr = POPDPTR(ss,ix);
10499 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10500 any_dup(FPTR2DPTR(void *, dptr),
10503 case SAVEt_DESTRUCTOR_X:
10504 ptr = POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10506 dxptr = POPDXPTR(ss,ix);
10507 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10508 any_dup(FPTR2DPTR(void *, dxptr),
10511 case SAVEt_REGCONTEXT:
10514 TOPINT(nss,ix) = i;
10517 case SAVEt_AELEM: /* array element */
10518 sv = (SV*)POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10521 TOPINT(nss,ix) = i;
10522 av = (AV*)POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = av_dup_inc(av, param);
10526 ptr = POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = ptr;
10531 TOPINT(nss,ix) = i;
10532 ptr = POPPTR(ss,ix);
10535 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10536 HINTS_REFCNT_UNLOCK;
10538 TOPPTR(nss,ix) = ptr;
10539 if (i & HINT_LOCALIZE_HH) {
10540 hv = (HV*)POPPTR(ss,ix);
10541 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10545 longval = (long)POPLONG(ss,ix);
10546 TOPLONG(nss,ix) = longval;
10547 ptr = POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10549 sv = (SV*)POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup(sv, param);
10553 ptr = POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10555 longval = (long)POPBOOL(ss,ix);
10556 TOPBOOL(nss,ix) = (bool)longval;
10558 case SAVEt_SET_SVFLAGS:
10560 TOPINT(nss,ix) = i;
10562 TOPINT(nss,ix) = i;
10563 sv = (SV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = sv_dup(sv, param);
10566 case SAVEt_RE_STATE:
10568 const struct re_save_state *const old_state
10569 = (struct re_save_state *)
10570 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10571 struct re_save_state *const new_state
10572 = (struct re_save_state *)
10573 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10575 Copy(old_state, new_state, 1, struct re_save_state);
10576 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10578 new_state->re_state_bostr
10579 = pv_dup(old_state->re_state_bostr);
10580 new_state->re_state_reginput
10581 = pv_dup(old_state->re_state_reginput);
10582 new_state->re_state_regeol
10583 = pv_dup(old_state->re_state_regeol);
10584 new_state->re_state_regstartp
10585 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10586 new_state->re_state_regendp
10587 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10588 new_state->re_state_reglastparen
10589 = (U32*) any_dup(old_state->re_state_reglastparen,
10591 new_state->re_state_reglastcloseparen
10592 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10594 /* XXX This just has to be broken. The old save_re_context
10595 code did SAVEGENERICPV(PL_reg_start_tmp);
10596 PL_reg_start_tmp is char **.
10597 Look above to what the dup code does for
10598 SAVEt_GENERIC_PVREF
10599 It can never have worked.
10600 So this is merely a faithful copy of the exiting bug: */
10601 new_state->re_state_reg_start_tmp
10602 = (char **) pv_dup((char *)
10603 old_state->re_state_reg_start_tmp);
10604 /* I assume that it only ever "worked" because no-one called
10605 (pseudo)fork while the regexp engine had re-entered itself.
10607 #ifdef PERL_OLD_COPY_ON_WRITE
10608 new_state->re_state_nrs
10609 = sv_dup(old_state->re_state_nrs, param);
10611 new_state->re_state_reg_magic
10612 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10614 new_state->re_state_reg_oldcurpm
10615 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10617 new_state->re_state_reg_curpm
10618 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10620 new_state->re_state_reg_oldsaved
10621 = pv_dup(old_state->re_state_reg_oldsaved);
10622 new_state->re_state_reg_poscache
10623 = pv_dup(old_state->re_state_reg_poscache);
10624 new_state->re_state_reg_starttry
10625 = pv_dup(old_state->re_state_reg_starttry);
10628 case SAVEt_COMPILE_WARNINGS:
10629 ptr = POPPTR(ss,ix);
10630 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10634 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10642 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10643 * flag to the result. This is done for each stash before cloning starts,
10644 * so we know which stashes want their objects cloned */
10647 do_mark_cloneable_stash(pTHX_ SV *sv)
10649 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10651 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10652 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10653 if (cloner && GvCV(cloner)) {
10660 XPUSHs(sv_2mortal(newSVhek(hvname)));
10662 call_sv((SV*)GvCV(cloner), G_SCALAR);
10669 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10677 =for apidoc perl_clone
10679 Create and return a new interpreter by cloning the current one.
10681 perl_clone takes these flags as parameters:
10683 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10684 without it we only clone the data and zero the stacks,
10685 with it we copy the stacks and the new perl interpreter is
10686 ready to run at the exact same point as the previous one.
10687 The pseudo-fork code uses COPY_STACKS while the
10688 threads->new doesn't.
10690 CLONEf_KEEP_PTR_TABLE
10691 perl_clone keeps a ptr_table with the pointer of the old
10692 variable as a key and the new variable as a value,
10693 this allows it to check if something has been cloned and not
10694 clone it again but rather just use the value and increase the
10695 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10696 the ptr_table using the function
10697 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10698 reason to keep it around is if you want to dup some of your own
10699 variable who are outside the graph perl scans, example of this
10700 code is in threads.xs create
10703 This is a win32 thing, it is ignored on unix, it tells perls
10704 win32host code (which is c++) to clone itself, this is needed on
10705 win32 if you want to run two threads at the same time,
10706 if you just want to do some stuff in a separate perl interpreter
10707 and then throw it away and return to the original one,
10708 you don't need to do anything.
10713 /* XXX the above needs expanding by someone who actually understands it ! */
10714 EXTERN_C PerlInterpreter *
10715 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10718 perl_clone(PerlInterpreter *proto_perl, UV flags)
10721 #ifdef PERL_IMPLICIT_SYS
10723 /* perlhost.h so we need to call into it
10724 to clone the host, CPerlHost should have a c interface, sky */
10726 if (flags & CLONEf_CLONE_HOST) {
10727 return perl_clone_host(proto_perl,flags);
10729 return perl_clone_using(proto_perl, flags,
10731 proto_perl->IMemShared,
10732 proto_perl->IMemParse,
10734 proto_perl->IStdIO,
10738 proto_perl->IProc);
10742 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10743 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10744 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10745 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10746 struct IPerlDir* ipD, struct IPerlSock* ipS,
10747 struct IPerlProc* ipP)
10749 /* XXX many of the string copies here can be optimized if they're
10750 * constants; they need to be allocated as common memory and just
10751 * their pointers copied. */
10754 CLONE_PARAMS clone_params;
10755 CLONE_PARAMS* const param = &clone_params;
10757 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10758 /* for each stash, determine whether its objects should be cloned */
10759 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10760 PERL_SET_THX(my_perl);
10763 PoisonNew(my_perl, 1, PerlInterpreter);
10769 PL_savestack_ix = 0;
10770 PL_savestack_max = -1;
10771 PL_sig_pending = 0;
10772 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10773 # else /* !DEBUGGING */
10774 Zero(my_perl, 1, PerlInterpreter);
10775 # endif /* DEBUGGING */
10777 /* host pointers */
10779 PL_MemShared = ipMS;
10780 PL_MemParse = ipMP;
10787 #else /* !PERL_IMPLICIT_SYS */
10789 CLONE_PARAMS clone_params;
10790 CLONE_PARAMS* param = &clone_params;
10791 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10792 /* for each stash, determine whether its objects should be cloned */
10793 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10794 PERL_SET_THX(my_perl);
10797 PoisonNew(my_perl, 1, PerlInterpreter);
10803 PL_savestack_ix = 0;
10804 PL_savestack_max = -1;
10805 PL_sig_pending = 0;
10806 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10807 # else /* !DEBUGGING */
10808 Zero(my_perl, 1, PerlInterpreter);
10809 # endif /* DEBUGGING */
10810 #endif /* PERL_IMPLICIT_SYS */
10811 param->flags = flags;
10812 param->proto_perl = proto_perl;
10814 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10816 PL_body_arenas = NULL;
10817 Zero(&PL_body_roots, 1, PL_body_roots);
10819 PL_nice_chunk = NULL;
10820 PL_nice_chunk_size = 0;
10822 PL_sv_objcount = 0;
10824 PL_sv_arenaroot = NULL;
10826 PL_debug = proto_perl->Idebug;
10828 PL_hash_seed = proto_perl->Ihash_seed;
10829 PL_rehash_seed = proto_perl->Irehash_seed;
10831 #ifdef USE_REENTRANT_API
10832 /* XXX: things like -Dm will segfault here in perlio, but doing
10833 * PERL_SET_CONTEXT(proto_perl);
10834 * breaks too many other things
10836 Perl_reentrant_init(aTHX);
10839 /* create SV map for pointer relocation */
10840 PL_ptr_table = ptr_table_new();
10842 /* initialize these special pointers as early as possible */
10843 SvANY(&PL_sv_undef) = NULL;
10844 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10845 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10846 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10848 SvANY(&PL_sv_no) = new_XPVNV();
10849 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10850 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10851 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10852 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10853 SvCUR_set(&PL_sv_no, 0);
10854 SvLEN_set(&PL_sv_no, 1);
10855 SvIV_set(&PL_sv_no, 0);
10856 SvNV_set(&PL_sv_no, 0);
10857 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10859 SvANY(&PL_sv_yes) = new_XPVNV();
10860 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10861 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10862 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10863 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10864 SvCUR_set(&PL_sv_yes, 1);
10865 SvLEN_set(&PL_sv_yes, 2);
10866 SvIV_set(&PL_sv_yes, 1);
10867 SvNV_set(&PL_sv_yes, 1);
10868 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10870 /* create (a non-shared!) shared string table */
10871 PL_strtab = newHV();
10872 HvSHAREKEYS_off(PL_strtab);
10873 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10874 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10876 PL_compiling = proto_perl->Icompiling;
10878 /* These two PVs will be free'd special way so must set them same way op.c does */
10879 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10880 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10882 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10883 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10885 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10886 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10887 if (PL_compiling.cop_hints_hash) {
10889 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10890 HINTS_REFCNT_UNLOCK;
10892 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10894 /* pseudo environmental stuff */
10895 PL_origargc = proto_perl->Iorigargc;
10896 PL_origargv = proto_perl->Iorigargv;
10898 param->stashes = newAV(); /* Setup array of objects to call clone on */
10900 /* Set tainting stuff before PerlIO_debug can possibly get called */
10901 PL_tainting = proto_perl->Itainting;
10902 PL_taint_warn = proto_perl->Itaint_warn;
10904 #ifdef PERLIO_LAYERS
10905 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10906 PerlIO_clone(aTHX_ proto_perl, param);
10909 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10910 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10911 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10912 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10913 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10914 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10917 PL_minus_c = proto_perl->Iminus_c;
10918 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10919 PL_localpatches = proto_perl->Ilocalpatches;
10920 PL_splitstr = proto_perl->Isplitstr;
10921 PL_preprocess = proto_perl->Ipreprocess;
10922 PL_minus_n = proto_perl->Iminus_n;
10923 PL_minus_p = proto_perl->Iminus_p;
10924 PL_minus_l = proto_perl->Iminus_l;
10925 PL_minus_a = proto_perl->Iminus_a;
10926 PL_minus_E = proto_perl->Iminus_E;
10927 PL_minus_F = proto_perl->Iminus_F;
10928 PL_doswitches = proto_perl->Idoswitches;
10929 PL_dowarn = proto_perl->Idowarn;
10930 PL_doextract = proto_perl->Idoextract;
10931 PL_sawampersand = proto_perl->Isawampersand;
10932 PL_unsafe = proto_perl->Iunsafe;
10933 PL_inplace = SAVEPV(proto_perl->Iinplace);
10934 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10935 PL_perldb = proto_perl->Iperldb;
10936 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10937 PL_exit_flags = proto_perl->Iexit_flags;
10939 /* magical thingies */
10940 /* XXX time(&PL_basetime) when asked for? */
10941 PL_basetime = proto_perl->Ibasetime;
10942 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10944 PL_maxsysfd = proto_perl->Imaxsysfd;
10945 PL_statusvalue = proto_perl->Istatusvalue;
10947 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10949 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10951 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10953 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10954 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10955 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10958 /* RE engine related */
10959 Zero(&PL_reg_state, 1, struct re_save_state);
10960 PL_reginterp_cnt = 0;
10961 PL_regmatch_slab = NULL;
10963 /* Clone the regex array */
10964 PL_regex_padav = newAV();
10966 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10967 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10969 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10970 for(i = 1; i <= len; i++) {
10971 const SV * const regex = regexen[i];
10974 ? sv_dup_inc(regex, param)
10976 newSViv(PTR2IV(re_dup(
10977 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10979 av_push(PL_regex_padav, sv);
10982 PL_regex_pad = AvARRAY(PL_regex_padav);
10984 /* shortcuts to various I/O objects */
10985 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10986 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10987 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10988 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10989 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10990 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10992 /* shortcuts to regexp stuff */
10993 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10995 /* shortcuts to misc objects */
10996 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10998 /* shortcuts to debugging objects */
10999 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11000 PL_DBline = gv_dup(proto_perl->IDBline, param);
11001 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11002 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11003 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11004 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11005 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11006 PL_lineary = av_dup(proto_perl->Ilineary, param);
11007 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11009 /* symbol tables */
11010 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11011 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11012 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11013 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11014 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11016 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11017 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11018 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11019 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11020 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11021 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11022 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11023 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11025 PL_sub_generation = proto_perl->Isub_generation;
11027 /* funky return mechanisms */
11028 PL_forkprocess = proto_perl->Iforkprocess;
11030 /* subprocess state */
11031 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11033 /* internal state */
11034 PL_maxo = proto_perl->Imaxo;
11035 if (proto_perl->Iop_mask)
11036 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11039 /* PL_asserting = proto_perl->Iasserting; */
11041 /* current interpreter roots */
11042 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11043 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11044 PL_main_start = proto_perl->Imain_start;
11045 PL_eval_root = proto_perl->Ieval_root;
11046 PL_eval_start = proto_perl->Ieval_start;
11048 /* runtime control stuff */
11049 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11050 PL_copline = proto_perl->Icopline;
11052 PL_filemode = proto_perl->Ifilemode;
11053 PL_lastfd = proto_perl->Ilastfd;
11054 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11057 PL_gensym = proto_perl->Igensym;
11058 PL_preambled = proto_perl->Ipreambled;
11059 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11060 PL_laststatval = proto_perl->Ilaststatval;
11061 PL_laststype = proto_perl->Ilaststype;
11064 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11066 /* interpreter atexit processing */
11067 PL_exitlistlen = proto_perl->Iexitlistlen;
11068 if (PL_exitlistlen) {
11069 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11070 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11073 PL_exitlist = (PerlExitListEntry*)NULL;
11075 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11076 if (PL_my_cxt_size) {
11077 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11078 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11081 PL_my_cxt_list = (void**)NULL;
11082 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11083 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11084 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11086 PL_profiledata = NULL;
11087 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11088 /* PL_rsfp_filters entries have fake IoDIRP() */
11089 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11091 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11093 PAD_CLONE_VARS(proto_perl, param);
11095 #ifdef HAVE_INTERP_INTERN
11096 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11099 /* more statics moved here */
11100 PL_generation = proto_perl->Igeneration;
11101 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11103 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11104 PL_in_clean_all = proto_perl->Iin_clean_all;
11106 PL_uid = proto_perl->Iuid;
11107 PL_euid = proto_perl->Ieuid;
11108 PL_gid = proto_perl->Igid;
11109 PL_egid = proto_perl->Iegid;
11110 PL_nomemok = proto_perl->Inomemok;
11111 PL_an = proto_perl->Ian;
11112 PL_evalseq = proto_perl->Ievalseq;
11113 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11114 PL_origalen = proto_perl->Iorigalen;
11115 #ifdef PERL_USES_PL_PIDSTATUS
11116 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11118 PL_osname = SAVEPV(proto_perl->Iosname);
11119 PL_sighandlerp = proto_perl->Isighandlerp;
11121 PL_runops = proto_perl->Irunops;
11123 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11126 PL_cshlen = proto_perl->Icshlen;
11127 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11130 PL_lex_state = proto_perl->Ilex_state;
11131 PL_lex_defer = proto_perl->Ilex_defer;
11132 PL_lex_expect = proto_perl->Ilex_expect;
11133 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11134 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11135 PL_lex_starts = proto_perl->Ilex_starts;
11136 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11137 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11138 PL_lex_op = proto_perl->Ilex_op;
11139 PL_lex_inpat = proto_perl->Ilex_inpat;
11140 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11141 PL_lex_brackets = proto_perl->Ilex_brackets;
11142 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11143 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11144 PL_lex_casemods = proto_perl->Ilex_casemods;
11145 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11146 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11149 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11150 PL_lasttoke = proto_perl->Ilasttoke;
11151 PL_realtokenstart = proto_perl->Irealtokenstart;
11152 PL_faketokens = proto_perl->Ifaketokens;
11153 PL_thismad = proto_perl->Ithismad;
11154 PL_thistoken = proto_perl->Ithistoken;
11155 PL_thisopen = proto_perl->Ithisopen;
11156 PL_thisstuff = proto_perl->Ithisstuff;
11157 PL_thisclose = proto_perl->Ithisclose;
11158 PL_thiswhite = proto_perl->Ithiswhite;
11159 PL_nextwhite = proto_perl->Inextwhite;
11160 PL_skipwhite = proto_perl->Iskipwhite;
11161 PL_endwhite = proto_perl->Iendwhite;
11162 PL_curforce = proto_perl->Icurforce;
11164 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11165 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11166 PL_nexttoke = proto_perl->Inexttoke;
11169 /* XXX This is probably masking the deeper issue of why
11170 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11171 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11172 * (A little debugging with a watchpoint on it may help.)
11174 if (SvANY(proto_perl->Ilinestr)) {
11175 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11176 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11177 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11178 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11179 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11180 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11181 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11182 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11183 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11186 PL_linestr = newSV(79);
11187 sv_upgrade(PL_linestr,SVt_PVIV);
11188 sv_setpvn(PL_linestr,"",0);
11189 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11191 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11192 PL_pending_ident = proto_perl->Ipending_ident;
11193 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11195 PL_expect = proto_perl->Iexpect;
11197 PL_multi_start = proto_perl->Imulti_start;
11198 PL_multi_end = proto_perl->Imulti_end;
11199 PL_multi_open = proto_perl->Imulti_open;
11200 PL_multi_close = proto_perl->Imulti_close;
11202 PL_error_count = proto_perl->Ierror_count;
11203 PL_subline = proto_perl->Isubline;
11204 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11206 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11207 if (SvANY(proto_perl->Ilinestr)) {
11208 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11209 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11210 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11211 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 PL_last_lop_op = proto_perl->Ilast_lop_op;
11215 PL_last_uni = SvPVX(PL_linestr);
11216 PL_last_lop = SvPVX(PL_linestr);
11217 PL_last_lop_op = 0;
11219 PL_in_my = proto_perl->Iin_my;
11220 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11222 PL_cryptseen = proto_perl->Icryptseen;
11225 PL_hints = proto_perl->Ihints;
11227 PL_amagic_generation = proto_perl->Iamagic_generation;
11229 #ifdef USE_LOCALE_COLLATE
11230 PL_collation_ix = proto_perl->Icollation_ix;
11231 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11232 PL_collation_standard = proto_perl->Icollation_standard;
11233 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11234 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11235 #endif /* USE_LOCALE_COLLATE */
11237 #ifdef USE_LOCALE_NUMERIC
11238 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11239 PL_numeric_standard = proto_perl->Inumeric_standard;
11240 PL_numeric_local = proto_perl->Inumeric_local;
11241 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11242 #endif /* !USE_LOCALE_NUMERIC */
11244 /* utf8 character classes */
11245 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11246 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11247 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11248 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11249 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11250 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11251 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11252 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11253 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11254 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11255 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11256 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11257 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11258 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11259 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11260 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11261 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11262 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11263 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11264 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11266 /* Did the locale setup indicate UTF-8? */
11267 PL_utf8locale = proto_perl->Iutf8locale;
11268 /* Unicode features (see perlrun/-C) */
11269 PL_unicode = proto_perl->Iunicode;
11271 /* Pre-5.8 signals control */
11272 PL_signals = proto_perl->Isignals;
11274 /* times() ticks per second */
11275 PL_clocktick = proto_perl->Iclocktick;
11277 /* Recursion stopper for PerlIO_find_layer */
11278 PL_in_load_module = proto_perl->Iin_load_module;
11280 /* sort() routine */
11281 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11283 /* Not really needed/useful since the reenrant_retint is "volatile",
11284 * but do it for consistency's sake. */
11285 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11287 /* Hooks to shared SVs and locks. */
11288 PL_sharehook = proto_perl->Isharehook;
11289 PL_lockhook = proto_perl->Ilockhook;
11290 PL_unlockhook = proto_perl->Iunlockhook;
11291 PL_threadhook = proto_perl->Ithreadhook;
11293 PL_runops_std = proto_perl->Irunops_std;
11294 PL_runops_dbg = proto_perl->Irunops_dbg;
11296 #ifdef THREADS_HAVE_PIDS
11297 PL_ppid = proto_perl->Ippid;
11301 PL_last_swash_hv = NULL; /* reinits on demand */
11302 PL_last_swash_klen = 0;
11303 PL_last_swash_key[0]= '\0';
11304 PL_last_swash_tmps = (U8*)NULL;
11305 PL_last_swash_slen = 0;
11307 PL_glob_index = proto_perl->Iglob_index;
11308 PL_srand_called = proto_perl->Isrand_called;
11309 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11310 PL_bitcount = NULL; /* reinits on demand */
11312 if (proto_perl->Ipsig_pend) {
11313 Newxz(PL_psig_pend, SIG_SIZE, int);
11316 PL_psig_pend = (int*)NULL;
11319 if (proto_perl->Ipsig_ptr) {
11320 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11321 Newxz(PL_psig_name, SIG_SIZE, SV*);
11322 for (i = 1; i < SIG_SIZE; i++) {
11323 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11324 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11328 PL_psig_ptr = (SV**)NULL;
11329 PL_psig_name = (SV**)NULL;
11332 /* thrdvar.h stuff */
11334 if (flags & CLONEf_COPY_STACKS) {
11335 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11336 PL_tmps_ix = proto_perl->Ttmps_ix;
11337 PL_tmps_max = proto_perl->Ttmps_max;
11338 PL_tmps_floor = proto_perl->Ttmps_floor;
11339 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11341 while (i <= PL_tmps_ix) {
11342 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11346 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11347 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11348 Newxz(PL_markstack, i, I32);
11349 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11350 - proto_perl->Tmarkstack);
11351 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11352 - proto_perl->Tmarkstack);
11353 Copy(proto_perl->Tmarkstack, PL_markstack,
11354 PL_markstack_ptr - PL_markstack + 1, I32);
11356 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11357 * NOTE: unlike the others! */
11358 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11359 PL_scopestack_max = proto_perl->Tscopestack_max;
11360 Newxz(PL_scopestack, PL_scopestack_max, I32);
11361 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11363 /* NOTE: si_dup() looks at PL_markstack */
11364 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11366 /* PL_curstack = PL_curstackinfo->si_stack; */
11367 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11368 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11370 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11371 PL_stack_base = AvARRAY(PL_curstack);
11372 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11373 - proto_perl->Tstack_base);
11374 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11376 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11377 * NOTE: unlike the others! */
11378 PL_savestack_ix = proto_perl->Tsavestack_ix;
11379 PL_savestack_max = proto_perl->Tsavestack_max;
11380 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11381 PL_savestack = ss_dup(proto_perl, param);
11385 ENTER; /* perl_destruct() wants to LEAVE; */
11387 /* although we're not duplicating the tmps stack, we should still
11388 * add entries for any SVs on the tmps stack that got cloned by a
11389 * non-refcount means (eg a temp in @_); otherwise they will be
11392 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11393 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11394 proto_perl->Ttmps_stack[i]);
11395 if (nsv && !SvREFCNT(nsv)) {
11397 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11402 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11403 PL_top_env = &PL_start_env;
11405 PL_op = proto_perl->Top;
11408 PL_Xpv = (XPV*)NULL;
11409 PL_na = proto_perl->Tna;
11411 PL_statbuf = proto_perl->Tstatbuf;
11412 PL_statcache = proto_perl->Tstatcache;
11413 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11414 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11416 PL_timesbuf = proto_perl->Ttimesbuf;
11419 PL_tainted = proto_perl->Ttainted;
11420 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11421 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11422 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11423 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11424 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11425 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11426 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11427 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11428 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11430 PL_restartop = proto_perl->Trestartop;
11431 PL_in_eval = proto_perl->Tin_eval;
11432 PL_delaymagic = proto_perl->Tdelaymagic;
11433 PL_dirty = proto_perl->Tdirty;
11434 PL_localizing = proto_perl->Tlocalizing;
11436 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11437 PL_hv_fetch_ent_mh = NULL;
11438 PL_modcount = proto_perl->Tmodcount;
11439 PL_lastgotoprobe = NULL;
11440 PL_dumpindent = proto_perl->Tdumpindent;
11442 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11443 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11444 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11445 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11446 PL_efloatbuf = NULL; /* reinits on demand */
11447 PL_efloatsize = 0; /* reinits on demand */
11451 PL_screamfirst = NULL;
11452 PL_screamnext = NULL;
11453 PL_maxscream = -1; /* reinits on demand */
11454 PL_lastscream = NULL;
11456 PL_watchaddr = NULL;
11459 PL_regdummy = proto_perl->Tregdummy;
11460 PL_colorset = 0; /* reinits PL_colors[] */
11461 /*PL_colors[6] = {0,0,0,0,0,0};*/
11465 /* Pluggable optimizer */
11466 PL_peepp = proto_perl->Tpeepp;
11468 PL_stashcache = newHV();
11470 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11471 ptr_table_free(PL_ptr_table);
11472 PL_ptr_table = NULL;
11475 /* Call the ->CLONE method, if it exists, for each of the stashes
11476 identified by sv_dup() above.
11478 while(av_len(param->stashes) != -1) {
11479 HV* const stash = (HV*) av_shift(param->stashes);
11480 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11481 if (cloner && GvCV(cloner)) {
11486 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11488 call_sv((SV*)GvCV(cloner), G_DISCARD);
11494 SvREFCNT_dec(param->stashes);
11496 /* orphaned? eg threads->new inside BEGIN or use */
11497 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11498 SvREFCNT_inc_simple_void(PL_compcv);
11499 SAVEFREESV(PL_compcv);
11505 #endif /* USE_ITHREADS */
11508 =head1 Unicode Support
11510 =for apidoc sv_recode_to_utf8
11512 The encoding is assumed to be an Encode object, on entry the PV
11513 of the sv is assumed to be octets in that encoding, and the sv
11514 will be converted into Unicode (and UTF-8).
11516 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11517 is not a reference, nothing is done to the sv. If the encoding is not
11518 an C<Encode::XS> Encoding object, bad things will happen.
11519 (See F<lib/encoding.pm> and L<Encode>).
11521 The PV of the sv is returned.
11526 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11529 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11543 Passing sv_yes is wrong - it needs to be or'ed set of constants
11544 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11545 remove converted chars from source.
11547 Both will default the value - let them.
11549 XPUSHs(&PL_sv_yes);
11552 call_method("decode", G_SCALAR);
11556 s = SvPV_const(uni, len);
11557 if (s != SvPVX_const(sv)) {
11558 SvGROW(sv, len + 1);
11559 Move(s, SvPVX(sv), len + 1, char);
11560 SvCUR_set(sv, len);
11567 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11571 =for apidoc sv_cat_decode
11573 The encoding is assumed to be an Encode object, the PV of the ssv is
11574 assumed to be octets in that encoding and decoding the input starts
11575 from the position which (PV + *offset) pointed to. The dsv will be
11576 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11577 when the string tstr appears in decoding output or the input ends on
11578 the PV of the ssv. The value which the offset points will be modified
11579 to the last input position on the ssv.
11581 Returns TRUE if the terminator was found, else returns FALSE.
11586 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11587 SV *ssv, int *offset, char *tstr, int tlen)
11591 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11602 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11603 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11605 call_method("cat_decode", G_SCALAR);
11607 ret = SvTRUE(TOPs);
11608 *offset = SvIV(offsv);
11614 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11619 /* ---------------------------------------------------------------------
11621 * support functions for report_uninit()
11624 /* the maxiumum size of array or hash where we will scan looking
11625 * for the undefined element that triggered the warning */
11627 #define FUV_MAX_SEARCH_SIZE 1000
11629 /* Look for an entry in the hash whose value has the same SV as val;
11630 * If so, return a mortal copy of the key. */
11633 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11636 register HE **array;
11639 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11640 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11643 array = HvARRAY(hv);
11645 for (i=HvMAX(hv); i>0; i--) {
11646 register HE *entry;
11647 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11648 if (HeVAL(entry) != val)
11650 if ( HeVAL(entry) == &PL_sv_undef ||
11651 HeVAL(entry) == &PL_sv_placeholder)
11655 if (HeKLEN(entry) == HEf_SVKEY)
11656 return sv_mortalcopy(HeKEY_sv(entry));
11657 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11663 /* Look for an entry in the array whose value has the same SV as val;
11664 * If so, return the index, otherwise return -1. */
11667 S_find_array_subscript(pTHX_ AV *av, SV* val)
11670 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11671 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11674 if (val != &PL_sv_undef) {
11675 SV ** const svp = AvARRAY(av);
11678 for (i=AvFILLp(av); i>=0; i--)
11685 /* S_varname(): return the name of a variable, optionally with a subscript.
11686 * If gv is non-zero, use the name of that global, along with gvtype (one
11687 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11688 * targ. Depending on the value of the subscript_type flag, return:
11691 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11692 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11693 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11694 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11697 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11698 SV* keyname, I32 aindex, int subscript_type)
11701 SV * const name = sv_newmortal();
11704 buffer[0] = gvtype;
11707 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11709 gv_fullname4(name, gv, buffer, 0);
11711 if ((unsigned int)SvPVX(name)[1] <= 26) {
11713 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11715 /* Swap the 1 unprintable control character for the 2 byte pretty
11716 version - ie substr($name, 1, 1) = $buffer; */
11717 sv_insert(name, 1, 1, buffer, 2);
11722 CV * const cv = find_runcv(&unused);
11726 if (!cv || !CvPADLIST(cv))
11728 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11729 sv = *av_fetch(av, targ, FALSE);
11730 /* SvLEN in a pad name is not to be trusted */
11731 sv_setpv(name, SvPV_nolen_const(sv));
11734 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11735 SV * const sv = newSV(0);
11736 *SvPVX(name) = '$';
11737 Perl_sv_catpvf(aTHX_ name, "{%s}",
11738 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11741 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11742 *SvPVX(name) = '$';
11743 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11745 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11746 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11753 =for apidoc find_uninit_var
11755 Find the name of the undefined variable (if any) that caused the operator o
11756 to issue a "Use of uninitialized value" warning.
11757 If match is true, only return a name if it's value matches uninit_sv.
11758 So roughly speaking, if a unary operator (such as OP_COS) generates a
11759 warning, then following the direct child of the op may yield an
11760 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11761 other hand, with OP_ADD there are two branches to follow, so we only print
11762 the variable name if we get an exact match.
11764 The name is returned as a mortal SV.
11766 Assumes that PL_op is the op that originally triggered the error, and that
11767 PL_comppad/PL_curpad points to the currently executing pad.
11773 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11781 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11782 uninit_sv == &PL_sv_placeholder)))
11785 switch (obase->op_type) {
11792 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11793 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11796 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11798 if (pad) { /* @lex, %lex */
11799 sv = PAD_SVl(obase->op_targ);
11803 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11804 /* @global, %global */
11805 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11808 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11810 else /* @{expr}, %{expr} */
11811 return find_uninit_var(cUNOPx(obase)->op_first,
11815 /* attempt to find a match within the aggregate */
11817 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11819 subscript_type = FUV_SUBSCRIPT_HASH;
11822 index = find_array_subscript((AV*)sv, uninit_sv);
11824 subscript_type = FUV_SUBSCRIPT_ARRAY;
11827 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11830 return varname(gv, hash ? '%' : '@', obase->op_targ,
11831 keysv, index, subscript_type);
11835 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11837 return varname(NULL, '$', obase->op_targ,
11838 NULL, 0, FUV_SUBSCRIPT_NONE);
11841 gv = cGVOPx_gv(obase);
11842 if (!gv || (match && GvSV(gv) != uninit_sv))
11844 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11847 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11850 av = (AV*)PAD_SV(obase->op_targ);
11851 if (!av || SvRMAGICAL(av))
11853 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11854 if (!svp || *svp != uninit_sv)
11857 return varname(NULL, '$', obase->op_targ,
11858 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11861 gv = cGVOPx_gv(obase);
11867 if (!av || SvRMAGICAL(av))
11869 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11870 if (!svp || *svp != uninit_sv)
11873 return varname(gv, '$', 0,
11874 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11879 o = cUNOPx(obase)->op_first;
11880 if (!o || o->op_type != OP_NULL ||
11881 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11883 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11887 if (PL_op == obase)
11888 /* $a[uninit_expr] or $h{uninit_expr} */
11889 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11892 o = cBINOPx(obase)->op_first;
11893 kid = cBINOPx(obase)->op_last;
11895 /* get the av or hv, and optionally the gv */
11897 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11898 sv = PAD_SV(o->op_targ);
11900 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11901 && cUNOPo->op_first->op_type == OP_GV)
11903 gv = cGVOPx_gv(cUNOPo->op_first);
11906 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11911 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11912 /* index is constant */
11916 if (obase->op_type == OP_HELEM) {
11917 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11918 if (!he || HeVAL(he) != uninit_sv)
11922 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11923 if (!svp || *svp != uninit_sv)
11927 if (obase->op_type == OP_HELEM)
11928 return varname(gv, '%', o->op_targ,
11929 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11931 return varname(gv, '@', o->op_targ, NULL,
11932 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11935 /* index is an expression;
11936 * attempt to find a match within the aggregate */
11937 if (obase->op_type == OP_HELEM) {
11938 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11940 return varname(gv, '%', o->op_targ,
11941 keysv, 0, FUV_SUBSCRIPT_HASH);
11944 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11946 return varname(gv, '@', o->op_targ,
11947 NULL, index, FUV_SUBSCRIPT_ARRAY);
11952 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11954 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11959 /* only examine RHS */
11960 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11963 o = cUNOPx(obase)->op_first;
11964 if (o->op_type == OP_PUSHMARK)
11967 if (!o->op_sibling) {
11968 /* one-arg version of open is highly magical */
11970 if (o->op_type == OP_GV) { /* open FOO; */
11972 if (match && GvSV(gv) != uninit_sv)
11974 return varname(gv, '$', 0,
11975 NULL, 0, FUV_SUBSCRIPT_NONE);
11977 /* other possibilities not handled are:
11978 * open $x; or open my $x; should return '${*$x}'
11979 * open expr; should return '$'.expr ideally
11985 /* ops where $_ may be an implicit arg */
11989 if ( !(obase->op_flags & OPf_STACKED)) {
11990 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11991 ? PAD_SVl(obase->op_targ)
11994 sv = sv_newmortal();
11995 sv_setpvn(sv, "$_", 2);
12003 /* skip filehandle as it can't produce 'undef' warning */
12004 o = cUNOPx(obase)->op_first;
12005 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12006 o = o->op_sibling->op_sibling;
12013 match = 1; /* XS or custom code could trigger random warnings */
12018 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12019 return sv_2mortal(newSVpvs("${$/}"));
12024 if (!(obase->op_flags & OPf_KIDS))
12026 o = cUNOPx(obase)->op_first;
12032 /* if all except one arg are constant, or have no side-effects,
12033 * or are optimized away, then it's unambiguous */
12035 for (kid=o; kid; kid = kid->op_sibling) {
12037 const OPCODE type = kid->op_type;
12038 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12039 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12040 || (type == OP_PUSHMARK)
12044 if (o2) { /* more than one found */
12051 return find_uninit_var(o2, uninit_sv, match);
12053 /* scan all args */
12055 sv = find_uninit_var(o, uninit_sv, 1);
12067 =for apidoc report_uninit
12069 Print appropriate "Use of uninitialized variable" warning
12075 Perl_report_uninit(pTHX_ SV* uninit_sv)
12079 SV* varname = NULL;
12081 varname = find_uninit_var(PL_op, uninit_sv,0);
12083 sv_insert(varname, 0, 0, " ", 1);
12085 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12086 varname ? SvPV_nolen_const(varname) : "",
12087 " in ", OP_DESC(PL_op));
12090 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12096 * c-indentation-style: bsd
12097 * c-basic-offset: 4
12098 * indent-tabs-mode: t
12101 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob