3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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 /* The bind placeholder pretends to be an RV for now.
891 Also it's marked as "can't upgrade" top stop anyone using it before it's
893 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
895 /* IVs are in the head, so the allocation size is 0.
896 However, the slot is overloaded for PTEs. */
897 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
898 sizeof(IV), /* This is used to copy out the IV body. */
899 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
900 NOARENA /* IVS don't need an arena */,
901 /* But PTEs need to know the size of their arena */
902 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
905 /* 8 bytes on most ILP32 with IEEE doubles */
906 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
907 FIT_ARENA(0, sizeof(NV)) },
909 /* RVs are in the head now. */
910 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
912 /* 8 bytes on most ILP32 with IEEE doubles */
913 { sizeof(xpv_allocated),
914 copy_length(XPV, xpv_len)
915 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
916 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
917 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
920 { sizeof(xpviv_allocated),
921 copy_length(XPVIV, xiv_u)
922 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
923 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
924 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
927 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
931 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
935 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
936 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
939 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
940 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
942 { sizeof(xpvav_allocated),
943 copy_length(XPVAV, xmg_stash)
944 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
946 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
948 { sizeof(xpvhv_allocated),
949 copy_length(XPVHV, xmg_stash)
950 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
952 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
955 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
956 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
957 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
959 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
960 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
961 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
963 /* XPVIO is 84 bytes, fits 48x */
964 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
965 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
968 #define new_body_type(sv_type) \
969 (void *)((char *)S_new_body(aTHX_ sv_type))
971 #define del_body_type(p, sv_type) \
972 del_body(p, &PL_body_roots[sv_type])
975 #define new_body_allocated(sv_type) \
976 (void *)((char *)S_new_body(aTHX_ sv_type) \
977 - bodies_by_type[sv_type].offset)
979 #define del_body_allocated(p, sv_type) \
980 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
983 #define my_safemalloc(s) (void*)safemalloc(s)
984 #define my_safecalloc(s) (void*)safecalloc(s, 1)
985 #define my_safefree(p) safefree((char*)p)
989 #define new_XNV() my_safemalloc(sizeof(XPVNV))
990 #define del_XNV(p) my_safefree(p)
992 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
993 #define del_XPVNV(p) my_safefree(p)
995 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
996 #define del_XPVAV(p) my_safefree(p)
998 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
999 #define del_XPVHV(p) my_safefree(p)
1001 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1002 #define del_XPVMG(p) my_safefree(p)
1004 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1005 #define del_XPVGV(p) my_safefree(p)
1009 #define new_XNV() new_body_type(SVt_NV)
1010 #define del_XNV(p) del_body_type(p, SVt_NV)
1012 #define new_XPVNV() new_body_type(SVt_PVNV)
1013 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1015 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1016 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1018 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1019 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1021 #define new_XPVMG() new_body_type(SVt_PVMG)
1022 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1024 #define new_XPVGV() new_body_type(SVt_PVGV)
1025 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1029 /* no arena for you! */
1031 #define new_NOARENA(details) \
1032 my_safemalloc((details)->body_size + (details)->offset)
1033 #define new_NOARENAZ(details) \
1034 my_safecalloc((details)->body_size + (details)->offset)
1036 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1037 static bool done_sanity_check;
1041 S_more_bodies (pTHX_ svtype sv_type)
1044 void ** const root = &PL_body_roots[sv_type];
1045 const struct body_details * const bdp = &bodies_by_type[sv_type];
1046 const size_t body_size = bdp->body_size;
1050 assert(bdp->arena_size);
1052 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1053 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1054 * variables like done_sanity_check. */
1055 if (!done_sanity_check) {
1056 unsigned int i = SVt_LAST;
1058 done_sanity_check = TRUE;
1061 assert (bodies_by_type[i].type == i);
1065 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1067 end = start + bdp->arena_size - body_size;
1069 /* computed count doesnt reflect the 1st slot reservation */
1070 DEBUG_m(PerlIO_printf(Perl_debug_log,
1071 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1073 (int)bdp->arena_size, sv_type, (int)body_size,
1074 (int)bdp->arena_size / (int)body_size));
1076 *root = (void *)start;
1078 while (start < end) {
1079 char * const next = start + body_size;
1080 *(void**) start = (void *)next;
1083 *(void **)start = 0;
1088 /* grab a new thing from the free list, allocating more if necessary.
1089 The inline version is used for speed in hot routines, and the
1090 function using it serves the rest (unless PURIFY).
1092 #define new_body_inline(xpv, sv_type) \
1094 void ** const r3wt = &PL_body_roots[sv_type]; \
1096 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1097 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1098 *(r3wt) = *(void**)(xpv); \
1105 S_new_body(pTHX_ svtype sv_type)
1109 new_body_inline(xpv, sv_type);
1116 =for apidoc sv_upgrade
1118 Upgrade an SV to a more complex form. Generally adds a new body type to the
1119 SV, then copies across as much information as possible from the old body.
1120 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1126 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1131 const svtype old_type = SvTYPE(sv);
1132 const struct body_details *new_type_details;
1133 const struct body_details *const old_type_details
1134 = bodies_by_type + old_type;
1136 if (new_type != SVt_PV && SvIsCOW(sv)) {
1137 sv_force_normal_flags(sv, 0);
1140 if (old_type == new_type)
1143 if (old_type > new_type)
1144 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1145 (int)old_type, (int)new_type);
1148 old_body = SvANY(sv);
1150 /* Copying structures onto other structures that have been neatly zeroed
1151 has a subtle gotcha. Consider XPVMG
1153 +------+------+------+------+------+-------+-------+
1154 | NV | CUR | LEN | IV | MAGIC | STASH |
1155 +------+------+------+------+------+-------+-------+
1156 0 4 8 12 16 20 24 28
1158 where NVs are aligned to 8 bytes, so that sizeof that structure is
1159 actually 32 bytes long, with 4 bytes of padding at the end:
1161 +------+------+------+------+------+-------+-------+------+
1162 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1163 +------+------+------+------+------+-------+-------+------+
1164 0 4 8 12 16 20 24 28 32
1166 so what happens if you allocate memory for this structure:
1168 +------+------+------+------+------+-------+-------+------+------+...
1169 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1170 +------+------+------+------+------+-------+-------+------+------+...
1171 0 4 8 12 16 20 24 28 32 36
1173 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1174 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1175 started out as zero once, but it's quite possible that it isn't. So now,
1176 rather than a nicely zeroed GP, you have it pointing somewhere random.
1179 (In fact, GP ends up pointing at a previous GP structure, because the
1180 principle cause of the padding in XPVMG getting garbage is a copy of
1181 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1182 this happens to be moot because XPVGV has been re-ordered, with GP
1183 no longer after STASH)
1185 So we are careful and work out the size of used parts of all the
1192 if (new_type < SVt_PVIV) {
1193 new_type = (new_type == SVt_NV)
1194 ? SVt_PVNV : SVt_PVIV;
1198 if (new_type < SVt_PVNV) {
1199 new_type = SVt_PVNV;
1205 assert(new_type > SVt_PV);
1206 assert(SVt_IV < SVt_PV);
1207 assert(SVt_NV < SVt_PV);
1214 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1215 there's no way that it can be safely upgraded, because perl.c
1216 expects to Safefree(SvANY(PL_mess_sv)) */
1217 assert(sv != PL_mess_sv);
1218 /* This flag bit is used to mean other things in other scalar types.
1219 Given that it only has meaning inside the pad, it shouldn't be set
1220 on anything that can get upgraded. */
1221 assert(!SvPAD_TYPED(sv));
1224 if (old_type_details->cant_upgrade)
1225 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1226 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1228 new_type_details = bodies_by_type + new_type;
1230 SvFLAGS(sv) &= ~SVTYPEMASK;
1231 SvFLAGS(sv) |= new_type;
1233 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1234 the return statements above will have triggered. */
1235 assert (new_type != SVt_NULL);
1238 assert(old_type == SVt_NULL);
1239 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1243 assert(old_type == SVt_NULL);
1244 SvANY(sv) = new_XNV();
1248 assert(old_type == SVt_NULL);
1249 SvANY(sv) = &sv->sv_u.svu_rv;
1254 assert(new_type_details->body_size);
1257 assert(new_type_details->arena);
1258 assert(new_type_details->arena_size);
1259 /* This points to the start of the allocated area. */
1260 new_body_inline(new_body, new_type);
1261 Zero(new_body, new_type_details->body_size, char);
1262 new_body = ((char *)new_body) - new_type_details->offset;
1264 /* We always allocated the full length item with PURIFY. To do this
1265 we fake things so that arena is false for all 16 types.. */
1266 new_body = new_NOARENAZ(new_type_details);
1268 SvANY(sv) = new_body;
1269 if (new_type == SVt_PVAV) {
1275 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1276 The target created by newSVrv also is, and it can have magic.
1277 However, it never has SvPVX set.
1279 if (old_type >= SVt_RV) {
1280 assert(SvPVX_const(sv) == 0);
1283 if (old_type >= SVt_PVMG) {
1284 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1285 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1287 sv->sv_u.svu_array = NULL; /* or svu_hash */
1293 /* XXX Is this still needed? Was it ever needed? Surely as there is
1294 no route from NV to PVIV, NOK can never be true */
1295 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = (char*)saferealloc(s, newlen);
1456 s = (char*)safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
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) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2165 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2166 cache IVs just in case. In practice it seems that they never
2167 actually anywhere accessible by user Perl code, let alone get used
2168 in anything other than a string context. */
2169 if (flags & SV_GMAGIC)
2174 return I_V(SvNVX(sv));
2176 if (SvPOKp(sv) && SvLEN(sv)) {
2179 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2181 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2182 == IS_NUMBER_IN_UV) {
2183 /* It's definitely an integer */
2184 if (numtype & IS_NUMBER_NEG) {
2185 if (value < (UV)IV_MIN)
2188 if (value < (UV)IV_MAX)
2193 if (ckWARN(WARN_NUMERIC))
2196 return I_V(Atof(SvPVX_const(sv)));
2201 assert(SvTYPE(sv) >= SVt_PVMG);
2202 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2203 } else if (SvTHINKFIRST(sv)) {
2207 SV * const tmpstr=AMG_CALLun(sv,numer);
2208 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2209 return SvIV(tmpstr);
2212 return PTR2IV(SvRV(sv));
2215 sv_force_normal_flags(sv, 0);
2217 if (SvREADONLY(sv) && !SvOK(sv)) {
2218 if (ckWARN(WARN_UNINITIALIZED))
2224 if (S_sv_2iuv_common(aTHX_ sv))
2227 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2228 PTR2UV(sv),SvIVX(sv)));
2229 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2233 =for apidoc sv_2uv_flags
2235 Return the unsigned integer value of an SV, doing any necessary string
2236 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2237 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2243 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2248 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2249 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2250 cache IVs just in case. */
2251 if (flags & SV_GMAGIC)
2256 return U_V(SvNVX(sv));
2257 if (SvPOKp(sv) && SvLEN(sv)) {
2260 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2262 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2263 == IS_NUMBER_IN_UV) {
2264 /* It's definitely an integer */
2265 if (!(numtype & IS_NUMBER_NEG))
2269 if (ckWARN(WARN_NUMERIC))
2272 return U_V(Atof(SvPVX_const(sv)));
2277 assert(SvTYPE(sv) >= SVt_PVMG);
2278 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2279 } else if (SvTHINKFIRST(sv)) {
2283 SV *const tmpstr = AMG_CALLun(sv,numer);
2284 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2285 return SvUV(tmpstr);
2288 return PTR2UV(SvRV(sv));
2291 sv_force_normal_flags(sv, 0);
2293 if (SvREADONLY(sv) && !SvOK(sv)) {
2294 if (ckWARN(WARN_UNINITIALIZED))
2300 if (S_sv_2iuv_common(aTHX_ sv))
2304 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2305 PTR2UV(sv),SvUVX(sv)));
2306 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2312 Return the num value of an SV, doing any necessary string or integer
2313 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2320 Perl_sv_2nv(pTHX_ register SV *sv)
2325 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2326 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2327 cache IVs just in case. */
2331 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2332 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2333 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2335 return Atof(SvPVX_const(sv));
2339 return (NV)SvUVX(sv);
2341 return (NV)SvIVX(sv);
2346 assert(SvTYPE(sv) >= SVt_PVMG);
2347 /* This falls through to the report_uninit near the end of the
2349 } else if (SvTHINKFIRST(sv)) {
2353 SV *const tmpstr = AMG_CALLun(sv,numer);
2354 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2355 return SvNV(tmpstr);
2358 return PTR2NV(SvRV(sv));
2361 sv_force_normal_flags(sv, 0);
2363 if (SvREADONLY(sv) && !SvOK(sv)) {
2364 if (ckWARN(WARN_UNINITIALIZED))
2369 if (SvTYPE(sv) < SVt_NV) {
2370 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2371 sv_upgrade(sv, SVt_NV);
2372 #ifdef USE_LONG_DOUBLE
2374 STORE_NUMERIC_LOCAL_SET_STANDARD();
2375 PerlIO_printf(Perl_debug_log,
2376 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2377 PTR2UV(sv), SvNVX(sv));
2378 RESTORE_NUMERIC_LOCAL();
2382 STORE_NUMERIC_LOCAL_SET_STANDARD();
2383 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2384 PTR2UV(sv), SvNVX(sv));
2385 RESTORE_NUMERIC_LOCAL();
2389 else if (SvTYPE(sv) < SVt_PVNV)
2390 sv_upgrade(sv, SVt_PVNV);
2395 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2396 #ifdef NV_PRESERVES_UV
2399 /* Only set the public NV OK flag if this NV preserves the IV */
2400 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2401 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2402 : (SvIVX(sv) == I_V(SvNVX(sv))))
2408 else if (SvPOKp(sv) && SvLEN(sv)) {
2410 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2411 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2413 #ifdef NV_PRESERVES_UV
2414 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2415 == IS_NUMBER_IN_UV) {
2416 /* It's definitely an integer */
2417 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2419 SvNV_set(sv, Atof(SvPVX_const(sv)));
2422 SvNV_set(sv, Atof(SvPVX_const(sv)));
2423 /* Only set the public NV OK flag if this NV preserves the value in
2424 the PV at least as well as an IV/UV would.
2425 Not sure how to do this 100% reliably. */
2426 /* if that shift count is out of range then Configure's test is
2427 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2429 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2430 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2431 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2432 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2433 /* Can't use strtol etc to convert this string, so don't try.
2434 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2437 /* value has been set. It may not be precise. */
2438 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2439 /* 2s complement assumption for (UV)IV_MIN */
2440 SvNOK_on(sv); /* Integer is too negative. */
2445 if (numtype & IS_NUMBER_NEG) {
2446 SvIV_set(sv, -(IV)value);
2447 } else if (value <= (UV)IV_MAX) {
2448 SvIV_set(sv, (IV)value);
2450 SvUV_set(sv, value);
2454 if (numtype & IS_NUMBER_NOT_INT) {
2455 /* I believe that even if the original PV had decimals,
2456 they are lost beyond the limit of the FP precision.
2457 However, neither is canonical, so both only get p
2458 flags. NWC, 2000/11/25 */
2459 /* Both already have p flags, so do nothing */
2461 const NV nv = SvNVX(sv);
2462 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2463 if (SvIVX(sv) == I_V(nv)) {
2466 /* It had no "." so it must be integer. */
2470 /* between IV_MAX and NV(UV_MAX).
2471 Could be slightly > UV_MAX */
2473 if (numtype & IS_NUMBER_NOT_INT) {
2474 /* UV and NV both imprecise. */
2476 const UV nv_as_uv = U_V(nv);
2478 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2487 #endif /* NV_PRESERVES_UV */
2490 if (isGV_with_GP(sv)) {
2491 glob_2number((GV *)sv);
2495 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2497 assert (SvTYPE(sv) >= SVt_NV);
2498 /* Typically the caller expects that sv_any is not NULL now. */
2499 /* XXX Ilya implies that this is a bug in callers that assume this
2500 and ideally should be fixed. */
2503 #if defined(USE_LONG_DOUBLE)
2505 STORE_NUMERIC_LOCAL_SET_STANDARD();
2506 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2507 PTR2UV(sv), SvNVX(sv));
2508 RESTORE_NUMERIC_LOCAL();
2512 STORE_NUMERIC_LOCAL_SET_STANDARD();
2513 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2514 PTR2UV(sv), SvNVX(sv));
2515 RESTORE_NUMERIC_LOCAL();
2521 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2522 * UV as a string towards the end of buf, and return pointers to start and
2525 * We assume that buf is at least TYPE_CHARS(UV) long.
2529 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2531 char *ptr = buf + TYPE_CHARS(UV);
2532 char * const ebuf = ptr;
2545 *--ptr = '0' + (char)(uv % 10);
2554 =for apidoc sv_2pv_flags
2556 Returns a pointer to the string value of an SV, and sets *lp to its length.
2557 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2559 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2560 usually end up here too.
2566 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2576 if (SvGMAGICAL(sv)) {
2577 if (flags & SV_GMAGIC)
2582 if (flags & SV_MUTABLE_RETURN)
2583 return SvPVX_mutable(sv);
2584 if (flags & SV_CONST_RETURN)
2585 return (char *)SvPVX_const(sv);
2588 if (SvIOKp(sv) || SvNOKp(sv)) {
2589 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2594 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2595 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2597 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2604 #ifdef FIXNEGATIVEZERO
2605 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2611 SvUPGRADE(sv, SVt_PV);
2614 s = SvGROW_mutable(sv, len + 1);
2617 return (char*)memcpy(s, tbuf, len + 1);
2623 assert(SvTYPE(sv) >= SVt_PVMG);
2624 /* This falls through to the report_uninit near the end of the
2626 } else if (SvTHINKFIRST(sv)) {
2630 SV *const tmpstr = AMG_CALLun(sv,string);
2631 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2633 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2637 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2638 if (flags & SV_CONST_RETURN) {
2639 pv = (char *) SvPVX_const(tmpstr);
2641 pv = (flags & SV_MUTABLE_RETURN)
2642 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2645 *lp = SvCUR(tmpstr);
2647 pv = sv_2pv_flags(tmpstr, lp, flags);
2661 const SV *const referent = (SV*)SvRV(sv);
2665 retval = buffer = savepvn("NULLREF", len);
2666 } else if (SvTYPE(referent) == SVt_PVMG
2667 && ((SvFLAGS(referent) &
2668 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2669 == (SVs_OBJECT|SVs_SMG))
2670 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2675 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2680 PL_reginterp_cnt += haseval;
2683 const char *const typestr = sv_reftype(referent, 0);
2684 const STRLEN typelen = strlen(typestr);
2685 UV addr = PTR2UV(referent);
2686 const char *stashname = NULL;
2687 STRLEN stashnamelen = 0; /* hush, gcc */
2688 const char *buffer_end;
2690 if (SvOBJECT(referent)) {
2691 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2694 stashname = HEK_KEY(name);
2695 stashnamelen = HEK_LEN(name);
2697 if (HEK_UTF8(name)) {
2703 stashname = "__ANON__";
2706 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2707 + 2 * sizeof(UV) + 2 /* )\0 */;
2709 len = typelen + 3 /* (0x */
2710 + 2 * sizeof(UV) + 2 /* )\0 */;
2713 Newx(buffer, len, char);
2714 buffer_end = retval = buffer + len;
2716 /* Working backwards */
2720 *--retval = PL_hexdigit[addr & 15];
2721 } while (addr >>= 4);
2727 memcpy(retval, typestr, typelen);
2731 retval -= stashnamelen;
2732 memcpy(retval, stashname, stashnamelen);
2734 /* retval may not neccesarily have reached the start of the
2736 assert (retval >= buffer);
2738 len = buffer_end - retval - 1; /* -1 for that \0 */
2746 if (SvREADONLY(sv) && !SvOK(sv)) {
2747 if (ckWARN(WARN_UNINITIALIZED))
2754 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2755 /* I'm assuming that if both IV and NV are equally valid then
2756 converting the IV is going to be more efficient */
2757 const U32 isUIOK = SvIsUV(sv);
2758 char buf[TYPE_CHARS(UV)];
2761 if (SvTYPE(sv) < SVt_PVIV)
2762 sv_upgrade(sv, SVt_PVIV);
2763 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2764 /* inlined from sv_setpvn */
2765 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2766 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2767 SvCUR_set(sv, ebuf - ptr);
2771 else if (SvNOKp(sv)) {
2772 const int olderrno = errno;
2773 if (SvTYPE(sv) < SVt_PVNV)
2774 sv_upgrade(sv, SVt_PVNV);
2775 /* The +20 is pure guesswork. Configure test needed. --jhi */
2776 s = SvGROW_mutable(sv, NV_DIG + 20);
2777 /* some Xenix systems wipe out errno here */
2779 if (SvNVX(sv) == 0.0)
2780 my_strlcpy(s, "0", SvLEN(sv));
2784 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2787 #ifdef FIXNEGATIVEZERO
2788 if (*s == '-' && s[1] == '0' && !s[2])
2789 my_strlcpy(s, "0", SvLEN(s));
2798 if (isGV_with_GP(sv))
2799 return glob_2pv((GV *)sv, lp);
2801 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2805 if (SvTYPE(sv) < SVt_PV)
2806 /* Typically the caller expects that sv_any is not NULL now. */
2807 sv_upgrade(sv, SVt_PV);
2811 const STRLEN len = s - SvPVX_const(sv);
2817 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2818 PTR2UV(sv),SvPVX_const(sv)));
2819 if (flags & SV_CONST_RETURN)
2820 return (char *)SvPVX_const(sv);
2821 if (flags & SV_MUTABLE_RETURN)
2822 return SvPVX_mutable(sv);
2827 =for apidoc sv_copypv
2829 Copies a stringified representation of the source SV into the
2830 destination SV. Automatically performs any necessary mg_get and
2831 coercion of numeric values into strings. Guaranteed to preserve
2832 UTF-8 flag even from overloaded objects. Similar in nature to
2833 sv_2pv[_flags] but operates directly on an SV instead of just the
2834 string. Mostly uses sv_2pv_flags to do its work, except when that
2835 would lose the UTF-8'ness of the PV.
2841 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2844 const char * const s = SvPV_const(ssv,len);
2845 sv_setpvn(dsv,s,len);
2853 =for apidoc sv_2pvbyte
2855 Return a pointer to the byte-encoded representation of the SV, and set *lp
2856 to its length. May cause the SV to be downgraded from UTF-8 as a
2859 Usually accessed via the C<SvPVbyte> macro.
2865 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2867 sv_utf8_downgrade(sv,0);
2868 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2872 =for apidoc sv_2pvutf8
2874 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2875 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2877 Usually accessed via the C<SvPVutf8> macro.
2883 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2885 sv_utf8_upgrade(sv);
2886 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2891 =for apidoc sv_2bool
2893 This function is only called on magical items, and is only used by
2894 sv_true() or its macro equivalent.
2900 Perl_sv_2bool(pTHX_ register SV *sv)
2909 SV * const tmpsv = AMG_CALLun(sv,bool_);
2910 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2911 return (bool)SvTRUE(tmpsv);
2913 return SvRV(sv) != 0;
2916 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2918 (*sv->sv_u.svu_pv > '0' ||
2919 Xpvtmp->xpv_cur > 1 ||
2920 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2927 return SvIVX(sv) != 0;
2930 return SvNVX(sv) != 0.0;
2932 if (isGV_with_GP(sv))
2942 =for apidoc sv_utf8_upgrade
2944 Converts the PV of an SV to its UTF-8-encoded form.
2945 Forces the SV to string form if it is not already.
2946 Always sets the SvUTF8 flag to avoid future validity checks even
2947 if all the bytes have hibit clear.
2949 This is not as a general purpose byte encoding to Unicode interface:
2950 use the Encode extension for that.
2952 =for apidoc sv_utf8_upgrade_flags
2954 Converts the PV of an SV to its UTF-8-encoded form.
2955 Forces the SV to string form if it is not already.
2956 Always sets the SvUTF8 flag to avoid future validity checks even
2957 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2958 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2959 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2961 This is not as a general purpose byte encoding to Unicode interface:
2962 use the Encode extension for that.
2968 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2971 if (sv == &PL_sv_undef)
2975 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2976 (void) sv_2pv_flags(sv,&len, flags);
2980 (void) SvPV_force(sv,len);
2989 sv_force_normal_flags(sv, 0);
2992 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2993 sv_recode_to_utf8(sv, PL_encoding);
2994 else { /* Assume Latin-1/EBCDIC */
2995 /* This function could be much more efficient if we
2996 * had a FLAG in SVs to signal if there are any hibit
2997 * chars in the PV. Given that there isn't such a flag
2998 * make the loop as fast as possible. */
2999 const U8 * const s = (U8 *) SvPVX_const(sv);
3000 const U8 * const e = (U8 *) SvEND(sv);
3005 /* Check for hi bit */
3006 if (!NATIVE_IS_INVARIANT(ch)) {
3007 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3008 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3010 SvPV_free(sv); /* No longer using what was there before. */
3011 SvPV_set(sv, (char*)recoded);
3012 SvCUR_set(sv, len - 1);
3013 SvLEN_set(sv, len); /* No longer know the real size. */
3017 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3024 =for apidoc sv_utf8_downgrade
3026 Attempts to convert the PV of an SV from characters to bytes.
3027 If the PV contains a character beyond byte, this conversion will fail;
3028 in this case, either returns false or, if C<fail_ok> is not
3031 This is not as a general purpose Unicode to byte encoding interface:
3032 use the Encode extension for that.
3038 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3041 if (SvPOKp(sv) && SvUTF8(sv)) {
3047 sv_force_normal_flags(sv, 0);
3049 s = (U8 *) SvPV(sv, len);
3050 if (!utf8_to_bytes(s, &len)) {
3055 Perl_croak(aTHX_ "Wide character in %s",
3058 Perl_croak(aTHX_ "Wide character");
3069 =for apidoc sv_utf8_encode
3071 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3072 flag off so that it looks like octets again.
3078 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3081 sv_force_normal_flags(sv, 0);
3083 if (SvREADONLY(sv)) {
3084 Perl_croak(aTHX_ PL_no_modify);
3086 (void) sv_utf8_upgrade(sv);
3091 =for apidoc sv_utf8_decode
3093 If the PV of the SV is an octet sequence in UTF-8
3094 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3095 so that it looks like a character. If the PV contains only single-byte
3096 characters, the C<SvUTF8> flag stays being off.
3097 Scans PV for validity and returns false if the PV is invalid UTF-8.
3103 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3109 /* The octets may have got themselves encoded - get them back as
3112 if (!sv_utf8_downgrade(sv, TRUE))
3115 /* it is actually just a matter of turning the utf8 flag on, but
3116 * we want to make sure everything inside is valid utf8 first.
3118 c = (const U8 *) SvPVX_const(sv);
3119 if (!is_utf8_string(c, SvCUR(sv)+1))
3121 e = (const U8 *) SvEND(sv);
3124 if (!UTF8_IS_INVARIANT(ch)) {
3134 =for apidoc sv_setsv
3136 Copies the contents of the source SV C<ssv> into the destination SV
3137 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3138 function if the source SV needs to be reused. Does not handle 'set' magic.
3139 Loosely speaking, it performs a copy-by-value, obliterating any previous
3140 content of the destination.
3142 You probably want to use one of the assortment of wrappers, such as
3143 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3144 C<SvSetMagicSV_nosteal>.
3146 =for apidoc sv_setsv_flags
3148 Copies the contents of the source SV C<ssv> into the destination SV
3149 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3150 function if the source SV needs to be reused. Does not handle 'set' magic.
3151 Loosely speaking, it performs a copy-by-value, obliterating any previous
3152 content of the destination.
3153 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3154 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3155 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3156 and C<sv_setsv_nomg> are implemented in terms of this function.
3158 You probably want to use one of the assortment of wrappers, such as
3159 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3160 C<SvSetMagicSV_nosteal>.
3162 This is the primary function for copying scalars, and most other
3163 copy-ish functions and macros use this underneath.
3169 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3171 if (dtype != SVt_PVGV) {
3172 const char * const name = GvNAME(sstr);
3173 const STRLEN len = GvNAMELEN(sstr);
3174 /* don't upgrade SVt_PVLV: it can hold a glob */
3175 if (dtype != SVt_PVLV) {
3176 if (dtype >= SVt_PV) {
3182 sv_upgrade(dstr, SVt_PVGV);
3183 (void)SvOK_off(dstr);
3184 /* FIXME - why are we doing this, then turning it off and on again
3186 isGV_with_GP_on(dstr);
3188 GvSTASH(dstr) = GvSTASH(sstr);
3190 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3191 gv_name_set((GV *)dstr, name, len, GV_ADD);
3192 SvFAKE_on(dstr); /* can coerce to non-glob */
3195 #ifdef GV_UNIQUE_CHECK
3196 if (GvUNIQUE((GV*)dstr)) {
3197 Perl_croak(aTHX_ PL_no_modify);
3202 isGV_with_GP_off(dstr);
3203 (void)SvOK_off(dstr);
3204 isGV_with_GP_on(dstr);
3205 GvINTRO_off(dstr); /* one-shot flag */
3206 GvGP(dstr) = gp_ref(GvGP(sstr));
3207 if (SvTAINTED(sstr))
3209 if (GvIMPORTED(dstr) != GVf_IMPORTED
3210 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3212 GvIMPORTED_on(dstr);
3219 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3220 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3222 const int intro = GvINTRO(dstr);
3225 const U32 stype = SvTYPE(sref);
3228 #ifdef GV_UNIQUE_CHECK
3229 if (GvUNIQUE((GV*)dstr)) {
3230 Perl_croak(aTHX_ PL_no_modify);
3235 GvINTRO_off(dstr); /* one-shot flag */
3236 GvLINE(dstr) = CopLINE(PL_curcop);
3237 GvEGV(dstr) = (GV*)dstr;
3242 location = (SV **) &GvCV(dstr);
3243 import_flag = GVf_IMPORTED_CV;
3246 location = (SV **) &GvHV(dstr);
3247 import_flag = GVf_IMPORTED_HV;
3250 location = (SV **) &GvAV(dstr);
3251 import_flag = GVf_IMPORTED_AV;
3254 location = (SV **) &GvIOp(dstr);
3257 location = (SV **) &GvFORM(dstr);
3259 location = &GvSV(dstr);
3260 import_flag = GVf_IMPORTED_SV;
3263 if (stype == SVt_PVCV) {
3264 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3265 SvREFCNT_dec(GvCV(dstr));
3267 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3268 PL_sub_generation++;
3271 SAVEGENERICSV(*location);
3275 if (stype == SVt_PVCV && *location != sref) {
3276 CV* const cv = (CV*)*location;
3278 if (!GvCVGEN((GV*)dstr) &&
3279 (CvROOT(cv) || CvXSUB(cv)))
3281 /* Redefining a sub - warning is mandatory if
3282 it was a const and its value changed. */
3283 if (CvCONST(cv) && CvCONST((CV*)sref)
3284 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3286 /* They are 2 constant subroutines generated from
3287 the same constant. This probably means that
3288 they are really the "same" proxy subroutine
3289 instantiated in 2 places. Most likely this is
3290 when a constant is exported twice. Don't warn.
3293 else if (ckWARN(WARN_REDEFINE)
3295 && (!CvCONST((CV*)sref)
3296 || sv_cmp(cv_const_sv(cv),
3297 cv_const_sv((CV*)sref))))) {
3298 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3301 ? "Constant subroutine %s::%s redefined"
3302 : "Subroutine %s::%s redefined"),
3303 HvNAME_get(GvSTASH((GV*)dstr)),
3304 GvENAME((GV*)dstr));
3308 cv_ckproto_len(cv, (GV*)dstr,
3309 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3310 SvPOK(sref) ? SvCUR(sref) : 0);
3312 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3313 GvASSUMECV_on(dstr);
3314 PL_sub_generation++;
3317 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3318 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3319 GvFLAGS(dstr) |= import_flag;
3324 if (SvTAINTED(sstr))
3330 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3333 register U32 sflags;
3335 register svtype stype;
3340 if (SvIS_FREED(dstr)) {
3341 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3342 " to a freed scalar %p", sstr, dstr);
3344 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3346 sstr = &PL_sv_undef;
3347 if (SvIS_FREED(sstr)) {
3348 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3351 stype = SvTYPE(sstr);
3352 dtype = SvTYPE(dstr);
3357 /* need to nuke the magic */
3359 SvRMAGICAL_off(dstr);
3362 /* There's a lot of redundancy below but we're going for speed here */
3367 if (dtype != SVt_PVGV) {
3368 (void)SvOK_off(dstr);
3376 sv_upgrade(dstr, SVt_IV);
3381 sv_upgrade(dstr, SVt_PVIV);
3384 goto end_of_first_switch;
3386 (void)SvIOK_only(dstr);
3387 SvIV_set(dstr, SvIVX(sstr));
3390 /* SvTAINTED can only be true if the SV has taint magic, which in
3391 turn means that the SV type is PVMG (or greater). This is the
3392 case statement for SVt_IV, so this cannot be true (whatever gcov
3394 assert(!SvTAINTED(sstr));
3404 sv_upgrade(dstr, SVt_NV);
3409 sv_upgrade(dstr, SVt_PVNV);
3412 goto end_of_first_switch;
3414 SvNV_set(dstr, SvNVX(sstr));
3415 (void)SvNOK_only(dstr);
3416 /* SvTAINTED can only be true if the SV has taint magic, which in
3417 turn means that the SV type is PVMG (or greater). This is the
3418 case statement for SVt_NV, so this cannot be true (whatever gcov
3420 assert(!SvTAINTED(sstr));
3427 sv_upgrade(dstr, SVt_RV);
3430 #ifdef PERL_OLD_COPY_ON_WRITE
3431 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3432 if (dtype < SVt_PVIV)
3433 sv_upgrade(dstr, SVt_PVIV);
3440 sv_upgrade(dstr, SVt_PV);
3443 if (dtype < SVt_PVIV)
3444 sv_upgrade(dstr, SVt_PVIV);
3447 if (dtype < SVt_PVNV)
3448 sv_upgrade(dstr, SVt_PVNV);
3452 const char * const type = sv_reftype(sstr,0);
3454 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3456 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3460 /* case SVt_BIND: */
3462 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3463 glob_assign_glob(dstr, sstr, dtype);
3466 /* SvVALID means that this PVGV is playing at being an FBM. */
3471 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3473 if (SvTYPE(sstr) != stype) {
3474 stype = SvTYPE(sstr);
3475 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3476 glob_assign_glob(dstr, sstr, dtype);
3481 if (stype == SVt_PVLV)
3482 SvUPGRADE(dstr, SVt_PVNV);
3484 SvUPGRADE(dstr, (svtype)stype);
3486 end_of_first_switch:
3488 /* dstr may have been upgraded. */
3489 dtype = SvTYPE(dstr);
3490 sflags = SvFLAGS(sstr);
3492 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3493 /* Assigning to a subroutine sets the prototype. */
3496 const char *const ptr = SvPV_const(sstr, len);
3498 SvGROW(dstr, len + 1);
3499 Copy(ptr, SvPVX(dstr), len + 1, char);
3500 SvCUR_set(dstr, len);
3502 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3506 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3507 const char * const type = sv_reftype(dstr,0);
3509 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3511 Perl_croak(aTHX_ "Cannot copy to %s", type);
3512 } else if (sflags & SVf_ROK) {
3513 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3514 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3517 if (GvIMPORTED(dstr) != GVf_IMPORTED
3518 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3520 GvIMPORTED_on(dstr);
3525 glob_assign_glob(dstr, sstr, dtype);
3529 if (dtype >= SVt_PV) {
3530 if (dtype == SVt_PVGV) {
3531 glob_assign_ref(dstr, sstr);
3534 if (SvPVX_const(dstr)) {
3540 (void)SvOK_off(dstr);
3541 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3542 SvFLAGS(dstr) |= sflags & SVf_ROK;
3543 assert(!(sflags & SVp_NOK));
3544 assert(!(sflags & SVp_IOK));
3545 assert(!(sflags & SVf_NOK));
3546 assert(!(sflags & SVf_IOK));
3548 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3549 if (!(sflags & SVf_OK)) {
3550 if (ckWARN(WARN_MISC))
3551 Perl_warner(aTHX_ packWARN(WARN_MISC),
3552 "Undefined value assigned to typeglob");
3555 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3556 if (dstr != (SV*)gv) {
3559 GvGP(dstr) = gp_ref(GvGP(gv));
3563 else if (sflags & SVp_POK) {
3567 * Check to see if we can just swipe the string. If so, it's a
3568 * possible small lose on short strings, but a big win on long ones.
3569 * It might even be a win on short strings if SvPVX_const(dstr)
3570 * has to be allocated and SvPVX_const(sstr) has to be freed.
3571 * Likewise if we can set up COW rather than doing an actual copy, we
3572 * drop to the else clause, as the swipe code and the COW setup code
3573 * have much in common.
3576 /* Whichever path we take through the next code, we want this true,
3577 and doing it now facilitates the COW check. */
3578 (void)SvPOK_only(dstr);
3581 /* If we're already COW then this clause is not true, and if COW
3582 is allowed then we drop down to the else and make dest COW
3583 with us. If caller hasn't said that we're allowed to COW
3584 shared hash keys then we don't do the COW setup, even if the
3585 source scalar is a shared hash key scalar. */
3586 (((flags & SV_COW_SHARED_HASH_KEYS)
3587 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3588 : 1 /* If making a COW copy is forbidden then the behaviour we
3589 desire is as if the source SV isn't actually already
3590 COW, even if it is. So we act as if the source flags
3591 are not COW, rather than actually testing them. */
3593 #ifndef PERL_OLD_COPY_ON_WRITE
3594 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3595 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3596 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3597 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3598 but in turn, it's somewhat dead code, never expected to go
3599 live, but more kept as a placeholder on how to do it better
3600 in a newer implementation. */
3601 /* If we are COW and dstr is a suitable target then we drop down
3602 into the else and make dest a COW of us. */
3603 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3608 (sflags & SVs_TEMP) && /* slated for free anyway? */
3609 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3610 (!(flags & SV_NOSTEAL)) &&
3611 /* and we're allowed to steal temps */
3612 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3613 SvLEN(sstr) && /* and really is a string */
3614 /* and won't be needed again, potentially */
3615 !(PL_op && PL_op->op_type == OP_AASSIGN))
3616 #ifdef PERL_OLD_COPY_ON_WRITE
3617 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3618 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3619 && SvTYPE(sstr) >= SVt_PVIV)
3622 /* Failed the swipe test, and it's not a shared hash key either.
3623 Have to copy the string. */
3624 STRLEN len = SvCUR(sstr);
3625 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3626 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3627 SvCUR_set(dstr, len);
3628 *SvEND(dstr) = '\0';
3630 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3632 /* Either it's a shared hash key, or it's suitable for
3633 copy-on-write or we can swipe the string. */
3635 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3639 #ifdef PERL_OLD_COPY_ON_WRITE
3641 /* I believe I should acquire a global SV mutex if
3642 it's a COW sv (not a shared hash key) to stop
3643 it going un copy-on-write.
3644 If the source SV has gone un copy on write between up there
3645 and down here, then (assert() that) it is of the correct
3646 form to make it copy on write again */
3647 if ((sflags & (SVf_FAKE | SVf_READONLY))
3648 != (SVf_FAKE | SVf_READONLY)) {
3649 SvREADONLY_on(sstr);
3651 /* Make the source SV into a loop of 1.
3652 (about to become 2) */
3653 SV_COW_NEXT_SV_SET(sstr, sstr);
3657 /* Initial code is common. */
3658 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3663 /* making another shared SV. */
3664 STRLEN cur = SvCUR(sstr);
3665 STRLEN len = SvLEN(sstr);
3666 #ifdef PERL_OLD_COPY_ON_WRITE
3668 assert (SvTYPE(dstr) >= SVt_PVIV);
3669 /* SvIsCOW_normal */
3670 /* splice us in between source and next-after-source. */
3671 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3672 SV_COW_NEXT_SV_SET(sstr, dstr);
3673 SvPV_set(dstr, SvPVX_mutable(sstr));
3677 /* SvIsCOW_shared_hash */
3678 DEBUG_C(PerlIO_printf(Perl_debug_log,
3679 "Copy on write: Sharing hash\n"));
3681 assert (SvTYPE(dstr) >= SVt_PV);
3683 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3685 SvLEN_set(dstr, len);
3686 SvCUR_set(dstr, cur);
3687 SvREADONLY_on(dstr);
3689 /* Relesase a global SV mutex. */
3692 { /* Passes the swipe test. */
3693 SvPV_set(dstr, SvPVX_mutable(sstr));
3694 SvLEN_set(dstr, SvLEN(sstr));
3695 SvCUR_set(dstr, SvCUR(sstr));
3698 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3699 SvPV_set(sstr, NULL);
3705 if (sflags & SVp_NOK) {
3706 SvNV_set(dstr, SvNVX(sstr));
3708 if (sflags & SVp_IOK) {
3709 SvRELEASE_IVX(dstr);
3710 SvIV_set(dstr, SvIVX(sstr));
3711 /* Must do this otherwise some other overloaded use of 0x80000000
3712 gets confused. I guess SVpbm_VALID */
3713 if (sflags & SVf_IVisUV)
3716 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3718 const MAGIC * const smg = SvVSTRING_mg(sstr);
3720 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3721 smg->mg_ptr, smg->mg_len);
3722 SvRMAGICAL_on(dstr);
3726 else if (sflags & (SVp_IOK|SVp_NOK)) {
3727 (void)SvOK_off(dstr);
3728 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3729 if (sflags & SVp_IOK) {
3730 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3731 SvIV_set(dstr, SvIVX(sstr));
3733 if (sflags & SVp_NOK) {
3734 SvNV_set(dstr, SvNVX(sstr));
3738 if (isGV_with_GP(sstr)) {
3739 /* This stringification rule for globs is spread in 3 places.
3740 This feels bad. FIXME. */
3741 const U32 wasfake = sflags & SVf_FAKE;
3743 /* FAKE globs can get coerced, so need to turn this off
3744 temporarily if it is on. */
3746 gv_efullname3(dstr, (GV *)sstr, "*");
3747 SvFLAGS(sstr) |= wasfake;
3750 (void)SvOK_off(dstr);
3752 if (SvTAINTED(sstr))
3757 =for apidoc sv_setsv_mg
3759 Like C<sv_setsv>, but also handles 'set' magic.
3765 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3767 sv_setsv(dstr,sstr);
3771 #ifdef PERL_OLD_COPY_ON_WRITE
3773 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3775 STRLEN cur = SvCUR(sstr);
3776 STRLEN len = SvLEN(sstr);
3777 register char *new_pv;
3780 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3788 if (SvTHINKFIRST(dstr))
3789 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3790 else if (SvPVX_const(dstr))
3791 Safefree(SvPVX_const(dstr));
3795 SvUPGRADE(dstr, SVt_PVIV);
3797 assert (SvPOK(sstr));
3798 assert (SvPOKp(sstr));
3799 assert (!SvIOK(sstr));
3800 assert (!SvIOKp(sstr));
3801 assert (!SvNOK(sstr));
3802 assert (!SvNOKp(sstr));
3804 if (SvIsCOW(sstr)) {
3806 if (SvLEN(sstr) == 0) {
3807 /* source is a COW shared hash key. */
3808 DEBUG_C(PerlIO_printf(Perl_debug_log,
3809 "Fast copy on write: Sharing hash\n"));
3810 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3813 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3815 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3816 SvUPGRADE(sstr, SVt_PVIV);
3817 SvREADONLY_on(sstr);
3819 DEBUG_C(PerlIO_printf(Perl_debug_log,
3820 "Fast copy on write: Converting sstr to COW\n"));
3821 SV_COW_NEXT_SV_SET(dstr, sstr);
3823 SV_COW_NEXT_SV_SET(sstr, dstr);
3824 new_pv = SvPVX_mutable(sstr);
3827 SvPV_set(dstr, new_pv);
3828 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3831 SvLEN_set(dstr, len);
3832 SvCUR_set(dstr, cur);
3841 =for apidoc sv_setpvn
3843 Copies a string into an SV. The C<len> parameter indicates the number of
3844 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3845 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3851 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3854 register char *dptr;
3856 SV_CHECK_THINKFIRST_COW_DROP(sv);
3862 /* len is STRLEN which is unsigned, need to copy to signed */
3865 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3867 SvUPGRADE(sv, SVt_PV);
3869 dptr = SvGROW(sv, len + 1);
3870 Move(ptr,dptr,len,char);
3873 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3878 =for apidoc sv_setpvn_mg
3880 Like C<sv_setpvn>, but also handles 'set' magic.
3886 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3888 sv_setpvn(sv,ptr,len);
3893 =for apidoc sv_setpv
3895 Copies a string into an SV. The string must be null-terminated. Does not
3896 handle 'set' magic. See C<sv_setpv_mg>.
3902 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3905 register STRLEN len;
3907 SV_CHECK_THINKFIRST_COW_DROP(sv);
3913 SvUPGRADE(sv, SVt_PV);
3915 SvGROW(sv, len + 1);
3916 Move(ptr,SvPVX(sv),len+1,char);
3918 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3923 =for apidoc sv_setpv_mg
3925 Like C<sv_setpv>, but also handles 'set' magic.
3931 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3938 =for apidoc sv_usepvn_flags
3940 Tells an SV to use C<ptr> to find its string value. Normally the
3941 string is stored inside the SV but sv_usepvn allows the SV to use an
3942 outside string. The C<ptr> should point to memory that was allocated
3943 by C<malloc>. The string length, C<len>, must be supplied. By default
3944 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3945 so that pointer should not be freed or used by the programmer after
3946 giving it to sv_usepvn, and neither should any pointers from "behind"
3947 that pointer (e.g. ptr + 1) be used.
3949 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3950 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3951 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3952 C<len>, and already meets the requirements for storing in C<SvPVX>)
3958 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3962 SV_CHECK_THINKFIRST_COW_DROP(sv);
3963 SvUPGRADE(sv, SVt_PV);
3966 if (flags & SV_SMAGIC)
3970 if (SvPVX_const(sv))
3974 if (flags & SV_HAS_TRAILING_NUL)
3975 assert(ptr[len] == '\0');
3978 allocate = (flags & SV_HAS_TRAILING_NUL)
3979 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3980 if (flags & SV_HAS_TRAILING_NUL) {
3981 /* It's long enough - do nothing.
3982 Specfically Perl_newCONSTSUB is relying on this. */
3985 /* Force a move to shake out bugs in callers. */
3986 char *new_ptr = (char*)safemalloc(allocate);
3987 Copy(ptr, new_ptr, len, char);
3988 PoisonFree(ptr,len,char);
3992 ptr = (char*) saferealloc (ptr, allocate);
3997 SvLEN_set(sv, allocate);
3998 if (!(flags & SV_HAS_TRAILING_NUL)) {
4001 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4003 if (flags & SV_SMAGIC)
4007 #ifdef PERL_OLD_COPY_ON_WRITE
4008 /* Need to do this *after* making the SV normal, as we need the buffer
4009 pointer to remain valid until after we've copied it. If we let go too early,
4010 another thread could invalidate it by unsharing last of the same hash key
4011 (which it can do by means other than releasing copy-on-write Svs)
4012 or by changing the other copy-on-write SVs in the loop. */
4014 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4016 if (len) { /* this SV was SvIsCOW_normal(sv) */
4017 /* we need to find the SV pointing to us. */
4018 SV *current = SV_COW_NEXT_SV(after);
4020 if (current == sv) {
4021 /* The SV we point to points back to us (there were only two of us
4023 Hence other SV is no longer copy on write either. */
4025 SvREADONLY_off(after);
4027 /* We need to follow the pointers around the loop. */
4029 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4032 /* don't loop forever if the structure is bust, and we have
4033 a pointer into a closed loop. */
4034 assert (current != after);
4035 assert (SvPVX_const(current) == pvx);
4037 /* Make the SV before us point to the SV after us. */
4038 SV_COW_NEXT_SV_SET(current, after);
4041 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4046 Perl_sv_release_IVX(pTHX_ register SV *sv)
4049 sv_force_normal_flags(sv, 0);
4055 =for apidoc sv_force_normal_flags
4057 Undo various types of fakery on an SV: if the PV is a shared string, make
4058 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4059 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4060 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4061 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4062 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4063 set to some other value.) In addition, the C<flags> parameter gets passed to
4064 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4065 with flags set to 0.
4071 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4074 #ifdef PERL_OLD_COPY_ON_WRITE
4075 if (SvREADONLY(sv)) {
4076 /* At this point I believe I should acquire a global SV mutex. */
4078 const char * const pvx = SvPVX_const(sv);
4079 const STRLEN len = SvLEN(sv);
4080 const STRLEN cur = SvCUR(sv);
4081 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4083 PerlIO_printf(Perl_debug_log,
4084 "Copy on write: Force normal %ld\n",
4090 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4093 if (flags & SV_COW_DROP_PV) {
4094 /* OK, so we don't need to copy our buffer. */
4097 SvGROW(sv, cur + 1);
4098 Move(pvx,SvPVX(sv),cur,char);
4102 sv_release_COW(sv, pvx, len, next);
4107 else if (IN_PERL_RUNTIME)
4108 Perl_croak(aTHX_ PL_no_modify);
4109 /* At this point I believe that I can drop the global SV mutex. */
4112 if (SvREADONLY(sv)) {
4114 const char * const pvx = SvPVX_const(sv);
4115 const STRLEN len = SvCUR(sv);
4120 SvGROW(sv, len + 1);
4121 Move(pvx,SvPVX(sv),len,char);
4123 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4125 else if (IN_PERL_RUNTIME)
4126 Perl_croak(aTHX_ PL_no_modify);
4130 sv_unref_flags(sv, flags);
4131 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4138 Efficient removal of characters from the beginning of the string buffer.
4139 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4140 the string buffer. The C<ptr> becomes the first character of the adjusted
4141 string. Uses the "OOK hack".
4142 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4143 refer to the same chunk of data.
4149 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4151 register STRLEN delta;
4152 if (!ptr || !SvPOKp(sv))
4154 delta = ptr - SvPVX_const(sv);
4155 SV_CHECK_THINKFIRST(sv);
4156 if (SvTYPE(sv) < SVt_PVIV)
4157 sv_upgrade(sv,SVt_PVIV);
4160 if (!SvLEN(sv)) { /* make copy of shared string */
4161 const char *pvx = SvPVX_const(sv);
4162 const STRLEN len = SvCUR(sv);
4163 SvGROW(sv, len + 1);
4164 Move(pvx,SvPVX(sv),len,char);
4168 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4169 and we do that anyway inside the SvNIOK_off
4171 SvFLAGS(sv) |= SVf_OOK;
4174 SvLEN_set(sv, SvLEN(sv) - delta);
4175 SvCUR_set(sv, SvCUR(sv) - delta);
4176 SvPV_set(sv, SvPVX(sv) + delta);
4177 SvIV_set(sv, SvIVX(sv) + delta);
4181 =for apidoc sv_catpvn
4183 Concatenates the string onto the end of the string which is in the SV. The
4184 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4185 status set, then the bytes appended should be valid UTF-8.
4186 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4188 =for apidoc sv_catpvn_flags
4190 Concatenates the string onto the end of the string which is in the SV. The
4191 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4192 status set, then the bytes appended should be valid UTF-8.
4193 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4194 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4195 in terms of this function.
4201 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4205 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4207 SvGROW(dsv, dlen + slen + 1);
4209 sstr = SvPVX_const(dsv);
4210 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4211 SvCUR_set(dsv, SvCUR(dsv) + slen);
4213 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4215 if (flags & SV_SMAGIC)
4220 =for apidoc sv_catsv
4222 Concatenates the string from SV C<ssv> onto the end of the string in
4223 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4224 not 'set' magic. See C<sv_catsv_mg>.
4226 =for apidoc sv_catsv_flags
4228 Concatenates the string from SV C<ssv> onto the end of the string in
4229 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4230 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4231 and C<sv_catsv_nomg> are implemented in terms of this function.
4236 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4241 const char *spv = SvPV_const(ssv, slen);
4243 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4244 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4245 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4246 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4247 dsv->sv_flags doesn't have that bit set.
4248 Andy Dougherty 12 Oct 2001
4250 const I32 sutf8 = DO_UTF8(ssv);
4253 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4255 dutf8 = DO_UTF8(dsv);
4257 if (dutf8 != sutf8) {
4259 /* Not modifying source SV, so taking a temporary copy. */
4260 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4262 sv_utf8_upgrade(csv);
4263 spv = SvPV_const(csv, slen);
4266 sv_utf8_upgrade_nomg(dsv);
4268 sv_catpvn_nomg(dsv, spv, slen);
4271 if (flags & SV_SMAGIC)
4276 =for apidoc sv_catpv
4278 Concatenates the string onto the end of the string which is in the SV.
4279 If the SV has the UTF-8 status set, then the bytes appended should be
4280 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4285 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4288 register STRLEN len;
4294 junk = SvPV_force(sv, tlen);
4296 SvGROW(sv, tlen + len + 1);
4298 ptr = SvPVX_const(sv);
4299 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4300 SvCUR_set(sv, SvCUR(sv) + len);
4301 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4306 =for apidoc sv_catpv_mg
4308 Like C<sv_catpv>, but also handles 'set' magic.
4314 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4323 Creates a new SV. A non-zero C<len> parameter indicates the number of
4324 bytes of preallocated string space the SV should have. An extra byte for a
4325 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4326 space is allocated.) The reference count for the new SV is set to 1.
4328 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4329 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4330 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4331 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4332 modules supporting older perls.
4338 Perl_newSV(pTHX_ STRLEN len)
4345 sv_upgrade(sv, SVt_PV);
4346 SvGROW(sv, len + 1);
4351 =for apidoc sv_magicext
4353 Adds magic to an SV, upgrading it if necessary. Applies the
4354 supplied vtable and returns a pointer to the magic added.
4356 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4357 In particular, you can add magic to SvREADONLY SVs, and add more than
4358 one instance of the same 'how'.
4360 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4361 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4362 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4363 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4365 (This is now used as a subroutine by C<sv_magic>.)
4370 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4371 const char* name, I32 namlen)
4376 if (SvTYPE(sv) < SVt_PVMG) {
4377 SvUPGRADE(sv, SVt_PVMG);
4379 Newxz(mg, 1, MAGIC);
4380 mg->mg_moremagic = SvMAGIC(sv);
4381 SvMAGIC_set(sv, mg);
4383 /* Sometimes a magic contains a reference loop, where the sv and
4384 object refer to each other. To prevent a reference loop that
4385 would prevent such objects being freed, we look for such loops
4386 and if we find one we avoid incrementing the object refcount.
4388 Note we cannot do this to avoid self-tie loops as intervening RV must
4389 have its REFCNT incremented to keep it in existence.
4392 if (!obj || obj == sv ||
4393 how == PERL_MAGIC_arylen ||
4394 how == PERL_MAGIC_qr ||
4395 how == PERL_MAGIC_symtab ||
4396 (SvTYPE(obj) == SVt_PVGV &&
4397 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4398 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4399 GvFORM(obj) == (CV*)sv)))
4404 mg->mg_obj = SvREFCNT_inc_simple(obj);
4405 mg->mg_flags |= MGf_REFCOUNTED;
4408 /* Normal self-ties simply pass a null object, and instead of
4409 using mg_obj directly, use the SvTIED_obj macro to produce a
4410 new RV as needed. For glob "self-ties", we are tieing the PVIO
4411 with an RV obj pointing to the glob containing the PVIO. In
4412 this case, to avoid a reference loop, we need to weaken the
4416 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4417 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4423 mg->mg_len = namlen;
4426 mg->mg_ptr = savepvn(name, namlen);
4427 else if (namlen == HEf_SVKEY)
4428 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4430 mg->mg_ptr = (char *) name;
4432 mg->mg_virtual = (MGVTBL *) vtable;
4436 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4441 =for apidoc sv_magic
4443 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4444 then adds a new magic item of type C<how> to the head of the magic list.
4446 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4447 handling of the C<name> and C<namlen> arguments.
4449 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4450 to add more than one instance of the same 'how'.
4456 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4459 const MGVTBL *vtable;
4462 #ifdef PERL_OLD_COPY_ON_WRITE
4464 sv_force_normal_flags(sv, 0);
4466 if (SvREADONLY(sv)) {
4468 /* its okay to attach magic to shared strings; the subsequent
4469 * upgrade to PVMG will unshare the string */
4470 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4473 && how != PERL_MAGIC_regex_global
4474 && how != PERL_MAGIC_bm
4475 && how != PERL_MAGIC_fm
4476 && how != PERL_MAGIC_sv
4477 && how != PERL_MAGIC_backref
4480 Perl_croak(aTHX_ PL_no_modify);
4483 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4484 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4485 /* sv_magic() refuses to add a magic of the same 'how' as an
4488 if (how == PERL_MAGIC_taint) {
4490 /* Any scalar which already had taint magic on which someone
4491 (erroneously?) did SvIOK_on() or similar will now be
4492 incorrectly sporting public "OK" flags. */
4493 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4501 vtable = &PL_vtbl_sv;
4503 case PERL_MAGIC_overload:
4504 vtable = &PL_vtbl_amagic;
4506 case PERL_MAGIC_overload_elem:
4507 vtable = &PL_vtbl_amagicelem;
4509 case PERL_MAGIC_overload_table:
4510 vtable = &PL_vtbl_ovrld;
4513 vtable = &PL_vtbl_bm;
4515 case PERL_MAGIC_regdata:
4516 vtable = &PL_vtbl_regdata;
4518 case PERL_MAGIC_regdata_names:
4519 vtable = &PL_vtbl_regdata_names;
4521 case PERL_MAGIC_regdatum:
4522 vtable = &PL_vtbl_regdatum;
4524 case PERL_MAGIC_env:
4525 vtable = &PL_vtbl_env;
4528 vtable = &PL_vtbl_fm;
4530 case PERL_MAGIC_envelem:
4531 vtable = &PL_vtbl_envelem;
4533 case PERL_MAGIC_regex_global:
4534 vtable = &PL_vtbl_mglob;
4536 case PERL_MAGIC_isa:
4537 vtable = &PL_vtbl_isa;
4539 case PERL_MAGIC_isaelem:
4540 vtable = &PL_vtbl_isaelem;
4542 case PERL_MAGIC_nkeys:
4543 vtable = &PL_vtbl_nkeys;
4545 case PERL_MAGIC_dbfile:
4548 case PERL_MAGIC_dbline:
4549 vtable = &PL_vtbl_dbline;
4551 #ifdef USE_LOCALE_COLLATE
4552 case PERL_MAGIC_collxfrm:
4553 vtable = &PL_vtbl_collxfrm;
4555 #endif /* USE_LOCALE_COLLATE */
4556 case PERL_MAGIC_tied:
4557 vtable = &PL_vtbl_pack;
4559 case PERL_MAGIC_tiedelem:
4560 case PERL_MAGIC_tiedscalar:
4561 vtable = &PL_vtbl_packelem;
4564 vtable = &PL_vtbl_regexp;
4566 case PERL_MAGIC_hints:
4567 /* As this vtable is all NULL, we can reuse it. */
4568 case PERL_MAGIC_sig:
4569 vtable = &PL_vtbl_sig;
4571 case PERL_MAGIC_sigelem:
4572 vtable = &PL_vtbl_sigelem;
4574 case PERL_MAGIC_taint:
4575 vtable = &PL_vtbl_taint;
4577 case PERL_MAGIC_uvar:
4578 vtable = &PL_vtbl_uvar;
4580 case PERL_MAGIC_vec:
4581 vtable = &PL_vtbl_vec;
4583 case PERL_MAGIC_arylen_p:
4584 case PERL_MAGIC_rhash:
4585 case PERL_MAGIC_symtab:
4586 case PERL_MAGIC_vstring:
4589 case PERL_MAGIC_utf8:
4590 vtable = &PL_vtbl_utf8;
4592 case PERL_MAGIC_substr:
4593 vtable = &PL_vtbl_substr;
4595 case PERL_MAGIC_defelem:
4596 vtable = &PL_vtbl_defelem;
4598 case PERL_MAGIC_arylen:
4599 vtable = &PL_vtbl_arylen;
4601 case PERL_MAGIC_pos:
4602 vtable = &PL_vtbl_pos;
4604 case PERL_MAGIC_backref:
4605 vtable = &PL_vtbl_backref;
4607 case PERL_MAGIC_hintselem:
4608 vtable = &PL_vtbl_hintselem;
4610 case PERL_MAGIC_ext:
4611 /* Reserved for use by extensions not perl internals. */
4612 /* Useful for attaching extension internal data to perl vars. */
4613 /* Note that multiple extensions may clash if magical scalars */
4614 /* etc holding private data from one are passed to another. */
4618 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4621 /* Rest of work is done else where */
4622 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4625 case PERL_MAGIC_taint:
4628 case PERL_MAGIC_ext:
4629 case PERL_MAGIC_dbfile:
4636 =for apidoc sv_unmagic
4638 Removes all magic of type C<type> from an SV.
4644 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4648 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4650 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4651 for (mg = *mgp; mg; mg = *mgp) {
4652 if (mg->mg_type == type) {
4653 const MGVTBL* const vtbl = mg->mg_virtual;
4654 *mgp = mg->mg_moremagic;
4655 if (vtbl && vtbl->svt_free)
4656 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4657 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4659 Safefree(mg->mg_ptr);
4660 else if (mg->mg_len == HEf_SVKEY)
4661 SvREFCNT_dec((SV*)mg->mg_ptr);
4662 else if (mg->mg_type == PERL_MAGIC_utf8)
4663 Safefree(mg->mg_ptr);
4665 if (mg->mg_flags & MGf_REFCOUNTED)
4666 SvREFCNT_dec(mg->mg_obj);
4670 mgp = &mg->mg_moremagic;
4674 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4675 SvMAGIC_set(sv, NULL);
4682 =for apidoc sv_rvweaken
4684 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4685 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4686 push a back-reference to this RV onto the array of backreferences
4687 associated with that magic. If the RV is magical, set magic will be
4688 called after the RV is cleared.
4694 Perl_sv_rvweaken(pTHX_ SV *sv)
4697 if (!SvOK(sv)) /* let undefs pass */
4700 Perl_croak(aTHX_ "Can't weaken a nonreference");
4701 else if (SvWEAKREF(sv)) {
4702 if (ckWARN(WARN_MISC))
4703 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4707 Perl_sv_add_backref(aTHX_ tsv, sv);
4713 /* Give tsv backref magic if it hasn't already got it, then push a
4714 * back-reference to sv onto the array associated with the backref magic.
4718 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4723 if (SvTYPE(tsv) == SVt_PVHV) {
4724 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4728 /* There is no AV in the offical place - try a fixup. */
4729 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4732 /* Aha. They've got it stowed in magic. Bring it back. */
4733 av = (AV*)mg->mg_obj;
4734 /* Stop mg_free decreasing the refernce count. */
4736 /* Stop mg_free even calling the destructor, given that
4737 there's no AV to free up. */
4739 sv_unmagic(tsv, PERL_MAGIC_backref);
4743 SvREFCNT_inc_simple_void(av);
4748 const MAGIC *const mg
4749 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4751 av = (AV*)mg->mg_obj;
4755 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4756 /* av now has a refcnt of 2, which avoids it getting freed
4757 * before us during global cleanup. The extra ref is removed
4758 * by magic_killbackrefs() when tsv is being freed */
4761 if (AvFILLp(av) >= AvMAX(av)) {
4762 av_extend(av, AvFILLp(av)+1);
4764 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4767 /* delete a back-reference to ourselves from the backref magic associated
4768 * with the SV we point to.
4772 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4779 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4780 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4781 /* We mustn't attempt to "fix up" the hash here by moving the
4782 backreference array back to the hv_aux structure, as that is stored
4783 in the main HvARRAY(), and hfreentries assumes that no-one
4784 reallocates HvARRAY() while it is running. */
4787 const MAGIC *const mg
4788 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4790 av = (AV *)mg->mg_obj;
4793 if (PL_in_clean_all)
4795 Perl_croak(aTHX_ "panic: del_backref");
4802 /* We shouldn't be in here more than once, but for paranoia reasons lets
4804 for (i = AvFILLp(av); i >= 0; i--) {
4806 const SSize_t fill = AvFILLp(av);
4808 /* We weren't the last entry.
4809 An unordered list has this property that you can take the
4810 last element off the end to fill the hole, and it's still
4811 an unordered list :-)
4816 AvFILLp(av) = fill - 1;
4822 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4824 SV **svp = AvARRAY(av);
4826 PERL_UNUSED_ARG(sv);
4828 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4829 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4830 if (svp && !SvIS_FREED(av)) {
4831 SV *const *const last = svp + AvFILLp(av);
4833 while (svp <= last) {
4835 SV *const referrer = *svp;
4836 if (SvWEAKREF(referrer)) {
4837 /* XXX Should we check that it hasn't changed? */
4838 SvRV_set(referrer, 0);
4840 SvWEAKREF_off(referrer);
4841 SvSETMAGIC(referrer);
4842 } else if (SvTYPE(referrer) == SVt_PVGV ||
4843 SvTYPE(referrer) == SVt_PVLV) {
4844 /* You lookin' at me? */
4845 assert(GvSTASH(referrer));
4846 assert(GvSTASH(referrer) == (HV*)sv);
4847 GvSTASH(referrer) = 0;
4850 "panic: magic_killbackrefs (flags=%"UVxf")",
4851 (UV)SvFLAGS(referrer));
4859 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4864 =for apidoc sv_insert
4866 Inserts a string at the specified offset/length within the SV. Similar to
4867 the Perl substr() function.
4873 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4878 register char *midend;
4879 register char *bigend;
4885 Perl_croak(aTHX_ "Can't modify non-existent substring");
4886 SvPV_force(bigstr, curlen);
4887 (void)SvPOK_only_UTF8(bigstr);
4888 if (offset + len > curlen) {
4889 SvGROW(bigstr, offset+len+1);
4890 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4891 SvCUR_set(bigstr, offset+len);
4895 i = littlelen - len;
4896 if (i > 0) { /* string might grow */
4897 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4898 mid = big + offset + len;
4899 midend = bigend = big + SvCUR(bigstr);
4902 while (midend > mid) /* shove everything down */
4903 *--bigend = *--midend;
4904 Move(little,big+offset,littlelen,char);
4905 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4910 Move(little,SvPVX(bigstr)+offset,len,char);
4915 big = SvPVX(bigstr);
4918 bigend = big + SvCUR(bigstr);
4920 if (midend > bigend)
4921 Perl_croak(aTHX_ "panic: sv_insert");
4923 if (mid - big > bigend - midend) { /* faster to shorten from end */
4925 Move(little, mid, littlelen,char);
4928 i = bigend - midend;
4930 Move(midend, mid, i,char);
4934 SvCUR_set(bigstr, mid - big);
4936 else if ((i = mid - big)) { /* faster from front */
4937 midend -= littlelen;
4939 sv_chop(bigstr,midend-i);
4944 Move(little, mid, littlelen,char);
4946 else if (littlelen) {
4947 midend -= littlelen;
4948 sv_chop(bigstr,midend);
4949 Move(little,midend,littlelen,char);
4952 sv_chop(bigstr,midend);
4958 =for apidoc sv_replace
4960 Make the first argument a copy of the second, then delete the original.
4961 The target SV physically takes over ownership of the body of the source SV
4962 and inherits its flags; however, the target keeps any magic it owns,
4963 and any magic in the source is discarded.
4964 Note that this is a rather specialist SV copying operation; most of the
4965 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4971 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4974 const U32 refcnt = SvREFCNT(sv);
4975 SV_CHECK_THINKFIRST_COW_DROP(sv);
4976 if (SvREFCNT(nsv) != 1) {
4977 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4978 UVuf " != 1)", (UV) SvREFCNT(nsv));
4980 if (SvMAGICAL(sv)) {
4984 sv_upgrade(nsv, SVt_PVMG);
4985 SvMAGIC_set(nsv, SvMAGIC(sv));
4986 SvFLAGS(nsv) |= SvMAGICAL(sv);
4988 SvMAGIC_set(sv, NULL);
4992 assert(!SvREFCNT(sv));
4993 #ifdef DEBUG_LEAKING_SCALARS
4994 sv->sv_flags = nsv->sv_flags;
4995 sv->sv_any = nsv->sv_any;
4996 sv->sv_refcnt = nsv->sv_refcnt;
4997 sv->sv_u = nsv->sv_u;
4999 StructCopy(nsv,sv,SV);
5001 /* Currently could join these into one piece of pointer arithmetic, but
5002 it would be unclear. */
5003 if(SvTYPE(sv) == SVt_IV)
5005 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5006 else if (SvTYPE(sv) == SVt_RV) {
5007 SvANY(sv) = &sv->sv_u.svu_rv;
5011 #ifdef PERL_OLD_COPY_ON_WRITE
5012 if (SvIsCOW_normal(nsv)) {
5013 /* We need to follow the pointers around the loop to make the
5014 previous SV point to sv, rather than nsv. */
5017 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5020 assert(SvPVX_const(current) == SvPVX_const(nsv));
5022 /* Make the SV before us point to the SV after us. */
5024 PerlIO_printf(Perl_debug_log, "previous is\n");
5026 PerlIO_printf(Perl_debug_log,
5027 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5028 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5030 SV_COW_NEXT_SV_SET(current, sv);
5033 SvREFCNT(sv) = refcnt;
5034 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5040 =for apidoc sv_clear
5042 Clear an SV: call any destructors, free up any memory used by the body,
5043 and free the body itself. The SV's head is I<not> freed, although
5044 its type is set to all 1's so that it won't inadvertently be assumed
5045 to be live during global destruction etc.
5046 This function should only be called when REFCNT is zero. Most of the time
5047 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5054 Perl_sv_clear(pTHX_ register SV *sv)
5057 const U32 type = SvTYPE(sv);
5058 const struct body_details *const sv_type_details
5059 = bodies_by_type + type;
5062 assert(SvREFCNT(sv) == 0);
5064 if (type <= SVt_IV) {
5065 /* See the comment in sv.h about the collusion between this early
5066 return and the overloading of the NULL and IV slots in the size
5072 if (PL_defstash) { /* Still have a symbol table? */
5077 stash = SvSTASH(sv);
5078 destructor = StashHANDLER(stash,DESTROY);
5080 SV* const tmpref = newRV(sv);
5081 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5083 PUSHSTACKi(PERLSI_DESTROY);
5088 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5094 if(SvREFCNT(tmpref) < 2) {
5095 /* tmpref is not kept alive! */
5097 SvRV_set(tmpref, NULL);
5100 SvREFCNT_dec(tmpref);
5102 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5106 if (PL_in_clean_objs)
5107 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5109 /* DESTROY gave object new lease on life */
5115 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5116 SvOBJECT_off(sv); /* Curse the object. */
5117 if (type != SVt_PVIO)
5118 --PL_sv_objcount; /* XXX Might want something more general */
5121 if (type >= SVt_PVMG) {
5122 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5123 SvREFCNT_dec(OURSTASH(sv));
5124 } else if (SvMAGIC(sv))
5126 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5127 SvREFCNT_dec(SvSTASH(sv));
5130 /* case SVt_BIND: */
5133 IoIFP(sv) != PerlIO_stdin() &&
5134 IoIFP(sv) != PerlIO_stdout() &&
5135 IoIFP(sv) != PerlIO_stderr())
5137 io_close((IO*)sv, FALSE);
5139 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5140 PerlDir_close(IoDIRP(sv));
5141 IoDIRP(sv) = (DIR*)NULL;
5142 Safefree(IoTOP_NAME(sv));
5143 Safefree(IoFMT_NAME(sv));
5144 Safefree(IoBOTTOM_NAME(sv));
5151 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5158 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5159 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5160 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5161 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5163 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5164 SvREFCNT_dec(LvTARG(sv));
5167 if (isGV_with_GP(sv)) {
5170 unshare_hek(GvNAME_HEK(sv));
5171 /* If we're in a stash, we don't own a reference to it. However it does
5172 have a back reference to us, which needs to be cleared. */
5173 if (!SvVALID(sv) && GvSTASH(sv))
5174 sv_del_backref((SV*)GvSTASH(sv), sv);
5180 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5182 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5183 /* Don't even bother with turning off the OOK flag. */
5188 SV * const target = SvRV(sv);
5190 sv_del_backref(target, sv);
5192 SvREFCNT_dec(target);
5194 #ifdef PERL_OLD_COPY_ON_WRITE
5195 else if (SvPVX_const(sv)) {
5197 /* I believe I need to grab the global SV mutex here and
5198 then recheck the COW status. */
5200 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5203 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5204 SV_COW_NEXT_SV(sv));
5205 /* And drop it here. */
5207 } else if (SvLEN(sv)) {
5208 Safefree(SvPVX_const(sv));
5212 else if (SvPVX_const(sv) && SvLEN(sv))
5213 Safefree(SvPVX_mutable(sv));
5214 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5215 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5224 SvFLAGS(sv) &= SVf_BREAK;
5225 SvFLAGS(sv) |= SVTYPEMASK;
5227 if (sv_type_details->arena) {
5228 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5229 &PL_body_roots[type]);
5231 else if (sv_type_details->body_size) {
5232 my_safefree(SvANY(sv));
5237 =for apidoc sv_newref
5239 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5246 Perl_sv_newref(pTHX_ SV *sv)
5248 PERL_UNUSED_CONTEXT;
5257 Decrement an SV's reference count, and if it drops to zero, call
5258 C<sv_clear> to invoke destructors and free up any memory used by
5259 the body; finally, deallocate the SV's head itself.
5260 Normally called via a wrapper macro C<SvREFCNT_dec>.
5266 Perl_sv_free(pTHX_ SV *sv)
5271 if (SvREFCNT(sv) == 0) {
5272 if (SvFLAGS(sv) & SVf_BREAK)
5273 /* this SV's refcnt has been artificially decremented to
5274 * trigger cleanup */
5276 if (PL_in_clean_all) /* All is fair */
5278 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5279 /* make sure SvREFCNT(sv)==0 happens very seldom */
5280 SvREFCNT(sv) = (~(U32)0)/2;
5283 if (ckWARN_d(WARN_INTERNAL)) {
5284 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5285 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5286 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5287 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5288 Perl_dump_sv_child(aTHX_ sv);
5293 if (--(SvREFCNT(sv)) > 0)
5295 Perl_sv_free2(aTHX_ sv);
5299 Perl_sv_free2(pTHX_ SV *sv)
5304 if (ckWARN_d(WARN_DEBUGGING))
5305 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5306 "Attempt to free temp prematurely: SV 0x%"UVxf
5307 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5311 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5312 /* make sure SvREFCNT(sv)==0 happens very seldom */
5313 SvREFCNT(sv) = (~(U32)0)/2;
5324 Returns the length of the string in the SV. Handles magic and type
5325 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5331 Perl_sv_len(pTHX_ register SV *sv)
5339 len = mg_length(sv);
5341 (void)SvPV_const(sv, len);
5346 =for apidoc sv_len_utf8
5348 Returns the number of characters in the string in an SV, counting wide
5349 UTF-8 bytes as a single character. Handles magic and type coercion.
5355 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5356 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5357 * (Note that the mg_len is not the length of the mg_ptr field.
5358 * This allows the cache to store the character length of the string without
5359 * needing to malloc() extra storage to attach to the mg_ptr.)
5364 Perl_sv_len_utf8(pTHX_ register SV *sv)
5370 return mg_length(sv);
5374 const U8 *s = (U8*)SvPV_const(sv, len);
5378 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5380 if (mg && mg->mg_len != -1) {
5382 if (PL_utf8cache < 0) {
5383 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5385 /* Need to turn the assertions off otherwise we may
5386 recurse infinitely while printing error messages.
5388 SAVEI8(PL_utf8cache);
5390 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5391 " real %"UVuf" for %"SVf,
5392 (UV) ulen, (UV) real, (void*)sv);
5397 ulen = Perl_utf8_length(aTHX_ s, s + len);
5398 if (!SvREADONLY(sv)) {
5400 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5401 &PL_vtbl_utf8, 0, 0);
5409 return Perl_utf8_length(aTHX_ s, s + len);
5413 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5416 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5419 const U8 *s = start;
5421 while (s < send && uoffset--)
5424 /* This is the existing behaviour. Possibly it should be a croak, as
5425 it's actually a bounds error */
5431 /* Given the length of the string in both bytes and UTF-8 characters, decide
5432 whether to walk forwards or backwards to find the byte corresponding to
5433 the passed in UTF-8 offset. */
5435 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5436 STRLEN uoffset, STRLEN uend)
5438 STRLEN backw = uend - uoffset;
5439 if (uoffset < 2 * backw) {
5440 /* The assumption is that going forwards is twice the speed of going
5441 forward (that's where the 2 * backw comes from).
5442 (The real figure of course depends on the UTF-8 data.) */
5443 return sv_pos_u2b_forwards(start, send, uoffset);
5448 while (UTF8_IS_CONTINUATION(*send))
5451 return send - start;
5454 /* For the string representation of the given scalar, find the byte
5455 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5456 give another position in the string, *before* the sought offset, which
5457 (which is always true, as 0, 0 is a valid pair of positions), which should
5458 help reduce the amount of linear searching.
5459 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5460 will be used to reduce the amount of linear searching. The cache will be
5461 created if necessary, and the found value offered to it for update. */
5463 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5464 const U8 *const send, STRLEN uoffset,
5465 STRLEN uoffset0, STRLEN boffset0) {
5466 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5469 assert (uoffset >= uoffset0);
5471 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5472 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5473 if ((*mgp)->mg_ptr) {
5474 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5475 if (cache[0] == uoffset) {
5476 /* An exact match. */
5479 if (cache[2] == uoffset) {
5480 /* An exact match. */
5484 if (cache[0] < uoffset) {
5485 /* The cache already knows part of the way. */
5486 if (cache[0] > uoffset0) {
5487 /* The cache knows more than the passed in pair */
5488 uoffset0 = cache[0];
5489 boffset0 = cache[1];
5491 if ((*mgp)->mg_len != -1) {
5492 /* And we know the end too. */
5494 + sv_pos_u2b_midway(start + boffset0, send,
5496 (*mgp)->mg_len - uoffset0);
5499 + sv_pos_u2b_forwards(start + boffset0,
5500 send, uoffset - uoffset0);
5503 else if (cache[2] < uoffset) {
5504 /* We're between the two cache entries. */
5505 if (cache[2] > uoffset0) {
5506 /* and the cache knows more than the passed in pair */
5507 uoffset0 = cache[2];
5508 boffset0 = cache[3];
5512 + sv_pos_u2b_midway(start + boffset0,
5515 cache[0] - uoffset0);
5518 + sv_pos_u2b_midway(start + boffset0,
5521 cache[2] - uoffset0);
5525 else if ((*mgp)->mg_len != -1) {
5526 /* If we can take advantage of a passed in offset, do so. */
5527 /* In fact, offset0 is either 0, or less than offset, so don't
5528 need to worry about the other possibility. */
5530 + sv_pos_u2b_midway(start + boffset0, send,
5532 (*mgp)->mg_len - uoffset0);
5537 if (!found || PL_utf8cache < 0) {
5538 const STRLEN real_boffset
5539 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5540 send, uoffset - uoffset0);
5542 if (found && PL_utf8cache < 0) {
5543 if (real_boffset != boffset) {
5544 /* Need to turn the assertions off otherwise we may recurse
5545 infinitely while printing error messages. */
5546 SAVEI8(PL_utf8cache);
5548 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5549 " real %"UVuf" for %"SVf,
5550 (UV) boffset, (UV) real_boffset, (void*)sv);
5553 boffset = real_boffset;
5556 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5562 =for apidoc sv_pos_u2b
5564 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5565 the start of the string, to a count of the equivalent number of bytes; if
5566 lenp is non-zero, it does the same to lenp, but this time starting from
5567 the offset, rather than from the start of the string. Handles magic and
5574 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5575 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5576 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5581 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5589 start = (U8*)SvPV_const(sv, len);
5591 STRLEN uoffset = (STRLEN) *offsetp;
5592 const U8 * const send = start + len;
5594 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5597 *offsetp = (I32) boffset;
5600 /* Convert the relative offset to absolute. */
5601 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5602 const STRLEN boffset2
5603 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5604 uoffset, boffset) - boffset;
5618 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5619 byte length pairing. The (byte) length of the total SV is passed in too,
5620 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5621 may not have updated SvCUR, so we can't rely on reading it directly.
5623 The proffered utf8/byte length pairing isn't used if the cache already has
5624 two pairs, and swapping either for the proffered pair would increase the
5625 RMS of the intervals between known byte offsets.
5627 The cache itself consists of 4 STRLEN values
5628 0: larger UTF-8 offset
5629 1: corresponding byte offset
5630 2: smaller UTF-8 offset
5631 3: corresponding byte offset
5633 Unused cache pairs have the value 0, 0.
5634 Keeping the cache "backwards" means that the invariant of
5635 cache[0] >= cache[2] is maintained even with empty slots, which means that
5636 the code that uses it doesn't need to worry if only 1 entry has actually
5637 been set to non-zero. It also makes the "position beyond the end of the
5638 cache" logic much simpler, as the first slot is always the one to start
5642 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5650 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5652 (*mgp)->mg_len = -1;
5656 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5657 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5658 (*mgp)->mg_ptr = (char *) cache;
5662 if (PL_utf8cache < 0) {
5663 const U8 *start = (const U8 *) SvPVX_const(sv);
5664 const STRLEN realutf8 = utf8_length(start, start + byte);
5666 if (realutf8 != utf8) {
5667 /* Need to turn the assertions off otherwise we may recurse
5668 infinitely while printing error messages. */
5669 SAVEI8(PL_utf8cache);
5671 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5672 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5676 /* Cache is held with the later position first, to simplify the code
5677 that deals with unbounded ends. */
5679 ASSERT_UTF8_CACHE(cache);
5680 if (cache[1] == 0) {
5681 /* Cache is totally empty */
5684 } else if (cache[3] == 0) {
5685 if (byte > cache[1]) {
5686 /* New one is larger, so goes first. */
5687 cache[2] = cache[0];
5688 cache[3] = cache[1];
5696 #define THREEWAY_SQUARE(a,b,c,d) \
5697 ((float)((d) - (c))) * ((float)((d) - (c))) \
5698 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5699 + ((float)((b) - (a))) * ((float)((b) - (a)))
5701 /* Cache has 2 slots in use, and we know three potential pairs.
5702 Keep the two that give the lowest RMS distance. Do the
5703 calcualation in bytes simply because we always know the byte
5704 length. squareroot has the same ordering as the positive value,
5705 so don't bother with the actual square root. */
5706 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5707 if (byte > cache[1]) {
5708 /* New position is after the existing pair of pairs. */
5709 const float keep_earlier
5710 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5711 const float keep_later
5712 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5714 if (keep_later < keep_earlier) {
5715 if (keep_later < existing) {
5716 cache[2] = cache[0];
5717 cache[3] = cache[1];
5723 if (keep_earlier < existing) {
5729 else if (byte > cache[3]) {
5730 /* New position is between the existing pair of pairs. */
5731 const float keep_earlier
5732 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5733 const float keep_later
5734 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5736 if (keep_later < keep_earlier) {
5737 if (keep_later < existing) {
5743 if (keep_earlier < existing) {
5750 /* New position is before the existing pair of pairs. */
5751 const float keep_earlier
5752 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5753 const float keep_later
5754 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5756 if (keep_later < keep_earlier) {
5757 if (keep_later < existing) {
5763 if (keep_earlier < existing) {
5764 cache[0] = cache[2];
5765 cache[1] = cache[3];
5772 ASSERT_UTF8_CACHE(cache);
5775 /* We already know all of the way, now we may be able to walk back. The same
5776 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5777 backward is half the speed of walking forward. */
5779 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5782 const STRLEN forw = target - s;
5783 STRLEN backw = end - target;
5785 if (forw < 2 * backw) {
5786 return utf8_length(s, target);
5789 while (end > target) {
5791 while (UTF8_IS_CONTINUATION(*end)) {
5800 =for apidoc sv_pos_b2u
5802 Converts the value pointed to by offsetp from a count of bytes from the
5803 start of the string, to a count of the equivalent number of UTF-8 chars.
5804 Handles magic and type coercion.
5810 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5811 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5816 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5819 const STRLEN byte = *offsetp;
5820 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5829 s = (const U8*)SvPV_const(sv, blen);
5832 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5836 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5837 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5839 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5840 if (cache[1] == byte) {
5841 /* An exact match. */
5842 *offsetp = cache[0];
5845 if (cache[3] == byte) {
5846 /* An exact match. */
5847 *offsetp = cache[2];
5851 if (cache[1] < byte) {
5852 /* We already know part of the way. */
5853 if (mg->mg_len != -1) {
5854 /* Actually, we know the end too. */
5856 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5857 s + blen, mg->mg_len - cache[0]);
5859 len = cache[0] + utf8_length(s + cache[1], send);
5862 else if (cache[3] < byte) {
5863 /* We're between the two cached pairs, so we do the calculation
5864 offset by the byte/utf-8 positions for the earlier pair,
5865 then add the utf-8 characters from the string start to
5867 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5868 s + cache[1], cache[0] - cache[2])
5872 else { /* cache[3] > byte */
5873 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5877 ASSERT_UTF8_CACHE(cache);
5879 } else if (mg->mg_len != -1) {
5880 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5884 if (!found || PL_utf8cache < 0) {
5885 const STRLEN real_len = utf8_length(s, send);
5887 if (found && PL_utf8cache < 0) {
5888 if (len != real_len) {
5889 /* Need to turn the assertions off otherwise we may recurse
5890 infinitely while printing error messages. */
5891 SAVEI8(PL_utf8cache);
5893 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5894 " real %"UVuf" for %"SVf,
5895 (UV) len, (UV) real_len, (void*)sv);
5902 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5908 Returns a boolean indicating whether the strings in the two SVs are
5909 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5910 coerce its args to strings if necessary.
5916 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5925 SV* svrecode = NULL;
5932 /* if pv1 and pv2 are the same, second SvPV_const call may
5933 * invalidate pv1, so we may need to make a copy */
5934 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5935 pv1 = SvPV_const(sv1, cur1);
5936 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5937 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5939 pv1 = SvPV_const(sv1, cur1);
5947 pv2 = SvPV_const(sv2, cur2);
5949 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5950 /* Differing utf8ness.
5951 * Do not UTF8size the comparands as a side-effect. */
5954 svrecode = newSVpvn(pv2, cur2);
5955 sv_recode_to_utf8(svrecode, PL_encoding);
5956 pv2 = SvPV_const(svrecode, cur2);
5959 svrecode = newSVpvn(pv1, cur1);
5960 sv_recode_to_utf8(svrecode, PL_encoding);
5961 pv1 = SvPV_const(svrecode, cur1);
5963 /* Now both are in UTF-8. */
5965 SvREFCNT_dec(svrecode);
5970 bool is_utf8 = TRUE;
5973 /* sv1 is the UTF-8 one,
5974 * if is equal it must be downgrade-able */
5975 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5981 /* sv2 is the UTF-8 one,
5982 * if is equal it must be downgrade-able */
5983 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5989 /* Downgrade not possible - cannot be eq */
5997 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5999 SvREFCNT_dec(svrecode);
6009 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6010 string in C<sv1> is less than, equal to, or greater than the string in
6011 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6012 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6018 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6022 const char *pv1, *pv2;
6025 SV *svrecode = NULL;
6032 pv1 = SvPV_const(sv1, cur1);
6039 pv2 = SvPV_const(sv2, cur2);
6041 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6042 /* Differing utf8ness.
6043 * Do not UTF8size the comparands as a side-effect. */
6046 svrecode = newSVpvn(pv2, cur2);
6047 sv_recode_to_utf8(svrecode, PL_encoding);
6048 pv2 = SvPV_const(svrecode, cur2);
6051 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6056 svrecode = newSVpvn(pv1, cur1);
6057 sv_recode_to_utf8(svrecode, PL_encoding);
6058 pv1 = SvPV_const(svrecode, cur1);
6061 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6067 cmp = cur2 ? -1 : 0;
6071 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6074 cmp = retval < 0 ? -1 : 1;
6075 } else if (cur1 == cur2) {
6078 cmp = cur1 < cur2 ? -1 : 1;
6082 SvREFCNT_dec(svrecode);
6090 =for apidoc sv_cmp_locale
6092 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6093 'use bytes' aware, handles get magic, and will coerce its args to strings
6094 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6100 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6103 #ifdef USE_LOCALE_COLLATE
6109 if (PL_collation_standard)
6113 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6115 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6117 if (!pv1 || !len1) {
6128 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6131 return retval < 0 ? -1 : 1;
6134 * When the result of collation is equality, that doesn't mean
6135 * that there are no differences -- some locales exclude some
6136 * characters from consideration. So to avoid false equalities,
6137 * we use the raw string as a tiebreaker.
6143 #endif /* USE_LOCALE_COLLATE */
6145 return sv_cmp(sv1, sv2);
6149 #ifdef USE_LOCALE_COLLATE
6152 =for apidoc sv_collxfrm
6154 Add Collate Transform magic to an SV if it doesn't already have it.
6156 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6157 scalar data of the variable, but transformed to such a format that a normal
6158 memory comparison can be used to compare the data according to the locale
6165 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6170 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6171 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6177 Safefree(mg->mg_ptr);
6178 s = SvPV_const(sv, len);
6179 if ((xf = mem_collxfrm(s, len, &xlen))) {
6180 if (SvREADONLY(sv)) {
6183 return xf + sizeof(PL_collation_ix);
6186 #ifdef PERL_OLD_COPY_ON_WRITE
6188 sv_force_normal_flags(sv, 0);
6190 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6204 if (mg && mg->mg_ptr) {
6206 return mg->mg_ptr + sizeof(PL_collation_ix);
6214 #endif /* USE_LOCALE_COLLATE */
6219 Get a line from the filehandle and store it into the SV, optionally
6220 appending to the currently-stored string.
6226 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6231 register STDCHAR rslast;
6232 register STDCHAR *bp;
6237 if (SvTHINKFIRST(sv))
6238 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6239 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6241 However, perlbench says it's slower, because the existing swipe code
6242 is faster than copy on write.
6243 Swings and roundabouts. */
6244 SvUPGRADE(sv, SVt_PV);
6249 if (PerlIO_isutf8(fp)) {
6251 sv_utf8_upgrade_nomg(sv);
6252 sv_pos_u2b(sv,&append,0);
6254 } else if (SvUTF8(sv)) {
6255 SV * const tsv = newSV(0);
6256 sv_gets(tsv, fp, 0);
6257 sv_utf8_upgrade_nomg(tsv);
6258 SvCUR_set(sv,append);
6261 goto return_string_or_null;
6266 if (PerlIO_isutf8(fp))
6269 if (IN_PERL_COMPILETIME) {
6270 /* we always read code in line mode */
6274 else if (RsSNARF(PL_rs)) {
6275 /* If it is a regular disk file use size from stat() as estimate
6276 of amount we are going to read -- may result in mallocing
6277 more memory than we really need if the layers below reduce
6278 the size we read (e.g. CRLF or a gzip layer).
6281 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6282 const Off_t offset = PerlIO_tell(fp);
6283 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6284 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6290 else if (RsRECORD(PL_rs)) {
6295 /* Grab the size of the record we're getting */
6296 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6297 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6300 /* VMS wants read instead of fread, because fread doesn't respect */
6301 /* RMS record boundaries. This is not necessarily a good thing to be */
6302 /* doing, but we've got no other real choice - except avoid stdio
6303 as implementation - perhaps write a :vms layer ?
6305 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6307 bytesread = PerlIO_read(fp, buffer, recsize);
6311 SvCUR_set(sv, bytesread += append);
6312 buffer[bytesread] = '\0';
6313 goto return_string_or_null;
6315 else if (RsPARA(PL_rs)) {
6321 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6322 if (PerlIO_isutf8(fp)) {
6323 rsptr = SvPVutf8(PL_rs, rslen);
6326 if (SvUTF8(PL_rs)) {
6327 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6328 Perl_croak(aTHX_ "Wide character in $/");
6331 rsptr = SvPV_const(PL_rs, rslen);
6335 rslast = rslen ? rsptr[rslen - 1] : '\0';
6337 if (rspara) { /* have to do this both before and after */
6338 do { /* to make sure file boundaries work right */
6341 i = PerlIO_getc(fp);
6345 PerlIO_ungetc(fp,i);
6351 /* See if we know enough about I/O mechanism to cheat it ! */
6353 /* This used to be #ifdef test - it is made run-time test for ease
6354 of abstracting out stdio interface. One call should be cheap
6355 enough here - and may even be a macro allowing compile
6359 if (PerlIO_fast_gets(fp)) {
6362 * We're going to steal some values from the stdio struct
6363 * and put EVERYTHING in the innermost loop into registers.
6365 register STDCHAR *ptr;
6369 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6370 /* An ungetc()d char is handled separately from the regular
6371 * buffer, so we getc() it back out and stuff it in the buffer.
6373 i = PerlIO_getc(fp);
6374 if (i == EOF) return 0;
6375 *(--((*fp)->_ptr)) = (unsigned char) i;
6379 /* Here is some breathtakingly efficient cheating */
6381 cnt = PerlIO_get_cnt(fp); /* get count into register */
6382 /* make sure we have the room */
6383 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6384 /* Not room for all of it
6385 if we are looking for a separator and room for some
6387 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6388 /* just process what we have room for */
6389 shortbuffered = cnt - SvLEN(sv) + append + 1;
6390 cnt -= shortbuffered;
6394 /* remember that cnt can be negative */
6395 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6400 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6401 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6402 DEBUG_P(PerlIO_printf(Perl_debug_log,
6403 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6404 DEBUG_P(PerlIO_printf(Perl_debug_log,
6405 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6406 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6407 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6412 while (cnt > 0) { /* this | eat */
6414 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6415 goto thats_all_folks; /* screams | sed :-) */
6419 Copy(ptr, bp, cnt, char); /* this | eat */
6420 bp += cnt; /* screams | dust */
6421 ptr += cnt; /* louder | sed :-) */
6426 if (shortbuffered) { /* oh well, must extend */
6427 cnt = shortbuffered;
6429 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6431 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6432 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6436 DEBUG_P(PerlIO_printf(Perl_debug_log,
6437 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6438 PTR2UV(ptr),(long)cnt));
6439 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6441 DEBUG_P(PerlIO_printf(Perl_debug_log,
6442 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6443 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6444 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6446 /* This used to call 'filbuf' in stdio form, but as that behaves like
6447 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6448 another abstraction. */
6449 i = PerlIO_getc(fp); /* get more characters */
6451 DEBUG_P(PerlIO_printf(Perl_debug_log,
6452 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6453 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6454 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6456 cnt = PerlIO_get_cnt(fp);
6457 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6458 DEBUG_P(PerlIO_printf(Perl_debug_log,
6459 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6461 if (i == EOF) /* all done for ever? */
6462 goto thats_really_all_folks;
6464 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6466 SvGROW(sv, bpx + cnt + 2);
6467 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6469 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6471 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6472 goto thats_all_folks;
6476 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6477 memNE((char*)bp - rslen, rsptr, rslen))
6478 goto screamer; /* go back to the fray */
6479 thats_really_all_folks:
6481 cnt += shortbuffered;
6482 DEBUG_P(PerlIO_printf(Perl_debug_log,
6483 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6484 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6485 DEBUG_P(PerlIO_printf(Perl_debug_log,
6486 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6487 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6488 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6490 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6491 DEBUG_P(PerlIO_printf(Perl_debug_log,
6492 "Screamer: done, len=%ld, string=|%.*s|\n",
6493 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6497 /*The big, slow, and stupid way. */
6498 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6499 STDCHAR *buf = NULL;
6500 Newx(buf, 8192, STDCHAR);
6508 register const STDCHAR * const bpe = buf + sizeof(buf);
6510 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6511 ; /* keep reading */
6515 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6516 /* Accomodate broken VAXC compiler, which applies U8 cast to
6517 * both args of ?: operator, causing EOF to change into 255
6520 i = (U8)buf[cnt - 1];
6526 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6528 sv_catpvn(sv, (char *) buf, cnt);
6530 sv_setpvn(sv, (char *) buf, cnt);
6532 if (i != EOF && /* joy */
6534 SvCUR(sv) < rslen ||
6535 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6539 * If we're reading from a TTY and we get a short read,
6540 * indicating that the user hit his EOF character, we need
6541 * to notice it now, because if we try to read from the TTY
6542 * again, the EOF condition will disappear.
6544 * The comparison of cnt to sizeof(buf) is an optimization
6545 * that prevents unnecessary calls to feof().
6549 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6553 #ifdef USE_HEAP_INSTEAD_OF_STACK
6558 if (rspara) { /* have to do this both before and after */
6559 while (i != EOF) { /* to make sure file boundaries work right */
6560 i = PerlIO_getc(fp);
6562 PerlIO_ungetc(fp,i);
6568 return_string_or_null:
6569 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6575 Auto-increment of the value in the SV, doing string to numeric conversion
6576 if necessary. Handles 'get' magic.
6582 Perl_sv_inc(pTHX_ register SV *sv)
6591 if (SvTHINKFIRST(sv)) {
6593 sv_force_normal_flags(sv, 0);
6594 if (SvREADONLY(sv)) {
6595 if (IN_PERL_RUNTIME)
6596 Perl_croak(aTHX_ PL_no_modify);
6600 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6602 i = PTR2IV(SvRV(sv));
6607 flags = SvFLAGS(sv);
6608 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6609 /* It's (privately or publicly) a float, but not tested as an
6610 integer, so test it to see. */
6612 flags = SvFLAGS(sv);
6614 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6615 /* It's publicly an integer, or privately an integer-not-float */
6616 #ifdef PERL_PRESERVE_IVUV
6620 if (SvUVX(sv) == UV_MAX)
6621 sv_setnv(sv, UV_MAX_P1);
6623 (void)SvIOK_only_UV(sv);
6624 SvUV_set(sv, SvUVX(sv) + 1);
6626 if (SvIVX(sv) == IV_MAX)
6627 sv_setuv(sv, (UV)IV_MAX + 1);
6629 (void)SvIOK_only(sv);
6630 SvIV_set(sv, SvIVX(sv) + 1);
6635 if (flags & SVp_NOK) {
6636 (void)SvNOK_only(sv);
6637 SvNV_set(sv, SvNVX(sv) + 1.0);
6641 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6642 if ((flags & SVTYPEMASK) < SVt_PVIV)
6643 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6644 (void)SvIOK_only(sv);
6649 while (isALPHA(*d)) d++;
6650 while (isDIGIT(*d)) d++;
6652 #ifdef PERL_PRESERVE_IVUV
6653 /* Got to punt this as an integer if needs be, but we don't issue
6654 warnings. Probably ought to make the sv_iv_please() that does
6655 the conversion if possible, and silently. */
6656 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6657 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6658 /* Need to try really hard to see if it's an integer.
6659 9.22337203685478e+18 is an integer.
6660 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6661 so $a="9.22337203685478e+18"; $a+0; $a++
6662 needs to be the same as $a="9.22337203685478e+18"; $a++
6669 /* sv_2iv *should* have made this an NV */
6670 if (flags & SVp_NOK) {
6671 (void)SvNOK_only(sv);
6672 SvNV_set(sv, SvNVX(sv) + 1.0);
6675 /* I don't think we can get here. Maybe I should assert this
6676 And if we do get here I suspect that sv_setnv will croak. NWC
6678 #if defined(USE_LONG_DOUBLE)
6679 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",
6680 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6682 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6683 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6686 #endif /* PERL_PRESERVE_IVUV */
6687 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6691 while (d >= SvPVX_const(sv)) {
6699 /* MKS: The original code here died if letters weren't consecutive.
6700 * at least it didn't have to worry about non-C locales. The
6701 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6702 * arranged in order (although not consecutively) and that only
6703 * [A-Za-z] are accepted by isALPHA in the C locale.
6705 if (*d != 'z' && *d != 'Z') {
6706 do { ++*d; } while (!isALPHA(*d));
6709 *(d--) -= 'z' - 'a';
6714 *(d--) -= 'z' - 'a' + 1;
6718 /* oh,oh, the number grew */
6719 SvGROW(sv, SvCUR(sv) + 2);
6720 SvCUR_set(sv, SvCUR(sv) + 1);
6721 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6732 Auto-decrement of the value in the SV, doing string to numeric conversion
6733 if necessary. Handles 'get' magic.
6739 Perl_sv_dec(pTHX_ register SV *sv)
6747 if (SvTHINKFIRST(sv)) {
6749 sv_force_normal_flags(sv, 0);
6750 if (SvREADONLY(sv)) {
6751 if (IN_PERL_RUNTIME)
6752 Perl_croak(aTHX_ PL_no_modify);
6756 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6758 i = PTR2IV(SvRV(sv));
6763 /* Unlike sv_inc we don't have to worry about string-never-numbers
6764 and keeping them magic. But we mustn't warn on punting */
6765 flags = SvFLAGS(sv);
6766 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6767 /* It's publicly an integer, or privately an integer-not-float */
6768 #ifdef PERL_PRESERVE_IVUV
6772 if (SvUVX(sv) == 0) {
6773 (void)SvIOK_only(sv);
6777 (void)SvIOK_only_UV(sv);
6778 SvUV_set(sv, SvUVX(sv) - 1);
6781 if (SvIVX(sv) == IV_MIN)
6782 sv_setnv(sv, (NV)IV_MIN - 1.0);
6784 (void)SvIOK_only(sv);
6785 SvIV_set(sv, SvIVX(sv) - 1);
6790 if (flags & SVp_NOK) {
6791 SvNV_set(sv, SvNVX(sv) - 1.0);
6792 (void)SvNOK_only(sv);
6795 if (!(flags & SVp_POK)) {
6796 if ((flags & SVTYPEMASK) < SVt_PVIV)
6797 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6799 (void)SvIOK_only(sv);
6802 #ifdef PERL_PRESERVE_IVUV
6804 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6805 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6806 /* Need to try really hard to see if it's an integer.
6807 9.22337203685478e+18 is an integer.
6808 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6809 so $a="9.22337203685478e+18"; $a+0; $a--
6810 needs to be the same as $a="9.22337203685478e+18"; $a--
6817 /* sv_2iv *should* have made this an NV */
6818 if (flags & SVp_NOK) {
6819 (void)SvNOK_only(sv);
6820 SvNV_set(sv, SvNVX(sv) - 1.0);
6823 /* I don't think we can get here. Maybe I should assert this
6824 And if we do get here I suspect that sv_setnv will croak. NWC
6826 #if defined(USE_LONG_DOUBLE)
6827 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",
6828 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6830 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6831 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6835 #endif /* PERL_PRESERVE_IVUV */
6836 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6840 =for apidoc sv_mortalcopy
6842 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6843 The new SV is marked as mortal. It will be destroyed "soon", either by an
6844 explicit call to FREETMPS, or by an implicit call at places such as
6845 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6850 /* Make a string that will exist for the duration of the expression
6851 * evaluation. Actually, it may have to last longer than that, but
6852 * hopefully we won't free it until it has been assigned to a
6853 * permanent location. */
6856 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6862 sv_setsv(sv,oldstr);
6864 PL_tmps_stack[++PL_tmps_ix] = sv;
6870 =for apidoc sv_newmortal
6872 Creates a new null SV which is mortal. The reference count of the SV is
6873 set to 1. It will be destroyed "soon", either by an explicit call to
6874 FREETMPS, or by an implicit call at places such as statement boundaries.
6875 See also C<sv_mortalcopy> and C<sv_2mortal>.
6881 Perl_sv_newmortal(pTHX)
6887 SvFLAGS(sv) = SVs_TEMP;
6889 PL_tmps_stack[++PL_tmps_ix] = sv;
6894 =for apidoc sv_2mortal
6896 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6897 by an explicit call to FREETMPS, or by an implicit call at places such as
6898 statement boundaries. SvTEMP() is turned on which means that the SV's
6899 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6900 and C<sv_mortalcopy>.
6906 Perl_sv_2mortal(pTHX_ register SV *sv)
6911 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6914 PL_tmps_stack[++PL_tmps_ix] = sv;
6922 Creates a new SV and copies a string into it. The reference count for the
6923 SV is set to 1. If C<len> is zero, Perl will compute the length using
6924 strlen(). For efficiency, consider using C<newSVpvn> instead.
6930 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6936 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6941 =for apidoc newSVpvn
6943 Creates a new SV and copies a string into it. The reference count for the
6944 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6945 string. You are responsible for ensuring that the source string is at least
6946 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6952 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6958 sv_setpvn(sv,s,len);
6964 =for apidoc newSVhek
6966 Creates a new SV from the hash key structure. It will generate scalars that
6967 point to the shared string table where possible. Returns a new (undefined)
6968 SV if the hek is NULL.
6974 Perl_newSVhek(pTHX_ const HEK *hek)
6984 if (HEK_LEN(hek) == HEf_SVKEY) {
6985 return newSVsv(*(SV**)HEK_KEY(hek));
6987 const int flags = HEK_FLAGS(hek);
6988 if (flags & HVhek_WASUTF8) {
6990 Andreas would like keys he put in as utf8 to come back as utf8
6992 STRLEN utf8_len = HEK_LEN(hek);
6993 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6994 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6997 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6999 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7000 /* We don't have a pointer to the hv, so we have to replicate the
7001 flag into every HEK. This hv is using custom a hasing
7002 algorithm. Hence we can't return a shared string scalar, as
7003 that would contain the (wrong) hash value, and might get passed
7004 into an hv routine with a regular hash.
7005 Similarly, a hash that isn't using shared hash keys has to have
7006 the flag in every key so that we know not to try to call
7007 share_hek_kek on it. */
7009 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7014 /* This will be overwhelminly the most common case. */
7016 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7017 more efficient than sharepvn(). */
7021 sv_upgrade(sv, SVt_PV);
7022 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7023 SvCUR_set(sv, HEK_LEN(hek));
7036 =for apidoc newSVpvn_share
7038 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7039 table. If the string does not already exist in the table, it is created
7040 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7041 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7042 otherwise the hash is computed. The idea here is that as the string table
7043 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7044 hash lookup will avoid string compare.
7050 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7054 bool is_utf8 = FALSE;
7055 const char *const orig_src = src;
7058 STRLEN tmplen = -len;
7060 /* See the note in hv.c:hv_fetch() --jhi */
7061 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7065 PERL_HASH(hash, src, len);
7067 sv_upgrade(sv, SVt_PV);
7068 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7076 if (src != orig_src)
7082 #if defined(PERL_IMPLICIT_CONTEXT)
7084 /* pTHX_ magic can't cope with varargs, so this is a no-context
7085 * version of the main function, (which may itself be aliased to us).
7086 * Don't access this version directly.
7090 Perl_newSVpvf_nocontext(const char* pat, ...)
7095 va_start(args, pat);
7096 sv = vnewSVpvf(pat, &args);
7103 =for apidoc newSVpvf
7105 Creates a new SV and initializes it with the string formatted like
7112 Perl_newSVpvf(pTHX_ const char* pat, ...)
7116 va_start(args, pat);
7117 sv = vnewSVpvf(pat, &args);
7122 /* backend for newSVpvf() and newSVpvf_nocontext() */
7125 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7130 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7137 Creates a new SV and copies a floating point value into it.
7138 The reference count for the SV is set to 1.
7144 Perl_newSVnv(pTHX_ NV n)
7157 Creates a new SV and copies an integer into it. The reference count for the
7164 Perl_newSViv(pTHX_ IV i)
7177 Creates a new SV and copies an unsigned integer into it.
7178 The reference count for the SV is set to 1.
7184 Perl_newSVuv(pTHX_ UV u)
7195 =for apidoc newRV_noinc
7197 Creates an RV wrapper for an SV. The reference count for the original
7198 SV is B<not> incremented.
7204 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7210 sv_upgrade(sv, SVt_RV);
7212 SvRV_set(sv, tmpRef);
7217 /* newRV_inc is the official function name to use now.
7218 * newRV_inc is in fact #defined to newRV in sv.h
7222 Perl_newRV(pTHX_ SV *sv)
7225 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7231 Creates a new SV which is an exact duplicate of the original SV.
7238 Perl_newSVsv(pTHX_ register SV *old)
7245 if (SvTYPE(old) == SVTYPEMASK) {
7246 if (ckWARN_d(WARN_INTERNAL))
7247 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7251 /* SV_GMAGIC is the default for sv_setv()
7252 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7253 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7254 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7259 =for apidoc sv_reset
7261 Underlying implementation for the C<reset> Perl function.
7262 Note that the perl-level function is vaguely deprecated.
7268 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7271 char todo[PERL_UCHAR_MAX+1];
7276 if (!*s) { /* reset ?? searches */
7277 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7279 PMOP *pm = (PMOP *) mg->mg_obj;
7281 pm->op_pmdynflags &= ~PMdf_USED;
7288 /* reset variables */
7290 if (!HvARRAY(stash))
7293 Zero(todo, 256, char);
7296 I32 i = (unsigned char)*s;
7300 max = (unsigned char)*s++;
7301 for ( ; i <= max; i++) {
7304 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7306 for (entry = HvARRAY(stash)[i];
7308 entry = HeNEXT(entry))
7313 if (!todo[(U8)*HeKEY(entry)])
7315 gv = (GV*)HeVAL(entry);
7318 if (SvTHINKFIRST(sv)) {
7319 if (!SvREADONLY(sv) && SvROK(sv))
7321 /* XXX Is this continue a bug? Why should THINKFIRST
7322 exempt us from resetting arrays and hashes? */
7326 if (SvTYPE(sv) >= SVt_PV) {
7328 if (SvPVX_const(sv) != NULL)
7336 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7338 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7341 # if defined(USE_ENVIRON_ARRAY)
7344 # endif /* USE_ENVIRON_ARRAY */
7355 Using various gambits, try to get an IO from an SV: the IO slot if its a
7356 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7357 named after the PV if we're a string.
7363 Perl_sv_2io(pTHX_ SV *sv)
7368 switch (SvTYPE(sv)) {
7376 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7380 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7382 return sv_2io(SvRV(sv));
7383 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7389 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7398 Using various gambits, try to get a CV from an SV; in addition, try if
7399 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7400 The flags in C<lref> are passed to sv_fetchsv.
7406 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7417 switch (SvTYPE(sv)) {
7436 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7437 tryAMAGICunDEREF(to_cv);
7440 if (SvTYPE(sv) == SVt_PVCV) {
7449 Perl_croak(aTHX_ "Not a subroutine reference");
7454 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7460 /* Some flags to gv_fetchsv mean don't really create the GV */
7461 if (SvTYPE(gv) != SVt_PVGV) {
7467 if (lref && !GvCVu(gv)) {
7471 gv_efullname3(tmpsv, gv, NULL);
7472 /* XXX this is probably not what they think they're getting.
7473 * It has the same effect as "sub name;", i.e. just a forward
7475 newSUB(start_subparse(FALSE, 0),
7476 newSVOP(OP_CONST, 0, tmpsv),
7480 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7490 Returns true if the SV has a true value by Perl's rules.
7491 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7492 instead use an in-line version.
7498 Perl_sv_true(pTHX_ register SV *sv)
7503 register const XPV* const tXpv = (XPV*)SvANY(sv);
7505 (tXpv->xpv_cur > 1 ||
7506 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7513 return SvIVX(sv) != 0;
7516 return SvNVX(sv) != 0.0;
7518 return sv_2bool(sv);
7524 =for apidoc sv_pvn_force
7526 Get a sensible string out of the SV somehow.
7527 A private implementation of the C<SvPV_force> macro for compilers which
7528 can't cope with complex macro expressions. Always use the macro instead.
7530 =for apidoc sv_pvn_force_flags
7532 Get a sensible string out of the SV somehow.
7533 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7534 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7535 implemented in terms of this function.
7536 You normally want to use the various wrapper macros instead: see
7537 C<SvPV_force> and C<SvPV_force_nomg>
7543 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7546 if (SvTHINKFIRST(sv) && !SvROK(sv))
7547 sv_force_normal_flags(sv, 0);
7557 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7558 const char * const ref = sv_reftype(sv,0);
7560 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7561 ref, OP_NAME(PL_op));
7563 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7565 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7566 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7568 s = sv_2pv_flags(sv, &len, flags);
7572 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7575 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7576 SvGROW(sv, len + 1);
7577 Move(s,SvPVX(sv),len,char);
7582 SvPOK_on(sv); /* validate pointer */
7584 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7585 PTR2UV(sv),SvPVX_const(sv)));
7588 return SvPVX_mutable(sv);
7592 =for apidoc sv_pvbyten_force
7594 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7600 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7602 sv_pvn_force(sv,lp);
7603 sv_utf8_downgrade(sv,0);
7609 =for apidoc sv_pvutf8n_force
7611 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7617 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7619 sv_pvn_force(sv,lp);
7620 sv_utf8_upgrade(sv);
7626 =for apidoc sv_reftype
7628 Returns a string describing what the SV is a reference to.
7634 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7636 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7637 inside return suggests a const propagation bug in g++. */
7638 if (ob && SvOBJECT(sv)) {
7639 char * const name = HvNAME_get(SvSTASH(sv));
7640 return name ? name : (char *) "__ANON__";
7643 switch (SvTYPE(sv)) {
7659 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7660 /* tied lvalues should appear to be
7661 * scalars for backwards compatitbility */
7662 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7663 ? "SCALAR" : "LVALUE");
7664 case SVt_PVAV: return "ARRAY";
7665 case SVt_PVHV: return "HASH";
7666 case SVt_PVCV: return "CODE";
7667 case SVt_PVGV: return "GLOB";
7668 case SVt_PVFM: return "FORMAT";
7669 case SVt_PVIO: return "IO";
7670 case SVt_BIND: return "BIND";
7671 default: return "UNKNOWN";
7677 =for apidoc sv_isobject
7679 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7680 object. If the SV is not an RV, or if the object is not blessed, then this
7687 Perl_sv_isobject(pTHX_ SV *sv)
7703 Returns a boolean indicating whether the SV is blessed into the specified
7704 class. This does not check for subtypes; use C<sv_derived_from> to verify
7705 an inheritance relationship.
7711 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7722 hvname = HvNAME_get(SvSTASH(sv));
7726 return strEQ(hvname, name);
7732 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7733 it will be upgraded to one. If C<classname> is non-null then the new SV will
7734 be blessed in the specified package. The new SV is returned and its
7735 reference count is 1.
7741 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7748 SV_CHECK_THINKFIRST_COW_DROP(rv);
7751 if (SvTYPE(rv) >= SVt_PVMG) {
7752 const U32 refcnt = SvREFCNT(rv);
7756 SvREFCNT(rv) = refcnt;
7758 sv_upgrade(rv, SVt_RV);
7759 } else if (SvROK(rv)) {
7760 SvREFCNT_dec(SvRV(rv));
7761 } else if (SvTYPE(rv) < SVt_RV)
7762 sv_upgrade(rv, SVt_RV);
7763 else if (SvTYPE(rv) > SVt_RV) {
7774 HV* const stash = gv_stashpv(classname, TRUE);
7775 (void)sv_bless(rv, stash);
7781 =for apidoc sv_setref_pv
7783 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7784 argument will be upgraded to an RV. That RV will be modified to point to
7785 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7786 into the SV. The C<classname> argument indicates the package for the
7787 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7788 will have a reference count of 1, and the RV will be returned.
7790 Do not use with other Perl types such as HV, AV, SV, CV, because those
7791 objects will become corrupted by the pointer copy process.
7793 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7799 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7803 sv_setsv(rv, &PL_sv_undef);
7807 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7812 =for apidoc sv_setref_iv
7814 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7815 argument will be upgraded to an RV. That RV will be modified to point to
7816 the new SV. The C<classname> argument indicates the package for the
7817 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7818 will have a reference count of 1, and the RV will be returned.
7824 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7826 sv_setiv(newSVrv(rv,classname), iv);
7831 =for apidoc sv_setref_uv
7833 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7834 argument will be upgraded to an RV. That RV will be modified to point to
7835 the new SV. The C<classname> argument indicates the package for the
7836 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7837 will have a reference count of 1, and the RV will be returned.
7843 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7845 sv_setuv(newSVrv(rv,classname), uv);
7850 =for apidoc sv_setref_nv
7852 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7853 argument will be upgraded to an RV. That RV will be modified to point to
7854 the new SV. The C<classname> argument indicates the package for the
7855 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7856 will have a reference count of 1, and the RV will be returned.
7862 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7864 sv_setnv(newSVrv(rv,classname), nv);
7869 =for apidoc sv_setref_pvn
7871 Copies a string into a new SV, optionally blessing the SV. The length of the
7872 string must be specified with C<n>. The C<rv> argument will be upgraded to
7873 an RV. That RV will be modified to point to the new SV. The C<classname>
7874 argument indicates the package for the blessing. Set C<classname> to
7875 C<NULL> to avoid the blessing. The new SV will have a reference count
7876 of 1, and the RV will be returned.
7878 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7884 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7886 sv_setpvn(newSVrv(rv,classname), pv, n);
7891 =for apidoc sv_bless
7893 Blesses an SV into a specified package. The SV must be an RV. The package
7894 must be designated by its stash (see C<gv_stashpv()>). The reference count
7895 of the SV is unaffected.
7901 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7906 Perl_croak(aTHX_ "Can't bless non-reference value");
7908 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7909 if (SvREADONLY(tmpRef))
7910 Perl_croak(aTHX_ PL_no_modify);
7911 if (SvOBJECT(tmpRef)) {
7912 if (SvTYPE(tmpRef) != SVt_PVIO)
7914 SvREFCNT_dec(SvSTASH(tmpRef));
7917 SvOBJECT_on(tmpRef);
7918 if (SvTYPE(tmpRef) != SVt_PVIO)
7920 SvUPGRADE(tmpRef, SVt_PVMG);
7921 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7928 if(SvSMAGICAL(tmpRef))
7929 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7937 /* Downgrades a PVGV to a PVMG.
7941 S_sv_unglob(pTHX_ SV *sv)
7945 SV * const temp = sv_newmortal();
7947 assert(SvTYPE(sv) == SVt_PVGV);
7949 gv_efullname3(temp, (GV *) sv, "*");
7955 sv_del_backref((SV*)GvSTASH(sv), sv);
7959 if (GvNAME_HEK(sv)) {
7960 unshare_hek(GvNAME_HEK(sv));
7962 isGV_with_GP_off(sv);
7964 /* need to keep SvANY(sv) in the right arena */
7965 xpvmg = new_XPVMG();
7966 StructCopy(SvANY(sv), xpvmg, XPVMG);
7967 del_XPVGV(SvANY(sv));
7970 SvFLAGS(sv) &= ~SVTYPEMASK;
7971 SvFLAGS(sv) |= SVt_PVMG;
7973 /* Intentionally not calling any local SET magic, as this isn't so much a
7974 set operation as merely an internal storage change. */
7975 sv_setsv_flags(sv, temp, 0);
7979 =for apidoc sv_unref_flags
7981 Unsets the RV status of the SV, and decrements the reference count of
7982 whatever was being referenced by the RV. This can almost be thought of
7983 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7984 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7985 (otherwise the decrementing is conditional on the reference count being
7986 different from one or the reference being a readonly SV).
7993 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7995 SV* const target = SvRV(ref);
7997 if (SvWEAKREF(ref)) {
7998 sv_del_backref(target, ref);
8000 SvRV_set(ref, NULL);
8003 SvRV_set(ref, NULL);
8005 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8006 assigned to as BEGIN {$a = \"Foo"} will fail. */
8007 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8008 SvREFCNT_dec(target);
8009 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8010 sv_2mortal(target); /* Schedule for freeing later */
8014 =for apidoc sv_untaint
8016 Untaint an SV. Use C<SvTAINTED_off> instead.
8021 Perl_sv_untaint(pTHX_ SV *sv)
8023 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8024 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8031 =for apidoc sv_tainted
8033 Test an SV for taintedness. Use C<SvTAINTED> instead.
8038 Perl_sv_tainted(pTHX_ SV *sv)
8040 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8041 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8042 if (mg && (mg->mg_len & 1) )
8049 =for apidoc sv_setpviv
8051 Copies an integer into the given SV, also updating its string value.
8052 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8058 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8060 char buf[TYPE_CHARS(UV)];
8062 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8064 sv_setpvn(sv, ptr, ebuf - ptr);
8068 =for apidoc sv_setpviv_mg
8070 Like C<sv_setpviv>, but also handles 'set' magic.
8076 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8082 #if defined(PERL_IMPLICIT_CONTEXT)
8084 /* pTHX_ magic can't cope with varargs, so this is a no-context
8085 * version of the main function, (which may itself be aliased to us).
8086 * Don't access this version directly.
8090 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8094 va_start(args, pat);
8095 sv_vsetpvf(sv, pat, &args);
8099 /* pTHX_ magic can't cope with varargs, so this is a no-context
8100 * version of the main function, (which may itself be aliased to us).
8101 * Don't access this version directly.
8105 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8109 va_start(args, pat);
8110 sv_vsetpvf_mg(sv, pat, &args);
8116 =for apidoc sv_setpvf
8118 Works like C<sv_catpvf> but copies the text into the SV instead of
8119 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8125 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8128 va_start(args, pat);
8129 sv_vsetpvf(sv, pat, &args);
8134 =for apidoc sv_vsetpvf
8136 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8137 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8139 Usually used via its frontend C<sv_setpvf>.
8145 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8147 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8151 =for apidoc sv_setpvf_mg
8153 Like C<sv_setpvf>, but also handles 'set' magic.
8159 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8162 va_start(args, pat);
8163 sv_vsetpvf_mg(sv, pat, &args);
8168 =for apidoc sv_vsetpvf_mg
8170 Like C<sv_vsetpvf>, but also handles 'set' magic.
8172 Usually used via its frontend C<sv_setpvf_mg>.
8178 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8180 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8184 #if defined(PERL_IMPLICIT_CONTEXT)
8186 /* pTHX_ magic can't cope with varargs, so this is a no-context
8187 * version of the main function, (which may itself be aliased to us).
8188 * Don't access this version directly.
8192 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8196 va_start(args, pat);
8197 sv_vcatpvf(sv, pat, &args);
8201 /* pTHX_ magic can't cope with varargs, so this is a no-context
8202 * version of the main function, (which may itself be aliased to us).
8203 * Don't access this version directly.
8207 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8211 va_start(args, pat);
8212 sv_vcatpvf_mg(sv, pat, &args);
8218 =for apidoc sv_catpvf
8220 Processes its arguments like C<sprintf> and appends the formatted
8221 output to an SV. If the appended data contains "wide" characters
8222 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8223 and characters >255 formatted with %c), the original SV might get
8224 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8225 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8226 valid UTF-8; if the original SV was bytes, the pattern should be too.
8231 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8234 va_start(args, pat);
8235 sv_vcatpvf(sv, pat, &args);
8240 =for apidoc sv_vcatpvf
8242 Processes its arguments like C<vsprintf> and appends the formatted output
8243 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8245 Usually used via its frontend C<sv_catpvf>.
8251 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8253 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8257 =for apidoc sv_catpvf_mg
8259 Like C<sv_catpvf>, but also handles 'set' magic.
8265 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8268 va_start(args, pat);
8269 sv_vcatpvf_mg(sv, pat, &args);
8274 =for apidoc sv_vcatpvf_mg
8276 Like C<sv_vcatpvf>, but also handles 'set' magic.
8278 Usually used via its frontend C<sv_catpvf_mg>.
8284 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8286 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8291 =for apidoc sv_vsetpvfn
8293 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8296 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8302 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8304 sv_setpvn(sv, "", 0);
8305 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8309 S_expect_number(pTHX_ char** pattern)
8313 switch (**pattern) {
8314 case '1': case '2': case '3':
8315 case '4': case '5': case '6':
8316 case '7': case '8': case '9':
8317 var = *(*pattern)++ - '0';
8318 while (isDIGIT(**pattern)) {
8319 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8321 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8329 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8331 const int neg = nv < 0;
8340 if (uv & 1 && uv == nv)
8341 uv--; /* Round to even */
8343 const unsigned dig = uv % 10;
8356 =for apidoc sv_vcatpvfn
8358 Processes its arguments like C<vsprintf> and appends the formatted output
8359 to an SV. Uses an array of SVs if the C style variable argument list is
8360 missing (NULL). When running with taint checks enabled, indicates via
8361 C<maybe_tainted> if results are untrustworthy (often due to the use of
8364 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8370 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8371 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8372 vec_utf8 = DO_UTF8(vecsv);
8374 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8377 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8385 static const char nullstr[] = "(null)";
8387 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8388 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8390 /* Times 4: a decimal digit takes more than 3 binary digits.
8391 * NV_DIG: mantissa takes than many decimal digits.
8392 * Plus 32: Playing safe. */
8393 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8394 /* large enough for "%#.#f" --chip */
8395 /* what about long double NVs? --jhi */
8397 PERL_UNUSED_ARG(maybe_tainted);
8399 /* no matter what, this is a string now */
8400 (void)SvPV_force(sv, origlen);
8402 /* special-case "", "%s", and "%-p" (SVf - see below) */
8405 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8407 const char * const s = va_arg(*args, char*);
8408 sv_catpv(sv, s ? s : nullstr);
8410 else if (svix < svmax) {
8411 sv_catsv(sv, *svargs);
8415 if (args && patlen == 3 && pat[0] == '%' &&
8416 pat[1] == '-' && pat[2] == 'p') {
8417 argsv = va_arg(*args, SV*);
8418 sv_catsv(sv, argsv);
8422 #ifndef USE_LONG_DOUBLE
8423 /* special-case "%.<number>[gf]" */
8424 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8425 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8426 unsigned digits = 0;
8430 while (*pp >= '0' && *pp <= '9')
8431 digits = 10 * digits + (*pp++ - '0');
8432 if (pp - pat == (int)patlen - 1) {
8440 /* Add check for digits != 0 because it seems that some
8441 gconverts are buggy in this case, and we don't yet have
8442 a Configure test for this. */
8443 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8444 /* 0, point, slack */
8445 Gconvert(nv, (int)digits, 0, ebuf);
8447 if (*ebuf) /* May return an empty string for digits==0 */
8450 } else if (!digits) {
8453 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8454 sv_catpvn(sv, p, l);
8460 #endif /* !USE_LONG_DOUBLE */
8462 if (!args && svix < svmax && DO_UTF8(*svargs))
8465 patend = (char*)pat + patlen;
8466 for (p = (char*)pat; p < patend; p = q) {
8469 bool vectorize = FALSE;
8470 bool vectorarg = FALSE;
8471 bool vec_utf8 = FALSE;
8477 bool has_precis = FALSE;
8479 const I32 osvix = svix;
8480 bool is_utf8 = FALSE; /* is this item utf8? */
8481 #ifdef HAS_LDBL_SPRINTF_BUG
8482 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8483 with sfio - Allen <allens@cpan.org> */
8484 bool fix_ldbl_sprintf_bug = FALSE;
8488 U8 utf8buf[UTF8_MAXBYTES+1];
8489 STRLEN esignlen = 0;
8491 const char *eptr = NULL;
8494 const U8 *vecstr = NULL;
8501 /* we need a long double target in case HAS_LONG_DOUBLE but
8504 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8512 const char *dotstr = ".";
8513 STRLEN dotstrlen = 1;
8514 I32 efix = 0; /* explicit format parameter index */
8515 I32 ewix = 0; /* explicit width index */
8516 I32 epix = 0; /* explicit precision index */
8517 I32 evix = 0; /* explicit vector index */
8518 bool asterisk = FALSE;
8520 /* echo everything up to the next format specification */
8521 for (q = p; q < patend && *q != '%'; ++q) ;
8523 if (has_utf8 && !pat_utf8)
8524 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8526 sv_catpvn(sv, p, q - p);
8533 We allow format specification elements in this order:
8534 \d+\$ explicit format parameter index
8536 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8537 0 flag (as above): repeated to allow "v02"
8538 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8539 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8541 [%bcdefginopsuxDFOUX] format (mandatory)
8546 As of perl5.9.3, printf format checking is on by default.
8547 Internally, perl uses %p formats to provide an escape to
8548 some extended formatting. This block deals with those
8549 extensions: if it does not match, (char*)q is reset and
8550 the normal format processing code is used.
8552 Currently defined extensions are:
8553 %p include pointer address (standard)
8554 %-p (SVf) include an SV (previously %_)
8555 %-<num>p include an SV with precision <num>
8556 %1p (VDf) include a v-string (as %vd)
8557 %<num>p reserved for future extensions
8559 Robin Barker 2005-07-14
8566 n = expect_number(&q);
8573 argsv = va_arg(*args, SV*);
8574 eptr = SvPVx_const(argsv, elen);
8580 else if (n == vdNUMBER) { /* VDf */
8587 if (ckWARN_d(WARN_INTERNAL))
8588 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8589 "internal %%<num>p might conflict with future printf extensions");
8595 if ( (width = expect_number(&q)) ) {
8610 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8639 if ( (ewix = expect_number(&q)) )
8648 if ((vectorarg = asterisk)) {
8661 width = expect_number(&q);
8667 vecsv = va_arg(*args, SV*);
8669 vecsv = (evix > 0 && evix <= svmax)
8670 ? svargs[evix-1] : &PL_sv_undef;
8672 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8674 dotstr = SvPV_const(vecsv, dotstrlen);
8675 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8676 bad with tied or overloaded values that return UTF8. */
8679 else if (has_utf8) {
8680 vecsv = sv_mortalcopy(vecsv);
8681 sv_utf8_upgrade(vecsv);
8682 dotstr = SvPV_const(vecsv, dotstrlen);
8689 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8690 vecsv = svargs[efix ? efix-1 : svix++];
8691 vecstr = (U8*)SvPV_const(vecsv,veclen);
8692 vec_utf8 = DO_UTF8(vecsv);
8694 /* if this is a version object, we need to convert
8695 * back into v-string notation and then let the
8696 * vectorize happen normally
8698 if (sv_derived_from(vecsv, "version")) {
8699 char *version = savesvpv(vecsv);
8700 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8701 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8702 "vector argument not supported with alpha versions");
8705 vecsv = sv_newmortal();
8706 /* scan_vstring is expected to be called during
8707 * tokenization, so we need to fake up the end
8708 * of the buffer for it
8710 PL_bufend = version + veclen;
8711 scan_vstring(version, vecsv);
8712 vecstr = (U8*)SvPV_const(vecsv, veclen);
8713 vec_utf8 = DO_UTF8(vecsv);
8725 i = va_arg(*args, int);
8727 i = (ewix ? ewix <= svmax : svix < svmax) ?
8728 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8730 width = (i < 0) ? -i : i;
8740 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8742 /* XXX: todo, support specified precision parameter */
8746 i = va_arg(*args, int);
8748 i = (ewix ? ewix <= svmax : svix < svmax)
8749 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8751 has_precis = !(i < 0);
8756 precis = precis * 10 + (*q++ - '0');
8765 case 'I': /* Ix, I32x, and I64x */
8767 if (q[1] == '6' && q[2] == '4') {
8773 if (q[1] == '3' && q[2] == '2') {
8783 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8794 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8795 if (*(q + 1) == 'l') { /* lld, llf */
8821 if (!vectorize && !args) {
8823 const I32 i = efix-1;
8824 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8826 argsv = (svix >= 0 && svix < svmax)
8827 ? svargs[svix++] : &PL_sv_undef;
8838 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8840 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8842 eptr = (char*)utf8buf;
8843 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8857 eptr = va_arg(*args, char*);
8859 #ifdef MACOS_TRADITIONAL
8860 /* On MacOS, %#s format is used for Pascal strings */
8865 elen = strlen(eptr);
8867 eptr = (char *)nullstr;
8868 elen = sizeof nullstr - 1;
8872 eptr = SvPVx_const(argsv, elen);
8873 if (DO_UTF8(argsv)) {
8874 I32 old_precis = precis;
8875 if (has_precis && precis < elen) {
8877 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8880 if (width) { /* fudge width (can't fudge elen) */
8881 if (has_precis && precis < elen)
8882 width += precis - old_precis;
8884 width += elen - sv_len_utf8(argsv);
8891 if (has_precis && elen > precis)
8898 if (alt || vectorize)
8900 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8921 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8930 esignbuf[esignlen++] = plus;
8934 case 'h': iv = (short)va_arg(*args, int); break;
8935 case 'l': iv = va_arg(*args, long); break;
8936 case 'V': iv = va_arg(*args, IV); break;
8937 default: iv = va_arg(*args, int); break;
8939 case 'q': iv = va_arg(*args, Quad_t); break;
8944 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8946 case 'h': iv = (short)tiv; break;
8947 case 'l': iv = (long)tiv; break;
8949 default: iv = tiv; break;
8951 case 'q': iv = (Quad_t)tiv; break;
8955 if ( !vectorize ) /* we already set uv above */
8960 esignbuf[esignlen++] = plus;
8964 esignbuf[esignlen++] = '-';
9008 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9019 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9020 case 'l': uv = va_arg(*args, unsigned long); break;
9021 case 'V': uv = va_arg(*args, UV); break;
9022 default: uv = va_arg(*args, unsigned); break;
9024 case 'q': uv = va_arg(*args, Uquad_t); break;
9029 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9031 case 'h': uv = (unsigned short)tuv; break;
9032 case 'l': uv = (unsigned long)tuv; break;
9034 default: uv = tuv; break;
9036 case 'q': uv = (Uquad_t)tuv; break;
9043 char *ptr = ebuf + sizeof ebuf;
9044 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9050 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9056 esignbuf[esignlen++] = '0';
9057 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9065 if (alt && *ptr != '0')
9074 esignbuf[esignlen++] = '0';
9075 esignbuf[esignlen++] = c;
9078 default: /* it had better be ten or less */
9082 } while (uv /= base);
9085 elen = (ebuf + sizeof ebuf) - ptr;
9089 zeros = precis - elen;
9090 else if (precis == 0 && elen == 1 && *eptr == '0'
9091 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9094 /* a precision nullifies the 0 flag. */
9101 /* FLOATING POINT */
9104 c = 'f'; /* maybe %F isn't supported here */
9112 /* This is evil, but floating point is even more evil */
9114 /* for SV-style calling, we can only get NV
9115 for C-style calling, we assume %f is double;
9116 for simplicity we allow any of %Lf, %llf, %qf for long double
9120 #if defined(USE_LONG_DOUBLE)
9124 /* [perl #20339] - we should accept and ignore %lf rather than die */
9128 #if defined(USE_LONG_DOUBLE)
9129 intsize = args ? 0 : 'q';
9133 #if defined(HAS_LONG_DOUBLE)
9142 /* now we need (long double) if intsize == 'q', else (double) */
9144 #if LONG_DOUBLESIZE > DOUBLESIZE
9146 va_arg(*args, long double) :
9147 va_arg(*args, double)
9149 va_arg(*args, double)
9154 if (c != 'e' && c != 'E') {
9156 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9157 will cast our (long double) to (double) */
9158 (void)Perl_frexp(nv, &i);
9159 if (i == PERL_INT_MIN)
9160 Perl_die(aTHX_ "panic: frexp");
9162 need = BIT_DIGITS(i);
9164 need += has_precis ? precis : 6; /* known default */
9169 #ifdef HAS_LDBL_SPRINTF_BUG
9170 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9171 with sfio - Allen <allens@cpan.org> */
9174 # define MY_DBL_MAX DBL_MAX
9175 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9176 # if DOUBLESIZE >= 8
9177 # define MY_DBL_MAX 1.7976931348623157E+308L
9179 # define MY_DBL_MAX 3.40282347E+38L
9183 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9184 # define MY_DBL_MAX_BUG 1L
9186 # define MY_DBL_MAX_BUG MY_DBL_MAX
9190 # define MY_DBL_MIN DBL_MIN
9191 # else /* XXX guessing! -Allen */
9192 # if DOUBLESIZE >= 8
9193 # define MY_DBL_MIN 2.2250738585072014E-308L
9195 # define MY_DBL_MIN 1.17549435E-38L
9199 if ((intsize == 'q') && (c == 'f') &&
9200 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9202 /* it's going to be short enough that
9203 * long double precision is not needed */
9205 if ((nv <= 0L) && (nv >= -0L))
9206 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9208 /* would use Perl_fp_class as a double-check but not
9209 * functional on IRIX - see perl.h comments */
9211 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9212 /* It's within the range that a double can represent */
9213 #if defined(DBL_MAX) && !defined(DBL_MIN)
9214 if ((nv >= ((long double)1/DBL_MAX)) ||
9215 (nv <= (-(long double)1/DBL_MAX)))
9217 fix_ldbl_sprintf_bug = TRUE;
9220 if (fix_ldbl_sprintf_bug == TRUE) {
9230 # undef MY_DBL_MAX_BUG
9233 #endif /* HAS_LDBL_SPRINTF_BUG */
9235 need += 20; /* fudge factor */
9236 if (PL_efloatsize < need) {
9237 Safefree(PL_efloatbuf);
9238 PL_efloatsize = need + 20; /* more fudge */
9239 Newx(PL_efloatbuf, PL_efloatsize, char);
9240 PL_efloatbuf[0] = '\0';
9243 if ( !(width || left || plus || alt) && fill != '0'
9244 && has_precis && intsize != 'q' ) { /* Shortcuts */
9245 /* See earlier comment about buggy Gconvert when digits,
9247 if ( c == 'g' && precis) {
9248 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9249 /* May return an empty string for digits==0 */
9250 if (*PL_efloatbuf) {
9251 elen = strlen(PL_efloatbuf);
9252 goto float_converted;
9254 } else if ( c == 'f' && !precis) {
9255 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9260 char *ptr = ebuf + sizeof ebuf;
9263 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9264 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9265 if (intsize == 'q') {
9266 /* Copy the one or more characters in a long double
9267 * format before the 'base' ([efgEFG]) character to
9268 * the format string. */
9269 static char const prifldbl[] = PERL_PRIfldbl;
9270 char const *p = prifldbl + sizeof(prifldbl) - 3;
9271 while (p >= prifldbl) { *--ptr = *p--; }
9276 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9281 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9293 /* No taint. Otherwise we are in the strange situation
9294 * where printf() taints but print($float) doesn't.
9296 #if defined(HAS_LONG_DOUBLE)
9297 elen = ((intsize == 'q')
9298 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9299 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9301 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9305 eptr = PL_efloatbuf;
9313 i = SvCUR(sv) - origlen;
9316 case 'h': *(va_arg(*args, short*)) = i; break;
9317 default: *(va_arg(*args, int*)) = i; break;
9318 case 'l': *(va_arg(*args, long*)) = i; break;
9319 case 'V': *(va_arg(*args, IV*)) = i; break;
9321 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9326 sv_setuv_mg(argsv, (UV)i);
9327 continue; /* not "break" */
9334 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9335 && ckWARN(WARN_PRINTF))
9337 SV * const msg = sv_newmortal();
9338 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9339 (PL_op->op_type == OP_PRTF) ? "" : "s");
9342 Perl_sv_catpvf(aTHX_ msg,
9343 "\"%%%c\"", c & 0xFF);
9345 Perl_sv_catpvf(aTHX_ msg,
9346 "\"%%\\%03"UVof"\"",
9349 sv_catpvs(msg, "end of string");
9350 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9353 /* output mangled stuff ... */
9359 /* ... right here, because formatting flags should not apply */
9360 SvGROW(sv, SvCUR(sv) + elen + 1);
9362 Copy(eptr, p, elen, char);
9365 SvCUR_set(sv, p - SvPVX_const(sv));
9367 continue; /* not "break" */
9370 if (is_utf8 != has_utf8) {
9373 sv_utf8_upgrade(sv);
9376 const STRLEN old_elen = elen;
9377 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9378 sv_utf8_upgrade(nsv);
9379 eptr = SvPVX_const(nsv);
9382 if (width) { /* fudge width (can't fudge elen) */
9383 width += elen - old_elen;
9389 have = esignlen + zeros + elen;
9391 Perl_croak_nocontext(PL_memory_wrap);
9393 need = (have > width ? have : width);
9396 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9397 Perl_croak_nocontext(PL_memory_wrap);
9398 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9400 if (esignlen && fill == '0') {
9402 for (i = 0; i < (int)esignlen; i++)
9406 memset(p, fill, gap);
9409 if (esignlen && fill != '0') {
9411 for (i = 0; i < (int)esignlen; i++)
9416 for (i = zeros; i; i--)
9420 Copy(eptr, p, elen, char);
9424 memset(p, ' ', gap);
9429 Copy(dotstr, p, dotstrlen, char);
9433 vectorize = FALSE; /* done iterating over vecstr */
9440 SvCUR_set(sv, p - SvPVX_const(sv));
9448 /* =========================================================================
9450 =head1 Cloning an interpreter
9452 All the macros and functions in this section are for the private use of
9453 the main function, perl_clone().
9455 The foo_dup() functions make an exact copy of an existing foo thinngy.
9456 During the course of a cloning, a hash table is used to map old addresses
9457 to new addresses. The table is created and manipulated with the
9458 ptr_table_* functions.
9462 ============================================================================*/
9465 #if defined(USE_ITHREADS)
9467 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9468 #ifndef GpREFCNT_inc
9469 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9473 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9474 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9475 If this changes, please unmerge ss_dup. */
9476 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9477 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9478 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9479 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9480 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9481 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9482 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9483 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9484 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9485 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9486 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9487 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9488 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9489 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9491 /* clone a parser */
9494 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9501 Newxz(parser, 1, yy_parser);
9503 parser->yyerrstatus = 0;
9504 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9506 /* XXX these not yet duped */
9507 parser->old_parser = NULL;
9508 parser->stack = NULL;
9510 parser->stack_size = 0;
9511 /* XXX parser->stack->state = 0; */
9513 /* XXX eventually, just Copy() most of the parser struct ? */
9515 parser->lex_brackets = proto->lex_brackets;
9516 parser->lex_casemods = proto->lex_casemods;
9517 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9518 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9519 parser->lex_casestack = savepvn(proto->lex_casestack,
9520 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9521 parser->lex_defer = proto->lex_defer;
9522 parser->lex_dojoin = proto->lex_dojoin;
9523 parser->lex_expect = proto->lex_expect;
9524 parser->lex_formbrack = proto->lex_formbrack;
9525 parser->lex_inpat = proto->lex_inpat;
9526 parser->lex_inwhat = proto->lex_inwhat;
9527 parser->lex_op = proto->lex_op;
9528 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9529 parser->lex_starts = proto->lex_starts;
9530 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9531 parser->multi_close = proto->multi_close;
9532 parser->multi_open = proto->multi_open;
9533 parser->multi_start = proto->multi_start;
9534 parser->pending_ident = proto->pending_ident;
9535 parser->preambled = proto->preambled;
9536 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9539 parser->endwhite = proto->endwhite;
9540 parser->faketokens = proto->faketokens;
9541 parser->lasttoke = proto->lasttoke;
9542 parser->nextwhite = proto->nextwhite;
9543 parser->realtokenstart = proto->realtokenstart;
9544 parser->skipwhite = proto->skipwhite;
9545 parser->thisclose = proto->thisclose;
9546 parser->thismad = proto->thismad;
9547 parser->thisopen = proto->thisopen;
9548 parser->thisstuff = proto->thisstuff;
9549 parser->thistoken = proto->thistoken;
9550 parser->thiswhite = proto->thiswhite;
9556 /* duplicate a file handle */
9559 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9563 PERL_UNUSED_ARG(type);
9566 return (PerlIO*)NULL;
9568 /* look for it in the table first */
9569 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9573 /* create anew and remember what it is */
9574 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9575 ptr_table_store(PL_ptr_table, fp, ret);
9579 /* duplicate a directory handle */
9582 Perl_dirp_dup(pTHX_ DIR *dp)
9584 PERL_UNUSED_CONTEXT;
9591 /* duplicate a typeglob */
9594 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9600 /* look for it in the table first */
9601 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9605 /* create anew and remember what it is */
9607 ptr_table_store(PL_ptr_table, gp, ret);
9610 ret->gp_refcnt = 0; /* must be before any other dups! */
9611 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9612 ret->gp_io = io_dup_inc(gp->gp_io, param);
9613 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9614 ret->gp_av = av_dup_inc(gp->gp_av, param);
9615 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9616 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9617 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9618 ret->gp_cvgen = gp->gp_cvgen;
9619 ret->gp_line = gp->gp_line;
9620 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9624 /* duplicate a chain of magic */
9627 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9629 MAGIC *mgprev = (MAGIC*)NULL;
9632 return (MAGIC*)NULL;
9633 /* look for it in the table first */
9634 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9638 for (; mg; mg = mg->mg_moremagic) {
9640 Newxz(nmg, 1, MAGIC);
9642 mgprev->mg_moremagic = nmg;
9645 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9646 nmg->mg_private = mg->mg_private;
9647 nmg->mg_type = mg->mg_type;
9648 nmg->mg_flags = mg->mg_flags;
9649 if (mg->mg_type == PERL_MAGIC_qr) {
9650 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9652 else if(mg->mg_type == PERL_MAGIC_backref) {
9653 /* The backref AV has its reference count deliberately bumped by
9655 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9657 else if (mg->mg_type == PERL_MAGIC_symtab) {
9658 nmg->mg_obj = mg->mg_obj;
9661 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9662 ? sv_dup_inc(mg->mg_obj, param)
9663 : sv_dup(mg->mg_obj, param);
9665 nmg->mg_len = mg->mg_len;
9666 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9667 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9668 if (mg->mg_len > 0) {
9669 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9670 if (mg->mg_type == PERL_MAGIC_overload_table &&
9671 AMT_AMAGIC((AMT*)mg->mg_ptr))
9673 const AMT * const amtp = (AMT*)mg->mg_ptr;
9674 AMT * const namtp = (AMT*)nmg->mg_ptr;
9676 for (i = 1; i < NofAMmeth; i++) {
9677 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9681 else if (mg->mg_len == HEf_SVKEY)
9682 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9684 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9685 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9692 #endif /* USE_ITHREADS */
9694 /* create a new pointer-mapping table */
9697 Perl_ptr_table_new(pTHX)
9700 PERL_UNUSED_CONTEXT;
9702 Newxz(tbl, 1, PTR_TBL_t);
9705 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9709 #define PTR_TABLE_HASH(ptr) \
9710 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9713 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9714 following define) and at call to new_body_inline made below in
9715 Perl_ptr_table_store()
9718 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9720 /* map an existing pointer using a table */
9722 STATIC PTR_TBL_ENT_t *
9723 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9724 PTR_TBL_ENT_t *tblent;
9725 const UV hash = PTR_TABLE_HASH(sv);
9727 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9728 for (; tblent; tblent = tblent->next) {
9729 if (tblent->oldval == sv)
9736 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9738 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9739 PERL_UNUSED_CONTEXT;
9740 return tblent ? tblent->newval : NULL;
9743 /* add a new entry to a pointer-mapping table */
9746 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9748 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9749 PERL_UNUSED_CONTEXT;
9752 tblent->newval = newsv;
9754 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9756 new_body_inline(tblent, PTE_SVSLOT);
9758 tblent->oldval = oldsv;
9759 tblent->newval = newsv;
9760 tblent->next = tbl->tbl_ary[entry];
9761 tbl->tbl_ary[entry] = tblent;
9763 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9764 ptr_table_split(tbl);
9768 /* double the hash bucket size of an existing ptr table */
9771 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9773 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9774 const UV oldsize = tbl->tbl_max + 1;
9775 UV newsize = oldsize * 2;
9777 PERL_UNUSED_CONTEXT;
9779 Renew(ary, newsize, PTR_TBL_ENT_t*);
9780 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9781 tbl->tbl_max = --newsize;
9783 for (i=0; i < oldsize; i++, ary++) {
9784 PTR_TBL_ENT_t **curentp, **entp, *ent;
9787 curentp = ary + oldsize;
9788 for (entp = ary, ent = *ary; ent; ent = *entp) {
9789 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9791 ent->next = *curentp;
9801 /* remove all the entries from a ptr table */
9804 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9806 if (tbl && tbl->tbl_items) {
9807 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9808 UV riter = tbl->tbl_max;
9811 PTR_TBL_ENT_t *entry = array[riter];
9814 PTR_TBL_ENT_t * const oentry = entry;
9815 entry = entry->next;
9824 /* clear and free a ptr table */
9827 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9832 ptr_table_clear(tbl);
9833 Safefree(tbl->tbl_ary);
9837 #if defined(USE_ITHREADS)
9840 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9843 SvRV_set(dstr, SvWEAKREF(sstr)
9844 ? sv_dup(SvRV(sstr), param)
9845 : sv_dup_inc(SvRV(sstr), param));
9848 else if (SvPVX_const(sstr)) {
9849 /* Has something there */
9851 /* Normal PV - clone whole allocated space */
9852 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9853 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9854 /* Not that normal - actually sstr is copy on write.
9855 But we are a true, independant SV, so: */
9856 SvREADONLY_off(dstr);
9861 /* Special case - not normally malloced for some reason */
9862 if (isGV_with_GP(sstr)) {
9863 /* Don't need to do anything here. */
9865 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9866 /* A "shared" PV - clone it as "shared" PV */
9868 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9872 /* Some other special case - random pointer */
9873 SvPV_set(dstr, SvPVX(sstr));
9879 if (SvTYPE(dstr) == SVt_RV)
9880 SvRV_set(dstr, NULL);
9882 SvPV_set(dstr, NULL);
9886 /* duplicate an SV of any type (including AV, HV etc) */
9889 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9894 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9896 /* look for it in the table first */
9897 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9901 if(param->flags & CLONEf_JOIN_IN) {
9902 /** We are joining here so we don't want do clone
9903 something that is bad **/
9904 if (SvTYPE(sstr) == SVt_PVHV) {
9905 const char * const hvname = HvNAME_get(sstr);
9907 /** don't clone stashes if they already exist **/
9908 return (SV*)gv_stashpv(hvname,0);
9912 /* create anew and remember what it is */
9915 #ifdef DEBUG_LEAKING_SCALARS
9916 dstr->sv_debug_optype = sstr->sv_debug_optype;
9917 dstr->sv_debug_line = sstr->sv_debug_line;
9918 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9919 dstr->sv_debug_cloned = 1;
9920 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9923 ptr_table_store(PL_ptr_table, sstr, dstr);
9926 SvFLAGS(dstr) = SvFLAGS(sstr);
9927 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9928 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9931 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9932 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9933 PL_watch_pvx, SvPVX_const(sstr));
9936 /* don't clone objects whose class has asked us not to */
9937 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9938 SvFLAGS(dstr) &= ~SVTYPEMASK;
9943 switch (SvTYPE(sstr)) {
9948 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9949 SvIV_set(dstr, SvIVX(sstr));
9952 SvANY(dstr) = new_XNV();
9953 SvNV_set(dstr, SvNVX(sstr));
9956 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9957 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9959 /* case SVt_BIND: */
9962 /* These are all the types that need complex bodies allocating. */
9964 const svtype sv_type = SvTYPE(sstr);
9965 const struct body_details *const sv_type_details
9966 = bodies_by_type + sv_type;
9970 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9974 if (GvUNIQUE((GV*)sstr)) {
9975 NOOP; /* Do sharing here, and fall through */
9987 assert(sv_type_details->body_size);
9988 if (sv_type_details->arena) {
9989 new_body_inline(new_body, sv_type);
9991 = (void*)((char*)new_body - sv_type_details->offset);
9993 new_body = new_NOARENA(sv_type_details);
9997 SvANY(dstr) = new_body;
10000 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10001 ((char*)SvANY(dstr)) + sv_type_details->offset,
10002 sv_type_details->copy, char);
10004 Copy(((char*)SvANY(sstr)),
10005 ((char*)SvANY(dstr)),
10006 sv_type_details->body_size + sv_type_details->offset, char);
10009 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10010 && !isGV_with_GP(dstr))
10011 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10013 /* The Copy above means that all the source (unduplicated) pointers
10014 are now in the destination. We can check the flags and the
10015 pointers in either, but it's possible that there's less cache
10016 missing by always going for the destination.
10017 FIXME - instrument and check that assumption */
10018 if (sv_type >= SVt_PVMG) {
10019 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10020 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10021 } else if (SvMAGIC(dstr))
10022 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10024 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10027 /* The cast silences a GCC warning about unhandled types. */
10028 switch ((int)sv_type) {
10038 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10039 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10040 LvTARG(dstr) = dstr;
10041 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10042 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10044 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10047 if(isGV_with_GP(sstr)) {
10048 if (GvNAME_HEK(dstr))
10049 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10052 /* Don't call sv_add_backref here as it's going to be created
10053 as part of the magic cloning of the symbol table. */
10055 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10056 if(isGV_with_GP(sstr)) {
10057 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10058 at the point of this comment. */
10059 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10060 (void)GpREFCNT_inc(GvGP(dstr));
10062 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10065 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10066 if (IoOFP(dstr) == IoIFP(sstr))
10067 IoOFP(dstr) = IoIFP(dstr);
10069 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10070 /* PL_rsfp_filters entries have fake IoDIRP() */
10071 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10072 /* I have no idea why fake dirp (rsfps)
10073 should be treated differently but otherwise
10074 we end up with leaks -- sky*/
10075 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10076 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10077 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10079 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10080 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10081 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10082 if (IoDIRP(dstr)) {
10083 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10086 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10089 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10090 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10091 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10094 if (AvARRAY((AV*)sstr)) {
10095 SV **dst_ary, **src_ary;
10096 SSize_t items = AvFILLp((AV*)sstr) + 1;
10098 src_ary = AvARRAY((AV*)sstr);
10099 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10100 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10101 AvARRAY((AV*)dstr) = dst_ary;
10102 AvALLOC((AV*)dstr) = dst_ary;
10103 if (AvREAL((AV*)sstr)) {
10104 while (items-- > 0)
10105 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10108 while (items-- > 0)
10109 *dst_ary++ = sv_dup(*src_ary++, param);
10111 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10112 while (items-- > 0) {
10113 *dst_ary++ = &PL_sv_undef;
10117 AvARRAY((AV*)dstr) = NULL;
10118 AvALLOC((AV*)dstr) = (SV**)NULL;
10122 if (HvARRAY((HV*)sstr)) {
10124 const bool sharekeys = !!HvSHAREKEYS(sstr);
10125 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10126 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10128 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10129 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10131 HvARRAY(dstr) = (HE**)darray;
10132 while (i <= sxhv->xhv_max) {
10133 const HE * const source = HvARRAY(sstr)[i];
10134 HvARRAY(dstr)[i] = source
10135 ? he_dup(source, sharekeys, param) : 0;
10140 const struct xpvhv_aux * const saux = HvAUX(sstr);
10141 struct xpvhv_aux * const daux = HvAUX(dstr);
10142 /* This flag isn't copied. */
10143 /* SvOOK_on(hv) attacks the IV flags. */
10144 SvFLAGS(dstr) |= SVf_OOK;
10146 hvname = saux->xhv_name;
10147 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10149 daux->xhv_riter = saux->xhv_riter;
10150 daux->xhv_eiter = saux->xhv_eiter
10151 ? he_dup(saux->xhv_eiter,
10152 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10153 daux->xhv_backreferences =
10154 saux->xhv_backreferences
10155 ? (AV*) SvREFCNT_inc(
10156 sv_dup((SV*)saux->xhv_backreferences, param))
10158 /* Record stashes for possible cloning in Perl_clone(). */
10160 av_push(param->stashes, dstr);
10164 HvARRAY((HV*)dstr) = NULL;
10167 if (!(param->flags & CLONEf_COPY_STACKS)) {
10171 /* NOTE: not refcounted */
10172 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10174 if (!CvISXSUB(dstr))
10175 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10177 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10178 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10179 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10180 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10182 /* don't dup if copying back - CvGV isn't refcounted, so the
10183 * duped GV may never be freed. A bit of a hack! DAPM */
10184 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10185 NULL : gv_dup(CvGV(dstr), param) ;
10186 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10188 CvWEAKOUTSIDE(sstr)
10189 ? cv_dup( CvOUTSIDE(dstr), param)
10190 : cv_dup_inc(CvOUTSIDE(dstr), param);
10191 if (!CvISXSUB(dstr))
10192 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10198 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10204 /* duplicate a context */
10207 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10209 PERL_CONTEXT *ncxs;
10212 return (PERL_CONTEXT*)NULL;
10214 /* look for it in the table first */
10215 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10219 /* create anew and remember what it is */
10220 Newxz(ncxs, max + 1, PERL_CONTEXT);
10221 ptr_table_store(PL_ptr_table, cxs, ncxs);
10224 PERL_CONTEXT * const cx = &cxs[ix];
10225 PERL_CONTEXT * const ncx = &ncxs[ix];
10226 ncx->cx_type = cx->cx_type;
10227 if (CxTYPE(cx) == CXt_SUBST) {
10228 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10231 ncx->blk_oldsp = cx->blk_oldsp;
10232 ncx->blk_oldcop = cx->blk_oldcop;
10233 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10234 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10235 ncx->blk_oldpm = cx->blk_oldpm;
10236 ncx->blk_gimme = cx->blk_gimme;
10237 switch (CxTYPE(cx)) {
10239 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10240 ? cv_dup_inc(cx->blk_sub.cv, param)
10241 : cv_dup(cx->blk_sub.cv,param));
10242 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10243 ? av_dup_inc(cx->blk_sub.argarray, param)
10245 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10246 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10247 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10248 ncx->blk_sub.lval = cx->blk_sub.lval;
10249 ncx->blk_sub.retop = cx->blk_sub.retop;
10250 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10251 cx->blk_sub.oldcomppad);
10254 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10255 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10256 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10257 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10258 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10259 ncx->blk_eval.retop = cx->blk_eval.retop;
10262 ncx->blk_loop.label = cx->blk_loop.label;
10263 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10264 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10265 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10266 ? cx->blk_loop.iterdata
10267 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10268 ncx->blk_loop.oldcomppad
10269 = (PAD*)ptr_table_fetch(PL_ptr_table,
10270 cx->blk_loop.oldcomppad);
10271 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10272 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10273 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10274 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10275 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10278 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10279 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10280 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10281 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10282 ncx->blk_sub.retop = cx->blk_sub.retop;
10294 /* duplicate a stack info structure */
10297 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10302 return (PERL_SI*)NULL;
10304 /* look for it in the table first */
10305 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10309 /* create anew and remember what it is */
10310 Newxz(nsi, 1, PERL_SI);
10311 ptr_table_store(PL_ptr_table, si, nsi);
10313 nsi->si_stack = av_dup_inc(si->si_stack, param);
10314 nsi->si_cxix = si->si_cxix;
10315 nsi->si_cxmax = si->si_cxmax;
10316 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10317 nsi->si_type = si->si_type;
10318 nsi->si_prev = si_dup(si->si_prev, param);
10319 nsi->si_next = si_dup(si->si_next, param);
10320 nsi->si_markoff = si->si_markoff;
10325 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10326 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10327 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10328 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10329 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10330 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10331 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10332 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10333 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10334 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10335 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10336 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10337 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10338 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10341 #define pv_dup_inc(p) SAVEPV(p)
10342 #define pv_dup(p) SAVEPV(p)
10343 #define svp_dup_inc(p,pp) any_dup(p,pp)
10345 /* map any object to the new equivent - either something in the
10346 * ptr table, or something in the interpreter structure
10350 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10355 return (void*)NULL;
10357 /* look for it in the table first */
10358 ret = ptr_table_fetch(PL_ptr_table, v);
10362 /* see if it is part of the interpreter structure */
10363 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10364 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10372 /* duplicate the save stack */
10375 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10378 ANY * const ss = proto_perl->Tsavestack;
10379 const I32 max = proto_perl->Tsavestack_max;
10380 I32 ix = proto_perl->Tsavestack_ix;
10393 void (*dptr) (void*);
10394 void (*dxptr) (pTHX_ void*);
10396 Newxz(nss, max, ANY);
10399 const I32 type = POPINT(ss,ix);
10400 TOPINT(nss,ix) = type;
10402 case SAVEt_HELEM: /* hash element */
10403 sv = (SV*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10406 case SAVEt_ITEM: /* normal string */
10407 case SAVEt_SV: /* scalar reference */
10408 sv = (SV*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10412 case SAVEt_MORTALIZESV:
10413 sv = (SV*)POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10416 case SAVEt_SHARED_PVREF: /* char* in shared space */
10417 c = (char*)POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = savesharedpv(c);
10419 ptr = POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10422 case SAVEt_GENERIC_SVREF: /* generic sv */
10423 case SAVEt_SVREF: /* scalar reference */
10424 sv = (SV*)POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10426 ptr = POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10429 case SAVEt_HV: /* hash reference */
10430 case SAVEt_AV: /* array reference */
10431 sv = (SV*) POPPTR(ss,ix);
10432 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10434 case SAVEt_COMPPAD:
10436 sv = (SV*) POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = sv_dup(sv, param);
10439 case SAVEt_INT: /* int reference */
10440 ptr = POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10442 intval = (int)POPINT(ss,ix);
10443 TOPINT(nss,ix) = intval;
10445 case SAVEt_LONG: /* long reference */
10446 ptr = POPPTR(ss,ix);
10447 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10449 case SAVEt_CLEARSV:
10450 longval = (long)POPLONG(ss,ix);
10451 TOPLONG(nss,ix) = longval;
10453 case SAVEt_I32: /* I32 reference */
10454 case SAVEt_I16: /* I16 reference */
10455 case SAVEt_I8: /* I8 reference */
10456 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10457 ptr = POPPTR(ss,ix);
10458 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10460 TOPINT(nss,ix) = i;
10462 case SAVEt_IV: /* IV reference */
10463 ptr = POPPTR(ss,ix);
10464 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10466 TOPIV(nss,ix) = iv;
10468 case SAVEt_HPTR: /* HV* reference */
10469 case SAVEt_APTR: /* AV* reference */
10470 case SAVEt_SPTR: /* SV* reference */
10471 ptr = POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10473 sv = (SV*)POPPTR(ss,ix);
10474 TOPPTR(nss,ix) = sv_dup(sv, param);
10476 case SAVEt_VPTR: /* random* reference */
10477 ptr = POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10479 ptr = POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10482 case SAVEt_GENERIC_PVREF: /* generic char* */
10483 case SAVEt_PPTR: /* char* reference */
10484 ptr = POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 c = (char*)POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = pv_dup(c);
10489 case SAVEt_GP: /* scalar reference */
10490 gp = (GP*)POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10492 (void)GpREFCNT_inc(gp);
10493 gv = (GV*)POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10497 ptr = POPPTR(ss,ix);
10498 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10499 /* these are assumed to be refcounted properly */
10501 switch (((OP*)ptr)->op_type) {
10503 case OP_LEAVESUBLV:
10507 case OP_LEAVEWRITE:
10508 TOPPTR(nss,ix) = ptr;
10515 TOPPTR(nss,ix) = NULL;
10520 TOPPTR(nss,ix) = NULL;
10523 c = (char*)POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = pv_dup_inc(c);
10527 hv = (HV*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10529 c = (char*)POPPTR(ss,ix);
10530 TOPPTR(nss,ix) = pv_dup_inc(c);
10532 case SAVEt_STACK_POS: /* Position on Perl stack */
10534 TOPINT(nss,ix) = i;
10536 case SAVEt_DESTRUCTOR:
10537 ptr = POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10539 dptr = POPDPTR(ss,ix);
10540 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10541 any_dup(FPTR2DPTR(void *, dptr),
10544 case SAVEt_DESTRUCTOR_X:
10545 ptr = POPPTR(ss,ix);
10546 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10547 dxptr = POPDXPTR(ss,ix);
10548 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10549 any_dup(FPTR2DPTR(void *, dxptr),
10552 case SAVEt_REGCONTEXT:
10555 TOPINT(nss,ix) = i;
10558 case SAVEt_AELEM: /* array element */
10559 sv = (SV*)POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10562 TOPINT(nss,ix) = i;
10563 av = (AV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = av_dup_inc(av, param);
10567 ptr = POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = ptr;
10572 TOPINT(nss,ix) = i;
10573 ptr = POPPTR(ss,ix);
10576 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10577 HINTS_REFCNT_UNLOCK;
10579 TOPPTR(nss,ix) = ptr;
10580 if (i & HINT_LOCALIZE_HH) {
10581 hv = (HV*)POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10586 longval = (long)POPLONG(ss,ix);
10587 TOPLONG(nss,ix) = longval;
10588 ptr = POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10590 sv = (SV*)POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = sv_dup(sv, param);
10594 ptr = POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10596 longval = (long)POPBOOL(ss,ix);
10597 TOPBOOL(nss,ix) = (bool)longval;
10599 case SAVEt_SET_SVFLAGS:
10601 TOPINT(nss,ix) = i;
10603 TOPINT(nss,ix) = i;
10604 sv = (SV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = sv_dup(sv, param);
10607 case SAVEt_RE_STATE:
10609 const struct re_save_state *const old_state
10610 = (struct re_save_state *)
10611 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10612 struct re_save_state *const new_state
10613 = (struct re_save_state *)
10614 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10616 Copy(old_state, new_state, 1, struct re_save_state);
10617 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10619 new_state->re_state_bostr
10620 = pv_dup(old_state->re_state_bostr);
10621 new_state->re_state_reginput
10622 = pv_dup(old_state->re_state_reginput);
10623 new_state->re_state_regeol
10624 = pv_dup(old_state->re_state_regeol);
10625 new_state->re_state_regstartp
10626 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10627 new_state->re_state_regendp
10628 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10629 new_state->re_state_reglastparen
10630 = (U32*) any_dup(old_state->re_state_reglastparen,
10632 new_state->re_state_reglastcloseparen
10633 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10635 /* XXX This just has to be broken. The old save_re_context
10636 code did SAVEGENERICPV(PL_reg_start_tmp);
10637 PL_reg_start_tmp is char **.
10638 Look above to what the dup code does for
10639 SAVEt_GENERIC_PVREF
10640 It can never have worked.
10641 So this is merely a faithful copy of the exiting bug: */
10642 new_state->re_state_reg_start_tmp
10643 = (char **) pv_dup((char *)
10644 old_state->re_state_reg_start_tmp);
10645 /* I assume that it only ever "worked" because no-one called
10646 (pseudo)fork while the regexp engine had re-entered itself.
10648 #ifdef PERL_OLD_COPY_ON_WRITE
10649 new_state->re_state_nrs
10650 = sv_dup(old_state->re_state_nrs, param);
10652 new_state->re_state_reg_magic
10653 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10655 new_state->re_state_reg_oldcurpm
10656 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10658 new_state->re_state_reg_curpm
10659 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10661 new_state->re_state_reg_oldsaved
10662 = pv_dup(old_state->re_state_reg_oldsaved);
10663 new_state->re_state_reg_poscache
10664 = pv_dup(old_state->re_state_reg_poscache);
10665 new_state->re_state_reg_starttry
10666 = pv_dup(old_state->re_state_reg_starttry);
10669 case SAVEt_COMPILE_WARNINGS:
10670 ptr = POPPTR(ss,ix);
10671 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10675 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10683 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10684 * flag to the result. This is done for each stash before cloning starts,
10685 * so we know which stashes want their objects cloned */
10688 do_mark_cloneable_stash(pTHX_ SV *sv)
10690 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10692 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10693 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10694 if (cloner && GvCV(cloner)) {
10701 XPUSHs(sv_2mortal(newSVhek(hvname)));
10703 call_sv((SV*)GvCV(cloner), G_SCALAR);
10710 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10718 =for apidoc perl_clone
10720 Create and return a new interpreter by cloning the current one.
10722 perl_clone takes these flags as parameters:
10724 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10725 without it we only clone the data and zero the stacks,
10726 with it we copy the stacks and the new perl interpreter is
10727 ready to run at the exact same point as the previous one.
10728 The pseudo-fork code uses COPY_STACKS while the
10729 threads->new doesn't.
10731 CLONEf_KEEP_PTR_TABLE
10732 perl_clone keeps a ptr_table with the pointer of the old
10733 variable as a key and the new variable as a value,
10734 this allows it to check if something has been cloned and not
10735 clone it again but rather just use the value and increase the
10736 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10737 the ptr_table using the function
10738 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10739 reason to keep it around is if you want to dup some of your own
10740 variable who are outside the graph perl scans, example of this
10741 code is in threads.xs create
10744 This is a win32 thing, it is ignored on unix, it tells perls
10745 win32host code (which is c++) to clone itself, this is needed on
10746 win32 if you want to run two threads at the same time,
10747 if you just want to do some stuff in a separate perl interpreter
10748 and then throw it away and return to the original one,
10749 you don't need to do anything.
10754 /* XXX the above needs expanding by someone who actually understands it ! */
10755 EXTERN_C PerlInterpreter *
10756 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10759 perl_clone(PerlInterpreter *proto_perl, UV flags)
10762 #ifdef PERL_IMPLICIT_SYS
10764 /* perlhost.h so we need to call into it
10765 to clone the host, CPerlHost should have a c interface, sky */
10767 if (flags & CLONEf_CLONE_HOST) {
10768 return perl_clone_host(proto_perl,flags);
10770 return perl_clone_using(proto_perl, flags,
10772 proto_perl->IMemShared,
10773 proto_perl->IMemParse,
10775 proto_perl->IStdIO,
10779 proto_perl->IProc);
10783 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10784 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10785 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10786 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10787 struct IPerlDir* ipD, struct IPerlSock* ipS,
10788 struct IPerlProc* ipP)
10790 /* XXX many of the string copies here can be optimized if they're
10791 * constants; they need to be allocated as common memory and just
10792 * their pointers copied. */
10795 CLONE_PARAMS clone_params;
10796 CLONE_PARAMS* const param = &clone_params;
10798 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10799 /* for each stash, determine whether its objects should be cloned */
10800 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10801 PERL_SET_THX(my_perl);
10804 PoisonNew(my_perl, 1, PerlInterpreter);
10810 PL_savestack_ix = 0;
10811 PL_savestack_max = -1;
10812 PL_sig_pending = 0;
10813 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10814 # else /* !DEBUGGING */
10815 Zero(my_perl, 1, PerlInterpreter);
10816 # endif /* DEBUGGING */
10818 /* host pointers */
10820 PL_MemShared = ipMS;
10821 PL_MemParse = ipMP;
10828 #else /* !PERL_IMPLICIT_SYS */
10830 CLONE_PARAMS clone_params;
10831 CLONE_PARAMS* param = &clone_params;
10832 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10833 /* for each stash, determine whether its objects should be cloned */
10834 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10835 PERL_SET_THX(my_perl);
10838 PoisonNew(my_perl, 1, PerlInterpreter);
10844 PL_savestack_ix = 0;
10845 PL_savestack_max = -1;
10846 PL_sig_pending = 0;
10847 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10848 # else /* !DEBUGGING */
10849 Zero(my_perl, 1, PerlInterpreter);
10850 # endif /* DEBUGGING */
10851 #endif /* PERL_IMPLICIT_SYS */
10852 param->flags = flags;
10853 param->proto_perl = proto_perl;
10855 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10857 PL_body_arenas = NULL;
10858 Zero(&PL_body_roots, 1, PL_body_roots);
10860 PL_nice_chunk = NULL;
10861 PL_nice_chunk_size = 0;
10863 PL_sv_objcount = 0;
10865 PL_sv_arenaroot = NULL;
10867 PL_debug = proto_perl->Idebug;
10869 PL_hash_seed = proto_perl->Ihash_seed;
10870 PL_rehash_seed = proto_perl->Irehash_seed;
10872 #ifdef USE_REENTRANT_API
10873 /* XXX: things like -Dm will segfault here in perlio, but doing
10874 * PERL_SET_CONTEXT(proto_perl);
10875 * breaks too many other things
10877 Perl_reentrant_init(aTHX);
10880 /* create SV map for pointer relocation */
10881 PL_ptr_table = ptr_table_new();
10883 /* initialize these special pointers as early as possible */
10884 SvANY(&PL_sv_undef) = NULL;
10885 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10886 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10887 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10889 SvANY(&PL_sv_no) = new_XPVNV();
10890 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10891 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10892 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10893 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10894 SvCUR_set(&PL_sv_no, 0);
10895 SvLEN_set(&PL_sv_no, 1);
10896 SvIV_set(&PL_sv_no, 0);
10897 SvNV_set(&PL_sv_no, 0);
10898 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10900 SvANY(&PL_sv_yes) = new_XPVNV();
10901 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10902 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10903 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10904 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10905 SvCUR_set(&PL_sv_yes, 1);
10906 SvLEN_set(&PL_sv_yes, 2);
10907 SvIV_set(&PL_sv_yes, 1);
10908 SvNV_set(&PL_sv_yes, 1);
10909 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10911 /* create (a non-shared!) shared string table */
10912 PL_strtab = newHV();
10913 HvSHAREKEYS_off(PL_strtab);
10914 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10915 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10917 PL_compiling = proto_perl->Icompiling;
10919 /* These two PVs will be free'd special way so must set them same way op.c does */
10920 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10921 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10923 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10924 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10926 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10927 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10928 if (PL_compiling.cop_hints_hash) {
10930 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10931 HINTS_REFCNT_UNLOCK;
10933 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10935 /* pseudo environmental stuff */
10936 PL_origargc = proto_perl->Iorigargc;
10937 PL_origargv = proto_perl->Iorigargv;
10939 param->stashes = newAV(); /* Setup array of objects to call clone on */
10941 /* Set tainting stuff before PerlIO_debug can possibly get called */
10942 PL_tainting = proto_perl->Itainting;
10943 PL_taint_warn = proto_perl->Itaint_warn;
10945 #ifdef PERLIO_LAYERS
10946 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10947 PerlIO_clone(aTHX_ proto_perl, param);
10950 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10951 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10952 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10953 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10954 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10955 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10958 PL_minus_c = proto_perl->Iminus_c;
10959 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10960 PL_localpatches = proto_perl->Ilocalpatches;
10961 PL_splitstr = proto_perl->Isplitstr;
10962 PL_preprocess = proto_perl->Ipreprocess;
10963 PL_minus_n = proto_perl->Iminus_n;
10964 PL_minus_p = proto_perl->Iminus_p;
10965 PL_minus_l = proto_perl->Iminus_l;
10966 PL_minus_a = proto_perl->Iminus_a;
10967 PL_minus_E = proto_perl->Iminus_E;
10968 PL_minus_F = proto_perl->Iminus_F;
10969 PL_doswitches = proto_perl->Idoswitches;
10970 PL_dowarn = proto_perl->Idowarn;
10971 PL_doextract = proto_perl->Idoextract;
10972 PL_sawampersand = proto_perl->Isawampersand;
10973 PL_unsafe = proto_perl->Iunsafe;
10974 PL_inplace = SAVEPV(proto_perl->Iinplace);
10975 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10976 PL_perldb = proto_perl->Iperldb;
10977 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10978 PL_exit_flags = proto_perl->Iexit_flags;
10980 /* magical thingies */
10981 /* XXX time(&PL_basetime) when asked for? */
10982 PL_basetime = proto_perl->Ibasetime;
10983 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10985 PL_maxsysfd = proto_perl->Imaxsysfd;
10986 PL_statusvalue = proto_perl->Istatusvalue;
10988 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10990 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10992 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10994 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10995 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10996 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10999 /* RE engine related */
11000 Zero(&PL_reg_state, 1, struct re_save_state);
11001 PL_reginterp_cnt = 0;
11002 PL_regmatch_slab = NULL;
11004 /* Clone the regex array */
11005 PL_regex_padav = newAV();
11007 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11008 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11010 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11011 for(i = 1; i <= len; i++) {
11012 const SV * const regex = regexen[i];
11015 ? sv_dup_inc(regex, param)
11017 newSViv(PTR2IV(CALLREGDUPE(
11018 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11020 av_push(PL_regex_padav, sv);
11023 PL_regex_pad = AvARRAY(PL_regex_padav);
11025 /* shortcuts to various I/O objects */
11026 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11027 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11028 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11029 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11030 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11031 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11033 /* shortcuts to regexp stuff */
11034 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11036 /* shortcuts to misc objects */
11037 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11039 /* shortcuts to debugging objects */
11040 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11041 PL_DBline = gv_dup(proto_perl->IDBline, param);
11042 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11043 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11044 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11045 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11046 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11047 PL_lineary = av_dup(proto_perl->Ilineary, param);
11048 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11050 /* symbol tables */
11051 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11052 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11053 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11054 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11055 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11057 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11058 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11059 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11060 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11061 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11062 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11063 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11064 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11066 PL_sub_generation = proto_perl->Isub_generation;
11068 /* funky return mechanisms */
11069 PL_forkprocess = proto_perl->Iforkprocess;
11071 /* subprocess state */
11072 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11074 /* internal state */
11075 PL_maxo = proto_perl->Imaxo;
11076 if (proto_perl->Iop_mask)
11077 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11080 /* PL_asserting = proto_perl->Iasserting; */
11082 /* current interpreter roots */
11083 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11085 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11087 PL_main_start = proto_perl->Imain_start;
11088 PL_eval_root = proto_perl->Ieval_root;
11089 PL_eval_start = proto_perl->Ieval_start;
11091 /* runtime control stuff */
11092 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11093 PL_copline = proto_perl->Icopline;
11095 PL_filemode = proto_perl->Ifilemode;
11096 PL_lastfd = proto_perl->Ilastfd;
11097 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11100 PL_gensym = proto_perl->Igensym;
11101 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11102 PL_laststatval = proto_perl->Ilaststatval;
11103 PL_laststype = proto_perl->Ilaststype;
11106 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11108 /* interpreter atexit processing */
11109 PL_exitlistlen = proto_perl->Iexitlistlen;
11110 if (PL_exitlistlen) {
11111 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11112 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11115 PL_exitlist = (PerlExitListEntry*)NULL;
11117 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11118 if (PL_my_cxt_size) {
11119 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11120 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11121 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11122 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11123 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11127 PL_my_cxt_list = (void**)NULL;
11128 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11129 PL_my_cxt_keys = (void**)NULL;
11132 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11133 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11134 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11136 PL_profiledata = NULL;
11137 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11138 /* PL_rsfp_filters entries have fake IoDIRP() */
11139 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11141 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11143 PAD_CLONE_VARS(proto_perl, param);
11145 #ifdef HAVE_INTERP_INTERN
11146 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11149 /* more statics moved here */
11150 PL_generation = proto_perl->Igeneration;
11151 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11153 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11154 PL_in_clean_all = proto_perl->Iin_clean_all;
11156 PL_uid = proto_perl->Iuid;
11157 PL_euid = proto_perl->Ieuid;
11158 PL_gid = proto_perl->Igid;
11159 PL_egid = proto_perl->Iegid;
11160 PL_nomemok = proto_perl->Inomemok;
11161 PL_an = proto_perl->Ian;
11162 PL_evalseq = proto_perl->Ievalseq;
11163 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11164 PL_origalen = proto_perl->Iorigalen;
11165 #ifdef PERL_USES_PL_PIDSTATUS
11166 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11168 PL_osname = SAVEPV(proto_perl->Iosname);
11169 PL_sighandlerp = proto_perl->Isighandlerp;
11171 PL_runops = proto_perl->Irunops;
11173 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11176 PL_cshlen = proto_perl->Icshlen;
11177 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11180 PL_parser = parser_dup(proto_perl->Iparser, param);
11182 PL_lex_state = proto_perl->Ilex_state;
11185 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11186 PL_curforce = proto_perl->Icurforce;
11188 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11189 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11190 PL_nexttoke = proto_perl->Inexttoke;
11193 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11194 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11195 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11196 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11197 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11198 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11199 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11200 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11201 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11202 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11204 PL_expect = proto_perl->Iexpect;
11206 PL_multi_end = proto_perl->Imulti_end;
11208 PL_error_count = proto_perl->Ierror_count;
11209 PL_subline = proto_perl->Isubline;
11210 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11212 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11213 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11214 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11215 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11216 PL_last_lop_op = proto_perl->Ilast_lop_op;
11217 PL_in_my = proto_perl->Iin_my;
11218 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11220 PL_cryptseen = proto_perl->Icryptseen;
11223 PL_hints = proto_perl->Ihints;
11225 PL_amagic_generation = proto_perl->Iamagic_generation;
11227 #ifdef USE_LOCALE_COLLATE
11228 PL_collation_ix = proto_perl->Icollation_ix;
11229 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11230 PL_collation_standard = proto_perl->Icollation_standard;
11231 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11232 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11233 #endif /* USE_LOCALE_COLLATE */
11235 #ifdef USE_LOCALE_NUMERIC
11236 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11237 PL_numeric_standard = proto_perl->Inumeric_standard;
11238 PL_numeric_local = proto_perl->Inumeric_local;
11239 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11240 #endif /* !USE_LOCALE_NUMERIC */
11242 /* utf8 character classes */
11243 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11244 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11245 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11246 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11247 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11248 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11249 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11250 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11251 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11252 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11253 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11254 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11255 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11256 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11257 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11258 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11259 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11260 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11261 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11262 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11264 /* Did the locale setup indicate UTF-8? */
11265 PL_utf8locale = proto_perl->Iutf8locale;
11266 /* Unicode features (see perlrun/-C) */
11267 PL_unicode = proto_perl->Iunicode;
11269 /* Pre-5.8 signals control */
11270 PL_signals = proto_perl->Isignals;
11272 /* times() ticks per second */
11273 PL_clocktick = proto_perl->Iclocktick;
11275 /* Recursion stopper for PerlIO_find_layer */
11276 PL_in_load_module = proto_perl->Iin_load_module;
11278 /* sort() routine */
11279 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11281 /* Not really needed/useful since the reenrant_retint is "volatile",
11282 * but do it for consistency's sake. */
11283 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11285 /* Hooks to shared SVs and locks. */
11286 PL_sharehook = proto_perl->Isharehook;
11287 PL_lockhook = proto_perl->Ilockhook;
11288 PL_unlockhook = proto_perl->Iunlockhook;
11289 PL_threadhook = proto_perl->Ithreadhook;
11291 PL_runops_std = proto_perl->Irunops_std;
11292 PL_runops_dbg = proto_perl->Irunops_dbg;
11294 #ifdef THREADS_HAVE_PIDS
11295 PL_ppid = proto_perl->Ippid;
11299 PL_last_swash_hv = NULL; /* reinits on demand */
11300 PL_last_swash_klen = 0;
11301 PL_last_swash_key[0]= '\0';
11302 PL_last_swash_tmps = (U8*)NULL;
11303 PL_last_swash_slen = 0;
11305 PL_glob_index = proto_perl->Iglob_index;
11306 PL_srand_called = proto_perl->Isrand_called;
11307 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11308 PL_bitcount = NULL; /* reinits on demand */
11310 if (proto_perl->Ipsig_pend) {
11311 Newxz(PL_psig_pend, SIG_SIZE, int);
11314 PL_psig_pend = (int*)NULL;
11317 if (proto_perl->Ipsig_ptr) {
11318 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11319 Newxz(PL_psig_name, SIG_SIZE, SV*);
11320 for (i = 1; i < SIG_SIZE; i++) {
11321 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11322 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11326 PL_psig_ptr = (SV**)NULL;
11327 PL_psig_name = (SV**)NULL;
11330 /* thrdvar.h stuff */
11332 if (flags & CLONEf_COPY_STACKS) {
11333 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11334 PL_tmps_ix = proto_perl->Ttmps_ix;
11335 PL_tmps_max = proto_perl->Ttmps_max;
11336 PL_tmps_floor = proto_perl->Ttmps_floor;
11337 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11339 while (i <= PL_tmps_ix) {
11340 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11344 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11345 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11346 Newxz(PL_markstack, i, I32);
11347 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11348 - proto_perl->Tmarkstack);
11349 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11350 - proto_perl->Tmarkstack);
11351 Copy(proto_perl->Tmarkstack, PL_markstack,
11352 PL_markstack_ptr - PL_markstack + 1, I32);
11354 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11355 * NOTE: unlike the others! */
11356 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11357 PL_scopestack_max = proto_perl->Tscopestack_max;
11358 Newxz(PL_scopestack, PL_scopestack_max, I32);
11359 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11361 /* NOTE: si_dup() looks at PL_markstack */
11362 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11364 /* PL_curstack = PL_curstackinfo->si_stack; */
11365 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11366 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11368 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11369 PL_stack_base = AvARRAY(PL_curstack);
11370 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11371 - proto_perl->Tstack_base);
11372 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11374 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11375 * NOTE: unlike the others! */
11376 PL_savestack_ix = proto_perl->Tsavestack_ix;
11377 PL_savestack_max = proto_perl->Tsavestack_max;
11378 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11379 PL_savestack = ss_dup(proto_perl, param);
11383 ENTER; /* perl_destruct() wants to LEAVE; */
11385 /* although we're not duplicating the tmps stack, we should still
11386 * add entries for any SVs on the tmps stack that got cloned by a
11387 * non-refcount means (eg a temp in @_); otherwise they will be
11390 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11391 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11392 proto_perl->Ttmps_stack[i]);
11393 if (nsv && !SvREFCNT(nsv)) {
11395 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11400 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11401 PL_top_env = &PL_start_env;
11403 PL_op = proto_perl->Top;
11406 PL_Xpv = (XPV*)NULL;
11407 PL_na = proto_perl->Tna;
11409 PL_statbuf = proto_perl->Tstatbuf;
11410 PL_statcache = proto_perl->Tstatcache;
11411 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11412 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11414 PL_timesbuf = proto_perl->Ttimesbuf;
11417 PL_tainted = proto_perl->Ttainted;
11418 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11419 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11420 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11421 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11422 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11423 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11424 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11425 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11426 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11428 PL_restartop = proto_perl->Trestartop;
11429 PL_in_eval = proto_perl->Tin_eval;
11430 PL_delaymagic = proto_perl->Tdelaymagic;
11431 PL_dirty = proto_perl->Tdirty;
11432 PL_localizing = proto_perl->Tlocalizing;
11434 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11435 PL_hv_fetch_ent_mh = NULL;
11436 PL_modcount = proto_perl->Tmodcount;
11437 PL_lastgotoprobe = NULL;
11438 PL_dumpindent = proto_perl->Tdumpindent;
11440 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11441 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11442 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11443 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11444 PL_efloatbuf = NULL; /* reinits on demand */
11445 PL_efloatsize = 0; /* reinits on demand */
11449 PL_screamfirst = NULL;
11450 PL_screamnext = NULL;
11451 PL_maxscream = -1; /* reinits on demand */
11452 PL_lastscream = NULL;
11454 PL_watchaddr = NULL;
11457 PL_regdummy = proto_perl->Tregdummy;
11458 PL_colorset = 0; /* reinits PL_colors[] */
11459 /*PL_colors[6] = {0,0,0,0,0,0};*/
11463 /* Pluggable optimizer */
11464 PL_peepp = proto_perl->Tpeepp;
11466 PL_stashcache = newHV();
11468 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11469 ptr_table_free(PL_ptr_table);
11470 PL_ptr_table = NULL;
11473 /* Call the ->CLONE method, if it exists, for each of the stashes
11474 identified by sv_dup() above.
11476 while(av_len(param->stashes) != -1) {
11477 HV* const stash = (HV*) av_shift(param->stashes);
11478 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11479 if (cloner && GvCV(cloner)) {
11484 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11486 call_sv((SV*)GvCV(cloner), G_DISCARD);
11492 SvREFCNT_dec(param->stashes);
11494 /* orphaned? eg threads->new inside BEGIN or use */
11495 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11496 SvREFCNT_inc_simple_void(PL_compcv);
11497 SAVEFREESV(PL_compcv);
11503 #endif /* USE_ITHREADS */
11506 =head1 Unicode Support
11508 =for apidoc sv_recode_to_utf8
11510 The encoding is assumed to be an Encode object, on entry the PV
11511 of the sv is assumed to be octets in that encoding, and the sv
11512 will be converted into Unicode (and UTF-8).
11514 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11515 is not a reference, nothing is done to the sv. If the encoding is not
11516 an C<Encode::XS> Encoding object, bad things will happen.
11517 (See F<lib/encoding.pm> and L<Encode>).
11519 The PV of the sv is returned.
11524 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11527 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11541 Passing sv_yes is wrong - it needs to be or'ed set of constants
11542 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11543 remove converted chars from source.
11545 Both will default the value - let them.
11547 XPUSHs(&PL_sv_yes);
11550 call_method("decode", G_SCALAR);
11554 s = SvPV_const(uni, len);
11555 if (s != SvPVX_const(sv)) {
11556 SvGROW(sv, len + 1);
11557 Move(s, SvPVX(sv), len + 1, char);
11558 SvCUR_set(sv, len);
11565 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11569 =for apidoc sv_cat_decode
11571 The encoding is assumed to be an Encode object, the PV of the ssv is
11572 assumed to be octets in that encoding and decoding the input starts
11573 from the position which (PV + *offset) pointed to. The dsv will be
11574 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11575 when the string tstr appears in decoding output or the input ends on
11576 the PV of the ssv. The value which the offset points will be modified
11577 to the last input position on the ssv.
11579 Returns TRUE if the terminator was found, else returns FALSE.
11584 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11585 SV *ssv, int *offset, char *tstr, int tlen)
11589 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11600 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11601 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11603 call_method("cat_decode", G_SCALAR);
11605 ret = SvTRUE(TOPs);
11606 *offset = SvIV(offsv);
11612 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11617 /* ---------------------------------------------------------------------
11619 * support functions for report_uninit()
11622 /* the maxiumum size of array or hash where we will scan looking
11623 * for the undefined element that triggered the warning */
11625 #define FUV_MAX_SEARCH_SIZE 1000
11627 /* Look for an entry in the hash whose value has the same SV as val;
11628 * If so, return a mortal copy of the key. */
11631 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11634 register HE **array;
11637 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11638 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11641 array = HvARRAY(hv);
11643 for (i=HvMAX(hv); i>0; i--) {
11644 register HE *entry;
11645 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11646 if (HeVAL(entry) != val)
11648 if ( HeVAL(entry) == &PL_sv_undef ||
11649 HeVAL(entry) == &PL_sv_placeholder)
11653 if (HeKLEN(entry) == HEf_SVKEY)
11654 return sv_mortalcopy(HeKEY_sv(entry));
11655 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11661 /* Look for an entry in the array whose value has the same SV as val;
11662 * If so, return the index, otherwise return -1. */
11665 S_find_array_subscript(pTHX_ AV *av, SV* val)
11668 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11669 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11672 if (val != &PL_sv_undef) {
11673 SV ** const svp = AvARRAY(av);
11676 for (i=AvFILLp(av); i>=0; i--)
11683 /* S_varname(): return the name of a variable, optionally with a subscript.
11684 * If gv is non-zero, use the name of that global, along with gvtype (one
11685 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11686 * targ. Depending on the value of the subscript_type flag, return:
11689 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11690 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11691 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11692 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11695 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11696 SV* keyname, I32 aindex, int subscript_type)
11699 SV * const name = sv_newmortal();
11702 buffer[0] = gvtype;
11705 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11707 gv_fullname4(name, gv, buffer, 0);
11709 if ((unsigned int)SvPVX(name)[1] <= 26) {
11711 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11713 /* Swap the 1 unprintable control character for the 2 byte pretty
11714 version - ie substr($name, 1, 1) = $buffer; */
11715 sv_insert(name, 1, 1, buffer, 2);
11720 CV * const cv = find_runcv(&unused);
11724 if (!cv || !CvPADLIST(cv))
11726 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11727 sv = *av_fetch(av, targ, FALSE);
11728 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11731 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11732 SV * const sv = newSV(0);
11733 *SvPVX(name) = '$';
11734 Perl_sv_catpvf(aTHX_ name, "{%s}",
11735 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11738 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11739 *SvPVX(name) = '$';
11740 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11742 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11743 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11750 =for apidoc find_uninit_var
11752 Find the name of the undefined variable (if any) that caused the operator o
11753 to issue a "Use of uninitialized value" warning.
11754 If match is true, only return a name if it's value matches uninit_sv.
11755 So roughly speaking, if a unary operator (such as OP_COS) generates a
11756 warning, then following the direct child of the op may yield an
11757 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11758 other hand, with OP_ADD there are two branches to follow, so we only print
11759 the variable name if we get an exact match.
11761 The name is returned as a mortal SV.
11763 Assumes that PL_op is the op that originally triggered the error, and that
11764 PL_comppad/PL_curpad points to the currently executing pad.
11770 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11778 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11779 uninit_sv == &PL_sv_placeholder)))
11782 switch (obase->op_type) {
11789 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11790 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11793 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11795 if (pad) { /* @lex, %lex */
11796 sv = PAD_SVl(obase->op_targ);
11800 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11801 /* @global, %global */
11802 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11805 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11807 else /* @{expr}, %{expr} */
11808 return find_uninit_var(cUNOPx(obase)->op_first,
11812 /* attempt to find a match within the aggregate */
11814 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11816 subscript_type = FUV_SUBSCRIPT_HASH;
11819 index = find_array_subscript((AV*)sv, uninit_sv);
11821 subscript_type = FUV_SUBSCRIPT_ARRAY;
11824 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11827 return varname(gv, hash ? '%' : '@', obase->op_targ,
11828 keysv, index, subscript_type);
11832 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11834 return varname(NULL, '$', obase->op_targ,
11835 NULL, 0, FUV_SUBSCRIPT_NONE);
11838 gv = cGVOPx_gv(obase);
11839 if (!gv || (match && GvSV(gv) != uninit_sv))
11841 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11844 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11847 av = (AV*)PAD_SV(obase->op_targ);
11848 if (!av || SvRMAGICAL(av))
11850 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11851 if (!svp || *svp != uninit_sv)
11854 return varname(NULL, '$', obase->op_targ,
11855 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11858 gv = cGVOPx_gv(obase);
11864 if (!av || SvRMAGICAL(av))
11866 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11867 if (!svp || *svp != uninit_sv)
11870 return varname(gv, '$', 0,
11871 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11876 o = cUNOPx(obase)->op_first;
11877 if (!o || o->op_type != OP_NULL ||
11878 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11880 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11884 if (PL_op == obase)
11885 /* $a[uninit_expr] or $h{uninit_expr} */
11886 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11889 o = cBINOPx(obase)->op_first;
11890 kid = cBINOPx(obase)->op_last;
11892 /* get the av or hv, and optionally the gv */
11894 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11895 sv = PAD_SV(o->op_targ);
11897 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11898 && cUNOPo->op_first->op_type == OP_GV)
11900 gv = cGVOPx_gv(cUNOPo->op_first);
11903 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11908 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11909 /* index is constant */
11913 if (obase->op_type == OP_HELEM) {
11914 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11915 if (!he || HeVAL(he) != uninit_sv)
11919 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11920 if (!svp || *svp != uninit_sv)
11924 if (obase->op_type == OP_HELEM)
11925 return varname(gv, '%', o->op_targ,
11926 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11928 return varname(gv, '@', o->op_targ, NULL,
11929 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11932 /* index is an expression;
11933 * attempt to find a match within the aggregate */
11934 if (obase->op_type == OP_HELEM) {
11935 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11937 return varname(gv, '%', o->op_targ,
11938 keysv, 0, FUV_SUBSCRIPT_HASH);
11941 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11943 return varname(gv, '@', o->op_targ,
11944 NULL, index, FUV_SUBSCRIPT_ARRAY);
11949 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11951 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11956 /* only examine RHS */
11957 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11960 o = cUNOPx(obase)->op_first;
11961 if (o->op_type == OP_PUSHMARK)
11964 if (!o->op_sibling) {
11965 /* one-arg version of open is highly magical */
11967 if (o->op_type == OP_GV) { /* open FOO; */
11969 if (match && GvSV(gv) != uninit_sv)
11971 return varname(gv, '$', 0,
11972 NULL, 0, FUV_SUBSCRIPT_NONE);
11974 /* other possibilities not handled are:
11975 * open $x; or open my $x; should return '${*$x}'
11976 * open expr; should return '$'.expr ideally
11982 /* ops where $_ may be an implicit arg */
11986 if ( !(obase->op_flags & OPf_STACKED)) {
11987 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11988 ? PAD_SVl(obase->op_targ)
11991 sv = sv_newmortal();
11992 sv_setpvn(sv, "$_", 2);
12000 /* skip filehandle as it can't produce 'undef' warning */
12001 o = cUNOPx(obase)->op_first;
12002 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12003 o = o->op_sibling->op_sibling;
12010 match = 1; /* XS or custom code could trigger random warnings */
12015 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12016 return sv_2mortal(newSVpvs("${$/}"));
12021 if (!(obase->op_flags & OPf_KIDS))
12023 o = cUNOPx(obase)->op_first;
12029 /* if all except one arg are constant, or have no side-effects,
12030 * or are optimized away, then it's unambiguous */
12032 for (kid=o; kid; kid = kid->op_sibling) {
12034 const OPCODE type = kid->op_type;
12035 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12036 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12037 || (type == OP_PUSHMARK)
12041 if (o2) { /* more than one found */
12048 return find_uninit_var(o2, uninit_sv, match);
12050 /* scan all args */
12052 sv = find_uninit_var(o, uninit_sv, 1);
12064 =for apidoc report_uninit
12066 Print appropriate "Use of uninitialized variable" warning
12072 Perl_report_uninit(pTHX_ SV* uninit_sv)
12076 SV* varname = NULL;
12078 varname = find_uninit_var(PL_op, uninit_sv,0);
12080 sv_insert(varname, 0, 0, " ", 1);
12082 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12083 varname ? SvPV_nolen_const(varname) : "",
12084 " in ", OP_DESC(PL_op));
12087 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12093 * c-indentation-style: bsd
12094 * c-basic-offset: 4
12095 * indent-tabs-mode: t
12098 * ex: set ts=8 sts=4 sw=4 noet: