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, (void*)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",
1072 (void*)start, (void*)end,
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);
3175 if (dtype >= SVt_PV) {
3181 SvUPGRADE(dstr, SVt_PVGV);
3182 (void)SvOK_off(dstr);
3183 /* FIXME - why are we doing this, then turning it off and on again
3185 isGV_with_GP_on(dstr);
3187 GvSTASH(dstr) = GvSTASH(sstr);
3189 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3190 gv_name_set((GV *)dstr, name, len, GV_ADD);
3191 SvFAKE_on(dstr); /* can coerce to non-glob */
3194 #ifdef GV_UNIQUE_CHECK
3195 if (GvUNIQUE((GV*)dstr)) {
3196 Perl_croak(aTHX_ PL_no_modify);
3201 isGV_with_GP_off(dstr);
3202 (void)SvOK_off(dstr);
3203 isGV_with_GP_on(dstr);
3204 GvINTRO_off(dstr); /* one-shot flag */
3205 GvGP(dstr) = gp_ref(GvGP(sstr));
3206 if (SvTAINTED(sstr))
3208 if (GvIMPORTED(dstr) != GVf_IMPORTED
3209 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3211 GvIMPORTED_on(dstr);
3218 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3219 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3221 const int intro = GvINTRO(dstr);
3224 const U32 stype = SvTYPE(sref);
3227 #ifdef GV_UNIQUE_CHECK
3228 if (GvUNIQUE((GV*)dstr)) {
3229 Perl_croak(aTHX_ PL_no_modify);
3234 GvINTRO_off(dstr); /* one-shot flag */
3235 GvLINE(dstr) = CopLINE(PL_curcop);
3236 GvEGV(dstr) = (GV*)dstr;
3241 location = (SV **) &GvCV(dstr);
3242 import_flag = GVf_IMPORTED_CV;
3245 location = (SV **) &GvHV(dstr);
3246 import_flag = GVf_IMPORTED_HV;
3249 location = (SV **) &GvAV(dstr);
3250 import_flag = GVf_IMPORTED_AV;
3253 location = (SV **) &GvIOp(dstr);
3256 location = (SV **) &GvFORM(dstr);
3258 location = &GvSV(dstr);
3259 import_flag = GVf_IMPORTED_SV;
3262 if (stype == SVt_PVCV) {
3263 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3264 SvREFCNT_dec(GvCV(dstr));
3266 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3267 PL_sub_generation++;
3270 SAVEGENERICSV(*location);
3274 if (stype == SVt_PVCV && *location != sref) {
3275 CV* const cv = (CV*)*location;
3277 if (!GvCVGEN((GV*)dstr) &&
3278 (CvROOT(cv) || CvXSUB(cv)))
3280 /* Redefining a sub - warning is mandatory if
3281 it was a const and its value changed. */
3282 if (CvCONST(cv) && CvCONST((CV*)sref)
3283 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3285 /* They are 2 constant subroutines generated from
3286 the same constant. This probably means that
3287 they are really the "same" proxy subroutine
3288 instantiated in 2 places. Most likely this is
3289 when a constant is exported twice. Don't warn.
3292 else if (ckWARN(WARN_REDEFINE)
3294 && (!CvCONST((CV*)sref)
3295 || sv_cmp(cv_const_sv(cv),
3296 cv_const_sv((CV*)sref))))) {
3297 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3300 ? "Constant subroutine %s::%s redefined"
3301 : "Subroutine %s::%s redefined"),
3302 HvNAME_get(GvSTASH((GV*)dstr)),
3303 GvENAME((GV*)dstr));
3307 cv_ckproto_len(cv, (GV*)dstr,
3308 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3309 SvPOK(sref) ? SvCUR(sref) : 0);
3311 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3312 GvASSUMECV_on(dstr);
3313 PL_sub_generation++;
3316 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3317 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3318 GvFLAGS(dstr) |= import_flag;
3323 if (SvTAINTED(sstr))
3329 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3332 register U32 sflags;
3334 register svtype stype;
3339 if (SvIS_FREED(dstr)) {
3340 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3341 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3343 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3345 sstr = &PL_sv_undef;
3346 if (SvIS_FREED(sstr)) {
3347 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3348 (void*)sstr, (void*)dstr);
3350 stype = SvTYPE(sstr);
3351 dtype = SvTYPE(dstr);
3356 /* need to nuke the magic */
3358 SvRMAGICAL_off(dstr);
3361 /* There's a lot of redundancy below but we're going for speed here */
3366 if (dtype != SVt_PVGV) {
3367 (void)SvOK_off(dstr);
3375 sv_upgrade(dstr, SVt_IV);
3380 sv_upgrade(dstr, SVt_PVIV);
3383 goto end_of_first_switch;
3385 (void)SvIOK_only(dstr);
3386 SvIV_set(dstr, SvIVX(sstr));
3389 /* SvTAINTED can only be true if the SV has taint magic, which in
3390 turn means that the SV type is PVMG (or greater). This is the
3391 case statement for SVt_IV, so this cannot be true (whatever gcov
3393 assert(!SvTAINTED(sstr));
3403 sv_upgrade(dstr, SVt_NV);
3408 sv_upgrade(dstr, SVt_PVNV);
3411 goto end_of_first_switch;
3413 SvNV_set(dstr, SvNVX(sstr));
3414 (void)SvNOK_only(dstr);
3415 /* SvTAINTED can only be true if the SV has taint magic, which in
3416 turn means that the SV type is PVMG (or greater). This is the
3417 case statement for SVt_NV, so this cannot be true (whatever gcov
3419 assert(!SvTAINTED(sstr));
3426 sv_upgrade(dstr, SVt_RV);
3429 #ifdef PERL_OLD_COPY_ON_WRITE
3430 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3431 if (dtype < SVt_PVIV)
3432 sv_upgrade(dstr, SVt_PVIV);
3439 sv_upgrade(dstr, SVt_PV);
3442 if (dtype < SVt_PVIV)
3443 sv_upgrade(dstr, SVt_PVIV);
3446 if (dtype < SVt_PVNV)
3447 sv_upgrade(dstr, SVt_PVNV);
3451 const char * const type = sv_reftype(sstr,0);
3453 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3455 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3459 /* case SVt_BIND: */
3461 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3462 glob_assign_glob(dstr, sstr, dtype);
3465 /* SvVALID means that this PVGV is playing at being an FBM. */
3470 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3472 if (SvTYPE(sstr) != stype) {
3473 stype = SvTYPE(sstr);
3474 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3475 glob_assign_glob(dstr, sstr, dtype);
3480 if (stype == SVt_PVLV)
3481 SvUPGRADE(dstr, SVt_PVNV);
3483 SvUPGRADE(dstr, (svtype)stype);
3485 end_of_first_switch:
3487 /* dstr may have been upgraded. */
3488 dtype = SvTYPE(dstr);
3489 sflags = SvFLAGS(sstr);
3491 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3492 /* Assigning to a subroutine sets the prototype. */
3495 const char *const ptr = SvPV_const(sstr, len);
3497 SvGROW(dstr, len + 1);
3498 Copy(ptr, SvPVX(dstr), len + 1, char);
3499 SvCUR_set(dstr, len);
3501 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3505 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3506 const char * const type = sv_reftype(dstr,0);
3508 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3510 Perl_croak(aTHX_ "Cannot copy to %s", type);
3511 } else if (sflags & SVf_ROK) {
3512 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3513 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3516 if (GvIMPORTED(dstr) != GVf_IMPORTED
3517 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3519 GvIMPORTED_on(dstr);
3524 glob_assign_glob(dstr, sstr, dtype);
3528 if (dtype >= SVt_PV) {
3529 if (dtype == SVt_PVGV) {
3530 glob_assign_ref(dstr, sstr);
3533 if (SvPVX_const(dstr)) {
3539 (void)SvOK_off(dstr);
3540 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3541 SvFLAGS(dstr) |= sflags & SVf_ROK;
3542 assert(!(sflags & SVp_NOK));
3543 assert(!(sflags & SVp_IOK));
3544 assert(!(sflags & SVf_NOK));
3545 assert(!(sflags & SVf_IOK));
3547 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3548 if (!(sflags & SVf_OK)) {
3549 if (ckWARN(WARN_MISC))
3550 Perl_warner(aTHX_ packWARN(WARN_MISC),
3551 "Undefined value assigned to typeglob");
3554 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3555 if (dstr != (SV*)gv) {
3558 GvGP(dstr) = gp_ref(GvGP(gv));
3562 else if (sflags & SVp_POK) {
3566 * Check to see if we can just swipe the string. If so, it's a
3567 * possible small lose on short strings, but a big win on long ones.
3568 * It might even be a win on short strings if SvPVX_const(dstr)
3569 * has to be allocated and SvPVX_const(sstr) has to be freed.
3570 * Likewise if we can set up COW rather than doing an actual copy, we
3571 * drop to the else clause, as the swipe code and the COW setup code
3572 * have much in common.
3575 /* Whichever path we take through the next code, we want this true,
3576 and doing it now facilitates the COW check. */
3577 (void)SvPOK_only(dstr);
3580 /* If we're already COW then this clause is not true, and if COW
3581 is allowed then we drop down to the else and make dest COW
3582 with us. If caller hasn't said that we're allowed to COW
3583 shared hash keys then we don't do the COW setup, even if the
3584 source scalar is a shared hash key scalar. */
3585 (((flags & SV_COW_SHARED_HASH_KEYS)
3586 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3587 : 1 /* If making a COW copy is forbidden then the behaviour we
3588 desire is as if the source SV isn't actually already
3589 COW, even if it is. So we act as if the source flags
3590 are not COW, rather than actually testing them. */
3592 #ifndef PERL_OLD_COPY_ON_WRITE
3593 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3594 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3595 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3596 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3597 but in turn, it's somewhat dead code, never expected to go
3598 live, but more kept as a placeholder on how to do it better
3599 in a newer implementation. */
3600 /* If we are COW and dstr is a suitable target then we drop down
3601 into the else and make dest a COW of us. */
3602 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3607 (sflags & SVs_TEMP) && /* slated for free anyway? */
3608 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3609 (!(flags & SV_NOSTEAL)) &&
3610 /* and we're allowed to steal temps */
3611 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3612 SvLEN(sstr) && /* and really is a string */
3613 /* and won't be needed again, potentially */
3614 !(PL_op && PL_op->op_type == OP_AASSIGN))
3615 #ifdef PERL_OLD_COPY_ON_WRITE
3616 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3617 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3618 && SvTYPE(sstr) >= SVt_PVIV)
3621 /* Failed the swipe test, and it's not a shared hash key either.
3622 Have to copy the string. */
3623 STRLEN len = SvCUR(sstr);
3624 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3625 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3626 SvCUR_set(dstr, len);
3627 *SvEND(dstr) = '\0';
3629 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3631 /* Either it's a shared hash key, or it's suitable for
3632 copy-on-write or we can swipe the string. */
3634 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3638 #ifdef PERL_OLD_COPY_ON_WRITE
3640 /* I believe I should acquire a global SV mutex if
3641 it's a COW sv (not a shared hash key) to stop
3642 it going un copy-on-write.
3643 If the source SV has gone un copy on write between up there
3644 and down here, then (assert() that) it is of the correct
3645 form to make it copy on write again */
3646 if ((sflags & (SVf_FAKE | SVf_READONLY))
3647 != (SVf_FAKE | SVf_READONLY)) {
3648 SvREADONLY_on(sstr);
3650 /* Make the source SV into a loop of 1.
3651 (about to become 2) */
3652 SV_COW_NEXT_SV_SET(sstr, sstr);
3656 /* Initial code is common. */
3657 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3662 /* making another shared SV. */
3663 STRLEN cur = SvCUR(sstr);
3664 STRLEN len = SvLEN(sstr);
3665 #ifdef PERL_OLD_COPY_ON_WRITE
3667 assert (SvTYPE(dstr) >= SVt_PVIV);
3668 /* SvIsCOW_normal */
3669 /* splice us in between source and next-after-source. */
3670 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3671 SV_COW_NEXT_SV_SET(sstr, dstr);
3672 SvPV_set(dstr, SvPVX_mutable(sstr));
3676 /* SvIsCOW_shared_hash */
3677 DEBUG_C(PerlIO_printf(Perl_debug_log,
3678 "Copy on write: Sharing hash\n"));
3680 assert (SvTYPE(dstr) >= SVt_PV);
3682 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3684 SvLEN_set(dstr, len);
3685 SvCUR_set(dstr, cur);
3686 SvREADONLY_on(dstr);
3688 /* Relesase a global SV mutex. */
3691 { /* Passes the swipe test. */
3692 SvPV_set(dstr, SvPVX_mutable(sstr));
3693 SvLEN_set(dstr, SvLEN(sstr));
3694 SvCUR_set(dstr, SvCUR(sstr));
3697 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3698 SvPV_set(sstr, NULL);
3704 if (sflags & SVp_NOK) {
3705 SvNV_set(dstr, SvNVX(sstr));
3707 if (sflags & SVp_IOK) {
3708 SvRELEASE_IVX(dstr);
3709 SvIV_set(dstr, SvIVX(sstr));
3710 /* Must do this otherwise some other overloaded use of 0x80000000
3711 gets confused. I guess SVpbm_VALID */
3712 if (sflags & SVf_IVisUV)
3715 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3717 const MAGIC * const smg = SvVSTRING_mg(sstr);
3719 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3720 smg->mg_ptr, smg->mg_len);
3721 SvRMAGICAL_on(dstr);
3725 else if (sflags & (SVp_IOK|SVp_NOK)) {
3726 (void)SvOK_off(dstr);
3727 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3728 if (sflags & SVp_IOK) {
3729 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3730 SvIV_set(dstr, SvIVX(sstr));
3732 if (sflags & SVp_NOK) {
3733 SvNV_set(dstr, SvNVX(sstr));
3737 if (isGV_with_GP(sstr)) {
3738 /* This stringification rule for globs is spread in 3 places.
3739 This feels bad. FIXME. */
3740 const U32 wasfake = sflags & SVf_FAKE;
3742 /* FAKE globs can get coerced, so need to turn this off
3743 temporarily if it is on. */
3745 gv_efullname3(dstr, (GV *)sstr, "*");
3746 SvFLAGS(sstr) |= wasfake;
3749 (void)SvOK_off(dstr);
3751 if (SvTAINTED(sstr))
3756 =for apidoc sv_setsv_mg
3758 Like C<sv_setsv>, but also handles 'set' magic.
3764 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3766 sv_setsv(dstr,sstr);
3770 #ifdef PERL_OLD_COPY_ON_WRITE
3772 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3774 STRLEN cur = SvCUR(sstr);
3775 STRLEN len = SvLEN(sstr);
3776 register char *new_pv;
3779 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3780 (void*)sstr, (void*)dstr);
3787 if (SvTHINKFIRST(dstr))
3788 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3789 else if (SvPVX_const(dstr))
3790 Safefree(SvPVX_const(dstr));
3794 SvUPGRADE(dstr, SVt_PVIV);
3796 assert (SvPOK(sstr));
3797 assert (SvPOKp(sstr));
3798 assert (!SvIOK(sstr));
3799 assert (!SvIOKp(sstr));
3800 assert (!SvNOK(sstr));
3801 assert (!SvNOKp(sstr));
3803 if (SvIsCOW(sstr)) {
3805 if (SvLEN(sstr) == 0) {
3806 /* source is a COW shared hash key. */
3807 DEBUG_C(PerlIO_printf(Perl_debug_log,
3808 "Fast copy on write: Sharing hash\n"));
3809 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3812 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3814 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3815 SvUPGRADE(sstr, SVt_PVIV);
3816 SvREADONLY_on(sstr);
3818 DEBUG_C(PerlIO_printf(Perl_debug_log,
3819 "Fast copy on write: Converting sstr to COW\n"));
3820 SV_COW_NEXT_SV_SET(dstr, sstr);
3822 SV_COW_NEXT_SV_SET(sstr, dstr);
3823 new_pv = SvPVX_mutable(sstr);
3826 SvPV_set(dstr, new_pv);
3827 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3830 SvLEN_set(dstr, len);
3831 SvCUR_set(dstr, cur);
3840 =for apidoc sv_setpvn
3842 Copies a string into an SV. The C<len> parameter indicates the number of
3843 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3844 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3850 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3853 register char *dptr;
3855 SV_CHECK_THINKFIRST_COW_DROP(sv);
3861 /* len is STRLEN which is unsigned, need to copy to signed */
3864 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3866 SvUPGRADE(sv, SVt_PV);
3868 dptr = SvGROW(sv, len + 1);
3869 Move(ptr,dptr,len,char);
3872 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3877 =for apidoc sv_setpvn_mg
3879 Like C<sv_setpvn>, but also handles 'set' magic.
3885 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3887 sv_setpvn(sv,ptr,len);
3892 =for apidoc sv_setpv
3894 Copies a string into an SV. The string must be null-terminated. Does not
3895 handle 'set' magic. See C<sv_setpv_mg>.
3901 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3904 register STRLEN len;
3906 SV_CHECK_THINKFIRST_COW_DROP(sv);
3912 SvUPGRADE(sv, SVt_PV);
3914 SvGROW(sv, len + 1);
3915 Move(ptr,SvPVX(sv),len+1,char);
3917 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3922 =for apidoc sv_setpv_mg
3924 Like C<sv_setpv>, but also handles 'set' magic.
3930 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3937 =for apidoc sv_usepvn_flags
3939 Tells an SV to use C<ptr> to find its string value. Normally the
3940 string is stored inside the SV but sv_usepvn allows the SV to use an
3941 outside string. The C<ptr> should point to memory that was allocated
3942 by C<malloc>. The string length, C<len>, must be supplied. By default
3943 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3944 so that pointer should not be freed or used by the programmer after
3945 giving it to sv_usepvn, and neither should any pointers from "behind"
3946 that pointer (e.g. ptr + 1) be used.
3948 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3949 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3950 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3951 C<len>, and already meets the requirements for storing in C<SvPVX>)
3957 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3961 SV_CHECK_THINKFIRST_COW_DROP(sv);
3962 SvUPGRADE(sv, SVt_PV);
3965 if (flags & SV_SMAGIC)
3969 if (SvPVX_const(sv))
3973 if (flags & SV_HAS_TRAILING_NUL)
3974 assert(ptr[len] == '\0');
3977 allocate = (flags & SV_HAS_TRAILING_NUL)
3978 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3979 if (flags & SV_HAS_TRAILING_NUL) {
3980 /* It's long enough - do nothing.
3981 Specfically Perl_newCONSTSUB is relying on this. */
3984 /* Force a move to shake out bugs in callers. */
3985 char *new_ptr = (char*)safemalloc(allocate);
3986 Copy(ptr, new_ptr, len, char);
3987 PoisonFree(ptr,len,char);
3991 ptr = (char*) saferealloc (ptr, allocate);
3996 SvLEN_set(sv, allocate);
3997 if (!(flags & SV_HAS_TRAILING_NUL)) {
4000 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4002 if (flags & SV_SMAGIC)
4006 #ifdef PERL_OLD_COPY_ON_WRITE
4007 /* Need to do this *after* making the SV normal, as we need the buffer
4008 pointer to remain valid until after we've copied it. If we let go too early,
4009 another thread could invalidate it by unsharing last of the same hash key
4010 (which it can do by means other than releasing copy-on-write Svs)
4011 or by changing the other copy-on-write SVs in the loop. */
4013 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4015 { /* this SV was SvIsCOW_normal(sv) */
4016 /* we need to find the SV pointing to us. */
4017 SV *current = SV_COW_NEXT_SV(after);
4019 if (current == sv) {
4020 /* The SV we point to points back to us (there were only two of us
4022 Hence other SV is no longer copy on write either. */
4024 SvREADONLY_off(after);
4026 /* We need to follow the pointers around the loop. */
4028 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4031 /* don't loop forever if the structure is bust, and we have
4032 a pointer into a closed loop. */
4033 assert (current != after);
4034 assert (SvPVX_const(current) == pvx);
4036 /* Make the SV before us point to the SV after us. */
4037 SV_COW_NEXT_SV_SET(current, after);
4043 =for apidoc sv_force_normal_flags
4045 Undo various types of fakery on an SV: if the PV is a shared string, make
4046 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4047 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4048 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4049 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4050 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4051 set to some other value.) In addition, the C<flags> parameter gets passed to
4052 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4053 with flags set to 0.
4059 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4062 #ifdef PERL_OLD_COPY_ON_WRITE
4063 if (SvREADONLY(sv)) {
4064 /* At this point I believe I should acquire a global SV mutex. */
4066 const char * const pvx = SvPVX_const(sv);
4067 const STRLEN len = SvLEN(sv);
4068 const STRLEN cur = SvCUR(sv);
4069 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4070 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4071 we'll fail an assertion. */
4072 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4075 PerlIO_printf(Perl_debug_log,
4076 "Copy on write: Force normal %ld\n",
4082 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4085 if (flags & SV_COW_DROP_PV) {
4086 /* OK, so we don't need to copy our buffer. */
4089 SvGROW(sv, cur + 1);
4090 Move(pvx,SvPVX(sv),cur,char);
4095 sv_release_COW(sv, pvx, next);
4097 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4103 else if (IN_PERL_RUNTIME)
4104 Perl_croak(aTHX_ PL_no_modify);
4105 /* At this point I believe that I can drop the global SV mutex. */
4108 if (SvREADONLY(sv)) {
4110 const char * const pvx = SvPVX_const(sv);
4111 const STRLEN len = SvCUR(sv);
4116 SvGROW(sv, len + 1);
4117 Move(pvx,SvPVX(sv),len,char);
4119 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4121 else if (IN_PERL_RUNTIME)
4122 Perl_croak(aTHX_ PL_no_modify);
4126 sv_unref_flags(sv, flags);
4127 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4134 Efficient removal of characters from the beginning of the string buffer.
4135 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4136 the string buffer. The C<ptr> becomes the first character of the adjusted
4137 string. Uses the "OOK hack".
4138 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4139 refer to the same chunk of data.
4145 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4147 register STRLEN delta;
4148 if (!ptr || !SvPOKp(sv))
4150 delta = ptr - SvPVX_const(sv);
4151 SV_CHECK_THINKFIRST(sv);
4152 if (SvTYPE(sv) < SVt_PVIV)
4153 sv_upgrade(sv,SVt_PVIV);
4156 if (!SvLEN(sv)) { /* make copy of shared string */
4157 const char *pvx = SvPVX_const(sv);
4158 const STRLEN len = SvCUR(sv);
4159 SvGROW(sv, len + 1);
4160 Move(pvx,SvPVX(sv),len,char);
4164 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4165 and we do that anyway inside the SvNIOK_off
4167 SvFLAGS(sv) |= SVf_OOK;
4170 SvLEN_set(sv, SvLEN(sv) - delta);
4171 SvCUR_set(sv, SvCUR(sv) - delta);
4172 SvPV_set(sv, SvPVX(sv) + delta);
4173 SvIV_set(sv, SvIVX(sv) + delta);
4177 =for apidoc sv_catpvn
4179 Concatenates the string onto the end of the string which is in the SV. The
4180 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4181 status set, then the bytes appended should be valid UTF-8.
4182 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4184 =for apidoc sv_catpvn_flags
4186 Concatenates the string onto the end of the string which is in the SV. The
4187 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4188 status set, then the bytes appended should be valid UTF-8.
4189 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4190 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4191 in terms of this function.
4197 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4201 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4203 SvGROW(dsv, dlen + slen + 1);
4205 sstr = SvPVX_const(dsv);
4206 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4207 SvCUR_set(dsv, SvCUR(dsv) + slen);
4209 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4211 if (flags & SV_SMAGIC)
4216 =for apidoc sv_catsv
4218 Concatenates the string from SV C<ssv> onto the end of the string in
4219 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4220 not 'set' magic. See C<sv_catsv_mg>.
4222 =for apidoc sv_catsv_flags
4224 Concatenates the string from SV C<ssv> onto the end of the string in
4225 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4226 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4227 and C<sv_catsv_nomg> are implemented in terms of this function.
4232 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4237 const char *spv = SvPV_const(ssv, slen);
4239 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4240 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4241 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4242 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4243 dsv->sv_flags doesn't have that bit set.
4244 Andy Dougherty 12 Oct 2001
4246 const I32 sutf8 = DO_UTF8(ssv);
4249 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4251 dutf8 = DO_UTF8(dsv);
4253 if (dutf8 != sutf8) {
4255 /* Not modifying source SV, so taking a temporary copy. */
4256 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4258 sv_utf8_upgrade(csv);
4259 spv = SvPV_const(csv, slen);
4262 sv_utf8_upgrade_nomg(dsv);
4264 sv_catpvn_nomg(dsv, spv, slen);
4267 if (flags & SV_SMAGIC)
4272 =for apidoc sv_catpv
4274 Concatenates the string onto the end of the string which is in the SV.
4275 If the SV has the UTF-8 status set, then the bytes appended should be
4276 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4281 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4284 register STRLEN len;
4290 junk = SvPV_force(sv, tlen);
4292 SvGROW(sv, tlen + len + 1);
4294 ptr = SvPVX_const(sv);
4295 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4296 SvCUR_set(sv, SvCUR(sv) + len);
4297 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4302 =for apidoc sv_catpv_mg
4304 Like C<sv_catpv>, but also handles 'set' magic.
4310 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4319 Creates a new SV. A non-zero C<len> parameter indicates the number of
4320 bytes of preallocated string space the SV should have. An extra byte for a
4321 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4322 space is allocated.) The reference count for the new SV is set to 1.
4324 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4325 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4326 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4327 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4328 modules supporting older perls.
4334 Perl_newSV(pTHX_ STRLEN len)
4341 sv_upgrade(sv, SVt_PV);
4342 SvGROW(sv, len + 1);
4347 =for apidoc sv_magicext
4349 Adds magic to an SV, upgrading it if necessary. Applies the
4350 supplied vtable and returns a pointer to the magic added.
4352 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4353 In particular, you can add magic to SvREADONLY SVs, and add more than
4354 one instance of the same 'how'.
4356 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4357 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4358 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4359 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4361 (This is now used as a subroutine by C<sv_magic>.)
4366 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4367 const char* name, I32 namlen)
4372 if (SvTYPE(sv) < SVt_PVMG) {
4373 SvUPGRADE(sv, SVt_PVMG);
4375 Newxz(mg, 1, MAGIC);
4376 mg->mg_moremagic = SvMAGIC(sv);
4377 SvMAGIC_set(sv, mg);
4379 /* Sometimes a magic contains a reference loop, where the sv and
4380 object refer to each other. To prevent a reference loop that
4381 would prevent such objects being freed, we look for such loops
4382 and if we find one we avoid incrementing the object refcount.
4384 Note we cannot do this to avoid self-tie loops as intervening RV must
4385 have its REFCNT incremented to keep it in existence.
4388 if (!obj || obj == sv ||
4389 how == PERL_MAGIC_arylen ||
4390 how == PERL_MAGIC_qr ||
4391 how == PERL_MAGIC_symtab ||
4392 (SvTYPE(obj) == SVt_PVGV &&
4393 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4394 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4395 GvFORM(obj) == (CV*)sv)))
4400 mg->mg_obj = SvREFCNT_inc_simple(obj);
4401 mg->mg_flags |= MGf_REFCOUNTED;
4404 /* Normal self-ties simply pass a null object, and instead of
4405 using mg_obj directly, use the SvTIED_obj macro to produce a
4406 new RV as needed. For glob "self-ties", we are tieing the PVIO
4407 with an RV obj pointing to the glob containing the PVIO. In
4408 this case, to avoid a reference loop, we need to weaken the
4412 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4413 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4419 mg->mg_len = namlen;
4422 mg->mg_ptr = savepvn(name, namlen);
4423 else if (namlen == HEf_SVKEY)
4424 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4426 mg->mg_ptr = (char *) name;
4428 mg->mg_virtual = (MGVTBL *) vtable;
4432 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4437 =for apidoc sv_magic
4439 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4440 then adds a new magic item of type C<how> to the head of the magic list.
4442 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4443 handling of the C<name> and C<namlen> arguments.
4445 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4446 to add more than one instance of the same 'how'.
4452 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4455 const MGVTBL *vtable;
4458 #ifdef PERL_OLD_COPY_ON_WRITE
4460 sv_force_normal_flags(sv, 0);
4462 if (SvREADONLY(sv)) {
4464 /* its okay to attach magic to shared strings; the subsequent
4465 * upgrade to PVMG will unshare the string */
4466 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4469 && how != PERL_MAGIC_regex_global
4470 && how != PERL_MAGIC_bm
4471 && how != PERL_MAGIC_fm
4472 && how != PERL_MAGIC_sv
4473 && how != PERL_MAGIC_backref
4476 Perl_croak(aTHX_ PL_no_modify);
4479 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4480 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4481 /* sv_magic() refuses to add a magic of the same 'how' as an
4484 if (how == PERL_MAGIC_taint) {
4486 /* Any scalar which already had taint magic on which someone
4487 (erroneously?) did SvIOK_on() or similar will now be
4488 incorrectly sporting public "OK" flags. */
4489 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4497 vtable = &PL_vtbl_sv;
4499 case PERL_MAGIC_overload:
4500 vtable = &PL_vtbl_amagic;
4502 case PERL_MAGIC_overload_elem:
4503 vtable = &PL_vtbl_amagicelem;
4505 case PERL_MAGIC_overload_table:
4506 vtable = &PL_vtbl_ovrld;
4509 vtable = &PL_vtbl_bm;
4511 case PERL_MAGIC_regdata:
4512 vtable = &PL_vtbl_regdata;
4514 case PERL_MAGIC_regdatum:
4515 vtable = &PL_vtbl_regdatum;
4517 case PERL_MAGIC_env:
4518 vtable = &PL_vtbl_env;
4521 vtable = &PL_vtbl_fm;
4523 case PERL_MAGIC_envelem:
4524 vtable = &PL_vtbl_envelem;
4526 case PERL_MAGIC_regex_global:
4527 vtable = &PL_vtbl_mglob;
4529 case PERL_MAGIC_isa:
4530 vtable = &PL_vtbl_isa;
4532 case PERL_MAGIC_isaelem:
4533 vtable = &PL_vtbl_isaelem;
4535 case PERL_MAGIC_nkeys:
4536 vtable = &PL_vtbl_nkeys;
4538 case PERL_MAGIC_dbfile:
4541 case PERL_MAGIC_dbline:
4542 vtable = &PL_vtbl_dbline;
4544 #ifdef USE_LOCALE_COLLATE
4545 case PERL_MAGIC_collxfrm:
4546 vtable = &PL_vtbl_collxfrm;
4548 #endif /* USE_LOCALE_COLLATE */
4549 case PERL_MAGIC_tied:
4550 vtable = &PL_vtbl_pack;
4552 case PERL_MAGIC_tiedelem:
4553 case PERL_MAGIC_tiedscalar:
4554 vtable = &PL_vtbl_packelem;
4557 vtable = &PL_vtbl_regexp;
4559 case PERL_MAGIC_hints:
4560 /* As this vtable is all NULL, we can reuse it. */
4561 case PERL_MAGIC_sig:
4562 vtable = &PL_vtbl_sig;
4564 case PERL_MAGIC_sigelem:
4565 vtable = &PL_vtbl_sigelem;
4567 case PERL_MAGIC_taint:
4568 vtable = &PL_vtbl_taint;
4570 case PERL_MAGIC_uvar:
4571 vtable = &PL_vtbl_uvar;
4573 case PERL_MAGIC_vec:
4574 vtable = &PL_vtbl_vec;
4576 case PERL_MAGIC_arylen_p:
4577 case PERL_MAGIC_rhash:
4578 case PERL_MAGIC_symtab:
4579 case PERL_MAGIC_vstring:
4582 case PERL_MAGIC_utf8:
4583 vtable = &PL_vtbl_utf8;
4585 case PERL_MAGIC_substr:
4586 vtable = &PL_vtbl_substr;
4588 case PERL_MAGIC_defelem:
4589 vtable = &PL_vtbl_defelem;
4591 case PERL_MAGIC_arylen:
4592 vtable = &PL_vtbl_arylen;
4594 case PERL_MAGIC_pos:
4595 vtable = &PL_vtbl_pos;
4597 case PERL_MAGIC_backref:
4598 vtable = &PL_vtbl_backref;
4600 case PERL_MAGIC_hintselem:
4601 vtable = &PL_vtbl_hintselem;
4603 case PERL_MAGIC_ext:
4604 /* Reserved for use by extensions not perl internals. */
4605 /* Useful for attaching extension internal data to perl vars. */
4606 /* Note that multiple extensions may clash if magical scalars */
4607 /* etc holding private data from one are passed to another. */
4611 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4614 /* Rest of work is done else where */
4615 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4618 case PERL_MAGIC_taint:
4621 case PERL_MAGIC_ext:
4622 case PERL_MAGIC_dbfile:
4629 =for apidoc sv_unmagic
4631 Removes all magic of type C<type> from an SV.
4637 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4641 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4643 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4644 for (mg = *mgp; mg; mg = *mgp) {
4645 if (mg->mg_type == type) {
4646 const MGVTBL* const vtbl = mg->mg_virtual;
4647 *mgp = mg->mg_moremagic;
4648 if (vtbl && vtbl->svt_free)
4649 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4650 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4652 Safefree(mg->mg_ptr);
4653 else if (mg->mg_len == HEf_SVKEY)
4654 SvREFCNT_dec((SV*)mg->mg_ptr);
4655 else if (mg->mg_type == PERL_MAGIC_utf8)
4656 Safefree(mg->mg_ptr);
4658 if (mg->mg_flags & MGf_REFCOUNTED)
4659 SvREFCNT_dec(mg->mg_obj);
4663 mgp = &mg->mg_moremagic;
4667 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4668 SvMAGIC_set(sv, NULL);
4675 =for apidoc sv_rvweaken
4677 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4678 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4679 push a back-reference to this RV onto the array of backreferences
4680 associated with that magic. If the RV is magical, set magic will be
4681 called after the RV is cleared.
4687 Perl_sv_rvweaken(pTHX_ SV *sv)
4690 if (!SvOK(sv)) /* let undefs pass */
4693 Perl_croak(aTHX_ "Can't weaken a nonreference");
4694 else if (SvWEAKREF(sv)) {
4695 if (ckWARN(WARN_MISC))
4696 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4700 Perl_sv_add_backref(aTHX_ tsv, sv);
4706 /* Give tsv backref magic if it hasn't already got it, then push a
4707 * back-reference to sv onto the array associated with the backref magic.
4711 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4716 if (SvTYPE(tsv) == SVt_PVHV) {
4717 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4721 /* There is no AV in the offical place - try a fixup. */
4722 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4725 /* Aha. They've got it stowed in magic. Bring it back. */
4726 av = (AV*)mg->mg_obj;
4727 /* Stop mg_free decreasing the refernce count. */
4729 /* Stop mg_free even calling the destructor, given that
4730 there's no AV to free up. */
4732 sv_unmagic(tsv, PERL_MAGIC_backref);
4736 SvREFCNT_inc_simple_void(av);
4741 const MAGIC *const mg
4742 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4744 av = (AV*)mg->mg_obj;
4748 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4749 /* av now has a refcnt of 2, which avoids it getting freed
4750 * before us during global cleanup. The extra ref is removed
4751 * by magic_killbackrefs() when tsv is being freed */
4754 if (AvFILLp(av) >= AvMAX(av)) {
4755 av_extend(av, AvFILLp(av)+1);
4757 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4760 /* delete a back-reference to ourselves from the backref magic associated
4761 * with the SV we point to.
4765 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4772 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4773 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4774 /* We mustn't attempt to "fix up" the hash here by moving the
4775 backreference array back to the hv_aux structure, as that is stored
4776 in the main HvARRAY(), and hfreentries assumes that no-one
4777 reallocates HvARRAY() while it is running. */
4780 const MAGIC *const mg
4781 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4783 av = (AV *)mg->mg_obj;
4786 if (PL_in_clean_all)
4788 Perl_croak(aTHX_ "panic: del_backref");
4795 /* We shouldn't be in here more than once, but for paranoia reasons lets
4797 for (i = AvFILLp(av); i >= 0; i--) {
4799 const SSize_t fill = AvFILLp(av);
4801 /* We weren't the last entry.
4802 An unordered list has this property that you can take the
4803 last element off the end to fill the hole, and it's still
4804 an unordered list :-)
4809 AvFILLp(av) = fill - 1;
4815 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4817 SV **svp = AvARRAY(av);
4819 PERL_UNUSED_ARG(sv);
4821 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4822 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4823 if (svp && !SvIS_FREED(av)) {
4824 SV *const *const last = svp + AvFILLp(av);
4826 while (svp <= last) {
4828 SV *const referrer = *svp;
4829 if (SvWEAKREF(referrer)) {
4830 /* XXX Should we check that it hasn't changed? */
4831 SvRV_set(referrer, 0);
4833 SvWEAKREF_off(referrer);
4834 SvSETMAGIC(referrer);
4835 } else if (SvTYPE(referrer) == SVt_PVGV ||
4836 SvTYPE(referrer) == SVt_PVLV) {
4837 /* You lookin' at me? */
4838 assert(GvSTASH(referrer));
4839 assert(GvSTASH(referrer) == (HV*)sv);
4840 GvSTASH(referrer) = 0;
4843 "panic: magic_killbackrefs (flags=%"UVxf")",
4844 (UV)SvFLAGS(referrer));
4852 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4857 =for apidoc sv_insert
4859 Inserts a string at the specified offset/length within the SV. Similar to
4860 the Perl substr() function.
4866 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4871 register char *midend;
4872 register char *bigend;
4878 Perl_croak(aTHX_ "Can't modify non-existent substring");
4879 SvPV_force(bigstr, curlen);
4880 (void)SvPOK_only_UTF8(bigstr);
4881 if (offset + len > curlen) {
4882 SvGROW(bigstr, offset+len+1);
4883 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4884 SvCUR_set(bigstr, offset+len);
4888 i = littlelen - len;
4889 if (i > 0) { /* string might grow */
4890 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4891 mid = big + offset + len;
4892 midend = bigend = big + SvCUR(bigstr);
4895 while (midend > mid) /* shove everything down */
4896 *--bigend = *--midend;
4897 Move(little,big+offset,littlelen,char);
4898 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4903 Move(little,SvPVX(bigstr)+offset,len,char);
4908 big = SvPVX(bigstr);
4911 bigend = big + SvCUR(bigstr);
4913 if (midend > bigend)
4914 Perl_croak(aTHX_ "panic: sv_insert");
4916 if (mid - big > bigend - midend) { /* faster to shorten from end */
4918 Move(little, mid, littlelen,char);
4921 i = bigend - midend;
4923 Move(midend, mid, i,char);
4927 SvCUR_set(bigstr, mid - big);
4929 else if ((i = mid - big)) { /* faster from front */
4930 midend -= littlelen;
4932 sv_chop(bigstr,midend-i);
4937 Move(little, mid, littlelen,char);
4939 else if (littlelen) {
4940 midend -= littlelen;
4941 sv_chop(bigstr,midend);
4942 Move(little,midend,littlelen,char);
4945 sv_chop(bigstr,midend);
4951 =for apidoc sv_replace
4953 Make the first argument a copy of the second, then delete the original.
4954 The target SV physically takes over ownership of the body of the source SV
4955 and inherits its flags; however, the target keeps any magic it owns,
4956 and any magic in the source is discarded.
4957 Note that this is a rather specialist SV copying operation; most of the
4958 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4964 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4967 const U32 refcnt = SvREFCNT(sv);
4968 SV_CHECK_THINKFIRST_COW_DROP(sv);
4969 if (SvREFCNT(nsv) != 1) {
4970 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4971 UVuf " != 1)", (UV) SvREFCNT(nsv));
4973 if (SvMAGICAL(sv)) {
4977 sv_upgrade(nsv, SVt_PVMG);
4978 SvMAGIC_set(nsv, SvMAGIC(sv));
4979 SvFLAGS(nsv) |= SvMAGICAL(sv);
4981 SvMAGIC_set(sv, NULL);
4985 assert(!SvREFCNT(sv));
4986 #ifdef DEBUG_LEAKING_SCALARS
4987 sv->sv_flags = nsv->sv_flags;
4988 sv->sv_any = nsv->sv_any;
4989 sv->sv_refcnt = nsv->sv_refcnt;
4990 sv->sv_u = nsv->sv_u;
4992 StructCopy(nsv,sv,SV);
4994 /* Currently could join these into one piece of pointer arithmetic, but
4995 it would be unclear. */
4996 if(SvTYPE(sv) == SVt_IV)
4998 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4999 else if (SvTYPE(sv) == SVt_RV) {
5000 SvANY(sv) = &sv->sv_u.svu_rv;
5004 #ifdef PERL_OLD_COPY_ON_WRITE
5005 if (SvIsCOW_normal(nsv)) {
5006 /* We need to follow the pointers around the loop to make the
5007 previous SV point to sv, rather than nsv. */
5010 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5013 assert(SvPVX_const(current) == SvPVX_const(nsv));
5015 /* Make the SV before us point to the SV after us. */
5017 PerlIO_printf(Perl_debug_log, "previous is\n");
5019 PerlIO_printf(Perl_debug_log,
5020 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5021 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5023 SV_COW_NEXT_SV_SET(current, sv);
5026 SvREFCNT(sv) = refcnt;
5027 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5033 =for apidoc sv_clear
5035 Clear an SV: call any destructors, free up any memory used by the body,
5036 and free the body itself. The SV's head is I<not> freed, although
5037 its type is set to all 1's so that it won't inadvertently be assumed
5038 to be live during global destruction etc.
5039 This function should only be called when REFCNT is zero. Most of the time
5040 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5047 Perl_sv_clear(pTHX_ register SV *sv)
5050 const U32 type = SvTYPE(sv);
5051 const struct body_details *const sv_type_details
5052 = bodies_by_type + type;
5055 assert(SvREFCNT(sv) == 0);
5057 if (type <= SVt_IV) {
5058 /* See the comment in sv.h about the collusion between this early
5059 return and the overloading of the NULL and IV slots in the size
5065 if (PL_defstash) { /* Still have a symbol table? */
5070 stash = SvSTASH(sv);
5071 destructor = StashHANDLER(stash,DESTROY);
5073 SV* const tmpref = newRV(sv);
5074 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5076 PUSHSTACKi(PERLSI_DESTROY);
5081 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5087 if(SvREFCNT(tmpref) < 2) {
5088 /* tmpref is not kept alive! */
5090 SvRV_set(tmpref, NULL);
5093 SvREFCNT_dec(tmpref);
5095 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5099 if (PL_in_clean_objs)
5100 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5102 /* DESTROY gave object new lease on life */
5108 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5109 SvOBJECT_off(sv); /* Curse the object. */
5110 if (type != SVt_PVIO)
5111 --PL_sv_objcount; /* XXX Might want something more general */
5114 if (type >= SVt_PVMG) {
5115 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5116 SvREFCNT_dec(SvOURSTASH(sv));
5117 } else if (SvMAGIC(sv))
5119 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5120 SvREFCNT_dec(SvSTASH(sv));
5123 /* case SVt_BIND: */
5126 IoIFP(sv) != PerlIO_stdin() &&
5127 IoIFP(sv) != PerlIO_stdout() &&
5128 IoIFP(sv) != PerlIO_stderr())
5130 io_close((IO*)sv, FALSE);
5132 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5133 PerlDir_close(IoDIRP(sv));
5134 IoDIRP(sv) = (DIR*)NULL;
5135 Safefree(IoTOP_NAME(sv));
5136 Safefree(IoFMT_NAME(sv));
5137 Safefree(IoBOTTOM_NAME(sv));
5144 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5151 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5152 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5153 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5154 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5156 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5157 SvREFCNT_dec(LvTARG(sv));
5160 if (isGV_with_GP(sv)) {
5163 unshare_hek(GvNAME_HEK(sv));
5164 /* If we're in a stash, we don't own a reference to it. However it does
5165 have a back reference to us, which needs to be cleared. */
5166 if (!SvVALID(sv) && GvSTASH(sv))
5167 sv_del_backref((SV*)GvSTASH(sv), sv);
5173 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5175 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5176 /* Don't even bother with turning off the OOK flag. */
5181 SV * const target = SvRV(sv);
5183 sv_del_backref(target, sv);
5185 SvREFCNT_dec(target);
5187 #ifdef PERL_OLD_COPY_ON_WRITE
5188 else if (SvPVX_const(sv)) {
5190 /* I believe I need to grab the global SV mutex here and
5191 then recheck the COW status. */
5193 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5197 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5199 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5202 /* And drop it here. */
5204 } else if (SvLEN(sv)) {
5205 Safefree(SvPVX_const(sv));
5209 else if (SvPVX_const(sv) && SvLEN(sv))
5210 Safefree(SvPVX_mutable(sv));
5211 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5212 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5221 SvFLAGS(sv) &= SVf_BREAK;
5222 SvFLAGS(sv) |= SVTYPEMASK;
5224 if (sv_type_details->arena) {
5225 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5226 &PL_body_roots[type]);
5228 else if (sv_type_details->body_size) {
5229 my_safefree(SvANY(sv));
5234 =for apidoc sv_newref
5236 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5243 Perl_sv_newref(pTHX_ SV *sv)
5245 PERL_UNUSED_CONTEXT;
5254 Decrement an SV's reference count, and if it drops to zero, call
5255 C<sv_clear> to invoke destructors and free up any memory used by
5256 the body; finally, deallocate the SV's head itself.
5257 Normally called via a wrapper macro C<SvREFCNT_dec>.
5263 Perl_sv_free(pTHX_ SV *sv)
5268 if (SvREFCNT(sv) == 0) {
5269 if (SvFLAGS(sv) & SVf_BREAK)
5270 /* this SV's refcnt has been artificially decremented to
5271 * trigger cleanup */
5273 if (PL_in_clean_all) /* All is fair */
5275 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5276 /* make sure SvREFCNT(sv)==0 happens very seldom */
5277 SvREFCNT(sv) = (~(U32)0)/2;
5280 if (ckWARN_d(WARN_INTERNAL)) {
5281 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5282 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5283 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5284 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5285 Perl_dump_sv_child(aTHX_ sv);
5290 if (--(SvREFCNT(sv)) > 0)
5292 Perl_sv_free2(aTHX_ sv);
5296 Perl_sv_free2(pTHX_ SV *sv)
5301 if (ckWARN_d(WARN_DEBUGGING))
5302 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5303 "Attempt to free temp prematurely: SV 0x%"UVxf
5304 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5308 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5309 /* make sure SvREFCNT(sv)==0 happens very seldom */
5310 SvREFCNT(sv) = (~(U32)0)/2;
5321 Returns the length of the string in the SV. Handles magic and type
5322 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5328 Perl_sv_len(pTHX_ register SV *sv)
5336 len = mg_length(sv);
5338 (void)SvPV_const(sv, len);
5343 =for apidoc sv_len_utf8
5345 Returns the number of characters in the string in an SV, counting wide
5346 UTF-8 bytes as a single character. Handles magic and type coercion.
5352 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5353 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5354 * (Note that the mg_len is not the length of the mg_ptr field.
5355 * This allows the cache to store the character length of the string without
5356 * needing to malloc() extra storage to attach to the mg_ptr.)
5361 Perl_sv_len_utf8(pTHX_ register SV *sv)
5367 return mg_length(sv);
5371 const U8 *s = (U8*)SvPV_const(sv, len);
5375 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5377 if (mg && mg->mg_len != -1) {
5379 if (PL_utf8cache < 0) {
5380 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5382 /* Need to turn the assertions off otherwise we may
5383 recurse infinitely while printing error messages.
5385 SAVEI8(PL_utf8cache);
5387 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5388 " real %"UVuf" for %"SVf,
5389 (UV) ulen, (UV) real, SVfARG(sv));
5394 ulen = Perl_utf8_length(aTHX_ s, s + len);
5395 if (!SvREADONLY(sv)) {
5397 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5398 &PL_vtbl_utf8, 0, 0);
5406 return Perl_utf8_length(aTHX_ s, s + len);
5410 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5413 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5416 const U8 *s = start;
5418 while (s < send && uoffset--)
5421 /* This is the existing behaviour. Possibly it should be a croak, as
5422 it's actually a bounds error */
5428 /* Given the length of the string in both bytes and UTF-8 characters, decide
5429 whether to walk forwards or backwards to find the byte corresponding to
5430 the passed in UTF-8 offset. */
5432 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5433 STRLEN uoffset, STRLEN uend)
5435 STRLEN backw = uend - uoffset;
5436 if (uoffset < 2 * backw) {
5437 /* The assumption is that going forwards is twice the speed of going
5438 forward (that's where the 2 * backw comes from).
5439 (The real figure of course depends on the UTF-8 data.) */
5440 return sv_pos_u2b_forwards(start, send, uoffset);
5445 while (UTF8_IS_CONTINUATION(*send))
5448 return send - start;
5451 /* For the string representation of the given scalar, find the byte
5452 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5453 give another position in the string, *before* the sought offset, which
5454 (which is always true, as 0, 0 is a valid pair of positions), which should
5455 help reduce the amount of linear searching.
5456 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5457 will be used to reduce the amount of linear searching. The cache will be
5458 created if necessary, and the found value offered to it for update. */
5460 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5461 const U8 *const send, STRLEN uoffset,
5462 STRLEN uoffset0, STRLEN boffset0) {
5463 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5466 assert (uoffset >= uoffset0);
5468 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5469 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5470 if ((*mgp)->mg_ptr) {
5471 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5472 if (cache[0] == uoffset) {
5473 /* An exact match. */
5476 if (cache[2] == uoffset) {
5477 /* An exact match. */
5481 if (cache[0] < uoffset) {
5482 /* The cache already knows part of the way. */
5483 if (cache[0] > uoffset0) {
5484 /* The cache knows more than the passed in pair */
5485 uoffset0 = cache[0];
5486 boffset0 = cache[1];
5488 if ((*mgp)->mg_len != -1) {
5489 /* And we know the end too. */
5491 + sv_pos_u2b_midway(start + boffset0, send,
5493 (*mgp)->mg_len - uoffset0);
5496 + sv_pos_u2b_forwards(start + boffset0,
5497 send, uoffset - uoffset0);
5500 else if (cache[2] < uoffset) {
5501 /* We're between the two cache entries. */
5502 if (cache[2] > uoffset0) {
5503 /* and the cache knows more than the passed in pair */
5504 uoffset0 = cache[2];
5505 boffset0 = cache[3];
5509 + sv_pos_u2b_midway(start + boffset0,
5512 cache[0] - uoffset0);
5515 + sv_pos_u2b_midway(start + boffset0,
5518 cache[2] - uoffset0);
5522 else if ((*mgp)->mg_len != -1) {
5523 /* If we can take advantage of a passed in offset, do so. */
5524 /* In fact, offset0 is either 0, or less than offset, so don't
5525 need to worry about the other possibility. */
5527 + sv_pos_u2b_midway(start + boffset0, send,
5529 (*mgp)->mg_len - uoffset0);
5534 if (!found || PL_utf8cache < 0) {
5535 const STRLEN real_boffset
5536 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5537 send, uoffset - uoffset0);
5539 if (found && PL_utf8cache < 0) {
5540 if (real_boffset != boffset) {
5541 /* Need to turn the assertions off otherwise we may recurse
5542 infinitely while printing error messages. */
5543 SAVEI8(PL_utf8cache);
5545 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5546 " real %"UVuf" for %"SVf,
5547 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5550 boffset = real_boffset;
5553 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5559 =for apidoc sv_pos_u2b
5561 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5562 the start of the string, to a count of the equivalent number of bytes; if
5563 lenp is non-zero, it does the same to lenp, but this time starting from
5564 the offset, rather than from the start of the string. Handles magic and
5571 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5572 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5573 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5578 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5586 start = (U8*)SvPV_const(sv, len);
5588 STRLEN uoffset = (STRLEN) *offsetp;
5589 const U8 * const send = start + len;
5591 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5594 *offsetp = (I32) boffset;
5597 /* Convert the relative offset to absolute. */
5598 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5599 const STRLEN boffset2
5600 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5601 uoffset, boffset) - boffset;
5615 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5616 byte length pairing. The (byte) length of the total SV is passed in too,
5617 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5618 may not have updated SvCUR, so we can't rely on reading it directly.
5620 The proffered utf8/byte length pairing isn't used if the cache already has
5621 two pairs, and swapping either for the proffered pair would increase the
5622 RMS of the intervals between known byte offsets.
5624 The cache itself consists of 4 STRLEN values
5625 0: larger UTF-8 offset
5626 1: corresponding byte offset
5627 2: smaller UTF-8 offset
5628 3: corresponding byte offset
5630 Unused cache pairs have the value 0, 0.
5631 Keeping the cache "backwards" means that the invariant of
5632 cache[0] >= cache[2] is maintained even with empty slots, which means that
5633 the code that uses it doesn't need to worry if only 1 entry has actually
5634 been set to non-zero. It also makes the "position beyond the end of the
5635 cache" logic much simpler, as the first slot is always the one to start
5639 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5647 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5649 (*mgp)->mg_len = -1;
5653 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5654 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5655 (*mgp)->mg_ptr = (char *) cache;
5659 if (PL_utf8cache < 0) {
5660 const U8 *start = (const U8 *) SvPVX_const(sv);
5661 const STRLEN realutf8 = utf8_length(start, start + byte);
5663 if (realutf8 != utf8) {
5664 /* Need to turn the assertions off otherwise we may recurse
5665 infinitely while printing error messages. */
5666 SAVEI8(PL_utf8cache);
5668 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5669 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5673 /* Cache is held with the later position first, to simplify the code
5674 that deals with unbounded ends. */
5676 ASSERT_UTF8_CACHE(cache);
5677 if (cache[1] == 0) {
5678 /* Cache is totally empty */
5681 } else if (cache[3] == 0) {
5682 if (byte > cache[1]) {
5683 /* New one is larger, so goes first. */
5684 cache[2] = cache[0];
5685 cache[3] = cache[1];
5693 #define THREEWAY_SQUARE(a,b,c,d) \
5694 ((float)((d) - (c))) * ((float)((d) - (c))) \
5695 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5696 + ((float)((b) - (a))) * ((float)((b) - (a)))
5698 /* Cache has 2 slots in use, and we know three potential pairs.
5699 Keep the two that give the lowest RMS distance. Do the
5700 calcualation in bytes simply because we always know the byte
5701 length. squareroot has the same ordering as the positive value,
5702 so don't bother with the actual square root. */
5703 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5704 if (byte > cache[1]) {
5705 /* New position is after the existing pair of pairs. */
5706 const float keep_earlier
5707 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5708 const float keep_later
5709 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5711 if (keep_later < keep_earlier) {
5712 if (keep_later < existing) {
5713 cache[2] = cache[0];
5714 cache[3] = cache[1];
5720 if (keep_earlier < existing) {
5726 else if (byte > cache[3]) {
5727 /* New position is between the existing pair of pairs. */
5728 const float keep_earlier
5729 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5730 const float keep_later
5731 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5733 if (keep_later < keep_earlier) {
5734 if (keep_later < existing) {
5740 if (keep_earlier < existing) {
5747 /* New position is before the existing pair of pairs. */
5748 const float keep_earlier
5749 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5750 const float keep_later
5751 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5753 if (keep_later < keep_earlier) {
5754 if (keep_later < existing) {
5760 if (keep_earlier < existing) {
5761 cache[0] = cache[2];
5762 cache[1] = cache[3];
5769 ASSERT_UTF8_CACHE(cache);
5772 /* We already know all of the way, now we may be able to walk back. The same
5773 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5774 backward is half the speed of walking forward. */
5776 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5779 const STRLEN forw = target - s;
5780 STRLEN backw = end - target;
5782 if (forw < 2 * backw) {
5783 return utf8_length(s, target);
5786 while (end > target) {
5788 while (UTF8_IS_CONTINUATION(*end)) {
5797 =for apidoc sv_pos_b2u
5799 Converts the value pointed to by offsetp from a count of bytes from the
5800 start of the string, to a count of the equivalent number of UTF-8 chars.
5801 Handles magic and type coercion.
5807 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5808 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5813 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5816 const STRLEN byte = *offsetp;
5817 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5826 s = (const U8*)SvPV_const(sv, blen);
5829 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5833 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5834 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5836 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5837 if (cache[1] == byte) {
5838 /* An exact match. */
5839 *offsetp = cache[0];
5842 if (cache[3] == byte) {
5843 /* An exact match. */
5844 *offsetp = cache[2];
5848 if (cache[1] < byte) {
5849 /* We already know part of the way. */
5850 if (mg->mg_len != -1) {
5851 /* Actually, we know the end too. */
5853 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5854 s + blen, mg->mg_len - cache[0]);
5856 len = cache[0] + utf8_length(s + cache[1], send);
5859 else if (cache[3] < byte) {
5860 /* We're between the two cached pairs, so we do the calculation
5861 offset by the byte/utf-8 positions for the earlier pair,
5862 then add the utf-8 characters from the string start to
5864 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5865 s + cache[1], cache[0] - cache[2])
5869 else { /* cache[3] > byte */
5870 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5874 ASSERT_UTF8_CACHE(cache);
5876 } else if (mg->mg_len != -1) {
5877 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5881 if (!found || PL_utf8cache < 0) {
5882 const STRLEN real_len = utf8_length(s, send);
5884 if (found && PL_utf8cache < 0) {
5885 if (len != real_len) {
5886 /* Need to turn the assertions off otherwise we may recurse
5887 infinitely while printing error messages. */
5888 SAVEI8(PL_utf8cache);
5890 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5891 " real %"UVuf" for %"SVf,
5892 (UV) len, (UV) real_len, SVfARG(sv));
5899 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5905 Returns a boolean indicating whether the strings in the two SVs are
5906 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5907 coerce its args to strings if necessary.
5913 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5922 SV* svrecode = NULL;
5929 /* if pv1 and pv2 are the same, second SvPV_const call may
5930 * invalidate pv1, so we may need to make a copy */
5931 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5932 pv1 = SvPV_const(sv1, cur1);
5933 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5934 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5936 pv1 = SvPV_const(sv1, cur1);
5944 pv2 = SvPV_const(sv2, cur2);
5946 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5947 /* Differing utf8ness.
5948 * Do not UTF8size the comparands as a side-effect. */
5951 svrecode = newSVpvn(pv2, cur2);
5952 sv_recode_to_utf8(svrecode, PL_encoding);
5953 pv2 = SvPV_const(svrecode, cur2);
5956 svrecode = newSVpvn(pv1, cur1);
5957 sv_recode_to_utf8(svrecode, PL_encoding);
5958 pv1 = SvPV_const(svrecode, cur1);
5960 /* Now both are in UTF-8. */
5962 SvREFCNT_dec(svrecode);
5967 bool is_utf8 = TRUE;
5970 /* sv1 is the UTF-8 one,
5971 * if is equal it must be downgrade-able */
5972 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5978 /* sv2 is the UTF-8 one,
5979 * if is equal it must be downgrade-able */
5980 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5986 /* Downgrade not possible - cannot be eq */
5994 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5996 SvREFCNT_dec(svrecode);
6006 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6007 string in C<sv1> is less than, equal to, or greater than the string in
6008 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6009 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6015 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6019 const char *pv1, *pv2;
6022 SV *svrecode = NULL;
6029 pv1 = SvPV_const(sv1, cur1);
6036 pv2 = SvPV_const(sv2, cur2);
6038 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6039 /* Differing utf8ness.
6040 * Do not UTF8size the comparands as a side-effect. */
6043 svrecode = newSVpvn(pv2, cur2);
6044 sv_recode_to_utf8(svrecode, PL_encoding);
6045 pv2 = SvPV_const(svrecode, cur2);
6048 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6053 svrecode = newSVpvn(pv1, cur1);
6054 sv_recode_to_utf8(svrecode, PL_encoding);
6055 pv1 = SvPV_const(svrecode, cur1);
6058 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6064 cmp = cur2 ? -1 : 0;
6068 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6071 cmp = retval < 0 ? -1 : 1;
6072 } else if (cur1 == cur2) {
6075 cmp = cur1 < cur2 ? -1 : 1;
6079 SvREFCNT_dec(svrecode);
6087 =for apidoc sv_cmp_locale
6089 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6090 'use bytes' aware, handles get magic, and will coerce its args to strings
6091 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6097 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6100 #ifdef USE_LOCALE_COLLATE
6106 if (PL_collation_standard)
6110 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6112 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6114 if (!pv1 || !len1) {
6125 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6128 return retval < 0 ? -1 : 1;
6131 * When the result of collation is equality, that doesn't mean
6132 * that there are no differences -- some locales exclude some
6133 * characters from consideration. So to avoid false equalities,
6134 * we use the raw string as a tiebreaker.
6140 #endif /* USE_LOCALE_COLLATE */
6142 return sv_cmp(sv1, sv2);
6146 #ifdef USE_LOCALE_COLLATE
6149 =for apidoc sv_collxfrm
6151 Add Collate Transform magic to an SV if it doesn't already have it.
6153 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6154 scalar data of the variable, but transformed to such a format that a normal
6155 memory comparison can be used to compare the data according to the locale
6162 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6167 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6168 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6174 Safefree(mg->mg_ptr);
6175 s = SvPV_const(sv, len);
6176 if ((xf = mem_collxfrm(s, len, &xlen))) {
6177 if (SvREADONLY(sv)) {
6180 return xf + sizeof(PL_collation_ix);
6183 #ifdef PERL_OLD_COPY_ON_WRITE
6185 sv_force_normal_flags(sv, 0);
6187 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6201 if (mg && mg->mg_ptr) {
6203 return mg->mg_ptr + sizeof(PL_collation_ix);
6211 #endif /* USE_LOCALE_COLLATE */
6216 Get a line from the filehandle and store it into the SV, optionally
6217 appending to the currently-stored string.
6223 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6228 register STDCHAR rslast;
6229 register STDCHAR *bp;
6234 if (SvTHINKFIRST(sv))
6235 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6236 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6238 However, perlbench says it's slower, because the existing swipe code
6239 is faster than copy on write.
6240 Swings and roundabouts. */
6241 SvUPGRADE(sv, SVt_PV);
6246 if (PerlIO_isutf8(fp)) {
6248 sv_utf8_upgrade_nomg(sv);
6249 sv_pos_u2b(sv,&append,0);
6251 } else if (SvUTF8(sv)) {
6252 SV * const tsv = newSV(0);
6253 sv_gets(tsv, fp, 0);
6254 sv_utf8_upgrade_nomg(tsv);
6255 SvCUR_set(sv,append);
6258 goto return_string_or_null;
6263 if (PerlIO_isutf8(fp))
6266 if (IN_PERL_COMPILETIME) {
6267 /* we always read code in line mode */
6271 else if (RsSNARF(PL_rs)) {
6272 /* If it is a regular disk file use size from stat() as estimate
6273 of amount we are going to read -- may result in mallocing
6274 more memory than we really need if the layers below reduce
6275 the size we read (e.g. CRLF or a gzip layer).
6278 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6279 const Off_t offset = PerlIO_tell(fp);
6280 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6281 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6287 else if (RsRECORD(PL_rs)) {
6292 /* Grab the size of the record we're getting */
6293 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6294 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6297 /* VMS wants read instead of fread, because fread doesn't respect */
6298 /* RMS record boundaries. This is not necessarily a good thing to be */
6299 /* doing, but we've got no other real choice - except avoid stdio
6300 as implementation - perhaps write a :vms layer ?
6302 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6304 bytesread = PerlIO_read(fp, buffer, recsize);
6308 SvCUR_set(sv, bytesread += append);
6309 buffer[bytesread] = '\0';
6310 goto return_string_or_null;
6312 else if (RsPARA(PL_rs)) {
6318 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6319 if (PerlIO_isutf8(fp)) {
6320 rsptr = SvPVutf8(PL_rs, rslen);
6323 if (SvUTF8(PL_rs)) {
6324 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6325 Perl_croak(aTHX_ "Wide character in $/");
6328 rsptr = SvPV_const(PL_rs, rslen);
6332 rslast = rslen ? rsptr[rslen - 1] : '\0';
6334 if (rspara) { /* have to do this both before and after */
6335 do { /* to make sure file boundaries work right */
6338 i = PerlIO_getc(fp);
6342 PerlIO_ungetc(fp,i);
6348 /* See if we know enough about I/O mechanism to cheat it ! */
6350 /* This used to be #ifdef test - it is made run-time test for ease
6351 of abstracting out stdio interface. One call should be cheap
6352 enough here - and may even be a macro allowing compile
6356 if (PerlIO_fast_gets(fp)) {
6359 * We're going to steal some values from the stdio struct
6360 * and put EVERYTHING in the innermost loop into registers.
6362 register STDCHAR *ptr;
6366 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6367 /* An ungetc()d char is handled separately from the regular
6368 * buffer, so we getc() it back out and stuff it in the buffer.
6370 i = PerlIO_getc(fp);
6371 if (i == EOF) return 0;
6372 *(--((*fp)->_ptr)) = (unsigned char) i;
6376 /* Here is some breathtakingly efficient cheating */
6378 cnt = PerlIO_get_cnt(fp); /* get count into register */
6379 /* make sure we have the room */
6380 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6381 /* Not room for all of it
6382 if we are looking for a separator and room for some
6384 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6385 /* just process what we have room for */
6386 shortbuffered = cnt - SvLEN(sv) + append + 1;
6387 cnt -= shortbuffered;
6391 /* remember that cnt can be negative */
6392 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6397 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6398 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6399 DEBUG_P(PerlIO_printf(Perl_debug_log,
6400 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6401 DEBUG_P(PerlIO_printf(Perl_debug_log,
6402 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6403 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6404 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6409 while (cnt > 0) { /* this | eat */
6411 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6412 goto thats_all_folks; /* screams | sed :-) */
6416 Copy(ptr, bp, cnt, char); /* this | eat */
6417 bp += cnt; /* screams | dust */
6418 ptr += cnt; /* louder | sed :-) */
6423 if (shortbuffered) { /* oh well, must extend */
6424 cnt = shortbuffered;
6426 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6428 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6429 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6433 DEBUG_P(PerlIO_printf(Perl_debug_log,
6434 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6435 PTR2UV(ptr),(long)cnt));
6436 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6438 DEBUG_P(PerlIO_printf(Perl_debug_log,
6439 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6440 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6441 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6443 /* This used to call 'filbuf' in stdio form, but as that behaves like
6444 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6445 another abstraction. */
6446 i = PerlIO_getc(fp); /* get more characters */
6448 DEBUG_P(PerlIO_printf(Perl_debug_log,
6449 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6450 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6451 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6453 cnt = PerlIO_get_cnt(fp);
6454 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6455 DEBUG_P(PerlIO_printf(Perl_debug_log,
6456 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6458 if (i == EOF) /* all done for ever? */
6459 goto thats_really_all_folks;
6461 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6463 SvGROW(sv, bpx + cnt + 2);
6464 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6466 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6468 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6469 goto thats_all_folks;
6473 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6474 memNE((char*)bp - rslen, rsptr, rslen))
6475 goto screamer; /* go back to the fray */
6476 thats_really_all_folks:
6478 cnt += shortbuffered;
6479 DEBUG_P(PerlIO_printf(Perl_debug_log,
6480 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6481 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6482 DEBUG_P(PerlIO_printf(Perl_debug_log,
6483 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6484 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6485 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6487 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6488 DEBUG_P(PerlIO_printf(Perl_debug_log,
6489 "Screamer: done, len=%ld, string=|%.*s|\n",
6490 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6494 /*The big, slow, and stupid way. */
6495 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6496 STDCHAR *buf = NULL;
6497 Newx(buf, 8192, STDCHAR);
6505 register const STDCHAR * const bpe = buf + sizeof(buf);
6507 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6508 ; /* keep reading */
6512 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6513 /* Accomodate broken VAXC compiler, which applies U8 cast to
6514 * both args of ?: operator, causing EOF to change into 255
6517 i = (U8)buf[cnt - 1];
6523 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6525 sv_catpvn(sv, (char *) buf, cnt);
6527 sv_setpvn(sv, (char *) buf, cnt);
6529 if (i != EOF && /* joy */
6531 SvCUR(sv) < rslen ||
6532 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6536 * If we're reading from a TTY and we get a short read,
6537 * indicating that the user hit his EOF character, we need
6538 * to notice it now, because if we try to read from the TTY
6539 * again, the EOF condition will disappear.
6541 * The comparison of cnt to sizeof(buf) is an optimization
6542 * that prevents unnecessary calls to feof().
6546 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6550 #ifdef USE_HEAP_INSTEAD_OF_STACK
6555 if (rspara) { /* have to do this both before and after */
6556 while (i != EOF) { /* to make sure file boundaries work right */
6557 i = PerlIO_getc(fp);
6559 PerlIO_ungetc(fp,i);
6565 return_string_or_null:
6566 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6572 Auto-increment of the value in the SV, doing string to numeric conversion
6573 if necessary. Handles 'get' magic.
6579 Perl_sv_inc(pTHX_ register SV *sv)
6588 if (SvTHINKFIRST(sv)) {
6590 sv_force_normal_flags(sv, 0);
6591 if (SvREADONLY(sv)) {
6592 if (IN_PERL_RUNTIME)
6593 Perl_croak(aTHX_ PL_no_modify);
6597 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6599 i = PTR2IV(SvRV(sv));
6604 flags = SvFLAGS(sv);
6605 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6606 /* It's (privately or publicly) a float, but not tested as an
6607 integer, so test it to see. */
6609 flags = SvFLAGS(sv);
6611 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6612 /* It's publicly an integer, or privately an integer-not-float */
6613 #ifdef PERL_PRESERVE_IVUV
6617 if (SvUVX(sv) == UV_MAX)
6618 sv_setnv(sv, UV_MAX_P1);
6620 (void)SvIOK_only_UV(sv);
6621 SvUV_set(sv, SvUVX(sv) + 1);
6623 if (SvIVX(sv) == IV_MAX)
6624 sv_setuv(sv, (UV)IV_MAX + 1);
6626 (void)SvIOK_only(sv);
6627 SvIV_set(sv, SvIVX(sv) + 1);
6632 if (flags & SVp_NOK) {
6633 (void)SvNOK_only(sv);
6634 SvNV_set(sv, SvNVX(sv) + 1.0);
6638 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6639 if ((flags & SVTYPEMASK) < SVt_PVIV)
6640 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6641 (void)SvIOK_only(sv);
6646 while (isALPHA(*d)) d++;
6647 while (isDIGIT(*d)) d++;
6649 #ifdef PERL_PRESERVE_IVUV
6650 /* Got to punt this as an integer if needs be, but we don't issue
6651 warnings. Probably ought to make the sv_iv_please() that does
6652 the conversion if possible, and silently. */
6653 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6654 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6655 /* Need to try really hard to see if it's an integer.
6656 9.22337203685478e+18 is an integer.
6657 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6658 so $a="9.22337203685478e+18"; $a+0; $a++
6659 needs to be the same as $a="9.22337203685478e+18"; $a++
6666 /* sv_2iv *should* have made this an NV */
6667 if (flags & SVp_NOK) {
6668 (void)SvNOK_only(sv);
6669 SvNV_set(sv, SvNVX(sv) + 1.0);
6672 /* I don't think we can get here. Maybe I should assert this
6673 And if we do get here I suspect that sv_setnv will croak. NWC
6675 #if defined(USE_LONG_DOUBLE)
6676 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",
6677 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6679 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6680 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6683 #endif /* PERL_PRESERVE_IVUV */
6684 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6688 while (d >= SvPVX_const(sv)) {
6696 /* MKS: The original code here died if letters weren't consecutive.
6697 * at least it didn't have to worry about non-C locales. The
6698 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6699 * arranged in order (although not consecutively) and that only
6700 * [A-Za-z] are accepted by isALPHA in the C locale.
6702 if (*d != 'z' && *d != 'Z') {
6703 do { ++*d; } while (!isALPHA(*d));
6706 *(d--) -= 'z' - 'a';
6711 *(d--) -= 'z' - 'a' + 1;
6715 /* oh,oh, the number grew */
6716 SvGROW(sv, SvCUR(sv) + 2);
6717 SvCUR_set(sv, SvCUR(sv) + 1);
6718 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6729 Auto-decrement of the value in the SV, doing string to numeric conversion
6730 if necessary. Handles 'get' magic.
6736 Perl_sv_dec(pTHX_ register SV *sv)
6744 if (SvTHINKFIRST(sv)) {
6746 sv_force_normal_flags(sv, 0);
6747 if (SvREADONLY(sv)) {
6748 if (IN_PERL_RUNTIME)
6749 Perl_croak(aTHX_ PL_no_modify);
6753 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6755 i = PTR2IV(SvRV(sv));
6760 /* Unlike sv_inc we don't have to worry about string-never-numbers
6761 and keeping them magic. But we mustn't warn on punting */
6762 flags = SvFLAGS(sv);
6763 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6764 /* It's publicly an integer, or privately an integer-not-float */
6765 #ifdef PERL_PRESERVE_IVUV
6769 if (SvUVX(sv) == 0) {
6770 (void)SvIOK_only(sv);
6774 (void)SvIOK_only_UV(sv);
6775 SvUV_set(sv, SvUVX(sv) - 1);
6778 if (SvIVX(sv) == IV_MIN)
6779 sv_setnv(sv, (NV)IV_MIN - 1.0);
6781 (void)SvIOK_only(sv);
6782 SvIV_set(sv, SvIVX(sv) - 1);
6787 if (flags & SVp_NOK) {
6788 SvNV_set(sv, SvNVX(sv) - 1.0);
6789 (void)SvNOK_only(sv);
6792 if (!(flags & SVp_POK)) {
6793 if ((flags & SVTYPEMASK) < SVt_PVIV)
6794 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6796 (void)SvIOK_only(sv);
6799 #ifdef PERL_PRESERVE_IVUV
6801 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6802 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6803 /* Need to try really hard to see if it's an integer.
6804 9.22337203685478e+18 is an integer.
6805 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6806 so $a="9.22337203685478e+18"; $a+0; $a--
6807 needs to be the same as $a="9.22337203685478e+18"; $a--
6814 /* sv_2iv *should* have made this an NV */
6815 if (flags & SVp_NOK) {
6816 (void)SvNOK_only(sv);
6817 SvNV_set(sv, SvNVX(sv) - 1.0);
6820 /* I don't think we can get here. Maybe I should assert this
6821 And if we do get here I suspect that sv_setnv will croak. NWC
6823 #if defined(USE_LONG_DOUBLE)
6824 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",
6825 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6827 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6828 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6832 #endif /* PERL_PRESERVE_IVUV */
6833 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6837 =for apidoc sv_mortalcopy
6839 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6840 The new SV is marked as mortal. It will be destroyed "soon", either by an
6841 explicit call to FREETMPS, or by an implicit call at places such as
6842 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6847 /* Make a string that will exist for the duration of the expression
6848 * evaluation. Actually, it may have to last longer than that, but
6849 * hopefully we won't free it until it has been assigned to a
6850 * permanent location. */
6853 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6859 sv_setsv(sv,oldstr);
6861 PL_tmps_stack[++PL_tmps_ix] = sv;
6867 =for apidoc sv_newmortal
6869 Creates a new null SV which is mortal. The reference count of the SV is
6870 set to 1. It will be destroyed "soon", either by an explicit call to
6871 FREETMPS, or by an implicit call at places such as statement boundaries.
6872 See also C<sv_mortalcopy> and C<sv_2mortal>.
6878 Perl_sv_newmortal(pTHX)
6884 SvFLAGS(sv) = SVs_TEMP;
6886 PL_tmps_stack[++PL_tmps_ix] = sv;
6891 =for apidoc sv_2mortal
6893 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6894 by an explicit call to FREETMPS, or by an implicit call at places such as
6895 statement boundaries. SvTEMP() is turned on which means that the SV's
6896 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6897 and C<sv_mortalcopy>.
6903 Perl_sv_2mortal(pTHX_ register SV *sv)
6908 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6911 PL_tmps_stack[++PL_tmps_ix] = sv;
6919 Creates a new SV and copies a string into it. The reference count for the
6920 SV is set to 1. If C<len> is zero, Perl will compute the length using
6921 strlen(). For efficiency, consider using C<newSVpvn> instead.
6927 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6933 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6938 =for apidoc newSVpvn
6940 Creates a new SV and copies a string into it. The reference count for the
6941 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6942 string. You are responsible for ensuring that the source string is at least
6943 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6949 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6955 sv_setpvn(sv,s,len);
6961 =for apidoc newSVhek
6963 Creates a new SV from the hash key structure. It will generate scalars that
6964 point to the shared string table where possible. Returns a new (undefined)
6965 SV if the hek is NULL.
6971 Perl_newSVhek(pTHX_ const HEK *hek)
6981 if (HEK_LEN(hek) == HEf_SVKEY) {
6982 return newSVsv(*(SV**)HEK_KEY(hek));
6984 const int flags = HEK_FLAGS(hek);
6985 if (flags & HVhek_WASUTF8) {
6987 Andreas would like keys he put in as utf8 to come back as utf8
6989 STRLEN utf8_len = HEK_LEN(hek);
6990 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6991 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6994 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6996 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6997 /* We don't have a pointer to the hv, so we have to replicate the
6998 flag into every HEK. This hv is using custom a hasing
6999 algorithm. Hence we can't return a shared string scalar, as
7000 that would contain the (wrong) hash value, and might get passed
7001 into an hv routine with a regular hash.
7002 Similarly, a hash that isn't using shared hash keys has to have
7003 the flag in every key so that we know not to try to call
7004 share_hek_kek on it. */
7006 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7011 /* This will be overwhelminly the most common case. */
7013 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7014 more efficient than sharepvn(). */
7018 sv_upgrade(sv, SVt_PV);
7019 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7020 SvCUR_set(sv, HEK_LEN(hek));
7033 =for apidoc newSVpvn_share
7035 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7036 table. If the string does not already exist in the table, it is created
7037 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7038 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7039 otherwise the hash is computed. The idea here is that as the string table
7040 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7041 hash lookup will avoid string compare.
7047 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7051 bool is_utf8 = FALSE;
7052 const char *const orig_src = src;
7055 STRLEN tmplen = -len;
7057 /* See the note in hv.c:hv_fetch() --jhi */
7058 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7062 PERL_HASH(hash, src, len);
7064 sv_upgrade(sv, SVt_PV);
7065 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7073 if (src != orig_src)
7079 #if defined(PERL_IMPLICIT_CONTEXT)
7081 /* pTHX_ magic can't cope with varargs, so this is a no-context
7082 * version of the main function, (which may itself be aliased to us).
7083 * Don't access this version directly.
7087 Perl_newSVpvf_nocontext(const char* pat, ...)
7092 va_start(args, pat);
7093 sv = vnewSVpvf(pat, &args);
7100 =for apidoc newSVpvf
7102 Creates a new SV and initializes it with the string formatted like
7109 Perl_newSVpvf(pTHX_ const char* pat, ...)
7113 va_start(args, pat);
7114 sv = vnewSVpvf(pat, &args);
7119 /* backend for newSVpvf() and newSVpvf_nocontext() */
7122 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7127 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7134 Creates a new SV and copies a floating point value into it.
7135 The reference count for the SV is set to 1.
7141 Perl_newSVnv(pTHX_ NV n)
7154 Creates a new SV and copies an integer into it. The reference count for the
7161 Perl_newSViv(pTHX_ IV i)
7174 Creates a new SV and copies an unsigned integer into it.
7175 The reference count for the SV is set to 1.
7181 Perl_newSVuv(pTHX_ UV u)
7192 =for apidoc newRV_noinc
7194 Creates an RV wrapper for an SV. The reference count for the original
7195 SV is B<not> incremented.
7201 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7207 sv_upgrade(sv, SVt_RV);
7209 SvRV_set(sv, tmpRef);
7214 /* newRV_inc is the official function name to use now.
7215 * newRV_inc is in fact #defined to newRV in sv.h
7219 Perl_newRV(pTHX_ SV *sv)
7222 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7228 Creates a new SV which is an exact duplicate of the original SV.
7235 Perl_newSVsv(pTHX_ register SV *old)
7242 if (SvTYPE(old) == SVTYPEMASK) {
7243 if (ckWARN_d(WARN_INTERNAL))
7244 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7248 /* SV_GMAGIC is the default for sv_setv()
7249 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7250 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7251 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7256 =for apidoc sv_reset
7258 Underlying implementation for the C<reset> Perl function.
7259 Note that the perl-level function is vaguely deprecated.
7265 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7268 char todo[PERL_UCHAR_MAX+1];
7273 if (!*s) { /* reset ?? searches */
7274 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7276 PMOP *pm = (PMOP *) mg->mg_obj;
7278 pm->op_pmdynflags &= ~PMdf_USED;
7285 /* reset variables */
7287 if (!HvARRAY(stash))
7290 Zero(todo, 256, char);
7293 I32 i = (unsigned char)*s;
7297 max = (unsigned char)*s++;
7298 for ( ; i <= max; i++) {
7301 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7303 for (entry = HvARRAY(stash)[i];
7305 entry = HeNEXT(entry))
7310 if (!todo[(U8)*HeKEY(entry)])
7312 gv = (GV*)HeVAL(entry);
7315 if (SvTHINKFIRST(sv)) {
7316 if (!SvREADONLY(sv) && SvROK(sv))
7318 /* XXX Is this continue a bug? Why should THINKFIRST
7319 exempt us from resetting arrays and hashes? */
7323 if (SvTYPE(sv) >= SVt_PV) {
7325 if (SvPVX_const(sv) != NULL)
7333 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7335 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7338 # if defined(USE_ENVIRON_ARRAY)
7341 # endif /* USE_ENVIRON_ARRAY */
7352 Using various gambits, try to get an IO from an SV: the IO slot if its a
7353 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7354 named after the PV if we're a string.
7360 Perl_sv_2io(pTHX_ SV *sv)
7365 switch (SvTYPE(sv)) {
7373 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7377 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7379 return sv_2io(SvRV(sv));
7380 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7386 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7395 Using various gambits, try to get a CV from an SV; in addition, try if
7396 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7397 The flags in C<lref> are passed to sv_fetchsv.
7403 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7414 switch (SvTYPE(sv)) {
7433 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7434 tryAMAGICunDEREF(to_cv);
7437 if (SvTYPE(sv) == SVt_PVCV) {
7446 Perl_croak(aTHX_ "Not a subroutine reference");
7451 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7457 /* Some flags to gv_fetchsv mean don't really create the GV */
7458 if (SvTYPE(gv) != SVt_PVGV) {
7464 if (lref && !GvCVu(gv)) {
7468 gv_efullname3(tmpsv, gv, NULL);
7469 /* XXX this is probably not what they think they're getting.
7470 * It has the same effect as "sub name;", i.e. just a forward
7472 newSUB(start_subparse(FALSE, 0),
7473 newSVOP(OP_CONST, 0, tmpsv),
7477 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7487 Returns true if the SV has a true value by Perl's rules.
7488 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7489 instead use an in-line version.
7495 Perl_sv_true(pTHX_ register SV *sv)
7500 register const XPV* const tXpv = (XPV*)SvANY(sv);
7502 (tXpv->xpv_cur > 1 ||
7503 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7510 return SvIVX(sv) != 0;
7513 return SvNVX(sv) != 0.0;
7515 return sv_2bool(sv);
7521 =for apidoc sv_pvn_force
7523 Get a sensible string out of the SV somehow.
7524 A private implementation of the C<SvPV_force> macro for compilers which
7525 can't cope with complex macro expressions. Always use the macro instead.
7527 =for apidoc sv_pvn_force_flags
7529 Get a sensible string out of the SV somehow.
7530 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7531 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7532 implemented in terms of this function.
7533 You normally want to use the various wrapper macros instead: see
7534 C<SvPV_force> and C<SvPV_force_nomg>
7540 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7543 if (SvTHINKFIRST(sv) && !SvROK(sv))
7544 sv_force_normal_flags(sv, 0);
7554 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7555 const char * const ref = sv_reftype(sv,0);
7557 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7558 ref, OP_NAME(PL_op));
7560 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7562 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7563 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7565 s = sv_2pv_flags(sv, &len, flags);
7569 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7572 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7573 SvGROW(sv, len + 1);
7574 Move(s,SvPVX(sv),len,char);
7579 SvPOK_on(sv); /* validate pointer */
7581 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7582 PTR2UV(sv),SvPVX_const(sv)));
7585 return SvPVX_mutable(sv);
7589 =for apidoc sv_pvbyten_force
7591 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7597 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7599 sv_pvn_force(sv,lp);
7600 sv_utf8_downgrade(sv,0);
7606 =for apidoc sv_pvutf8n_force
7608 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7614 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7616 sv_pvn_force(sv,lp);
7617 sv_utf8_upgrade(sv);
7623 =for apidoc sv_reftype
7625 Returns a string describing what the SV is a reference to.
7631 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7633 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7634 inside return suggests a const propagation bug in g++. */
7635 if (ob && SvOBJECT(sv)) {
7636 char * const name = HvNAME_get(SvSTASH(sv));
7637 return name ? name : (char *) "__ANON__";
7640 switch (SvTYPE(sv)) {
7656 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7657 /* tied lvalues should appear to be
7658 * scalars for backwards compatitbility */
7659 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7660 ? "SCALAR" : "LVALUE");
7661 case SVt_PVAV: return "ARRAY";
7662 case SVt_PVHV: return "HASH";
7663 case SVt_PVCV: return "CODE";
7664 case SVt_PVGV: return "GLOB";
7665 case SVt_PVFM: return "FORMAT";
7666 case SVt_PVIO: return "IO";
7667 case SVt_BIND: return "BIND";
7668 default: return "UNKNOWN";
7674 =for apidoc sv_isobject
7676 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7677 object. If the SV is not an RV, or if the object is not blessed, then this
7684 Perl_sv_isobject(pTHX_ SV *sv)
7700 Returns a boolean indicating whether the SV is blessed into the specified
7701 class. This does not check for subtypes; use C<sv_derived_from> to verify
7702 an inheritance relationship.
7708 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7719 hvname = HvNAME_get(SvSTASH(sv));
7723 return strEQ(hvname, name);
7729 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7730 it will be upgraded to one. If C<classname> is non-null then the new SV will
7731 be blessed in the specified package. The new SV is returned and its
7732 reference count is 1.
7738 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7745 SV_CHECK_THINKFIRST_COW_DROP(rv);
7748 if (SvTYPE(rv) >= SVt_PVMG) {
7749 const U32 refcnt = SvREFCNT(rv);
7753 SvREFCNT(rv) = refcnt;
7755 sv_upgrade(rv, SVt_RV);
7756 } else if (SvROK(rv)) {
7757 SvREFCNT_dec(SvRV(rv));
7758 } else if (SvTYPE(rv) < SVt_RV)
7759 sv_upgrade(rv, SVt_RV);
7760 else if (SvTYPE(rv) > SVt_RV) {
7771 HV* const stash = gv_stashpv(classname, TRUE);
7772 (void)sv_bless(rv, stash);
7778 =for apidoc sv_setref_pv
7780 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7781 argument will be upgraded to an RV. That RV will be modified to point to
7782 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7783 into the SV. The C<classname> argument indicates the package for the
7784 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7785 will have a reference count of 1, and the RV will be returned.
7787 Do not use with other Perl types such as HV, AV, SV, CV, because those
7788 objects will become corrupted by the pointer copy process.
7790 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7796 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7800 sv_setsv(rv, &PL_sv_undef);
7804 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7809 =for apidoc sv_setref_iv
7811 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7812 argument will be upgraded to an RV. That RV will be modified to point to
7813 the new SV. The C<classname> argument indicates the package for the
7814 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7815 will have a reference count of 1, and the RV will be returned.
7821 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7823 sv_setiv(newSVrv(rv,classname), iv);
7828 =for apidoc sv_setref_uv
7830 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7831 argument will be upgraded to an RV. That RV will be modified to point to
7832 the new SV. The C<classname> argument indicates the package for the
7833 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7834 will have a reference count of 1, and the RV will be returned.
7840 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7842 sv_setuv(newSVrv(rv,classname), uv);
7847 =for apidoc sv_setref_nv
7849 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7850 argument will be upgraded to an RV. That RV will be modified to point to
7851 the new SV. The C<classname> argument indicates the package for the
7852 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7853 will have a reference count of 1, and the RV will be returned.
7859 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7861 sv_setnv(newSVrv(rv,classname), nv);
7866 =for apidoc sv_setref_pvn
7868 Copies a string into a new SV, optionally blessing the SV. The length of the
7869 string must be specified with C<n>. The C<rv> argument will be upgraded to
7870 an RV. That RV will be modified to point to the new SV. The C<classname>
7871 argument indicates the package for the blessing. Set C<classname> to
7872 C<NULL> to avoid the blessing. The new SV will have a reference count
7873 of 1, and the RV will be returned.
7875 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7881 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7883 sv_setpvn(newSVrv(rv,classname), pv, n);
7888 =for apidoc sv_bless
7890 Blesses an SV into a specified package. The SV must be an RV. The package
7891 must be designated by its stash (see C<gv_stashpv()>). The reference count
7892 of the SV is unaffected.
7898 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7903 Perl_croak(aTHX_ "Can't bless non-reference value");
7905 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7906 if (SvREADONLY(tmpRef))
7907 Perl_croak(aTHX_ PL_no_modify);
7908 if (SvOBJECT(tmpRef)) {
7909 if (SvTYPE(tmpRef) != SVt_PVIO)
7911 SvREFCNT_dec(SvSTASH(tmpRef));
7914 SvOBJECT_on(tmpRef);
7915 if (SvTYPE(tmpRef) != SVt_PVIO)
7917 SvUPGRADE(tmpRef, SVt_PVMG);
7918 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7925 if(SvSMAGICAL(tmpRef))
7926 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7934 /* Downgrades a PVGV to a PVMG.
7938 S_sv_unglob(pTHX_ SV *sv)
7942 SV * const temp = sv_newmortal();
7944 assert(SvTYPE(sv) == SVt_PVGV);
7946 gv_efullname3(temp, (GV *) sv, "*");
7952 sv_del_backref((SV*)GvSTASH(sv), sv);
7956 if (GvNAME_HEK(sv)) {
7957 unshare_hek(GvNAME_HEK(sv));
7959 isGV_with_GP_off(sv);
7961 /* need to keep SvANY(sv) in the right arena */
7962 xpvmg = new_XPVMG();
7963 StructCopy(SvANY(sv), xpvmg, XPVMG);
7964 del_XPVGV(SvANY(sv));
7967 SvFLAGS(sv) &= ~SVTYPEMASK;
7968 SvFLAGS(sv) |= SVt_PVMG;
7970 /* Intentionally not calling any local SET magic, as this isn't so much a
7971 set operation as merely an internal storage change. */
7972 sv_setsv_flags(sv, temp, 0);
7976 =for apidoc sv_unref_flags
7978 Unsets the RV status of the SV, and decrements the reference count of
7979 whatever was being referenced by the RV. This can almost be thought of
7980 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7981 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7982 (otherwise the decrementing is conditional on the reference count being
7983 different from one or the reference being a readonly SV).
7990 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7992 SV* const target = SvRV(ref);
7994 if (SvWEAKREF(ref)) {
7995 sv_del_backref(target, ref);
7997 SvRV_set(ref, NULL);
8000 SvRV_set(ref, NULL);
8002 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8003 assigned to as BEGIN {$a = \"Foo"} will fail. */
8004 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8005 SvREFCNT_dec(target);
8006 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8007 sv_2mortal(target); /* Schedule for freeing later */
8011 =for apidoc sv_untaint
8013 Untaint an SV. Use C<SvTAINTED_off> instead.
8018 Perl_sv_untaint(pTHX_ SV *sv)
8020 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8021 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8028 =for apidoc sv_tainted
8030 Test an SV for taintedness. Use C<SvTAINTED> instead.
8035 Perl_sv_tainted(pTHX_ SV *sv)
8037 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8038 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8039 if (mg && (mg->mg_len & 1) )
8046 =for apidoc sv_setpviv
8048 Copies an integer into the given SV, also updating its string value.
8049 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8055 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8057 char buf[TYPE_CHARS(UV)];
8059 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8061 sv_setpvn(sv, ptr, ebuf - ptr);
8065 =for apidoc sv_setpviv_mg
8067 Like C<sv_setpviv>, but also handles 'set' magic.
8073 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8079 #if defined(PERL_IMPLICIT_CONTEXT)
8081 /* pTHX_ magic can't cope with varargs, so this is a no-context
8082 * version of the main function, (which may itself be aliased to us).
8083 * Don't access this version directly.
8087 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8091 va_start(args, pat);
8092 sv_vsetpvf(sv, pat, &args);
8096 /* pTHX_ magic can't cope with varargs, so this is a no-context
8097 * version of the main function, (which may itself be aliased to us).
8098 * Don't access this version directly.
8102 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8106 va_start(args, pat);
8107 sv_vsetpvf_mg(sv, pat, &args);
8113 =for apidoc sv_setpvf
8115 Works like C<sv_catpvf> but copies the text into the SV instead of
8116 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8122 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8125 va_start(args, pat);
8126 sv_vsetpvf(sv, pat, &args);
8131 =for apidoc sv_vsetpvf
8133 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8134 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8136 Usually used via its frontend C<sv_setpvf>.
8142 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8144 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8148 =for apidoc sv_setpvf_mg
8150 Like C<sv_setpvf>, but also handles 'set' magic.
8156 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8159 va_start(args, pat);
8160 sv_vsetpvf_mg(sv, pat, &args);
8165 =for apidoc sv_vsetpvf_mg
8167 Like C<sv_vsetpvf>, but also handles 'set' magic.
8169 Usually used via its frontend C<sv_setpvf_mg>.
8175 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8177 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8181 #if defined(PERL_IMPLICIT_CONTEXT)
8183 /* pTHX_ magic can't cope with varargs, so this is a no-context
8184 * version of the main function, (which may itself be aliased to us).
8185 * Don't access this version directly.
8189 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8193 va_start(args, pat);
8194 sv_vcatpvf(sv, pat, &args);
8198 /* pTHX_ magic can't cope with varargs, so this is a no-context
8199 * version of the main function, (which may itself be aliased to us).
8200 * Don't access this version directly.
8204 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8208 va_start(args, pat);
8209 sv_vcatpvf_mg(sv, pat, &args);
8215 =for apidoc sv_catpvf
8217 Processes its arguments like C<sprintf> and appends the formatted
8218 output to an SV. If the appended data contains "wide" characters
8219 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8220 and characters >255 formatted with %c), the original SV might get
8221 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8222 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8223 valid UTF-8; if the original SV was bytes, the pattern should be too.
8228 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8231 va_start(args, pat);
8232 sv_vcatpvf(sv, pat, &args);
8237 =for apidoc sv_vcatpvf
8239 Processes its arguments like C<vsprintf> and appends the formatted output
8240 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8242 Usually used via its frontend C<sv_catpvf>.
8248 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8250 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8254 =for apidoc sv_catpvf_mg
8256 Like C<sv_catpvf>, but also handles 'set' magic.
8262 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8265 va_start(args, pat);
8266 sv_vcatpvf_mg(sv, pat, &args);
8271 =for apidoc sv_vcatpvf_mg
8273 Like C<sv_vcatpvf>, but also handles 'set' magic.
8275 Usually used via its frontend C<sv_catpvf_mg>.
8281 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8283 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8288 =for apidoc sv_vsetpvfn
8290 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8293 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8299 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8301 sv_setpvn(sv, "", 0);
8302 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8306 S_expect_number(pTHX_ char** pattern)
8310 switch (**pattern) {
8311 case '1': case '2': case '3':
8312 case '4': case '5': case '6':
8313 case '7': case '8': case '9':
8314 var = *(*pattern)++ - '0';
8315 while (isDIGIT(**pattern)) {
8316 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8318 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8326 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8328 const int neg = nv < 0;
8337 if (uv & 1 && uv == nv)
8338 uv--; /* Round to even */
8340 const unsigned dig = uv % 10;
8353 =for apidoc sv_vcatpvfn
8355 Processes its arguments like C<vsprintf> and appends the formatted output
8356 to an SV. Uses an array of SVs if the C style variable argument list is
8357 missing (NULL). When running with taint checks enabled, indicates via
8358 C<maybe_tainted> if results are untrustworthy (often due to the use of
8361 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8367 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8368 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8369 vec_utf8 = DO_UTF8(vecsv);
8371 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8374 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8382 static const char nullstr[] = "(null)";
8384 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8385 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8387 /* Times 4: a decimal digit takes more than 3 binary digits.
8388 * NV_DIG: mantissa takes than many decimal digits.
8389 * Plus 32: Playing safe. */
8390 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8391 /* large enough for "%#.#f" --chip */
8392 /* what about long double NVs? --jhi */
8394 PERL_UNUSED_ARG(maybe_tainted);
8396 /* no matter what, this is a string now */
8397 (void)SvPV_force(sv, origlen);
8399 /* special-case "", "%s", and "%-p" (SVf - see below) */
8402 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8404 const char * const s = va_arg(*args, char*);
8405 sv_catpv(sv, s ? s : nullstr);
8407 else if (svix < svmax) {
8408 sv_catsv(sv, *svargs);
8412 if (args && patlen == 3 && pat[0] == '%' &&
8413 pat[1] == '-' && pat[2] == 'p') {
8414 argsv = (SV*)va_arg(*args, void*);
8415 sv_catsv(sv, argsv);
8419 #ifndef USE_LONG_DOUBLE
8420 /* special-case "%.<number>[gf]" */
8421 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8422 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8423 unsigned digits = 0;
8427 while (*pp >= '0' && *pp <= '9')
8428 digits = 10 * digits + (*pp++ - '0');
8429 if (pp - pat == (int)patlen - 1) {
8437 /* Add check for digits != 0 because it seems that some
8438 gconverts are buggy in this case, and we don't yet have
8439 a Configure test for this. */
8440 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8441 /* 0, point, slack */
8442 Gconvert(nv, (int)digits, 0, ebuf);
8444 if (*ebuf) /* May return an empty string for digits==0 */
8447 } else if (!digits) {
8450 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8451 sv_catpvn(sv, p, l);
8457 #endif /* !USE_LONG_DOUBLE */
8459 if (!args && svix < svmax && DO_UTF8(*svargs))
8462 patend = (char*)pat + patlen;
8463 for (p = (char*)pat; p < patend; p = q) {
8466 bool vectorize = FALSE;
8467 bool vectorarg = FALSE;
8468 bool vec_utf8 = FALSE;
8474 bool has_precis = FALSE;
8476 const I32 osvix = svix;
8477 bool is_utf8 = FALSE; /* is this item utf8? */
8478 #ifdef HAS_LDBL_SPRINTF_BUG
8479 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8480 with sfio - Allen <allens@cpan.org> */
8481 bool fix_ldbl_sprintf_bug = FALSE;
8485 U8 utf8buf[UTF8_MAXBYTES+1];
8486 STRLEN esignlen = 0;
8488 const char *eptr = NULL;
8491 const U8 *vecstr = NULL;
8498 /* we need a long double target in case HAS_LONG_DOUBLE but
8501 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8509 const char *dotstr = ".";
8510 STRLEN dotstrlen = 1;
8511 I32 efix = 0; /* explicit format parameter index */
8512 I32 ewix = 0; /* explicit width index */
8513 I32 epix = 0; /* explicit precision index */
8514 I32 evix = 0; /* explicit vector index */
8515 bool asterisk = FALSE;
8517 /* echo everything up to the next format specification */
8518 for (q = p; q < patend && *q != '%'; ++q) ;
8520 if (has_utf8 && !pat_utf8)
8521 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8523 sv_catpvn(sv, p, q - p);
8530 We allow format specification elements in this order:
8531 \d+\$ explicit format parameter index
8533 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8534 0 flag (as above): repeated to allow "v02"
8535 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8536 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8538 [%bcdefginopsuxDFOUX] format (mandatory)
8543 As of perl5.9.3, printf format checking is on by default.
8544 Internally, perl uses %p formats to provide an escape to
8545 some extended formatting. This block deals with those
8546 extensions: if it does not match, (char*)q is reset and
8547 the normal format processing code is used.
8549 Currently defined extensions are:
8550 %p include pointer address (standard)
8551 %-p (SVf) include an SV (previously %_)
8552 %-<num>p include an SV with precision <num>
8553 %1p (VDf) include a v-string (as %vd)
8554 %<num>p reserved for future extensions
8556 Robin Barker 2005-07-14
8563 n = expect_number(&q);
8570 argsv = (SV*)va_arg(*args, void*);
8571 eptr = SvPVx_const(argsv, elen);
8577 else if (n == vdNUMBER) { /* VDf */
8584 if (ckWARN_d(WARN_INTERNAL))
8585 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8586 "internal %%<num>p might conflict with future printf extensions");
8592 if ( (width = expect_number(&q)) ) {
8607 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8636 if ( (ewix = expect_number(&q)) )
8645 if ((vectorarg = asterisk)) {
8658 width = expect_number(&q);
8664 vecsv = va_arg(*args, SV*);
8666 vecsv = (evix > 0 && evix <= svmax)
8667 ? svargs[evix-1] : &PL_sv_undef;
8669 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8671 dotstr = SvPV_const(vecsv, dotstrlen);
8672 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8673 bad with tied or overloaded values that return UTF8. */
8676 else if (has_utf8) {
8677 vecsv = sv_mortalcopy(vecsv);
8678 sv_utf8_upgrade(vecsv);
8679 dotstr = SvPV_const(vecsv, dotstrlen);
8686 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8687 vecsv = svargs[efix ? efix-1 : svix++];
8688 vecstr = (U8*)SvPV_const(vecsv,veclen);
8689 vec_utf8 = DO_UTF8(vecsv);
8691 /* if this is a version object, we need to convert
8692 * back into v-string notation and then let the
8693 * vectorize happen normally
8695 if (sv_derived_from(vecsv, "version")) {
8696 char *version = savesvpv(vecsv);
8697 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8698 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8699 "vector argument not supported with alpha versions");
8702 vecsv = sv_newmortal();
8703 /* scan_vstring is expected to be called during
8704 * tokenization, so we need to fake up the end
8705 * of the buffer for it
8707 PL_bufend = version + veclen;
8708 scan_vstring(version, vecsv);
8709 vecstr = (U8*)SvPV_const(vecsv, veclen);
8710 vec_utf8 = DO_UTF8(vecsv);
8722 i = va_arg(*args, int);
8724 i = (ewix ? ewix <= svmax : svix < svmax) ?
8725 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8727 width = (i < 0) ? -i : i;
8737 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8739 /* XXX: todo, support specified precision parameter */
8743 i = va_arg(*args, int);
8745 i = (ewix ? ewix <= svmax : svix < svmax)
8746 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8748 has_precis = !(i < 0);
8753 precis = precis * 10 + (*q++ - '0');
8762 case 'I': /* Ix, I32x, and I64x */
8764 if (q[1] == '6' && q[2] == '4') {
8770 if (q[1] == '3' && q[2] == '2') {
8780 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8791 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8792 if (*(q + 1) == 'l') { /* lld, llf */
8818 if (!vectorize && !args) {
8820 const I32 i = efix-1;
8821 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8823 argsv = (svix >= 0 && svix < svmax)
8824 ? svargs[svix++] : &PL_sv_undef;
8835 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8837 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8839 eptr = (char*)utf8buf;
8840 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8854 eptr = va_arg(*args, char*);
8856 #ifdef MACOS_TRADITIONAL
8857 /* On MacOS, %#s format is used for Pascal strings */
8862 elen = strlen(eptr);
8864 eptr = (char *)nullstr;
8865 elen = sizeof nullstr - 1;
8869 eptr = SvPVx_const(argsv, elen);
8870 if (DO_UTF8(argsv)) {
8871 I32 old_precis = precis;
8872 if (has_precis && precis < elen) {
8874 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8877 if (width) { /* fudge width (can't fudge elen) */
8878 if (has_precis && precis < elen)
8879 width += precis - old_precis;
8881 width += elen - sv_len_utf8(argsv);
8888 if (has_precis && elen > precis)
8895 if (alt || vectorize)
8897 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8918 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8927 esignbuf[esignlen++] = plus;
8931 case 'h': iv = (short)va_arg(*args, int); break;
8932 case 'l': iv = va_arg(*args, long); break;
8933 case 'V': iv = va_arg(*args, IV); break;
8934 default: iv = va_arg(*args, int); break;
8936 case 'q': iv = va_arg(*args, Quad_t); break;
8941 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8943 case 'h': iv = (short)tiv; break;
8944 case 'l': iv = (long)tiv; break;
8946 default: iv = tiv; break;
8948 case 'q': iv = (Quad_t)tiv; break;
8952 if ( !vectorize ) /* we already set uv above */
8957 esignbuf[esignlen++] = plus;
8961 esignbuf[esignlen++] = '-';
9005 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9016 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9017 case 'l': uv = va_arg(*args, unsigned long); break;
9018 case 'V': uv = va_arg(*args, UV); break;
9019 default: uv = va_arg(*args, unsigned); break;
9021 case 'q': uv = va_arg(*args, Uquad_t); break;
9026 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9028 case 'h': uv = (unsigned short)tuv; break;
9029 case 'l': uv = (unsigned long)tuv; break;
9031 default: uv = tuv; break;
9033 case 'q': uv = (Uquad_t)tuv; break;
9040 char *ptr = ebuf + sizeof ebuf;
9041 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9047 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9053 esignbuf[esignlen++] = '0';
9054 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9062 if (alt && *ptr != '0')
9071 esignbuf[esignlen++] = '0';
9072 esignbuf[esignlen++] = c;
9075 default: /* it had better be ten or less */
9079 } while (uv /= base);
9082 elen = (ebuf + sizeof ebuf) - ptr;
9086 zeros = precis - elen;
9087 else if (precis == 0 && elen == 1 && *eptr == '0'
9088 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9091 /* a precision nullifies the 0 flag. */
9098 /* FLOATING POINT */
9101 c = 'f'; /* maybe %F isn't supported here */
9109 /* This is evil, but floating point is even more evil */
9111 /* for SV-style calling, we can only get NV
9112 for C-style calling, we assume %f is double;
9113 for simplicity we allow any of %Lf, %llf, %qf for long double
9117 #if defined(USE_LONG_DOUBLE)
9121 /* [perl #20339] - we should accept and ignore %lf rather than die */
9125 #if defined(USE_LONG_DOUBLE)
9126 intsize = args ? 0 : 'q';
9130 #if defined(HAS_LONG_DOUBLE)
9139 /* now we need (long double) if intsize == 'q', else (double) */
9141 #if LONG_DOUBLESIZE > DOUBLESIZE
9143 va_arg(*args, long double) :
9144 va_arg(*args, double)
9146 va_arg(*args, double)
9151 if (c != 'e' && c != 'E') {
9153 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9154 will cast our (long double) to (double) */
9155 (void)Perl_frexp(nv, &i);
9156 if (i == PERL_INT_MIN)
9157 Perl_die(aTHX_ "panic: frexp");
9159 need = BIT_DIGITS(i);
9161 need += has_precis ? precis : 6; /* known default */
9166 #ifdef HAS_LDBL_SPRINTF_BUG
9167 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9168 with sfio - Allen <allens@cpan.org> */
9171 # define MY_DBL_MAX DBL_MAX
9172 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9173 # if DOUBLESIZE >= 8
9174 # define MY_DBL_MAX 1.7976931348623157E+308L
9176 # define MY_DBL_MAX 3.40282347E+38L
9180 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9181 # define MY_DBL_MAX_BUG 1L
9183 # define MY_DBL_MAX_BUG MY_DBL_MAX
9187 # define MY_DBL_MIN DBL_MIN
9188 # else /* XXX guessing! -Allen */
9189 # if DOUBLESIZE >= 8
9190 # define MY_DBL_MIN 2.2250738585072014E-308L
9192 # define MY_DBL_MIN 1.17549435E-38L
9196 if ((intsize == 'q') && (c == 'f') &&
9197 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9199 /* it's going to be short enough that
9200 * long double precision is not needed */
9202 if ((nv <= 0L) && (nv >= -0L))
9203 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9205 /* would use Perl_fp_class as a double-check but not
9206 * functional on IRIX - see perl.h comments */
9208 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9209 /* It's within the range that a double can represent */
9210 #if defined(DBL_MAX) && !defined(DBL_MIN)
9211 if ((nv >= ((long double)1/DBL_MAX)) ||
9212 (nv <= (-(long double)1/DBL_MAX)))
9214 fix_ldbl_sprintf_bug = TRUE;
9217 if (fix_ldbl_sprintf_bug == TRUE) {
9227 # undef MY_DBL_MAX_BUG
9230 #endif /* HAS_LDBL_SPRINTF_BUG */
9232 need += 20; /* fudge factor */
9233 if (PL_efloatsize < need) {
9234 Safefree(PL_efloatbuf);
9235 PL_efloatsize = need + 20; /* more fudge */
9236 Newx(PL_efloatbuf, PL_efloatsize, char);
9237 PL_efloatbuf[0] = '\0';
9240 if ( !(width || left || plus || alt) && fill != '0'
9241 && has_precis && intsize != 'q' ) { /* Shortcuts */
9242 /* See earlier comment about buggy Gconvert when digits,
9244 if ( c == 'g' && precis) {
9245 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9246 /* May return an empty string for digits==0 */
9247 if (*PL_efloatbuf) {
9248 elen = strlen(PL_efloatbuf);
9249 goto float_converted;
9251 } else if ( c == 'f' && !precis) {
9252 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9257 char *ptr = ebuf + sizeof ebuf;
9260 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9261 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9262 if (intsize == 'q') {
9263 /* Copy the one or more characters in a long double
9264 * format before the 'base' ([efgEFG]) character to
9265 * the format string. */
9266 static char const prifldbl[] = PERL_PRIfldbl;
9267 char const *p = prifldbl + sizeof(prifldbl) - 3;
9268 while (p >= prifldbl) { *--ptr = *p--; }
9273 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9278 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9290 /* No taint. Otherwise we are in the strange situation
9291 * where printf() taints but print($float) doesn't.
9293 #if defined(HAS_LONG_DOUBLE)
9294 elen = ((intsize == 'q')
9295 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9296 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9298 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9302 eptr = PL_efloatbuf;
9310 i = SvCUR(sv) - origlen;
9313 case 'h': *(va_arg(*args, short*)) = i; break;
9314 default: *(va_arg(*args, int*)) = i; break;
9315 case 'l': *(va_arg(*args, long*)) = i; break;
9316 case 'V': *(va_arg(*args, IV*)) = i; break;
9318 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9323 sv_setuv_mg(argsv, (UV)i);
9324 continue; /* not "break" */
9331 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9332 && ckWARN(WARN_PRINTF))
9334 SV * const msg = sv_newmortal();
9335 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9336 (PL_op->op_type == OP_PRTF) ? "" : "s");
9339 Perl_sv_catpvf(aTHX_ msg,
9340 "\"%%%c\"", c & 0xFF);
9342 Perl_sv_catpvf(aTHX_ msg,
9343 "\"%%\\%03"UVof"\"",
9346 sv_catpvs(msg, "end of string");
9347 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9350 /* output mangled stuff ... */
9356 /* ... right here, because formatting flags should not apply */
9357 SvGROW(sv, SvCUR(sv) + elen + 1);
9359 Copy(eptr, p, elen, char);
9362 SvCUR_set(sv, p - SvPVX_const(sv));
9364 continue; /* not "break" */
9367 if (is_utf8 != has_utf8) {
9370 sv_utf8_upgrade(sv);
9373 const STRLEN old_elen = elen;
9374 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9375 sv_utf8_upgrade(nsv);
9376 eptr = SvPVX_const(nsv);
9379 if (width) { /* fudge width (can't fudge elen) */
9380 width += elen - old_elen;
9386 have = esignlen + zeros + elen;
9388 Perl_croak_nocontext(PL_memory_wrap);
9390 need = (have > width ? have : width);
9393 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9394 Perl_croak_nocontext(PL_memory_wrap);
9395 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9397 if (esignlen && fill == '0') {
9399 for (i = 0; i < (int)esignlen; i++)
9403 memset(p, fill, gap);
9406 if (esignlen && fill != '0') {
9408 for (i = 0; i < (int)esignlen; i++)
9413 for (i = zeros; i; i--)
9417 Copy(eptr, p, elen, char);
9421 memset(p, ' ', gap);
9426 Copy(dotstr, p, dotstrlen, char);
9430 vectorize = FALSE; /* done iterating over vecstr */
9437 SvCUR_set(sv, p - SvPVX_const(sv));
9445 /* =========================================================================
9447 =head1 Cloning an interpreter
9449 All the macros and functions in this section are for the private use of
9450 the main function, perl_clone().
9452 The foo_dup() functions make an exact copy of an existing foo thinngy.
9453 During the course of a cloning, a hash table is used to map old addresses
9454 to new addresses. The table is created and manipulated with the
9455 ptr_table_* functions.
9459 ============================================================================*/
9462 #if defined(USE_ITHREADS)
9464 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9465 #ifndef GpREFCNT_inc
9466 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9470 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9471 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9472 If this changes, please unmerge ss_dup. */
9473 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9474 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9475 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9476 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9477 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9478 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9479 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9480 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9481 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9482 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9483 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9484 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9485 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9486 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9488 /* clone a parser */
9491 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9498 /* look for it in the table first */
9499 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9503 /* create anew and remember what it is */
9504 Newxz(parser, 1, yy_parser);
9505 ptr_table_store(PL_ptr_table, proto, parser);
9507 parser->yyerrstatus = 0;
9508 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9510 /* XXX these not yet duped */
9511 parser->old_parser = NULL;
9512 parser->stack = NULL;
9514 parser->stack_size = 0;
9515 /* XXX parser->stack->state = 0; */
9517 /* XXX eventually, just Copy() most of the parser struct ? */
9519 parser->lex_brackets = proto->lex_brackets;
9520 parser->lex_casemods = proto->lex_casemods;
9521 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9522 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9523 parser->lex_casestack = savepvn(proto->lex_casestack,
9524 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9525 parser->lex_defer = proto->lex_defer;
9526 parser->lex_dojoin = proto->lex_dojoin;
9527 parser->lex_expect = proto->lex_expect;
9528 parser->lex_formbrack = proto->lex_formbrack;
9529 parser->lex_inpat = proto->lex_inpat;
9530 parser->lex_inwhat = proto->lex_inwhat;
9531 parser->lex_op = proto->lex_op;
9532 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9533 parser->lex_starts = proto->lex_starts;
9534 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9535 parser->multi_close = proto->multi_close;
9536 parser->multi_open = proto->multi_open;
9537 parser->multi_start = proto->multi_start;
9538 parser->pending_ident = proto->pending_ident;
9539 parser->preambled = proto->preambled;
9540 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9543 parser->endwhite = proto->endwhite;
9544 parser->faketokens = proto->faketokens;
9545 parser->lasttoke = proto->lasttoke;
9546 parser->nextwhite = proto->nextwhite;
9547 parser->realtokenstart = proto->realtokenstart;
9548 parser->skipwhite = proto->skipwhite;
9549 parser->thisclose = proto->thisclose;
9550 parser->thismad = proto->thismad;
9551 parser->thisopen = proto->thisopen;
9552 parser->thisstuff = proto->thisstuff;
9553 parser->thistoken = proto->thistoken;
9554 parser->thiswhite = proto->thiswhite;
9560 /* duplicate a file handle */
9563 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9567 PERL_UNUSED_ARG(type);
9570 return (PerlIO*)NULL;
9572 /* look for it in the table first */
9573 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9577 /* create anew and remember what it is */
9578 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9579 ptr_table_store(PL_ptr_table, fp, ret);
9583 /* duplicate a directory handle */
9586 Perl_dirp_dup(pTHX_ DIR *dp)
9588 PERL_UNUSED_CONTEXT;
9595 /* duplicate a typeglob */
9598 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9604 /* look for it in the table first */
9605 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9609 /* create anew and remember what it is */
9611 ptr_table_store(PL_ptr_table, gp, ret);
9614 ret->gp_refcnt = 0; /* must be before any other dups! */
9615 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9616 ret->gp_io = io_dup_inc(gp->gp_io, param);
9617 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9618 ret->gp_av = av_dup_inc(gp->gp_av, param);
9619 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9620 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9621 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9622 ret->gp_cvgen = gp->gp_cvgen;
9623 ret->gp_line = gp->gp_line;
9624 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9628 /* duplicate a chain of magic */
9631 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9633 MAGIC *mgprev = (MAGIC*)NULL;
9636 return (MAGIC*)NULL;
9637 /* look for it in the table first */
9638 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9642 for (; mg; mg = mg->mg_moremagic) {
9644 Newxz(nmg, 1, MAGIC);
9646 mgprev->mg_moremagic = nmg;
9649 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9650 nmg->mg_private = mg->mg_private;
9651 nmg->mg_type = mg->mg_type;
9652 nmg->mg_flags = mg->mg_flags;
9653 if (mg->mg_type == PERL_MAGIC_qr) {
9654 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9656 else if(mg->mg_type == PERL_MAGIC_backref) {
9657 /* The backref AV has its reference count deliberately bumped by
9659 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9661 else if (mg->mg_type == PERL_MAGIC_symtab) {
9662 nmg->mg_obj = mg->mg_obj;
9665 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9666 ? sv_dup_inc(mg->mg_obj, param)
9667 : sv_dup(mg->mg_obj, param);
9669 nmg->mg_len = mg->mg_len;
9670 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9671 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9672 if (mg->mg_len > 0) {
9673 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9674 if (mg->mg_type == PERL_MAGIC_overload_table &&
9675 AMT_AMAGIC((AMT*)mg->mg_ptr))
9677 const AMT * const amtp = (AMT*)mg->mg_ptr;
9678 AMT * const namtp = (AMT*)nmg->mg_ptr;
9680 for (i = 1; i < NofAMmeth; i++) {
9681 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9685 else if (mg->mg_len == HEf_SVKEY)
9686 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9688 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9689 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9696 #endif /* USE_ITHREADS */
9698 /* create a new pointer-mapping table */
9701 Perl_ptr_table_new(pTHX)
9704 PERL_UNUSED_CONTEXT;
9706 Newxz(tbl, 1, PTR_TBL_t);
9709 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9713 #define PTR_TABLE_HASH(ptr) \
9714 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9717 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9718 following define) and at call to new_body_inline made below in
9719 Perl_ptr_table_store()
9722 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9724 /* map an existing pointer using a table */
9726 STATIC PTR_TBL_ENT_t *
9727 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9728 PTR_TBL_ENT_t *tblent;
9729 const UV hash = PTR_TABLE_HASH(sv);
9731 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9732 for (; tblent; tblent = tblent->next) {
9733 if (tblent->oldval == sv)
9740 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9742 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9743 PERL_UNUSED_CONTEXT;
9744 return tblent ? tblent->newval : NULL;
9747 /* add a new entry to a pointer-mapping table */
9750 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9752 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9753 PERL_UNUSED_CONTEXT;
9756 tblent->newval = newsv;
9758 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9760 new_body_inline(tblent, PTE_SVSLOT);
9762 tblent->oldval = oldsv;
9763 tblent->newval = newsv;
9764 tblent->next = tbl->tbl_ary[entry];
9765 tbl->tbl_ary[entry] = tblent;
9767 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9768 ptr_table_split(tbl);
9772 /* double the hash bucket size of an existing ptr table */
9775 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9777 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9778 const UV oldsize = tbl->tbl_max + 1;
9779 UV newsize = oldsize * 2;
9781 PERL_UNUSED_CONTEXT;
9783 Renew(ary, newsize, PTR_TBL_ENT_t*);
9784 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9785 tbl->tbl_max = --newsize;
9787 for (i=0; i < oldsize; i++, ary++) {
9788 PTR_TBL_ENT_t **curentp, **entp, *ent;
9791 curentp = ary + oldsize;
9792 for (entp = ary, ent = *ary; ent; ent = *entp) {
9793 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9795 ent->next = *curentp;
9805 /* remove all the entries from a ptr table */
9808 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9810 if (tbl && tbl->tbl_items) {
9811 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9812 UV riter = tbl->tbl_max;
9815 PTR_TBL_ENT_t *entry = array[riter];
9818 PTR_TBL_ENT_t * const oentry = entry;
9819 entry = entry->next;
9828 /* clear and free a ptr table */
9831 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9836 ptr_table_clear(tbl);
9837 Safefree(tbl->tbl_ary);
9841 #if defined(USE_ITHREADS)
9844 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9847 SvRV_set(dstr, SvWEAKREF(sstr)
9848 ? sv_dup(SvRV(sstr), param)
9849 : sv_dup_inc(SvRV(sstr), param));
9852 else if (SvPVX_const(sstr)) {
9853 /* Has something there */
9855 /* Normal PV - clone whole allocated space */
9856 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9857 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9858 /* Not that normal - actually sstr is copy on write.
9859 But we are a true, independant SV, so: */
9860 SvREADONLY_off(dstr);
9865 /* Special case - not normally malloced for some reason */
9866 if (isGV_with_GP(sstr)) {
9867 /* Don't need to do anything here. */
9869 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9870 /* A "shared" PV - clone it as "shared" PV */
9872 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9876 /* Some other special case - random pointer */
9877 SvPV_set(dstr, SvPVX(sstr));
9883 if (SvTYPE(dstr) == SVt_RV)
9884 SvRV_set(dstr, NULL);
9886 SvPV_set(dstr, NULL);
9890 /* duplicate an SV of any type (including AV, HV etc) */
9893 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9898 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9900 /* look for it in the table first */
9901 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9905 if(param->flags & CLONEf_JOIN_IN) {
9906 /** We are joining here so we don't want do clone
9907 something that is bad **/
9908 if (SvTYPE(sstr) == SVt_PVHV) {
9909 const char * const hvname = HvNAME_get(sstr);
9911 /** don't clone stashes if they already exist **/
9912 return (SV*)gv_stashpv(hvname,0);
9916 /* create anew and remember what it is */
9919 #ifdef DEBUG_LEAKING_SCALARS
9920 dstr->sv_debug_optype = sstr->sv_debug_optype;
9921 dstr->sv_debug_line = sstr->sv_debug_line;
9922 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9923 dstr->sv_debug_cloned = 1;
9924 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9927 ptr_table_store(PL_ptr_table, sstr, dstr);
9930 SvFLAGS(dstr) = SvFLAGS(sstr);
9931 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9932 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9935 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9936 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9937 (void*)PL_watch_pvx, SvPVX_const(sstr));
9940 /* don't clone objects whose class has asked us not to */
9941 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9942 SvFLAGS(dstr) &= ~SVTYPEMASK;
9947 switch (SvTYPE(sstr)) {
9952 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9953 SvIV_set(dstr, SvIVX(sstr));
9956 SvANY(dstr) = new_XNV();
9957 SvNV_set(dstr, SvNVX(sstr));
9960 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9961 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9963 /* case SVt_BIND: */
9966 /* These are all the types that need complex bodies allocating. */
9968 const svtype sv_type = SvTYPE(sstr);
9969 const struct body_details *const sv_type_details
9970 = bodies_by_type + sv_type;
9974 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9978 if (GvUNIQUE((GV*)sstr)) {
9979 NOOP; /* Do sharing here, and fall through */
9991 assert(sv_type_details->body_size);
9992 if (sv_type_details->arena) {
9993 new_body_inline(new_body, sv_type);
9995 = (void*)((char*)new_body - sv_type_details->offset);
9997 new_body = new_NOARENA(sv_type_details);
10001 SvANY(dstr) = new_body;
10004 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10005 ((char*)SvANY(dstr)) + sv_type_details->offset,
10006 sv_type_details->copy, char);
10008 Copy(((char*)SvANY(sstr)),
10009 ((char*)SvANY(dstr)),
10010 sv_type_details->body_size + sv_type_details->offset, char);
10013 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10014 && !isGV_with_GP(dstr))
10015 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10017 /* The Copy above means that all the source (unduplicated) pointers
10018 are now in the destination. We can check the flags and the
10019 pointers in either, but it's possible that there's less cache
10020 missing by always going for the destination.
10021 FIXME - instrument and check that assumption */
10022 if (sv_type >= SVt_PVMG) {
10023 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10024 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10025 } else if (SvMAGIC(dstr))
10026 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10028 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10031 /* The cast silences a GCC warning about unhandled types. */
10032 switch ((int)sv_type) {
10042 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10043 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10044 LvTARG(dstr) = dstr;
10045 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10046 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10048 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10051 if(isGV_with_GP(sstr)) {
10052 if (GvNAME_HEK(dstr))
10053 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10056 /* Don't call sv_add_backref here as it's going to be created
10057 as part of the magic cloning of the symbol table. */
10059 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10060 if(isGV_with_GP(sstr)) {
10061 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10062 at the point of this comment. */
10063 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10064 (void)GpREFCNT_inc(GvGP(dstr));
10066 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10069 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10070 if (IoOFP(dstr) == IoIFP(sstr))
10071 IoOFP(dstr) = IoIFP(dstr);
10073 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10074 /* PL_rsfp_filters entries have fake IoDIRP() */
10075 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10076 /* I have no idea why fake dirp (rsfps)
10077 should be treated differently but otherwise
10078 we end up with leaks -- sky*/
10079 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10080 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10081 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10083 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10084 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10085 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10086 if (IoDIRP(dstr)) {
10087 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10090 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10093 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10094 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10095 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10098 if (AvARRAY((AV*)sstr)) {
10099 SV **dst_ary, **src_ary;
10100 SSize_t items = AvFILLp((AV*)sstr) + 1;
10102 src_ary = AvARRAY((AV*)sstr);
10103 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10104 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10105 AvARRAY((AV*)dstr) = dst_ary;
10106 AvALLOC((AV*)dstr) = dst_ary;
10107 if (AvREAL((AV*)sstr)) {
10108 while (items-- > 0)
10109 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10112 while (items-- > 0)
10113 *dst_ary++ = sv_dup(*src_ary++, param);
10115 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10116 while (items-- > 0) {
10117 *dst_ary++ = &PL_sv_undef;
10121 AvARRAY((AV*)dstr) = NULL;
10122 AvALLOC((AV*)dstr) = (SV**)NULL;
10126 if (HvARRAY((HV*)sstr)) {
10128 const bool sharekeys = !!HvSHAREKEYS(sstr);
10129 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10130 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10132 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10133 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10135 HvARRAY(dstr) = (HE**)darray;
10136 while (i <= sxhv->xhv_max) {
10137 const HE * const source = HvARRAY(sstr)[i];
10138 HvARRAY(dstr)[i] = source
10139 ? he_dup(source, sharekeys, param) : 0;
10144 const struct xpvhv_aux * const saux = HvAUX(sstr);
10145 struct xpvhv_aux * const daux = HvAUX(dstr);
10146 /* This flag isn't copied. */
10147 /* SvOOK_on(hv) attacks the IV flags. */
10148 SvFLAGS(dstr) |= SVf_OOK;
10150 hvname = saux->xhv_name;
10151 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10153 daux->xhv_riter = saux->xhv_riter;
10154 daux->xhv_eiter = saux->xhv_eiter
10155 ? he_dup(saux->xhv_eiter,
10156 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10157 daux->xhv_backreferences =
10158 saux->xhv_backreferences
10159 ? (AV*) SvREFCNT_inc(
10160 sv_dup((SV*)saux->xhv_backreferences, param))
10162 /* Record stashes for possible cloning in Perl_clone(). */
10164 av_push(param->stashes, dstr);
10168 HvARRAY((HV*)dstr) = NULL;
10171 if (!(param->flags & CLONEf_COPY_STACKS)) {
10175 /* NOTE: not refcounted */
10176 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10178 if (!CvISXSUB(dstr))
10179 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10181 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10182 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10183 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10184 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10186 /* don't dup if copying back - CvGV isn't refcounted, so the
10187 * duped GV may never be freed. A bit of a hack! DAPM */
10188 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10189 NULL : gv_dup(CvGV(dstr), param) ;
10190 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10192 CvWEAKOUTSIDE(sstr)
10193 ? cv_dup( CvOUTSIDE(dstr), param)
10194 : cv_dup_inc(CvOUTSIDE(dstr), param);
10195 if (!CvISXSUB(dstr))
10196 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10202 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10208 /* duplicate a context */
10211 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10213 PERL_CONTEXT *ncxs;
10216 return (PERL_CONTEXT*)NULL;
10218 /* look for it in the table first */
10219 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10223 /* create anew and remember what it is */
10224 Newxz(ncxs, max + 1, PERL_CONTEXT);
10225 ptr_table_store(PL_ptr_table, cxs, ncxs);
10228 PERL_CONTEXT * const cx = &cxs[ix];
10229 PERL_CONTEXT * const ncx = &ncxs[ix];
10230 ncx->cx_type = cx->cx_type;
10231 if (CxTYPE(cx) == CXt_SUBST) {
10232 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10235 ncx->blk_oldsp = cx->blk_oldsp;
10236 ncx->blk_oldcop = cx->blk_oldcop;
10237 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10238 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10239 ncx->blk_oldpm = cx->blk_oldpm;
10240 ncx->blk_gimme = cx->blk_gimme;
10241 switch (CxTYPE(cx)) {
10243 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10244 ? cv_dup_inc(cx->blk_sub.cv, param)
10245 : cv_dup(cx->blk_sub.cv,param));
10246 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10247 ? av_dup_inc(cx->blk_sub.argarray, param)
10249 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10250 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10251 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10252 ncx->blk_sub.lval = cx->blk_sub.lval;
10253 ncx->blk_sub.retop = cx->blk_sub.retop;
10254 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10255 cx->blk_sub.oldcomppad);
10258 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10259 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10260 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10261 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10262 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10263 ncx->blk_eval.retop = cx->blk_eval.retop;
10266 ncx->blk_loop.label = cx->blk_loop.label;
10267 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10268 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10269 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10270 ? cx->blk_loop.iterdata
10271 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10272 ncx->blk_loop.oldcomppad
10273 = (PAD*)ptr_table_fetch(PL_ptr_table,
10274 cx->blk_loop.oldcomppad);
10275 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10276 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10277 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10278 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10279 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10282 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10283 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10284 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10285 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10286 ncx->blk_sub.retop = cx->blk_sub.retop;
10298 /* duplicate a stack info structure */
10301 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10306 return (PERL_SI*)NULL;
10308 /* look for it in the table first */
10309 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10313 /* create anew and remember what it is */
10314 Newxz(nsi, 1, PERL_SI);
10315 ptr_table_store(PL_ptr_table, si, nsi);
10317 nsi->si_stack = av_dup_inc(si->si_stack, param);
10318 nsi->si_cxix = si->si_cxix;
10319 nsi->si_cxmax = si->si_cxmax;
10320 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10321 nsi->si_type = si->si_type;
10322 nsi->si_prev = si_dup(si->si_prev, param);
10323 nsi->si_next = si_dup(si->si_next, param);
10324 nsi->si_markoff = si->si_markoff;
10329 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10330 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10331 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10332 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10333 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10334 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10335 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10336 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10337 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10338 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10339 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10340 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10341 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10342 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10345 #define pv_dup_inc(p) SAVEPV(p)
10346 #define pv_dup(p) SAVEPV(p)
10347 #define svp_dup_inc(p,pp) any_dup(p,pp)
10349 /* map any object to the new equivent - either something in the
10350 * ptr table, or something in the interpreter structure
10354 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10359 return (void*)NULL;
10361 /* look for it in the table first */
10362 ret = ptr_table_fetch(PL_ptr_table, v);
10366 /* see if it is part of the interpreter structure */
10367 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10368 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10376 /* duplicate the save stack */
10379 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10382 ANY * const ss = proto_perl->Tsavestack;
10383 const I32 max = proto_perl->Tsavestack_max;
10384 I32 ix = proto_perl->Tsavestack_ix;
10397 void (*dptr) (void*);
10398 void (*dxptr) (pTHX_ void*);
10400 Newxz(nss, max, ANY);
10403 const I32 type = POPINT(ss,ix);
10404 TOPINT(nss,ix) = type;
10406 case SAVEt_HELEM: /* hash element */
10407 sv = (SV*)POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10410 case SAVEt_ITEM: /* normal string */
10411 case SAVEt_SV: /* scalar reference */
10412 sv = (SV*)POPPTR(ss,ix);
10413 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10416 case SAVEt_MORTALIZESV:
10417 sv = (SV*)POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10420 case SAVEt_SHARED_PVREF: /* char* in shared space */
10421 c = (char*)POPPTR(ss,ix);
10422 TOPPTR(nss,ix) = savesharedpv(c);
10423 ptr = POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10426 case SAVEt_GENERIC_SVREF: /* generic sv */
10427 case SAVEt_SVREF: /* scalar reference */
10428 sv = (SV*)POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10430 ptr = POPPTR(ss,ix);
10431 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10433 case SAVEt_HV: /* hash reference */
10434 case SAVEt_AV: /* array reference */
10435 sv = (SV*) POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10438 case SAVEt_COMPPAD:
10440 sv = (SV*) POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = sv_dup(sv, param);
10443 case SAVEt_INT: /* int reference */
10444 ptr = POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 intval = (int)POPINT(ss,ix);
10447 TOPINT(nss,ix) = intval;
10449 case SAVEt_LONG: /* long reference */
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10453 case SAVEt_CLEARSV:
10454 longval = (long)POPLONG(ss,ix);
10455 TOPLONG(nss,ix) = longval;
10457 case SAVEt_I32: /* I32 reference */
10458 case SAVEt_I16: /* I16 reference */
10459 case SAVEt_I8: /* I8 reference */
10460 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 TOPINT(nss,ix) = i;
10466 case SAVEt_IV: /* IV reference */
10467 ptr = POPPTR(ss,ix);
10468 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10470 TOPIV(nss,ix) = iv;
10472 case SAVEt_HPTR: /* HV* reference */
10473 case SAVEt_APTR: /* AV* reference */
10474 case SAVEt_SPTR: /* SV* reference */
10475 ptr = POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 sv = (SV*)POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = sv_dup(sv, param);
10480 case SAVEt_VPTR: /* random* reference */
10481 ptr = POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10483 ptr = POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 case SAVEt_GENERIC_PVREF: /* generic char* */
10487 case SAVEt_PPTR: /* char* reference */
10488 ptr = POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10490 c = (char*)POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = pv_dup(c);
10493 case SAVEt_GP: /* scalar reference */
10494 gp = (GP*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10496 (void)GpREFCNT_inc(gp);
10497 gv = (GV*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10501 ptr = POPPTR(ss,ix);
10502 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10503 /* these are assumed to be refcounted properly */
10505 switch (((OP*)ptr)->op_type) {
10507 case OP_LEAVESUBLV:
10511 case OP_LEAVEWRITE:
10512 TOPPTR(nss,ix) = ptr;
10519 TOPPTR(nss,ix) = NULL;
10524 TOPPTR(nss,ix) = NULL;
10527 c = (char*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = pv_dup_inc(c);
10531 hv = (HV*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10533 c = (char*)POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = pv_dup_inc(c);
10536 case SAVEt_STACK_POS: /* Position on Perl stack */
10538 TOPINT(nss,ix) = i;
10540 case SAVEt_DESTRUCTOR:
10541 ptr = POPPTR(ss,ix);
10542 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10543 dptr = POPDPTR(ss,ix);
10544 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10545 any_dup(FPTR2DPTR(void *, dptr),
10548 case SAVEt_DESTRUCTOR_X:
10549 ptr = POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10551 dxptr = POPDXPTR(ss,ix);
10552 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10553 any_dup(FPTR2DPTR(void *, dxptr),
10556 case SAVEt_REGCONTEXT:
10559 TOPINT(nss,ix) = i;
10562 case SAVEt_AELEM: /* array element */
10563 sv = (SV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10566 TOPINT(nss,ix) = i;
10567 av = (AV*)POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = av_dup_inc(av, param);
10571 ptr = POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = ptr;
10576 TOPINT(nss,ix) = i;
10577 ptr = POPPTR(ss,ix);
10580 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10581 HINTS_REFCNT_UNLOCK;
10583 TOPPTR(nss,ix) = ptr;
10584 if (i & HINT_LOCALIZE_HH) {
10585 hv = (HV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10590 longval = (long)POPLONG(ss,ix);
10591 TOPLONG(nss,ix) = longval;
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10594 sv = (SV*)POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = sv_dup(sv, param);
10598 ptr = POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600 longval = (long)POPBOOL(ss,ix);
10601 TOPBOOL(nss,ix) = (bool)longval;
10603 case SAVEt_SET_SVFLAGS:
10605 TOPINT(nss,ix) = i;
10607 TOPINT(nss,ix) = i;
10608 sv = (SV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = sv_dup(sv, param);
10611 case SAVEt_RE_STATE:
10613 const struct re_save_state *const old_state
10614 = (struct re_save_state *)
10615 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10616 struct re_save_state *const new_state
10617 = (struct re_save_state *)
10618 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10620 Copy(old_state, new_state, 1, struct re_save_state);
10621 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10623 new_state->re_state_bostr
10624 = pv_dup(old_state->re_state_bostr);
10625 new_state->re_state_reginput
10626 = pv_dup(old_state->re_state_reginput);
10627 new_state->re_state_regeol
10628 = pv_dup(old_state->re_state_regeol);
10629 new_state->re_state_regstartp
10630 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10631 new_state->re_state_regendp
10632 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10633 new_state->re_state_reglastparen
10634 = (U32*) any_dup(old_state->re_state_reglastparen,
10636 new_state->re_state_reglastcloseparen
10637 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10639 /* XXX This just has to be broken. The old save_re_context
10640 code did SAVEGENERICPV(PL_reg_start_tmp);
10641 PL_reg_start_tmp is char **.
10642 Look above to what the dup code does for
10643 SAVEt_GENERIC_PVREF
10644 It can never have worked.
10645 So this is merely a faithful copy of the exiting bug: */
10646 new_state->re_state_reg_start_tmp
10647 = (char **) pv_dup((char *)
10648 old_state->re_state_reg_start_tmp);
10649 /* I assume that it only ever "worked" because no-one called
10650 (pseudo)fork while the regexp engine had re-entered itself.
10652 #ifdef PERL_OLD_COPY_ON_WRITE
10653 new_state->re_state_nrs
10654 = sv_dup(old_state->re_state_nrs, param);
10656 new_state->re_state_reg_magic
10657 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10659 new_state->re_state_reg_oldcurpm
10660 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10662 new_state->re_state_reg_curpm
10663 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10665 new_state->re_state_reg_oldsaved
10666 = pv_dup(old_state->re_state_reg_oldsaved);
10667 new_state->re_state_reg_poscache
10668 = pv_dup(old_state->re_state_reg_poscache);
10669 new_state->re_state_reg_starttry
10670 = pv_dup(old_state->re_state_reg_starttry);
10673 case SAVEt_COMPILE_WARNINGS:
10674 ptr = POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10678 ptr = POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = parser_dup(ptr, param);
10683 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10691 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10692 * flag to the result. This is done for each stash before cloning starts,
10693 * so we know which stashes want their objects cloned */
10696 do_mark_cloneable_stash(pTHX_ SV *sv)
10698 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10700 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10701 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10702 if (cloner && GvCV(cloner)) {
10709 XPUSHs(sv_2mortal(newSVhek(hvname)));
10711 call_sv((SV*)GvCV(cloner), G_SCALAR);
10718 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10726 =for apidoc perl_clone
10728 Create and return a new interpreter by cloning the current one.
10730 perl_clone takes these flags as parameters:
10732 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10733 without it we only clone the data and zero the stacks,
10734 with it we copy the stacks and the new perl interpreter is
10735 ready to run at the exact same point as the previous one.
10736 The pseudo-fork code uses COPY_STACKS while the
10737 threads->new doesn't.
10739 CLONEf_KEEP_PTR_TABLE
10740 perl_clone keeps a ptr_table with the pointer of the old
10741 variable as a key and the new variable as a value,
10742 this allows it to check if something has been cloned and not
10743 clone it again but rather just use the value and increase the
10744 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10745 the ptr_table using the function
10746 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10747 reason to keep it around is if you want to dup some of your own
10748 variable who are outside the graph perl scans, example of this
10749 code is in threads.xs create
10752 This is a win32 thing, it is ignored on unix, it tells perls
10753 win32host code (which is c++) to clone itself, this is needed on
10754 win32 if you want to run two threads at the same time,
10755 if you just want to do some stuff in a separate perl interpreter
10756 and then throw it away and return to the original one,
10757 you don't need to do anything.
10762 /* XXX the above needs expanding by someone who actually understands it ! */
10763 EXTERN_C PerlInterpreter *
10764 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10767 perl_clone(PerlInterpreter *proto_perl, UV flags)
10770 #ifdef PERL_IMPLICIT_SYS
10772 /* perlhost.h so we need to call into it
10773 to clone the host, CPerlHost should have a c interface, sky */
10775 if (flags & CLONEf_CLONE_HOST) {
10776 return perl_clone_host(proto_perl,flags);
10778 return perl_clone_using(proto_perl, flags,
10780 proto_perl->IMemShared,
10781 proto_perl->IMemParse,
10783 proto_perl->IStdIO,
10787 proto_perl->IProc);
10791 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10792 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10793 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10794 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10795 struct IPerlDir* ipD, struct IPerlSock* ipS,
10796 struct IPerlProc* ipP)
10798 /* XXX many of the string copies here can be optimized if they're
10799 * constants; they need to be allocated as common memory and just
10800 * their pointers copied. */
10803 CLONE_PARAMS clone_params;
10804 CLONE_PARAMS* const param = &clone_params;
10806 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10807 /* for each stash, determine whether its objects should be cloned */
10808 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10809 PERL_SET_THX(my_perl);
10812 PoisonNew(my_perl, 1, PerlInterpreter);
10818 PL_savestack_ix = 0;
10819 PL_savestack_max = -1;
10820 PL_sig_pending = 0;
10821 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10822 # else /* !DEBUGGING */
10823 Zero(my_perl, 1, PerlInterpreter);
10824 # endif /* DEBUGGING */
10826 /* host pointers */
10828 PL_MemShared = ipMS;
10829 PL_MemParse = ipMP;
10836 #else /* !PERL_IMPLICIT_SYS */
10838 CLONE_PARAMS clone_params;
10839 CLONE_PARAMS* param = &clone_params;
10840 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10841 /* for each stash, determine whether its objects should be cloned */
10842 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10843 PERL_SET_THX(my_perl);
10846 PoisonNew(my_perl, 1, PerlInterpreter);
10852 PL_savestack_ix = 0;
10853 PL_savestack_max = -1;
10854 PL_sig_pending = 0;
10855 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10856 # else /* !DEBUGGING */
10857 Zero(my_perl, 1, PerlInterpreter);
10858 # endif /* DEBUGGING */
10859 #endif /* PERL_IMPLICIT_SYS */
10860 param->flags = flags;
10861 param->proto_perl = proto_perl;
10863 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10865 PL_body_arenas = NULL;
10866 Zero(&PL_body_roots, 1, PL_body_roots);
10868 PL_nice_chunk = NULL;
10869 PL_nice_chunk_size = 0;
10871 PL_sv_objcount = 0;
10873 PL_sv_arenaroot = NULL;
10875 PL_debug = proto_perl->Idebug;
10877 PL_hash_seed = proto_perl->Ihash_seed;
10878 PL_rehash_seed = proto_perl->Irehash_seed;
10880 #ifdef USE_REENTRANT_API
10881 /* XXX: things like -Dm will segfault here in perlio, but doing
10882 * PERL_SET_CONTEXT(proto_perl);
10883 * breaks too many other things
10885 Perl_reentrant_init(aTHX);
10888 /* create SV map for pointer relocation */
10889 PL_ptr_table = ptr_table_new();
10891 /* initialize these special pointers as early as possible */
10892 SvANY(&PL_sv_undef) = NULL;
10893 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10894 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10895 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10897 SvANY(&PL_sv_no) = new_XPVNV();
10898 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10899 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10900 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10901 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10902 SvCUR_set(&PL_sv_no, 0);
10903 SvLEN_set(&PL_sv_no, 1);
10904 SvIV_set(&PL_sv_no, 0);
10905 SvNV_set(&PL_sv_no, 0);
10906 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10908 SvANY(&PL_sv_yes) = new_XPVNV();
10909 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10910 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10911 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10912 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10913 SvCUR_set(&PL_sv_yes, 1);
10914 SvLEN_set(&PL_sv_yes, 2);
10915 SvIV_set(&PL_sv_yes, 1);
10916 SvNV_set(&PL_sv_yes, 1);
10917 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10919 /* create (a non-shared!) shared string table */
10920 PL_strtab = newHV();
10921 HvSHAREKEYS_off(PL_strtab);
10922 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10923 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10925 PL_compiling = proto_perl->Icompiling;
10927 /* These two PVs will be free'd special way so must set them same way op.c does */
10928 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10929 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10931 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10932 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10934 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10935 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10936 if (PL_compiling.cop_hints_hash) {
10938 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10939 HINTS_REFCNT_UNLOCK;
10941 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10943 /* pseudo environmental stuff */
10944 PL_origargc = proto_perl->Iorigargc;
10945 PL_origargv = proto_perl->Iorigargv;
10947 param->stashes = newAV(); /* Setup array of objects to call clone on */
10949 /* Set tainting stuff before PerlIO_debug can possibly get called */
10950 PL_tainting = proto_perl->Itainting;
10951 PL_taint_warn = proto_perl->Itaint_warn;
10953 #ifdef PERLIO_LAYERS
10954 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10955 PerlIO_clone(aTHX_ proto_perl, param);
10958 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10959 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10960 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10961 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10962 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10963 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10966 PL_minus_c = proto_perl->Iminus_c;
10967 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10968 PL_localpatches = proto_perl->Ilocalpatches;
10969 PL_splitstr = proto_perl->Isplitstr;
10970 PL_preprocess = proto_perl->Ipreprocess;
10971 PL_minus_n = proto_perl->Iminus_n;
10972 PL_minus_p = proto_perl->Iminus_p;
10973 PL_minus_l = proto_perl->Iminus_l;
10974 PL_minus_a = proto_perl->Iminus_a;
10975 PL_minus_E = proto_perl->Iminus_E;
10976 PL_minus_F = proto_perl->Iminus_F;
10977 PL_doswitches = proto_perl->Idoswitches;
10978 PL_dowarn = proto_perl->Idowarn;
10979 PL_doextract = proto_perl->Idoextract;
10980 PL_sawampersand = proto_perl->Isawampersand;
10981 PL_unsafe = proto_perl->Iunsafe;
10982 PL_inplace = SAVEPV(proto_perl->Iinplace);
10983 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10984 PL_perldb = proto_perl->Iperldb;
10985 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10986 PL_exit_flags = proto_perl->Iexit_flags;
10988 /* magical thingies */
10989 /* XXX time(&PL_basetime) when asked for? */
10990 PL_basetime = proto_perl->Ibasetime;
10991 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10993 PL_maxsysfd = proto_perl->Imaxsysfd;
10994 PL_statusvalue = proto_perl->Istatusvalue;
10996 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10998 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11000 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11002 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11003 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11004 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11007 /* RE engine related */
11008 Zero(&PL_reg_state, 1, struct re_save_state);
11009 PL_reginterp_cnt = 0;
11010 PL_regmatch_slab = NULL;
11012 /* Clone the regex array */
11013 PL_regex_padav = newAV();
11015 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11016 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11018 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11019 for(i = 1; i <= len; i++) {
11020 const SV * const regex = regexen[i];
11023 ? sv_dup_inc(regex, param)
11025 newSViv(PTR2IV(CALLREGDUPE(
11026 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11028 if (SvFLAGS(regex) & SVf_BREAK)
11029 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11030 av_push(PL_regex_padav, sv);
11033 PL_regex_pad = AvARRAY(PL_regex_padav);
11035 /* shortcuts to various I/O objects */
11036 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11037 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11038 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11039 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11040 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11041 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11043 /* shortcuts to regexp stuff */
11044 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11046 /* shortcuts to misc objects */
11047 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11049 /* shortcuts to debugging objects */
11050 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11051 PL_DBline = gv_dup(proto_perl->IDBline, param);
11052 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11053 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11054 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11055 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11056 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11057 PL_lineary = av_dup(proto_perl->Ilineary, param);
11058 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11060 /* symbol tables */
11061 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11062 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11063 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11064 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11065 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11067 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11068 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11069 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11070 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11071 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11072 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11073 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11074 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11076 PL_sub_generation = proto_perl->Isub_generation;
11078 /* funky return mechanisms */
11079 PL_forkprocess = proto_perl->Iforkprocess;
11081 /* subprocess state */
11082 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11084 /* internal state */
11085 PL_maxo = proto_perl->Imaxo;
11086 if (proto_perl->Iop_mask)
11087 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11090 /* PL_asserting = proto_perl->Iasserting; */
11092 /* current interpreter roots */
11093 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11095 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11097 PL_main_start = proto_perl->Imain_start;
11098 PL_eval_root = proto_perl->Ieval_root;
11099 PL_eval_start = proto_perl->Ieval_start;
11101 /* runtime control stuff */
11102 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11103 PL_copline = proto_perl->Icopline;
11105 PL_filemode = proto_perl->Ifilemode;
11106 PL_lastfd = proto_perl->Ilastfd;
11107 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11110 PL_gensym = proto_perl->Igensym;
11111 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11112 PL_laststatval = proto_perl->Ilaststatval;
11113 PL_laststype = proto_perl->Ilaststype;
11116 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11118 /* interpreter atexit processing */
11119 PL_exitlistlen = proto_perl->Iexitlistlen;
11120 if (PL_exitlistlen) {
11121 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11122 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11125 PL_exitlist = (PerlExitListEntry*)NULL;
11127 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11128 if (PL_my_cxt_size) {
11129 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11130 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11131 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11132 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11133 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11137 PL_my_cxt_list = (void**)NULL;
11138 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11139 PL_my_cxt_keys = (void**)NULL;
11142 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11143 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11144 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11146 PL_profiledata = NULL;
11147 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11148 /* PL_rsfp_filters entries have fake IoDIRP() */
11149 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11151 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11153 PAD_CLONE_VARS(proto_perl, param);
11155 #ifdef HAVE_INTERP_INTERN
11156 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11159 /* more statics moved here */
11160 PL_generation = proto_perl->Igeneration;
11161 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11163 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11164 PL_in_clean_all = proto_perl->Iin_clean_all;
11166 PL_uid = proto_perl->Iuid;
11167 PL_euid = proto_perl->Ieuid;
11168 PL_gid = proto_perl->Igid;
11169 PL_egid = proto_perl->Iegid;
11170 PL_nomemok = proto_perl->Inomemok;
11171 PL_an = proto_perl->Ian;
11172 PL_evalseq = proto_perl->Ievalseq;
11173 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11174 PL_origalen = proto_perl->Iorigalen;
11175 #ifdef PERL_USES_PL_PIDSTATUS
11176 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11178 PL_osname = SAVEPV(proto_perl->Iosname);
11179 PL_sighandlerp = proto_perl->Isighandlerp;
11181 PL_runops = proto_perl->Irunops;
11183 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11186 PL_cshlen = proto_perl->Icshlen;
11187 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11190 PL_parser = parser_dup(proto_perl->Iparser, param);
11192 PL_lex_state = proto_perl->Ilex_state;
11195 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11196 PL_curforce = proto_perl->Icurforce;
11198 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11199 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11200 PL_nexttoke = proto_perl->Inexttoke;
11203 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11204 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11205 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11206 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11207 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11208 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11209 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11210 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11211 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11214 PL_expect = proto_perl->Iexpect;
11216 PL_multi_end = proto_perl->Imulti_end;
11218 PL_error_count = proto_perl->Ierror_count;
11219 PL_subline = proto_perl->Isubline;
11220 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11222 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11223 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11224 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11225 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11226 PL_last_lop_op = proto_perl->Ilast_lop_op;
11227 PL_in_my = proto_perl->Iin_my;
11228 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11230 PL_cryptseen = proto_perl->Icryptseen;
11233 PL_hints = proto_perl->Ihints;
11235 PL_amagic_generation = proto_perl->Iamagic_generation;
11237 #ifdef USE_LOCALE_COLLATE
11238 PL_collation_ix = proto_perl->Icollation_ix;
11239 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11240 PL_collation_standard = proto_perl->Icollation_standard;
11241 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11242 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11243 #endif /* USE_LOCALE_COLLATE */
11245 #ifdef USE_LOCALE_NUMERIC
11246 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11247 PL_numeric_standard = proto_perl->Inumeric_standard;
11248 PL_numeric_local = proto_perl->Inumeric_local;
11249 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11250 #endif /* !USE_LOCALE_NUMERIC */
11252 /* utf8 character classes */
11253 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11254 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11255 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11256 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11257 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11258 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11259 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11260 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11261 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11262 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11263 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11264 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11265 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11266 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11267 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11268 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11269 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11270 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11271 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11272 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11274 /* Did the locale setup indicate UTF-8? */
11275 PL_utf8locale = proto_perl->Iutf8locale;
11276 /* Unicode features (see perlrun/-C) */
11277 PL_unicode = proto_perl->Iunicode;
11279 /* Pre-5.8 signals control */
11280 PL_signals = proto_perl->Isignals;
11282 /* times() ticks per second */
11283 PL_clocktick = proto_perl->Iclocktick;
11285 /* Recursion stopper for PerlIO_find_layer */
11286 PL_in_load_module = proto_perl->Iin_load_module;
11288 /* sort() routine */
11289 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11291 /* Not really needed/useful since the reenrant_retint is "volatile",
11292 * but do it for consistency's sake. */
11293 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11295 /* Hooks to shared SVs and locks. */
11296 PL_sharehook = proto_perl->Isharehook;
11297 PL_lockhook = proto_perl->Ilockhook;
11298 PL_unlockhook = proto_perl->Iunlockhook;
11299 PL_threadhook = proto_perl->Ithreadhook;
11301 PL_runops_std = proto_perl->Irunops_std;
11302 PL_runops_dbg = proto_perl->Irunops_dbg;
11304 #ifdef THREADS_HAVE_PIDS
11305 PL_ppid = proto_perl->Ippid;
11309 PL_last_swash_hv = NULL; /* reinits on demand */
11310 PL_last_swash_klen = 0;
11311 PL_last_swash_key[0]= '\0';
11312 PL_last_swash_tmps = (U8*)NULL;
11313 PL_last_swash_slen = 0;
11315 PL_glob_index = proto_perl->Iglob_index;
11316 PL_srand_called = proto_perl->Isrand_called;
11317 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11318 PL_bitcount = NULL; /* reinits on demand */
11320 if (proto_perl->Ipsig_pend) {
11321 Newxz(PL_psig_pend, SIG_SIZE, int);
11324 PL_psig_pend = (int*)NULL;
11327 if (proto_perl->Ipsig_ptr) {
11328 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11329 Newxz(PL_psig_name, SIG_SIZE, SV*);
11330 for (i = 1; i < SIG_SIZE; i++) {
11331 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11332 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11336 PL_psig_ptr = (SV**)NULL;
11337 PL_psig_name = (SV**)NULL;
11340 /* thrdvar.h stuff */
11342 if (flags & CLONEf_COPY_STACKS) {
11343 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11344 PL_tmps_ix = proto_perl->Ttmps_ix;
11345 PL_tmps_max = proto_perl->Ttmps_max;
11346 PL_tmps_floor = proto_perl->Ttmps_floor;
11347 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11349 while (i <= PL_tmps_ix) {
11350 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11354 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11355 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11356 Newxz(PL_markstack, i, I32);
11357 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11358 - proto_perl->Tmarkstack);
11359 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11360 - proto_perl->Tmarkstack);
11361 Copy(proto_perl->Tmarkstack, PL_markstack,
11362 PL_markstack_ptr - PL_markstack + 1, I32);
11364 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11365 * NOTE: unlike the others! */
11366 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11367 PL_scopestack_max = proto_perl->Tscopestack_max;
11368 Newxz(PL_scopestack, PL_scopestack_max, I32);
11369 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11371 /* NOTE: si_dup() looks at PL_markstack */
11372 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11374 /* PL_curstack = PL_curstackinfo->si_stack; */
11375 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11376 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11378 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11379 PL_stack_base = AvARRAY(PL_curstack);
11380 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11381 - proto_perl->Tstack_base);
11382 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11384 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11385 * NOTE: unlike the others! */
11386 PL_savestack_ix = proto_perl->Tsavestack_ix;
11387 PL_savestack_max = proto_perl->Tsavestack_max;
11388 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11389 PL_savestack = ss_dup(proto_perl, param);
11393 ENTER; /* perl_destruct() wants to LEAVE; */
11395 /* although we're not duplicating the tmps stack, we should still
11396 * add entries for any SVs on the tmps stack that got cloned by a
11397 * non-refcount means (eg a temp in @_); otherwise they will be
11400 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11401 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11402 proto_perl->Ttmps_stack[i]);
11403 if (nsv && !SvREFCNT(nsv)) {
11405 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11410 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11411 PL_top_env = &PL_start_env;
11413 PL_op = proto_perl->Top;
11416 PL_Xpv = (XPV*)NULL;
11417 PL_na = proto_perl->Tna;
11419 PL_statbuf = proto_perl->Tstatbuf;
11420 PL_statcache = proto_perl->Tstatcache;
11421 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11422 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11424 PL_timesbuf = proto_perl->Ttimesbuf;
11427 PL_tainted = proto_perl->Ttainted;
11428 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11429 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11430 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11431 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11432 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11433 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11434 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11435 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11436 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11438 PL_restartop = proto_perl->Trestartop;
11439 PL_in_eval = proto_perl->Tin_eval;
11440 PL_delaymagic = proto_perl->Tdelaymagic;
11441 PL_dirty = proto_perl->Tdirty;
11442 PL_localizing = proto_perl->Tlocalizing;
11444 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11445 PL_hv_fetch_ent_mh = NULL;
11446 PL_modcount = proto_perl->Tmodcount;
11447 PL_lastgotoprobe = NULL;
11448 PL_dumpindent = proto_perl->Tdumpindent;
11450 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11451 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11452 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11453 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11454 PL_efloatbuf = NULL; /* reinits on demand */
11455 PL_efloatsize = 0; /* reinits on demand */
11459 PL_screamfirst = NULL;
11460 PL_screamnext = NULL;
11461 PL_maxscream = -1; /* reinits on demand */
11462 PL_lastscream = NULL;
11464 PL_watchaddr = NULL;
11467 PL_regdummy = proto_perl->Tregdummy;
11468 PL_colorset = 0; /* reinits PL_colors[] */
11469 /*PL_colors[6] = {0,0,0,0,0,0};*/
11473 /* Pluggable optimizer */
11474 PL_peepp = proto_perl->Tpeepp;
11476 PL_stashcache = newHV();
11478 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11479 ptr_table_free(PL_ptr_table);
11480 PL_ptr_table = NULL;
11483 /* Call the ->CLONE method, if it exists, for each of the stashes
11484 identified by sv_dup() above.
11486 while(av_len(param->stashes) != -1) {
11487 HV* const stash = (HV*) av_shift(param->stashes);
11488 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11489 if (cloner && GvCV(cloner)) {
11494 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11496 call_sv((SV*)GvCV(cloner), G_DISCARD);
11502 SvREFCNT_dec(param->stashes);
11504 /* orphaned? eg threads->new inside BEGIN or use */
11505 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11506 SvREFCNT_inc_simple_void(PL_compcv);
11507 SAVEFREESV(PL_compcv);
11513 #endif /* USE_ITHREADS */
11516 =head1 Unicode Support
11518 =for apidoc sv_recode_to_utf8
11520 The encoding is assumed to be an Encode object, on entry the PV
11521 of the sv is assumed to be octets in that encoding, and the sv
11522 will be converted into Unicode (and UTF-8).
11524 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11525 is not a reference, nothing is done to the sv. If the encoding is not
11526 an C<Encode::XS> Encoding object, bad things will happen.
11527 (See F<lib/encoding.pm> and L<Encode>).
11529 The PV of the sv is returned.
11534 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11537 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11551 Passing sv_yes is wrong - it needs to be or'ed set of constants
11552 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11553 remove converted chars from source.
11555 Both will default the value - let them.
11557 XPUSHs(&PL_sv_yes);
11560 call_method("decode", G_SCALAR);
11564 s = SvPV_const(uni, len);
11565 if (s != SvPVX_const(sv)) {
11566 SvGROW(sv, len + 1);
11567 Move(s, SvPVX(sv), len + 1, char);
11568 SvCUR_set(sv, len);
11575 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11579 =for apidoc sv_cat_decode
11581 The encoding is assumed to be an Encode object, the PV of the ssv is
11582 assumed to be octets in that encoding and decoding the input starts
11583 from the position which (PV + *offset) pointed to. The dsv will be
11584 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11585 when the string tstr appears in decoding output or the input ends on
11586 the PV of the ssv. The value which the offset points will be modified
11587 to the last input position on the ssv.
11589 Returns TRUE if the terminator was found, else returns FALSE.
11594 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11595 SV *ssv, int *offset, char *tstr, int tlen)
11599 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11610 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11611 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11613 call_method("cat_decode", G_SCALAR);
11615 ret = SvTRUE(TOPs);
11616 *offset = SvIV(offsv);
11622 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11627 /* ---------------------------------------------------------------------
11629 * support functions for report_uninit()
11632 /* the maxiumum size of array or hash where we will scan looking
11633 * for the undefined element that triggered the warning */
11635 #define FUV_MAX_SEARCH_SIZE 1000
11637 /* Look for an entry in the hash whose value has the same SV as val;
11638 * If so, return a mortal copy of the key. */
11641 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11644 register HE **array;
11647 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11648 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11651 array = HvARRAY(hv);
11653 for (i=HvMAX(hv); i>0; i--) {
11654 register HE *entry;
11655 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11656 if (HeVAL(entry) != val)
11658 if ( HeVAL(entry) == &PL_sv_undef ||
11659 HeVAL(entry) == &PL_sv_placeholder)
11663 if (HeKLEN(entry) == HEf_SVKEY)
11664 return sv_mortalcopy(HeKEY_sv(entry));
11665 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11671 /* Look for an entry in the array whose value has the same SV as val;
11672 * If so, return the index, otherwise return -1. */
11675 S_find_array_subscript(pTHX_ AV *av, SV* val)
11678 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11679 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11682 if (val != &PL_sv_undef) {
11683 SV ** const svp = AvARRAY(av);
11686 for (i=AvFILLp(av); i>=0; i--)
11693 /* S_varname(): return the name of a variable, optionally with a subscript.
11694 * If gv is non-zero, use the name of that global, along with gvtype (one
11695 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11696 * targ. Depending on the value of the subscript_type flag, return:
11699 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11700 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11701 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11702 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11705 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11706 SV* keyname, I32 aindex, int subscript_type)
11709 SV * const name = sv_newmortal();
11712 buffer[0] = gvtype;
11715 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11717 gv_fullname4(name, gv, buffer, 0);
11719 if ((unsigned int)SvPVX(name)[1] <= 26) {
11721 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11723 /* Swap the 1 unprintable control character for the 2 byte pretty
11724 version - ie substr($name, 1, 1) = $buffer; */
11725 sv_insert(name, 1, 1, buffer, 2);
11730 CV * const cv = find_runcv(&unused);
11734 if (!cv || !CvPADLIST(cv))
11736 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11737 sv = *av_fetch(av, targ, FALSE);
11738 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11741 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11742 SV * const sv = newSV(0);
11743 *SvPVX(name) = '$';
11744 Perl_sv_catpvf(aTHX_ name, "{%s}",
11745 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11748 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11749 *SvPVX(name) = '$';
11750 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11752 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11753 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11760 =for apidoc find_uninit_var
11762 Find the name of the undefined variable (if any) that caused the operator o
11763 to issue a "Use of uninitialized value" warning.
11764 If match is true, only return a name if it's value matches uninit_sv.
11765 So roughly speaking, if a unary operator (such as OP_COS) generates a
11766 warning, then following the direct child of the op may yield an
11767 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11768 other hand, with OP_ADD there are two branches to follow, so we only print
11769 the variable name if we get an exact match.
11771 The name is returned as a mortal SV.
11773 Assumes that PL_op is the op that originally triggered the error, and that
11774 PL_comppad/PL_curpad points to the currently executing pad.
11780 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11788 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11789 uninit_sv == &PL_sv_placeholder)))
11792 switch (obase->op_type) {
11799 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11800 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11803 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11805 if (pad) { /* @lex, %lex */
11806 sv = PAD_SVl(obase->op_targ);
11810 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11811 /* @global, %global */
11812 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11815 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11817 else /* @{expr}, %{expr} */
11818 return find_uninit_var(cUNOPx(obase)->op_first,
11822 /* attempt to find a match within the aggregate */
11824 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11826 subscript_type = FUV_SUBSCRIPT_HASH;
11829 index = find_array_subscript((AV*)sv, uninit_sv);
11831 subscript_type = FUV_SUBSCRIPT_ARRAY;
11834 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11837 return varname(gv, hash ? '%' : '@', obase->op_targ,
11838 keysv, index, subscript_type);
11842 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11844 return varname(NULL, '$', obase->op_targ,
11845 NULL, 0, FUV_SUBSCRIPT_NONE);
11848 gv = cGVOPx_gv(obase);
11849 if (!gv || (match && GvSV(gv) != uninit_sv))
11851 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11854 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11857 av = (AV*)PAD_SV(obase->op_targ);
11858 if (!av || SvRMAGICAL(av))
11860 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11861 if (!svp || *svp != uninit_sv)
11864 return varname(NULL, '$', obase->op_targ,
11865 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11868 gv = cGVOPx_gv(obase);
11874 if (!av || SvRMAGICAL(av))
11876 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11877 if (!svp || *svp != uninit_sv)
11880 return varname(gv, '$', 0,
11881 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11886 o = cUNOPx(obase)->op_first;
11887 if (!o || o->op_type != OP_NULL ||
11888 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11890 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11894 if (PL_op == obase)
11895 /* $a[uninit_expr] or $h{uninit_expr} */
11896 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11899 o = cBINOPx(obase)->op_first;
11900 kid = cBINOPx(obase)->op_last;
11902 /* get the av or hv, and optionally the gv */
11904 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11905 sv = PAD_SV(o->op_targ);
11907 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11908 && cUNOPo->op_first->op_type == OP_GV)
11910 gv = cGVOPx_gv(cUNOPo->op_first);
11913 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11918 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11919 /* index is constant */
11923 if (obase->op_type == OP_HELEM) {
11924 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11925 if (!he || HeVAL(he) != uninit_sv)
11929 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11930 if (!svp || *svp != uninit_sv)
11934 if (obase->op_type == OP_HELEM)
11935 return varname(gv, '%', o->op_targ,
11936 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11938 return varname(gv, '@', o->op_targ, NULL,
11939 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11942 /* index is an expression;
11943 * attempt to find a match within the aggregate */
11944 if (obase->op_type == OP_HELEM) {
11945 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11947 return varname(gv, '%', o->op_targ,
11948 keysv, 0, FUV_SUBSCRIPT_HASH);
11951 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11953 return varname(gv, '@', o->op_targ,
11954 NULL, index, FUV_SUBSCRIPT_ARRAY);
11959 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11961 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11966 /* only examine RHS */
11967 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11970 o = cUNOPx(obase)->op_first;
11971 if (o->op_type == OP_PUSHMARK)
11974 if (!o->op_sibling) {
11975 /* one-arg version of open is highly magical */
11977 if (o->op_type == OP_GV) { /* open FOO; */
11979 if (match && GvSV(gv) != uninit_sv)
11981 return varname(gv, '$', 0,
11982 NULL, 0, FUV_SUBSCRIPT_NONE);
11984 /* other possibilities not handled are:
11985 * open $x; or open my $x; should return '${*$x}'
11986 * open expr; should return '$'.expr ideally
11992 /* ops where $_ may be an implicit arg */
11996 if ( !(obase->op_flags & OPf_STACKED)) {
11997 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11998 ? PAD_SVl(obase->op_targ)
12001 sv = sv_newmortal();
12002 sv_setpvn(sv, "$_", 2);
12010 /* skip filehandle as it can't produce 'undef' warning */
12011 o = cUNOPx(obase)->op_first;
12012 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12013 o = o->op_sibling->op_sibling;
12020 match = 1; /* XS or custom code could trigger random warnings */
12025 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12026 return sv_2mortal(newSVpvs("${$/}"));
12031 if (!(obase->op_flags & OPf_KIDS))
12033 o = cUNOPx(obase)->op_first;
12039 /* if all except one arg are constant, or have no side-effects,
12040 * or are optimized away, then it's unambiguous */
12042 for (kid=o; kid; kid = kid->op_sibling) {
12044 const OPCODE type = kid->op_type;
12045 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12046 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12047 || (type == OP_PUSHMARK)
12051 if (o2) { /* more than one found */
12058 return find_uninit_var(o2, uninit_sv, match);
12060 /* scan all args */
12062 sv = find_uninit_var(o, uninit_sv, 1);
12074 =for apidoc report_uninit
12076 Print appropriate "Use of uninitialized variable" warning
12082 Perl_report_uninit(pTHX_ SV* uninit_sv)
12086 SV* varname = NULL;
12088 varname = find_uninit_var(PL_op, uninit_sv,0);
12090 sv_insert(varname, 0, 0, " ", 1);
12092 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12093 varname ? SvPV_nolen_const(varname) : "",
12094 " in ", OP_DESC(PL_op));
12097 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12103 * c-indentation-style: bsd
12104 * c-basic-offset: 4
12105 * indent-tabs-mode: t
12108 * ex: set ts=8 sts=4 sw=4 noet: