3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
1280 /* Could put this in the else clause below, as PVMG must have SvPVX
1281 0 already (the assertion above) */
1284 if (old_type >= SVt_PVMG) {
1285 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1286 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 /* XXX Is this still needed? Was it ever needed? Surely as there is
1293 no route from NV to PVIV, NOK can never be true */
1294 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = (char*)saferealloc(s, newlen);
1456 s = (char*)safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1855 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1856 if (SvNVX(sv) < (NV)IV_MIN) {
1857 (void)SvIOKp_on(sv);
1859 SvIV_set(sv, IV_MIN);
1860 return IS_NUMBER_UNDERFLOW_IV;
1862 if (SvNVX(sv) > (NV)UV_MAX) {
1863 (void)SvIOKp_on(sv);
1866 SvUV_set(sv, UV_MAX);
1867 return IS_NUMBER_OVERFLOW_UV;
1869 (void)SvIOKp_on(sv);
1871 /* Can't use strtol etc to convert this string. (See truth table in
1873 if (SvNVX(sv) <= (UV)IV_MAX) {
1874 SvIV_set(sv, I_V(SvNVX(sv)));
1875 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1876 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1878 /* Integer is imprecise. NOK, IOKp */
1880 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1883 SvUV_set(sv, U_V(SvNVX(sv)));
1884 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1885 if (SvUVX(sv) == UV_MAX) {
1886 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1887 possibly be preserved by NV. Hence, it must be overflow.
1889 return IS_NUMBER_OVERFLOW_UV;
1891 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1893 /* Integer is imprecise. NOK, IOKp */
1895 return IS_NUMBER_OVERFLOW_IV;
1897 #endif /* !NV_PRESERVES_UV*/
1900 S_sv_2iuv_common(pTHX_ SV *sv) {
1903 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1904 * without also getting a cached IV/UV from it at the same time
1905 * (ie PV->NV conversion should detect loss of accuracy and cache
1906 * IV or UV at same time to avoid this. */
1907 /* IV-over-UV optimisation - choose to cache IV if possible */
1909 if (SvTYPE(sv) == SVt_NV)
1910 sv_upgrade(sv, SVt_PVNV);
1912 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1913 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1914 certainly cast into the IV range at IV_MAX, whereas the correct
1915 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1917 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1918 if (Perl_isnan(SvNVX(sv))) {
1924 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1925 SvIV_set(sv, I_V(SvNVX(sv)));
1926 if (SvNVX(sv) == (NV) SvIVX(sv)
1927 #ifndef NV_PRESERVES_UV
1928 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1929 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1930 /* Don't flag it as "accurately an integer" if the number
1931 came from a (by definition imprecise) NV operation, and
1932 we're outside the range of NV integer precision */
1935 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1943 /* IV not precise. No need to convert from PV, as NV
1944 conversion would already have cached IV if it detected
1945 that PV->IV would be better than PV->NV->IV
1946 flags already correct - don't set public IOK. */
1947 DEBUG_c(PerlIO_printf(Perl_debug_log,
1948 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1953 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1954 but the cast (NV)IV_MIN rounds to a the value less (more
1955 negative) than IV_MIN which happens to be equal to SvNVX ??
1956 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1957 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1958 (NV)UVX == NVX are both true, but the values differ. :-(
1959 Hopefully for 2s complement IV_MIN is something like
1960 0x8000000000000000 which will be exact. NWC */
1963 SvUV_set(sv, U_V(SvNVX(sv)));
1965 (SvNVX(sv) == (NV) SvUVX(sv))
1966 #ifndef NV_PRESERVES_UV
1967 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1968 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1969 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1970 /* Don't flag it as "accurately an integer" if the number
1971 came from a (by definition imprecise) NV operation, and
1972 we're outside the range of NV integer precision */
1977 DEBUG_c(PerlIO_printf(Perl_debug_log,
1978 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1984 else if (SvPOKp(sv) && SvLEN(sv)) {
1986 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1987 /* We want to avoid a possible problem when we cache an IV/ a UV which
1988 may be later translated to an NV, and the resulting NV is not
1989 the same as the direct translation of the initial string
1990 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1991 be careful to ensure that the value with the .456 is around if the
1992 NV value is requested in the future).
1994 This means that if we cache such an IV/a UV, we need to cache the
1995 NV as well. Moreover, we trade speed for space, and do not
1996 cache the NV if we are sure it's not needed.
1999 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2000 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2001 == IS_NUMBER_IN_UV) {
2002 /* It's definitely an integer, only upgrade to PVIV */
2003 if (SvTYPE(sv) < SVt_PVIV)
2004 sv_upgrade(sv, SVt_PVIV);
2006 } else if (SvTYPE(sv) < SVt_PVNV)
2007 sv_upgrade(sv, SVt_PVNV);
2009 /* If NVs preserve UVs then we only use the UV value if we know that
2010 we aren't going to call atof() below. If NVs don't preserve UVs
2011 then the value returned may have more precision than atof() will
2012 return, even though value isn't perfectly accurate. */
2013 if ((numtype & (IS_NUMBER_IN_UV
2014 #ifdef NV_PRESERVES_UV
2017 )) == IS_NUMBER_IN_UV) {
2018 /* This won't turn off the public IOK flag if it was set above */
2019 (void)SvIOKp_on(sv);
2021 if (!(numtype & IS_NUMBER_NEG)) {
2023 if (value <= (UV)IV_MAX) {
2024 SvIV_set(sv, (IV)value);
2026 /* it didn't overflow, and it was positive. */
2027 SvUV_set(sv, value);
2031 /* 2s complement assumption */
2032 if (value <= (UV)IV_MIN) {
2033 SvIV_set(sv, -(IV)value);
2035 /* Too negative for an IV. This is a double upgrade, but
2036 I'm assuming it will be rare. */
2037 if (SvTYPE(sv) < SVt_PVNV)
2038 sv_upgrade(sv, SVt_PVNV);
2042 SvNV_set(sv, -(NV)value);
2043 SvIV_set(sv, IV_MIN);
2047 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2048 will be in the previous block to set the IV slot, and the next
2049 block to set the NV slot. So no else here. */
2051 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2052 != IS_NUMBER_IN_UV) {
2053 /* It wasn't an (integer that doesn't overflow the UV). */
2054 SvNV_set(sv, Atof(SvPVX_const(sv)));
2056 if (! numtype && ckWARN(WARN_NUMERIC))
2059 #if defined(USE_LONG_DOUBLE)
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2067 #ifdef NV_PRESERVES_UV
2068 (void)SvIOKp_on(sv);
2070 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2071 SvIV_set(sv, I_V(SvNVX(sv)));
2072 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2075 NOOP; /* Integer is imprecise. NOK, IOKp */
2077 /* UV will not work better than IV */
2079 if (SvNVX(sv) > (NV)UV_MAX) {
2081 /* Integer is inaccurate. NOK, IOKp, is UV */
2082 SvUV_set(sv, UV_MAX);
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2085 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2086 NV preservse UV so can do correct comparison. */
2087 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2090 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2095 #else /* NV_PRESERVES_UV */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2098 /* The IV/UV slot will have been set from value returned by
2099 grok_number above. The NV slot has just been set using
2102 assert (SvIOKp(sv));
2104 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2105 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2106 /* Small enough to preserve all bits. */
2107 (void)SvIOKp_on(sv);
2109 SvIV_set(sv, I_V(SvNVX(sv)));
2110 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2112 /* Assumption: first non-preserved integer is < IV_MAX,
2113 this NV is in the preserved range, therefore: */
2114 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2116 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2120 0 0 already failed to read UV.
2121 0 1 already failed to read UV.
2122 1 0 you won't get here in this case. IV/UV
2123 slot set, public IOK, Atof() unneeded.
2124 1 1 already read UV.
2125 so there's no point in sv_2iuv_non_preserve() attempting
2126 to use atol, strtol, strtoul etc. */
2127 sv_2iuv_non_preserve (sv, numtype);
2130 #endif /* NV_PRESERVES_UV */
2134 if (isGV_with_GP(sv))
2135 return glob_2number((GV *)sv);
2137 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2138 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2141 if (SvTYPE(sv) < SVt_IV)
2142 /* Typically the caller expects that sv_any is not NULL now. */
2143 sv_upgrade(sv, SVt_IV);
2144 /* Return 0 from the caller. */
2151 =for apidoc sv_2iv_flags
2153 Return the integer value of an SV, doing any necessary string
2154 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2155 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2161 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2166 if (SvGMAGICAL(sv)) {
2167 if (flags & SV_GMAGIC)
2172 return I_V(SvNVX(sv));
2174 if (SvPOKp(sv) && SvLEN(sv)) {
2177 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == IS_NUMBER_IN_UV) {
2181 /* It's definitely an integer */
2182 if (numtype & IS_NUMBER_NEG) {
2183 if (value < (UV)IV_MIN)
2186 if (value < (UV)IV_MAX)
2191 if (ckWARN(WARN_NUMERIC))
2194 return I_V(Atof(SvPVX_const(sv)));
2199 assert(SvTYPE(sv) >= SVt_PVMG);
2200 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2201 } else if (SvTHINKFIRST(sv)) {
2205 SV * const tmpstr=AMG_CALLun(sv,numer);
2206 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207 return SvIV(tmpstr);
2210 return PTR2IV(SvRV(sv));
2213 sv_force_normal_flags(sv, 0);
2215 if (SvREADONLY(sv) && !SvOK(sv)) {
2216 if (ckWARN(WARN_UNINITIALIZED))
2222 if (S_sv_2iuv_common(aTHX_ sv))
2225 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226 PTR2UV(sv),SvIVX(sv)));
2227 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2231 =for apidoc sv_2uv_flags
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2246 if (SvGMAGICAL(sv)) {
2247 if (flags & SV_GMAGIC)
2252 return U_V(SvNVX(sv));
2253 if (SvPOKp(sv) && SvLEN(sv)) {
2256 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2258 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2259 == IS_NUMBER_IN_UV) {
2260 /* It's definitely an integer */
2261 if (!(numtype & IS_NUMBER_NEG))
2265 if (ckWARN(WARN_NUMERIC))
2268 return U_V(Atof(SvPVX_const(sv)));
2273 assert(SvTYPE(sv) >= SVt_PVMG);
2274 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2275 } else if (SvTHINKFIRST(sv)) {
2279 SV *const tmpstr = AMG_CALLun(sv,numer);
2280 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2281 return SvUV(tmpstr);
2284 return PTR2UV(SvRV(sv));
2287 sv_force_normal_flags(sv, 0);
2289 if (SvREADONLY(sv) && !SvOK(sv)) {
2290 if (ckWARN(WARN_UNINITIALIZED))
2296 if (S_sv_2iuv_common(aTHX_ sv))
2300 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2301 PTR2UV(sv),SvUVX(sv)));
2302 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2308 Return the num value of an SV, doing any necessary string or integer
2309 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2316 Perl_sv_2nv(pTHX_ register SV *sv)
2321 if (SvGMAGICAL(sv)) {
2325 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2326 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2327 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2329 return Atof(SvPVX_const(sv));
2333 return (NV)SvUVX(sv);
2335 return (NV)SvIVX(sv);
2340 assert(SvTYPE(sv) >= SVt_PVMG);
2341 /* This falls through to the report_uninit near the end of the
2343 } else if (SvTHINKFIRST(sv)) {
2347 SV *const tmpstr = AMG_CALLun(sv,numer);
2348 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2349 return SvNV(tmpstr);
2352 return PTR2NV(SvRV(sv));
2355 sv_force_normal_flags(sv, 0);
2357 if (SvREADONLY(sv) && !SvOK(sv)) {
2358 if (ckWARN(WARN_UNINITIALIZED))
2363 if (SvTYPE(sv) < SVt_NV) {
2364 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2365 sv_upgrade(sv, SVt_NV);
2366 #ifdef USE_LONG_DOUBLE
2368 STORE_NUMERIC_LOCAL_SET_STANDARD();
2369 PerlIO_printf(Perl_debug_log,
2370 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2371 PTR2UV(sv), SvNVX(sv));
2372 RESTORE_NUMERIC_LOCAL();
2376 STORE_NUMERIC_LOCAL_SET_STANDARD();
2377 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2378 PTR2UV(sv), SvNVX(sv));
2379 RESTORE_NUMERIC_LOCAL();
2383 else if (SvTYPE(sv) < SVt_PVNV)
2384 sv_upgrade(sv, SVt_PVNV);
2389 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2390 #ifdef NV_PRESERVES_UV
2393 /* Only set the public NV OK flag if this NV preserves the IV */
2394 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2395 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2396 : (SvIVX(sv) == I_V(SvNVX(sv))))
2402 else if (SvPOKp(sv) && SvLEN(sv)) {
2404 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2405 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2407 #ifdef NV_PRESERVES_UV
2408 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2409 == IS_NUMBER_IN_UV) {
2410 /* It's definitely an integer */
2411 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 SvNV_set(sv, Atof(SvPVX_const(sv)));
2417 /* Only set the public NV OK flag if this NV preserves the value in
2418 the PV at least as well as an IV/UV would.
2419 Not sure how to do this 100% reliably. */
2420 /* if that shift count is out of range then Configure's test is
2421 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2423 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2424 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2425 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2426 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2427 /* Can't use strtol etc to convert this string, so don't try.
2428 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2431 /* value has been set. It may not be precise. */
2432 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2433 /* 2s complement assumption for (UV)IV_MIN */
2434 SvNOK_on(sv); /* Integer is too negative. */
2439 if (numtype & IS_NUMBER_NEG) {
2440 SvIV_set(sv, -(IV)value);
2441 } else if (value <= (UV)IV_MAX) {
2442 SvIV_set(sv, (IV)value);
2444 SvUV_set(sv, value);
2448 if (numtype & IS_NUMBER_NOT_INT) {
2449 /* I believe that even if the original PV had decimals,
2450 they are lost beyond the limit of the FP precision.
2451 However, neither is canonical, so both only get p
2452 flags. NWC, 2000/11/25 */
2453 /* Both already have p flags, so do nothing */
2455 const NV nv = SvNVX(sv);
2456 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2457 if (SvIVX(sv) == I_V(nv)) {
2460 /* It had no "." so it must be integer. */
2464 /* between IV_MAX and NV(UV_MAX).
2465 Could be slightly > UV_MAX */
2467 if (numtype & IS_NUMBER_NOT_INT) {
2468 /* UV and NV both imprecise. */
2470 const UV nv_as_uv = U_V(nv);
2472 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2481 #endif /* NV_PRESERVES_UV */
2484 if (isGV_with_GP(sv)) {
2485 glob_2number((GV *)sv);
2489 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2491 assert (SvTYPE(sv) >= SVt_NV);
2492 /* Typically the caller expects that sv_any is not NULL now. */
2493 /* XXX Ilya implies that this is a bug in callers that assume this
2494 and ideally should be fixed. */
2497 #if defined(USE_LONG_DOUBLE)
2499 STORE_NUMERIC_LOCAL_SET_STANDARD();
2500 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2501 PTR2UV(sv), SvNVX(sv));
2502 RESTORE_NUMERIC_LOCAL();
2506 STORE_NUMERIC_LOCAL_SET_STANDARD();
2507 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2508 PTR2UV(sv), SvNVX(sv));
2509 RESTORE_NUMERIC_LOCAL();
2515 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2516 * UV as a string towards the end of buf, and return pointers to start and
2519 * We assume that buf is at least TYPE_CHARS(UV) long.
2523 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2525 char *ptr = buf + TYPE_CHARS(UV);
2526 char * const ebuf = ptr;
2539 *--ptr = '0' + (char)(uv % 10);
2547 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2548 * a regexp to its stringified form.
2552 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2554 const regexp * const re = (regexp *)mg->mg_obj;
2557 const char *fptr = "msix";
2562 bool need_newline = 0;
2563 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2565 while((ch = *fptr++)) {
2567 reflags[left++] = ch;
2570 reflags[right--] = ch;
2575 reflags[left] = '-';
2579 mg->mg_len = re->prelen + 4 + left;
2581 * If /x was used, we have to worry about a regex ending with a
2582 * comment later being embedded within another regex. If so, we don't
2583 * want this regex's "commentization" to leak out to the right part of
2584 * the enclosing regex, we must cap it with a newline.
2586 * So, if /x was used, we scan backwards from the end of the regex. If
2587 * we find a '#' before we find a newline, we need to add a newline
2588 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2589 * we don't need to add anything. -jfriedl
2591 if (PMf_EXTENDED & re->reganch) {
2592 const char *endptr = re->precomp + re->prelen;
2593 while (endptr >= re->precomp) {
2594 const char c = *(endptr--);
2596 break; /* don't need another */
2598 /* we end while in a comment, so we need a newline */
2599 mg->mg_len++; /* save space for it */
2600 need_newline = 1; /* note to add it */
2606 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2607 mg->mg_ptr[0] = '(';
2608 mg->mg_ptr[1] = '?';
2609 Copy(reflags, mg->mg_ptr+2, left, char);
2610 *(mg->mg_ptr+left+2) = ':';
2611 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2613 mg->mg_ptr[mg->mg_len - 2] = '\n';
2614 mg->mg_ptr[mg->mg_len - 1] = ')';
2615 mg->mg_ptr[mg->mg_len] = 0;
2617 PL_reginterp_cnt += re->program[0].next_off;
2619 if (re->reganch & ROPT_UTF8)
2629 =for apidoc sv_2pv_flags
2631 Returns a pointer to the string value of an SV, and sets *lp to its length.
2632 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2634 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2635 usually end up here too.
2641 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2651 if (SvGMAGICAL(sv)) {
2652 if (flags & SV_GMAGIC)
2657 if (flags & SV_MUTABLE_RETURN)
2658 return SvPVX_mutable(sv);
2659 if (flags & SV_CONST_RETURN)
2660 return (char *)SvPVX_const(sv);
2663 if (SvIOKp(sv) || SvNOKp(sv)) {
2664 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2669 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2670 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2672 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2679 #ifdef FIXNEGATIVEZERO
2680 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2686 SvUPGRADE(sv, SVt_PV);
2689 s = SvGROW_mutable(sv, len + 1);
2692 return (char*)memcpy(s, tbuf, len + 1);
2698 assert(SvTYPE(sv) >= SVt_PVMG);
2699 /* This falls through to the report_uninit near the end of the
2701 } else if (SvTHINKFIRST(sv)) {
2705 SV *const tmpstr = AMG_CALLun(sv,string);
2706 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2708 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2712 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2713 if (flags & SV_CONST_RETURN) {
2714 pv = (char *) SvPVX_const(tmpstr);
2716 pv = (flags & SV_MUTABLE_RETURN)
2717 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2720 *lp = SvCUR(tmpstr);
2722 pv = sv_2pv_flags(tmpstr, lp, flags);
2734 const SV *const referent = (SV*)SvRV(sv);
2737 tsv = sv_2mortal(newSVpvs("NULLREF"));
2738 } else if (SvTYPE(referent) == SVt_PVMG
2739 && ((SvFLAGS(referent) &
2740 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2741 == (SVs_OBJECT|SVs_SMG))
2742 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2743 return stringify_regexp(sv, mg, lp);
2745 const char *const typestr = sv_reftype(referent, 0);
2747 tsv = sv_newmortal();
2748 if (SvOBJECT(referent)) {
2749 const char *const name = HvNAME_get(SvSTASH(referent));
2750 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2751 name ? name : "__ANON__" , typestr,
2755 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2763 if (SvREADONLY(sv) && !SvOK(sv)) {
2764 if (ckWARN(WARN_UNINITIALIZED))
2771 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2772 /* I'm assuming that if both IV and NV are equally valid then
2773 converting the IV is going to be more efficient */
2774 const U32 isIOK = SvIOK(sv);
2775 const U32 isUIOK = SvIsUV(sv);
2776 char buf[TYPE_CHARS(UV)];
2779 if (SvTYPE(sv) < SVt_PVIV)
2780 sv_upgrade(sv, SVt_PVIV);
2781 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2782 /* inlined from sv_setpvn */
2783 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2784 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2785 SvCUR_set(sv, ebuf - ptr);
2795 else if (SvNOKp(sv)) {
2796 const int olderrno = errno;
2797 if (SvTYPE(sv) < SVt_PVNV)
2798 sv_upgrade(sv, SVt_PVNV);
2799 /* The +20 is pure guesswork. Configure test needed. --jhi */
2800 s = SvGROW_mutable(sv, NV_DIG + 20);
2801 /* some Xenix systems wipe out errno here */
2803 if (SvNVX(sv) == 0.0)
2804 my_strlcpy(s, "0", SvLEN(sv));
2808 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2811 #ifdef FIXNEGATIVEZERO
2812 if (*s == '-' && s[1] == '0' && !s[2])
2813 my_strlcpy(s, "0", SvLEN(s));
2822 if (isGV_with_GP(sv))
2823 return glob_2pv((GV *)sv, lp);
2825 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2829 if (SvTYPE(sv) < SVt_PV)
2830 /* Typically the caller expects that sv_any is not NULL now. */
2831 sv_upgrade(sv, SVt_PV);
2835 const STRLEN len = s - SvPVX_const(sv);
2841 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2842 PTR2UV(sv),SvPVX_const(sv)));
2843 if (flags & SV_CONST_RETURN)
2844 return (char *)SvPVX_const(sv);
2845 if (flags & SV_MUTABLE_RETURN)
2846 return SvPVX_mutable(sv);
2851 =for apidoc sv_copypv
2853 Copies a stringified representation of the source SV into the
2854 destination SV. Automatically performs any necessary mg_get and
2855 coercion of numeric values into strings. Guaranteed to preserve
2856 UTF-8 flag even from overloaded objects. Similar in nature to
2857 sv_2pv[_flags] but operates directly on an SV instead of just the
2858 string. Mostly uses sv_2pv_flags to do its work, except when that
2859 would lose the UTF-8'ness of the PV.
2865 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2868 const char * const s = SvPV_const(ssv,len);
2869 sv_setpvn(dsv,s,len);
2877 =for apidoc sv_2pvbyte
2879 Return a pointer to the byte-encoded representation of the SV, and set *lp
2880 to its length. May cause the SV to be downgraded from UTF-8 as a
2883 Usually accessed via the C<SvPVbyte> macro.
2889 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2891 sv_utf8_downgrade(sv,0);
2892 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2896 =for apidoc sv_2pvutf8
2898 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2899 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2901 Usually accessed via the C<SvPVutf8> macro.
2907 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2909 sv_utf8_upgrade(sv);
2910 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2915 =for apidoc sv_2bool
2917 This function is only called on magical items, and is only used by
2918 sv_true() or its macro equivalent.
2924 Perl_sv_2bool(pTHX_ register SV *sv)
2933 SV * const tmpsv = AMG_CALLun(sv,bool_);
2934 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2935 return (bool)SvTRUE(tmpsv);
2937 return SvRV(sv) != 0;
2940 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2942 (*sv->sv_u.svu_pv > '0' ||
2943 Xpvtmp->xpv_cur > 1 ||
2944 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2951 return SvIVX(sv) != 0;
2954 return SvNVX(sv) != 0.0;
2956 if (isGV_with_GP(sv))
2966 =for apidoc sv_utf8_upgrade
2968 Converts the PV of an SV to its UTF-8-encoded form.
2969 Forces the SV to string form if it is not already.
2970 Always sets the SvUTF8 flag to avoid future validity checks even
2971 if all the bytes have hibit clear.
2973 This is not as a general purpose byte encoding to Unicode interface:
2974 use the Encode extension for that.
2976 =for apidoc sv_utf8_upgrade_flags
2978 Converts the PV of an SV to its UTF-8-encoded form.
2979 Forces the SV to string form if it is not already.
2980 Always sets the SvUTF8 flag to avoid future validity checks even
2981 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2982 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2983 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2985 This is not as a general purpose byte encoding to Unicode interface:
2986 use the Encode extension for that.
2992 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2995 if (sv == &PL_sv_undef)
2999 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3000 (void) sv_2pv_flags(sv,&len, flags);
3004 (void) SvPV_force(sv,len);
3013 sv_force_normal_flags(sv, 0);
3016 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3017 sv_recode_to_utf8(sv, PL_encoding);
3018 else { /* Assume Latin-1/EBCDIC */
3019 /* This function could be much more efficient if we
3020 * had a FLAG in SVs to signal if there are any hibit
3021 * chars in the PV. Given that there isn't such a flag
3022 * make the loop as fast as possible. */
3023 const U8 * const s = (U8 *) SvPVX_const(sv);
3024 const U8 * const e = (U8 *) SvEND(sv);
3029 /* Check for hi bit */
3030 if (!NATIVE_IS_INVARIANT(ch)) {
3031 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3032 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3034 SvPV_free(sv); /* No longer using what was there before. */
3035 SvPV_set(sv, (char*)recoded);
3036 SvCUR_set(sv, len - 1);
3037 SvLEN_set(sv, len); /* No longer know the real size. */
3041 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3048 =for apidoc sv_utf8_downgrade
3050 Attempts to convert the PV of an SV from characters to bytes.
3051 If the PV contains a character beyond byte, this conversion will fail;
3052 in this case, either returns false or, if C<fail_ok> is not
3055 This is not as a general purpose Unicode to byte encoding interface:
3056 use the Encode extension for that.
3062 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3065 if (SvPOKp(sv) && SvUTF8(sv)) {
3071 sv_force_normal_flags(sv, 0);
3073 s = (U8 *) SvPV(sv, len);
3074 if (!utf8_to_bytes(s, &len)) {
3079 Perl_croak(aTHX_ "Wide character in %s",
3082 Perl_croak(aTHX_ "Wide character");
3093 =for apidoc sv_utf8_encode
3095 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3096 flag off so that it looks like octets again.
3102 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3105 sv_force_normal_flags(sv, 0);
3107 if (SvREADONLY(sv)) {
3108 Perl_croak(aTHX_ PL_no_modify);
3110 (void) sv_utf8_upgrade(sv);
3115 =for apidoc sv_utf8_decode
3117 If the PV of the SV is an octet sequence in UTF-8
3118 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3119 so that it looks like a character. If the PV contains only single-byte
3120 characters, the C<SvUTF8> flag stays being off.
3121 Scans PV for validity and returns false if the PV is invalid UTF-8.
3127 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3133 /* The octets may have got themselves encoded - get them back as
3136 if (!sv_utf8_downgrade(sv, TRUE))
3139 /* it is actually just a matter of turning the utf8 flag on, but
3140 * we want to make sure everything inside is valid utf8 first.
3142 c = (const U8 *) SvPVX_const(sv);
3143 if (!is_utf8_string(c, SvCUR(sv)+1))
3145 e = (const U8 *) SvEND(sv);
3148 if (!UTF8_IS_INVARIANT(ch)) {
3158 =for apidoc sv_setsv
3160 Copies the contents of the source SV C<ssv> into the destination SV
3161 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3162 function if the source SV needs to be reused. Does not handle 'set' magic.
3163 Loosely speaking, it performs a copy-by-value, obliterating any previous
3164 content of the destination.
3166 You probably want to use one of the assortment of wrappers, such as
3167 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3168 C<SvSetMagicSV_nosteal>.
3170 =for apidoc sv_setsv_flags
3172 Copies the contents of the source SV C<ssv> into the destination SV
3173 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3174 function if the source SV needs to be reused. Does not handle 'set' magic.
3175 Loosely speaking, it performs a copy-by-value, obliterating any previous
3176 content of the destination.
3177 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3178 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3179 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3180 and C<sv_setsv_nomg> are implemented in terms of this function.
3182 You probably want to use one of the assortment of wrappers, such as
3183 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3184 C<SvSetMagicSV_nosteal>.
3186 This is the primary function for copying scalars, and most other
3187 copy-ish functions and macros use this underneath.
3193 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3195 if (dtype != SVt_PVGV) {
3196 const char * const name = GvNAME(sstr);
3197 const STRLEN len = GvNAMELEN(sstr);
3198 /* don't upgrade SVt_PVLV: it can hold a glob */
3199 if (dtype != SVt_PVLV) {
3200 if (dtype >= SVt_PV) {
3206 sv_upgrade(dstr, SVt_PVGV);
3207 (void)SvOK_off(dstr);
3210 GvSTASH(dstr) = GvSTASH(sstr);
3212 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3213 gv_name_set((GV *)dstr, name, len, GV_ADD);
3214 SvFAKE_on(dstr); /* can coerce to non-glob */
3217 #ifdef GV_UNIQUE_CHECK
3218 if (GvUNIQUE((GV*)dstr)) {
3219 Perl_croak(aTHX_ PL_no_modify);
3225 (void)SvOK_off(dstr);
3227 GvINTRO_off(dstr); /* one-shot flag */
3228 GvGP(dstr) = gp_ref(GvGP(sstr));
3229 if (SvTAINTED(sstr))
3231 if (GvIMPORTED(dstr) != GVf_IMPORTED
3232 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3234 GvIMPORTED_on(dstr);
3241 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3242 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3244 const int intro = GvINTRO(dstr);
3247 const U32 stype = SvTYPE(sref);
3250 #ifdef GV_UNIQUE_CHECK
3251 if (GvUNIQUE((GV*)dstr)) {
3252 Perl_croak(aTHX_ PL_no_modify);
3257 GvINTRO_off(dstr); /* one-shot flag */
3258 GvLINE(dstr) = CopLINE(PL_curcop);
3259 GvEGV(dstr) = (GV*)dstr;
3264 location = (SV **) &GvCV(dstr);
3265 import_flag = GVf_IMPORTED_CV;
3268 location = (SV **) &GvHV(dstr);
3269 import_flag = GVf_IMPORTED_HV;
3272 location = (SV **) &GvAV(dstr);
3273 import_flag = GVf_IMPORTED_AV;
3276 location = (SV **) &GvIOp(dstr);
3279 location = (SV **) &GvFORM(dstr);
3281 location = &GvSV(dstr);
3282 import_flag = GVf_IMPORTED_SV;
3285 if (stype == SVt_PVCV) {
3286 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3287 SvREFCNT_dec(GvCV(dstr));
3289 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3290 PL_sub_generation++;
3293 SAVEGENERICSV(*location);
3297 if (stype == SVt_PVCV && *location != sref) {
3298 CV* const cv = (CV*)*location;
3300 if (!GvCVGEN((GV*)dstr) &&
3301 (CvROOT(cv) || CvXSUB(cv)))
3303 /* Redefining a sub - warning is mandatory if
3304 it was a const and its value changed. */
3305 if (CvCONST(cv) && CvCONST((CV*)sref)
3306 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3308 /* They are 2 constant subroutines generated from
3309 the same constant. This probably means that
3310 they are really the "same" proxy subroutine
3311 instantiated in 2 places. Most likely this is
3312 when a constant is exported twice. Don't warn.
3315 else if (ckWARN(WARN_REDEFINE)
3317 && (!CvCONST((CV*)sref)
3318 || sv_cmp(cv_const_sv(cv),
3319 cv_const_sv((CV*)sref))))) {
3320 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3323 ? "Constant subroutine %s::%s redefined"
3324 : "Subroutine %s::%s redefined"),
3325 HvNAME_get(GvSTASH((GV*)dstr)),
3326 GvENAME((GV*)dstr));
3330 cv_ckproto_len(cv, (GV*)dstr,
3331 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3332 SvPOK(sref) ? SvCUR(sref) : 0);
3334 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3335 GvASSUMECV_on(dstr);
3336 PL_sub_generation++;
3339 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3340 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3341 GvFLAGS(dstr) |= import_flag;
3346 if (SvTAINTED(sstr))
3352 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3355 register U32 sflags;
3357 register svtype stype;
3361 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3363 sstr = &PL_sv_undef;
3364 stype = SvTYPE(sstr);
3365 dtype = SvTYPE(dstr);
3370 /* need to nuke the magic */
3372 SvRMAGICAL_off(dstr);
3375 /* There's a lot of redundancy below but we're going for speed here */
3380 if (dtype != SVt_PVGV) {
3381 (void)SvOK_off(dstr);
3389 sv_upgrade(dstr, SVt_IV);
3394 sv_upgrade(dstr, SVt_PVIV);
3397 (void)SvIOK_only(dstr);
3398 SvIV_set(dstr, SvIVX(sstr));
3401 /* SvTAINTED can only be true if the SV has taint magic, which in
3402 turn means that the SV type is PVMG (or greater). This is the
3403 case statement for SVt_IV, so this cannot be true (whatever gcov
3405 assert(!SvTAINTED(sstr));
3415 sv_upgrade(dstr, SVt_NV);
3420 sv_upgrade(dstr, SVt_PVNV);
3423 SvNV_set(dstr, SvNVX(sstr));
3424 (void)SvNOK_only(dstr);
3425 /* SvTAINTED can only be true if the SV has taint magic, which in
3426 turn means that the SV type is PVMG (or greater). This is the
3427 case statement for SVt_NV, so this cannot be true (whatever gcov
3429 assert(!SvTAINTED(sstr));
3436 sv_upgrade(dstr, SVt_RV);
3439 #ifdef PERL_OLD_COPY_ON_WRITE
3440 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3449 sv_upgrade(dstr, SVt_PV);
3452 if (dtype < SVt_PVIV)
3453 sv_upgrade(dstr, SVt_PVIV);
3456 if (dtype < SVt_PVNV)
3457 sv_upgrade(dstr, SVt_PVNV);
3461 const char * const type = sv_reftype(sstr,0);
3463 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3465 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3470 if (dtype <= SVt_PVGV) {
3471 glob_assign_glob(dstr, sstr, dtype);
3479 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3481 if (SvTYPE(sstr) != stype) {
3482 stype = SvTYPE(sstr);
3483 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3484 glob_assign_glob(dstr, sstr, dtype);
3489 if (stype == SVt_PVLV)
3490 SvUPGRADE(dstr, SVt_PVNV);
3492 SvUPGRADE(dstr, (svtype)stype);
3495 /* dstr may have been upgraded. */
3496 dtype = SvTYPE(dstr);
3497 sflags = SvFLAGS(sstr);
3499 if (sflags & SVf_ROK) {
3500 if (dtype == SVt_PVGV &&
3501 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3504 if (GvIMPORTED(dstr) != GVf_IMPORTED
3505 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3507 GvIMPORTED_on(dstr);
3512 glob_assign_glob(dstr, sstr, dtype);
3516 if (dtype >= SVt_PV) {
3517 if (dtype == SVt_PVGV) {
3518 glob_assign_ref(dstr, sstr);
3521 if (SvPVX_const(dstr)) {
3527 (void)SvOK_off(dstr);
3528 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3529 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3530 assert(!(sflags & SVp_NOK));
3531 assert(!(sflags & SVp_IOK));
3532 assert(!(sflags & SVf_NOK));
3533 assert(!(sflags & SVf_IOK));
3535 else if (dtype == SVt_PVGV) {
3536 if (!(sflags & SVf_OK)) {
3537 if (ckWARN(WARN_MISC))
3538 Perl_warner(aTHX_ packWARN(WARN_MISC),
3539 "Undefined value assigned to typeglob");
3542 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3543 if (dstr != (SV*)gv) {
3546 GvGP(dstr) = gp_ref(GvGP(gv));
3550 else if (sflags & SVp_POK) {
3554 * Check to see if we can just swipe the string. If so, it's a
3555 * possible small lose on short strings, but a big win on long ones.
3556 * It might even be a win on short strings if SvPVX_const(dstr)
3557 * has to be allocated and SvPVX_const(sstr) has to be freed.
3560 /* Whichever path we take through the next code, we want this true,
3561 and doing it now facilitates the COW check. */
3562 (void)SvPOK_only(dstr);
3565 /* We're not already COW */
3566 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3567 #ifndef PERL_OLD_COPY_ON_WRITE
3568 /* or we are, but dstr isn't a suitable target. */
3569 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3574 (sflags & SVs_TEMP) && /* slated for free anyway? */
3575 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3576 (!(flags & SV_NOSTEAL)) &&
3577 /* and we're allowed to steal temps */
3578 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3579 SvLEN(sstr) && /* and really is a string */
3580 /* and won't be needed again, potentially */
3581 !(PL_op && PL_op->op_type == OP_AASSIGN))
3582 #ifdef PERL_OLD_COPY_ON_WRITE
3583 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3584 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3585 && SvTYPE(sstr) >= SVt_PVIV)
3588 /* Failed the swipe test, and it's not a shared hash key either.
3589 Have to copy the string. */
3590 STRLEN len = SvCUR(sstr);
3591 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3592 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3593 SvCUR_set(dstr, len);
3594 *SvEND(dstr) = '\0';
3596 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3598 /* Either it's a shared hash key, or it's suitable for
3599 copy-on-write or we can swipe the string. */
3601 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3605 #ifdef PERL_OLD_COPY_ON_WRITE
3607 /* I believe I should acquire a global SV mutex if
3608 it's a COW sv (not a shared hash key) to stop
3609 it going un copy-on-write.
3610 If the source SV has gone un copy on write between up there
3611 and down here, then (assert() that) it is of the correct
3612 form to make it copy on write again */
3613 if ((sflags & (SVf_FAKE | SVf_READONLY))
3614 != (SVf_FAKE | SVf_READONLY)) {
3615 SvREADONLY_on(sstr);
3617 /* Make the source SV into a loop of 1.
3618 (about to become 2) */
3619 SV_COW_NEXT_SV_SET(sstr, sstr);
3623 /* Initial code is common. */
3624 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3629 /* making another shared SV. */
3630 STRLEN cur = SvCUR(sstr);
3631 STRLEN len = SvLEN(sstr);
3632 #ifdef PERL_OLD_COPY_ON_WRITE
3634 assert (SvTYPE(dstr) >= SVt_PVIV);
3635 /* SvIsCOW_normal */
3636 /* splice us in between source and next-after-source. */
3637 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3638 SV_COW_NEXT_SV_SET(sstr, dstr);
3639 SvPV_set(dstr, SvPVX_mutable(sstr));
3643 /* SvIsCOW_shared_hash */
3644 DEBUG_C(PerlIO_printf(Perl_debug_log,
3645 "Copy on write: Sharing hash\n"));
3647 assert (SvTYPE(dstr) >= SVt_PV);
3649 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3651 SvLEN_set(dstr, len);
3652 SvCUR_set(dstr, cur);
3653 SvREADONLY_on(dstr);
3655 /* Relesase a global SV mutex. */
3658 { /* Passes the swipe test. */
3659 SvPV_set(dstr, SvPVX_mutable(sstr));
3660 SvLEN_set(dstr, SvLEN(sstr));
3661 SvCUR_set(dstr, SvCUR(sstr));
3664 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3665 SvPV_set(sstr, NULL);
3671 if (sflags & SVp_NOK) {
3672 SvNV_set(dstr, SvNVX(sstr));
3674 if (sflags & SVp_IOK) {
3675 SvRELEASE_IVX(dstr);
3676 SvIV_set(dstr, SvIVX(sstr));
3677 /* Must do this otherwise some other overloaded use of 0x80000000
3678 gets confused. I guess SVpbm_VALID */
3679 if (sflags & SVf_IVisUV)
3682 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3685 const MAGIC * const smg = SvVSTRING_mg(sstr);
3687 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3688 smg->mg_ptr, smg->mg_len);
3689 SvRMAGICAL_on(dstr);
3693 else if (sflags & (SVp_IOK|SVp_NOK)) {
3694 (void)SvOK_off(dstr);
3695 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3697 if (sflags & SVp_IOK) {
3698 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3699 SvIV_set(dstr, SvIVX(sstr));
3701 if (sflags & SVp_NOK) {
3702 SvNV_set(dstr, SvNVX(sstr));
3706 if (isGV_with_GP(sstr)) {
3707 /* This stringification rule for globs is spread in 3 places.
3708 This feels bad. FIXME. */
3709 const U32 wasfake = sflags & SVf_FAKE;
3711 /* FAKE globs can get coerced, so need to turn this off
3712 temporarily if it is on. */
3714 gv_efullname3(dstr, (GV *)sstr, "*");
3715 SvFLAGS(sstr) |= wasfake;
3716 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3719 (void)SvOK_off(dstr);
3721 if (SvTAINTED(sstr))
3726 =for apidoc sv_setsv_mg
3728 Like C<sv_setsv>, but also handles 'set' magic.
3734 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3736 sv_setsv(dstr,sstr);
3740 #ifdef PERL_OLD_COPY_ON_WRITE
3742 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3744 STRLEN cur = SvCUR(sstr);
3745 STRLEN len = SvLEN(sstr);
3746 register char *new_pv;
3749 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3757 if (SvTHINKFIRST(dstr))
3758 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3759 else if (SvPVX_const(dstr))
3760 Safefree(SvPVX_const(dstr));
3764 SvUPGRADE(dstr, SVt_PVIV);
3766 assert (SvPOK(sstr));
3767 assert (SvPOKp(sstr));
3768 assert (!SvIOK(sstr));
3769 assert (!SvIOKp(sstr));
3770 assert (!SvNOK(sstr));
3771 assert (!SvNOKp(sstr));
3773 if (SvIsCOW(sstr)) {
3775 if (SvLEN(sstr) == 0) {
3776 /* source is a COW shared hash key. */
3777 DEBUG_C(PerlIO_printf(Perl_debug_log,
3778 "Fast copy on write: Sharing hash\n"));
3779 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3782 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3784 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3785 SvUPGRADE(sstr, SVt_PVIV);
3786 SvREADONLY_on(sstr);
3788 DEBUG_C(PerlIO_printf(Perl_debug_log,
3789 "Fast copy on write: Converting sstr to COW\n"));
3790 SV_COW_NEXT_SV_SET(dstr, sstr);
3792 SV_COW_NEXT_SV_SET(sstr, dstr);
3793 new_pv = SvPVX_mutable(sstr);
3796 SvPV_set(dstr, new_pv);
3797 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3800 SvLEN_set(dstr, len);
3801 SvCUR_set(dstr, cur);
3810 =for apidoc sv_setpvn
3812 Copies a string into an SV. The C<len> parameter indicates the number of
3813 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3814 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3820 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3823 register char *dptr;
3825 SV_CHECK_THINKFIRST_COW_DROP(sv);
3831 /* len is STRLEN which is unsigned, need to copy to signed */
3834 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3836 SvUPGRADE(sv, SVt_PV);
3838 dptr = SvGROW(sv, len + 1);
3839 Move(ptr,dptr,len,char);
3842 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3847 =for apidoc sv_setpvn_mg
3849 Like C<sv_setpvn>, but also handles 'set' magic.
3855 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3857 sv_setpvn(sv,ptr,len);
3862 =for apidoc sv_setpv
3864 Copies a string into an SV. The string must be null-terminated. Does not
3865 handle 'set' magic. See C<sv_setpv_mg>.
3871 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3874 register STRLEN len;
3876 SV_CHECK_THINKFIRST_COW_DROP(sv);
3882 SvUPGRADE(sv, SVt_PV);
3884 SvGROW(sv, len + 1);
3885 Move(ptr,SvPVX(sv),len+1,char);
3887 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3892 =for apidoc sv_setpv_mg
3894 Like C<sv_setpv>, but also handles 'set' magic.
3900 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3907 =for apidoc sv_usepvn_flags
3909 Tells an SV to use C<ptr> to find its string value. Normally the
3910 string is stored inside the SV but sv_usepvn allows the SV to use an
3911 outside string. The C<ptr> should point to memory that was allocated
3912 by C<malloc>. The string length, C<len>, must be supplied. By default
3913 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3914 so that pointer should not be freed or used by the programmer after
3915 giving it to sv_usepvn, and neither should any pointers from "behind"
3916 that pointer (e.g. ptr + 1) be used.
3918 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3919 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3920 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3921 C<len>, and already meets the requirements for storing in C<SvPVX>)
3927 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3931 SV_CHECK_THINKFIRST_COW_DROP(sv);
3932 SvUPGRADE(sv, SVt_PV);
3935 if (flags & SV_SMAGIC)
3939 if (SvPVX_const(sv))
3943 if (flags & SV_HAS_TRAILING_NUL)
3944 assert(ptr[len] == '\0');
3947 allocate = (flags & SV_HAS_TRAILING_NUL)
3948 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3949 if (flags & SV_HAS_TRAILING_NUL) {
3950 /* It's long enough - do nothing.
3951 Specfically Perl_newCONSTSUB is relying on this. */
3954 /* Force a move to shake out bugs in callers. */
3955 char *new_ptr = (char*)safemalloc(allocate);
3956 Copy(ptr, new_ptr, len, char);
3957 PoisonFree(ptr,len,char);
3961 ptr = (char*) saferealloc (ptr, allocate);
3966 SvLEN_set(sv, allocate);
3967 if (!(flags & SV_HAS_TRAILING_NUL)) {
3970 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3972 if (flags & SV_SMAGIC)
3976 #ifdef PERL_OLD_COPY_ON_WRITE
3977 /* Need to do this *after* making the SV normal, as we need the buffer
3978 pointer to remain valid until after we've copied it. If we let go too early,
3979 another thread could invalidate it by unsharing last of the same hash key
3980 (which it can do by means other than releasing copy-on-write Svs)
3981 or by changing the other copy-on-write SVs in the loop. */
3983 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3985 if (len) { /* this SV was SvIsCOW_normal(sv) */
3986 /* we need to find the SV pointing to us. */
3987 SV *current = SV_COW_NEXT_SV(after);
3989 if (current == sv) {
3990 /* The SV we point to points back to us (there were only two of us
3992 Hence other SV is no longer copy on write either. */
3994 SvREADONLY_off(after);
3996 /* We need to follow the pointers around the loop. */
3998 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4001 /* don't loop forever if the structure is bust, and we have
4002 a pointer into a closed loop. */
4003 assert (current != after);
4004 assert (SvPVX_const(current) == pvx);
4006 /* Make the SV before us point to the SV after us. */
4007 SV_COW_NEXT_SV_SET(current, after);
4010 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4015 Perl_sv_release_IVX(pTHX_ register SV *sv)
4018 sv_force_normal_flags(sv, 0);
4024 =for apidoc sv_force_normal_flags
4026 Undo various types of fakery on an SV: if the PV is a shared string, make
4027 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4028 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4029 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4030 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4031 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4032 set to some other value.) In addition, the C<flags> parameter gets passed to
4033 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4034 with flags set to 0.
4040 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4043 #ifdef PERL_OLD_COPY_ON_WRITE
4044 if (SvREADONLY(sv)) {
4045 /* At this point I believe I should acquire a global SV mutex. */
4047 const char * const pvx = SvPVX_const(sv);
4048 const STRLEN len = SvLEN(sv);
4049 const STRLEN cur = SvCUR(sv);
4050 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4052 PerlIO_printf(Perl_debug_log,
4053 "Copy on write: Force normal %ld\n",
4059 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4062 if (flags & SV_COW_DROP_PV) {
4063 /* OK, so we don't need to copy our buffer. */
4066 SvGROW(sv, cur + 1);
4067 Move(pvx,SvPVX(sv),cur,char);
4071 sv_release_COW(sv, pvx, len, next);
4076 else if (IN_PERL_RUNTIME)
4077 Perl_croak(aTHX_ PL_no_modify);
4078 /* At this point I believe that I can drop the global SV mutex. */
4081 if (SvREADONLY(sv)) {
4083 const char * const pvx = SvPVX_const(sv);
4084 const STRLEN len = SvCUR(sv);
4089 SvGROW(sv, len + 1);
4090 Move(pvx,SvPVX(sv),len,char);
4092 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4094 else if (IN_PERL_RUNTIME)
4095 Perl_croak(aTHX_ PL_no_modify);
4099 sv_unref_flags(sv, flags);
4100 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4107 Efficient removal of characters from the beginning of the string buffer.
4108 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4109 the string buffer. The C<ptr> becomes the first character of the adjusted
4110 string. Uses the "OOK hack".
4111 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4112 refer to the same chunk of data.
4118 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4120 register STRLEN delta;
4121 if (!ptr || !SvPOKp(sv))
4123 delta = ptr - SvPVX_const(sv);
4124 SV_CHECK_THINKFIRST(sv);
4125 if (SvTYPE(sv) < SVt_PVIV)
4126 sv_upgrade(sv,SVt_PVIV);
4129 if (!SvLEN(sv)) { /* make copy of shared string */
4130 const char *pvx = SvPVX_const(sv);
4131 const STRLEN len = SvCUR(sv);
4132 SvGROW(sv, len + 1);
4133 Move(pvx,SvPVX(sv),len,char);
4137 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4138 and we do that anyway inside the SvNIOK_off
4140 SvFLAGS(sv) |= SVf_OOK;
4143 SvLEN_set(sv, SvLEN(sv) - delta);
4144 SvCUR_set(sv, SvCUR(sv) - delta);
4145 SvPV_set(sv, SvPVX(sv) + delta);
4146 SvIV_set(sv, SvIVX(sv) + delta);
4150 =for apidoc sv_catpvn
4152 Concatenates the string onto the end of the string which is in the SV. The
4153 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4154 status set, then the bytes appended should be valid UTF-8.
4155 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4157 =for apidoc sv_catpvn_flags
4159 Concatenates the string onto the end of the string which is in the SV. The
4160 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4161 status set, then the bytes appended should be valid UTF-8.
4162 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4163 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4164 in terms of this function.
4170 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4174 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4176 SvGROW(dsv, dlen + slen + 1);
4178 sstr = SvPVX_const(dsv);
4179 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4180 SvCUR_set(dsv, SvCUR(dsv) + slen);
4182 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4184 if (flags & SV_SMAGIC)
4189 =for apidoc sv_catsv
4191 Concatenates the string from SV C<ssv> onto the end of the string in
4192 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4193 not 'set' magic. See C<sv_catsv_mg>.
4195 =for apidoc sv_catsv_flags
4197 Concatenates the string from SV C<ssv> onto the end of the string in
4198 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4199 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4200 and C<sv_catsv_nomg> are implemented in terms of this function.
4205 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4210 const char *spv = SvPV_const(ssv, slen);
4212 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4213 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4214 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4215 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4216 dsv->sv_flags doesn't have that bit set.
4217 Andy Dougherty 12 Oct 2001
4219 const I32 sutf8 = DO_UTF8(ssv);
4222 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4224 dutf8 = DO_UTF8(dsv);
4226 if (dutf8 != sutf8) {
4228 /* Not modifying source SV, so taking a temporary copy. */
4229 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4231 sv_utf8_upgrade(csv);
4232 spv = SvPV_const(csv, slen);
4235 sv_utf8_upgrade_nomg(dsv);
4237 sv_catpvn_nomg(dsv, spv, slen);
4240 if (flags & SV_SMAGIC)
4245 =for apidoc sv_catpv
4247 Concatenates the string onto the end of the string which is in the SV.
4248 If the SV has the UTF-8 status set, then the bytes appended should be
4249 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4254 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4257 register STRLEN len;
4263 junk = SvPV_force(sv, tlen);
4265 SvGROW(sv, tlen + len + 1);
4267 ptr = SvPVX_const(sv);
4268 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4269 SvCUR_set(sv, SvCUR(sv) + len);
4270 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4275 =for apidoc sv_catpv_mg
4277 Like C<sv_catpv>, but also handles 'set' magic.
4283 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4292 Creates a new SV. A non-zero C<len> parameter indicates the number of
4293 bytes of preallocated string space the SV should have. An extra byte for a
4294 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4295 space is allocated.) The reference count for the new SV is set to 1.
4297 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4298 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4299 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4300 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4301 modules supporting older perls.
4307 Perl_newSV(pTHX_ STRLEN len)
4314 sv_upgrade(sv, SVt_PV);
4315 SvGROW(sv, len + 1);
4320 =for apidoc sv_magicext
4322 Adds magic to an SV, upgrading it if necessary. Applies the
4323 supplied vtable and returns a pointer to the magic added.
4325 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4326 In particular, you can add magic to SvREADONLY SVs, and add more than
4327 one instance of the same 'how'.
4329 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4330 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4331 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4332 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4334 (This is now used as a subroutine by C<sv_magic>.)
4339 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4340 const char* name, I32 namlen)
4345 if (SvTYPE(sv) < SVt_PVMG) {
4346 SvUPGRADE(sv, SVt_PVMG);
4348 Newxz(mg, 1, MAGIC);
4349 mg->mg_moremagic = SvMAGIC(sv);
4350 SvMAGIC_set(sv, mg);
4352 /* Sometimes a magic contains a reference loop, where the sv and
4353 object refer to each other. To prevent a reference loop that
4354 would prevent such objects being freed, we look for such loops
4355 and if we find one we avoid incrementing the object refcount.
4357 Note we cannot do this to avoid self-tie loops as intervening RV must
4358 have its REFCNT incremented to keep it in existence.
4361 if (!obj || obj == sv ||
4362 how == PERL_MAGIC_arylen ||
4363 how == PERL_MAGIC_qr ||
4364 how == PERL_MAGIC_symtab ||
4365 (SvTYPE(obj) == SVt_PVGV &&
4366 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4367 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4368 GvFORM(obj) == (CV*)sv)))
4373 mg->mg_obj = SvREFCNT_inc_simple(obj);
4374 mg->mg_flags |= MGf_REFCOUNTED;
4377 /* Normal self-ties simply pass a null object, and instead of
4378 using mg_obj directly, use the SvTIED_obj macro to produce a
4379 new RV as needed. For glob "self-ties", we are tieing the PVIO
4380 with an RV obj pointing to the glob containing the PVIO. In
4381 this case, to avoid a reference loop, we need to weaken the
4385 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4386 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4392 mg->mg_len = namlen;
4395 mg->mg_ptr = savepvn(name, namlen);
4396 else if (namlen == HEf_SVKEY)
4397 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4399 mg->mg_ptr = (char *) name;
4401 mg->mg_virtual = vtable;
4405 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4410 =for apidoc sv_magic
4412 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4413 then adds a new magic item of type C<how> to the head of the magic list.
4415 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4416 handling of the C<name> and C<namlen> arguments.
4418 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4419 to add more than one instance of the same 'how'.
4425 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4431 #ifdef PERL_OLD_COPY_ON_WRITE
4433 sv_force_normal_flags(sv, 0);
4435 if (SvREADONLY(sv)) {
4437 /* its okay to attach magic to shared strings; the subsequent
4438 * upgrade to PVMG will unshare the string */
4439 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4442 && how != PERL_MAGIC_regex_global
4443 && how != PERL_MAGIC_bm
4444 && how != PERL_MAGIC_fm
4445 && how != PERL_MAGIC_sv
4446 && how != PERL_MAGIC_backref
4449 Perl_croak(aTHX_ PL_no_modify);
4452 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4453 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4454 /* sv_magic() refuses to add a magic of the same 'how' as an
4457 if (how == PERL_MAGIC_taint) {
4459 /* Any scalar which already had taint magic on which someone
4460 (erroneously?) did SvIOK_on() or similar will now be
4461 incorrectly sporting public "OK" flags. */
4462 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4470 vtable = &PL_vtbl_sv;
4472 case PERL_MAGIC_overload:
4473 vtable = &PL_vtbl_amagic;
4475 case PERL_MAGIC_overload_elem:
4476 vtable = &PL_vtbl_amagicelem;
4478 case PERL_MAGIC_overload_table:
4479 vtable = &PL_vtbl_ovrld;
4482 vtable = &PL_vtbl_bm;
4484 case PERL_MAGIC_regdata:
4485 vtable = &PL_vtbl_regdata;
4487 case PERL_MAGIC_regdata_names:
4488 vtable = &PL_vtbl_regdata_names;
4490 case PERL_MAGIC_regdatum:
4491 vtable = &PL_vtbl_regdatum;
4493 case PERL_MAGIC_env:
4494 vtable = &PL_vtbl_env;
4497 vtable = &PL_vtbl_fm;
4499 case PERL_MAGIC_envelem:
4500 vtable = &PL_vtbl_envelem;
4502 case PERL_MAGIC_regex_global:
4503 vtable = &PL_vtbl_mglob;
4505 case PERL_MAGIC_isa:
4506 vtable = &PL_vtbl_isa;
4508 case PERL_MAGIC_isaelem:
4509 vtable = &PL_vtbl_isaelem;
4511 case PERL_MAGIC_nkeys:
4512 vtable = &PL_vtbl_nkeys;
4514 case PERL_MAGIC_dbfile:
4517 case PERL_MAGIC_dbline:
4518 vtable = &PL_vtbl_dbline;
4520 #ifdef USE_LOCALE_COLLATE
4521 case PERL_MAGIC_collxfrm:
4522 vtable = &PL_vtbl_collxfrm;
4524 #endif /* USE_LOCALE_COLLATE */
4525 case PERL_MAGIC_tied:
4526 vtable = &PL_vtbl_pack;
4528 case PERL_MAGIC_tiedelem:
4529 case PERL_MAGIC_tiedscalar:
4530 vtable = &PL_vtbl_packelem;
4533 vtable = &PL_vtbl_regexp;
4535 case PERL_MAGIC_hints:
4536 /* As this vtable is all NULL, we can reuse it. */
4537 case PERL_MAGIC_sig:
4538 vtable = &PL_vtbl_sig;
4540 case PERL_MAGIC_sigelem:
4541 vtable = &PL_vtbl_sigelem;
4543 case PERL_MAGIC_taint:
4544 vtable = &PL_vtbl_taint;
4546 case PERL_MAGIC_uvar:
4547 vtable = &PL_vtbl_uvar;
4549 case PERL_MAGIC_vec:
4550 vtable = &PL_vtbl_vec;
4552 case PERL_MAGIC_arylen_p:
4553 case PERL_MAGIC_rhash:
4554 case PERL_MAGIC_symtab:
4555 case PERL_MAGIC_vstring:
4558 case PERL_MAGIC_utf8:
4559 vtable = &PL_vtbl_utf8;
4561 case PERL_MAGIC_substr:
4562 vtable = &PL_vtbl_substr;
4564 case PERL_MAGIC_defelem:
4565 vtable = &PL_vtbl_defelem;
4567 case PERL_MAGIC_arylen:
4568 vtable = &PL_vtbl_arylen;
4570 case PERL_MAGIC_pos:
4571 vtable = &PL_vtbl_pos;
4573 case PERL_MAGIC_backref:
4574 vtable = &PL_vtbl_backref;
4576 case PERL_MAGIC_hintselem:
4577 vtable = &PL_vtbl_hintselem;
4579 case PERL_MAGIC_ext:
4580 /* Reserved for use by extensions not perl internals. */
4581 /* Useful for attaching extension internal data to perl vars. */
4582 /* Note that multiple extensions may clash if magical scalars */
4583 /* etc holding private data from one are passed to another. */
4587 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4590 /* Rest of work is done else where */
4591 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4594 case PERL_MAGIC_taint:
4597 case PERL_MAGIC_ext:
4598 case PERL_MAGIC_dbfile:
4605 =for apidoc sv_unmagic
4607 Removes all magic of type C<type> from an SV.
4613 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4617 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4619 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4620 for (mg = *mgp; mg; mg = *mgp) {
4621 if (mg->mg_type == type) {
4622 const MGVTBL* const vtbl = mg->mg_virtual;
4623 *mgp = mg->mg_moremagic;
4624 if (vtbl && vtbl->svt_free)
4625 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4626 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4628 Safefree(mg->mg_ptr);
4629 else if (mg->mg_len == HEf_SVKEY)
4630 SvREFCNT_dec((SV*)mg->mg_ptr);
4631 else if (mg->mg_type == PERL_MAGIC_utf8)
4632 Safefree(mg->mg_ptr);
4634 if (mg->mg_flags & MGf_REFCOUNTED)
4635 SvREFCNT_dec(mg->mg_obj);
4639 mgp = &mg->mg_moremagic;
4643 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4644 SvMAGIC_set(sv, NULL);
4651 =for apidoc sv_rvweaken
4653 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4654 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4655 push a back-reference to this RV onto the array of backreferences
4656 associated with that magic. If the RV is magical, set magic will be
4657 called after the RV is cleared.
4663 Perl_sv_rvweaken(pTHX_ SV *sv)
4666 if (!SvOK(sv)) /* let undefs pass */
4669 Perl_croak(aTHX_ "Can't weaken a nonreference");
4670 else if (SvWEAKREF(sv)) {
4671 if (ckWARN(WARN_MISC))
4672 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4676 Perl_sv_add_backref(aTHX_ tsv, sv);
4682 /* Give tsv backref magic if it hasn't already got it, then push a
4683 * back-reference to sv onto the array associated with the backref magic.
4687 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4692 if (SvTYPE(tsv) == SVt_PVHV) {
4693 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4697 /* There is no AV in the offical place - try a fixup. */
4698 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4701 /* Aha. They've got it stowed in magic. Bring it back. */
4702 av = (AV*)mg->mg_obj;
4703 /* Stop mg_free decreasing the refernce count. */
4705 /* Stop mg_free even calling the destructor, given that
4706 there's no AV to free up. */
4708 sv_unmagic(tsv, PERL_MAGIC_backref);
4712 SvREFCNT_inc_simple_void(av);
4717 const MAGIC *const mg
4718 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4720 av = (AV*)mg->mg_obj;
4724 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4725 /* av now has a refcnt of 2, which avoids it getting freed
4726 * before us during global cleanup. The extra ref is removed
4727 * by magic_killbackrefs() when tsv is being freed */
4730 if (AvFILLp(av) >= AvMAX(av)) {
4731 av_extend(av, AvFILLp(av)+1);
4733 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4736 /* delete a back-reference to ourselves from the backref magic associated
4737 * with the SV we point to.
4741 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4748 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4749 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4750 /* We mustn't attempt to "fix up" the hash here by moving the
4751 backreference array back to the hv_aux structure, as that is stored
4752 in the main HvARRAY(), and hfreentries assumes that no-one
4753 reallocates HvARRAY() while it is running. */
4756 const MAGIC *const mg
4757 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4759 av = (AV *)mg->mg_obj;
4762 if (PL_in_clean_all)
4764 Perl_croak(aTHX_ "panic: del_backref");
4771 /* We shouldn't be in here more than once, but for paranoia reasons lets
4773 for (i = AvFILLp(av); i >= 0; i--) {
4775 const SSize_t fill = AvFILLp(av);
4777 /* We weren't the last entry.
4778 An unordered list has this property that you can take the
4779 last element off the end to fill the hole, and it's still
4780 an unordered list :-)
4785 AvFILLp(av) = fill - 1;
4791 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4793 SV **svp = AvARRAY(av);
4795 PERL_UNUSED_ARG(sv);
4797 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4798 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4799 if (svp && !SvIS_FREED(av)) {
4800 SV *const *const last = svp + AvFILLp(av);
4802 while (svp <= last) {
4804 SV *const referrer = *svp;
4805 if (SvWEAKREF(referrer)) {
4806 /* XXX Should we check that it hasn't changed? */
4807 SvRV_set(referrer, 0);
4809 SvWEAKREF_off(referrer);
4810 SvSETMAGIC(referrer);
4811 } else if (SvTYPE(referrer) == SVt_PVGV ||
4812 SvTYPE(referrer) == SVt_PVLV) {
4813 /* You lookin' at me? */
4814 assert(GvSTASH(referrer));
4815 assert(GvSTASH(referrer) == (HV*)sv);
4816 GvSTASH(referrer) = 0;
4819 "panic: magic_killbackrefs (flags=%"UVxf")",
4820 (UV)SvFLAGS(referrer));
4828 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4833 =for apidoc sv_insert
4835 Inserts a string at the specified offset/length within the SV. Similar to
4836 the Perl substr() function.
4842 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4847 register char *midend;
4848 register char *bigend;
4854 Perl_croak(aTHX_ "Can't modify non-existent substring");
4855 SvPV_force(bigstr, curlen);
4856 (void)SvPOK_only_UTF8(bigstr);
4857 if (offset + len > curlen) {
4858 SvGROW(bigstr, offset+len+1);
4859 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4860 SvCUR_set(bigstr, offset+len);
4864 i = littlelen - len;
4865 if (i > 0) { /* string might grow */
4866 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4867 mid = big + offset + len;
4868 midend = bigend = big + SvCUR(bigstr);
4871 while (midend > mid) /* shove everything down */
4872 *--bigend = *--midend;
4873 Move(little,big+offset,littlelen,char);
4874 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4879 Move(little,SvPVX(bigstr)+offset,len,char);
4884 big = SvPVX(bigstr);
4887 bigend = big + SvCUR(bigstr);
4889 if (midend > bigend)
4890 Perl_croak(aTHX_ "panic: sv_insert");
4892 if (mid - big > bigend - midend) { /* faster to shorten from end */
4894 Move(little, mid, littlelen,char);
4897 i = bigend - midend;
4899 Move(midend, mid, i,char);
4903 SvCUR_set(bigstr, mid - big);
4905 else if ((i = mid - big)) { /* faster from front */
4906 midend -= littlelen;
4908 sv_chop(bigstr,midend-i);
4913 Move(little, mid, littlelen,char);
4915 else if (littlelen) {
4916 midend -= littlelen;
4917 sv_chop(bigstr,midend);
4918 Move(little,midend,littlelen,char);
4921 sv_chop(bigstr,midend);
4927 =for apidoc sv_replace
4929 Make the first argument a copy of the second, then delete the original.
4930 The target SV physically takes over ownership of the body of the source SV
4931 and inherits its flags; however, the target keeps any magic it owns,
4932 and any magic in the source is discarded.
4933 Note that this is a rather specialist SV copying operation; most of the
4934 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4940 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4943 const U32 refcnt = SvREFCNT(sv);
4944 SV_CHECK_THINKFIRST_COW_DROP(sv);
4945 if (SvREFCNT(nsv) != 1) {
4946 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4947 UVuf " != 1)", (UV) SvREFCNT(nsv));
4949 if (SvMAGICAL(sv)) {
4953 sv_upgrade(nsv, SVt_PVMG);
4954 SvMAGIC_set(nsv, SvMAGIC(sv));
4955 SvFLAGS(nsv) |= SvMAGICAL(sv);
4957 SvMAGIC_set(sv, NULL);
4961 assert(!SvREFCNT(sv));
4962 #ifdef DEBUG_LEAKING_SCALARS
4963 sv->sv_flags = nsv->sv_flags;
4964 sv->sv_any = nsv->sv_any;
4965 sv->sv_refcnt = nsv->sv_refcnt;
4966 sv->sv_u = nsv->sv_u;
4968 StructCopy(nsv,sv,SV);
4970 /* Currently could join these into one piece of pointer arithmetic, but
4971 it would be unclear. */
4972 if(SvTYPE(sv) == SVt_IV)
4974 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4975 else if (SvTYPE(sv) == SVt_RV) {
4976 SvANY(sv) = &sv->sv_u.svu_rv;
4980 #ifdef PERL_OLD_COPY_ON_WRITE
4981 if (SvIsCOW_normal(nsv)) {
4982 /* We need to follow the pointers around the loop to make the
4983 previous SV point to sv, rather than nsv. */
4986 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4989 assert(SvPVX_const(current) == SvPVX_const(nsv));
4991 /* Make the SV before us point to the SV after us. */
4993 PerlIO_printf(Perl_debug_log, "previous is\n");
4995 PerlIO_printf(Perl_debug_log,
4996 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4997 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4999 SV_COW_NEXT_SV_SET(current, sv);
5002 SvREFCNT(sv) = refcnt;
5003 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5009 =for apidoc sv_clear
5011 Clear an SV: call any destructors, free up any memory used by the body,
5012 and free the body itself. The SV's head is I<not> freed, although
5013 its type is set to all 1's so that it won't inadvertently be assumed
5014 to be live during global destruction etc.
5015 This function should only be called when REFCNT is zero. Most of the time
5016 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5023 Perl_sv_clear(pTHX_ register SV *sv)
5026 const U32 type = SvTYPE(sv);
5027 const struct body_details *const sv_type_details
5028 = bodies_by_type + type;
5031 assert(SvREFCNT(sv) == 0);
5033 if (type <= SVt_IV) {
5034 /* See the comment in sv.h about the collusion between this early
5035 return and the overloading of the NULL and IV slots in the size
5041 if (PL_defstash) { /* Still have a symbol table? */
5046 stash = SvSTASH(sv);
5047 destructor = StashHANDLER(stash,DESTROY);
5049 SV* const tmpref = newRV(sv);
5050 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5052 PUSHSTACKi(PERLSI_DESTROY);
5057 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5063 if(SvREFCNT(tmpref) < 2) {
5064 /* tmpref is not kept alive! */
5066 SvRV_set(tmpref, NULL);
5069 SvREFCNT_dec(tmpref);
5071 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5075 if (PL_in_clean_objs)
5076 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5078 /* DESTROY gave object new lease on life */
5084 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5085 SvOBJECT_off(sv); /* Curse the object. */
5086 if (type != SVt_PVIO)
5087 --PL_sv_objcount; /* XXX Might want something more general */
5090 if (type >= SVt_PVMG) {
5091 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5092 SvREFCNT_dec(OURSTASH(sv));
5093 } else if (SvMAGIC(sv))
5095 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5096 SvREFCNT_dec(SvSTASH(sv));
5101 IoIFP(sv) != PerlIO_stdin() &&
5102 IoIFP(sv) != PerlIO_stdout() &&
5103 IoIFP(sv) != PerlIO_stderr())
5105 io_close((IO*)sv, FALSE);
5107 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5108 PerlDir_close(IoDIRP(sv));
5109 IoDIRP(sv) = (DIR*)NULL;
5110 Safefree(IoTOP_NAME(sv));
5111 Safefree(IoFMT_NAME(sv));
5112 Safefree(IoBOTTOM_NAME(sv));
5121 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5128 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5129 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5130 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5131 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5133 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5134 SvREFCNT_dec(LvTARG(sv));
5138 if (GvNAME_HEK(sv)) {
5139 unshare_hek(GvNAME_HEK(sv));
5141 /* If we're in a stash, we don't own a reference to it. However it does
5142 have a back reference to us, which needs to be cleared. */
5144 sv_del_backref((SV*)GvSTASH(sv), sv);
5149 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5151 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5152 /* Don't even bother with turning off the OOK flag. */
5157 SV * const target = SvRV(sv);
5159 sv_del_backref(target, sv);
5161 SvREFCNT_dec(target);
5163 #ifdef PERL_OLD_COPY_ON_WRITE
5164 else if (SvPVX_const(sv)) {
5166 /* I believe I need to grab the global SV mutex here and
5167 then recheck the COW status. */
5169 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5172 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5173 SV_COW_NEXT_SV(sv));
5174 /* And drop it here. */
5176 } else if (SvLEN(sv)) {
5177 Safefree(SvPVX_const(sv));
5181 else if (SvPVX_const(sv) && SvLEN(sv))
5182 Safefree(SvPVX_mutable(sv));
5183 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5184 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5193 SvFLAGS(sv) &= SVf_BREAK;
5194 SvFLAGS(sv) |= SVTYPEMASK;
5196 if (sv_type_details->arena) {
5197 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5198 &PL_body_roots[type]);
5200 else if (sv_type_details->body_size) {
5201 my_safefree(SvANY(sv));
5206 =for apidoc sv_newref
5208 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5215 Perl_sv_newref(pTHX_ SV *sv)
5217 PERL_UNUSED_CONTEXT;
5226 Decrement an SV's reference count, and if it drops to zero, call
5227 C<sv_clear> to invoke destructors and free up any memory used by
5228 the body; finally, deallocate the SV's head itself.
5229 Normally called via a wrapper macro C<SvREFCNT_dec>.
5235 Perl_sv_free(pTHX_ SV *sv)
5240 if (SvREFCNT(sv) == 0) {
5241 if (SvFLAGS(sv) & SVf_BREAK)
5242 /* this SV's refcnt has been artificially decremented to
5243 * trigger cleanup */
5245 if (PL_in_clean_all) /* All is fair */
5247 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5248 /* make sure SvREFCNT(sv)==0 happens very seldom */
5249 SvREFCNT(sv) = (~(U32)0)/2;
5252 if (ckWARN_d(WARN_INTERNAL)) {
5253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5254 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5255 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5256 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5257 Perl_dump_sv_child(aTHX_ sv);
5262 if (--(SvREFCNT(sv)) > 0)
5264 Perl_sv_free2(aTHX_ sv);
5268 Perl_sv_free2(pTHX_ SV *sv)
5273 if (ckWARN_d(WARN_DEBUGGING))
5274 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5275 "Attempt to free temp prematurely: SV 0x%"UVxf
5276 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5280 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5281 /* make sure SvREFCNT(sv)==0 happens very seldom */
5282 SvREFCNT(sv) = (~(U32)0)/2;
5293 Returns the length of the string in the SV. Handles magic and type
5294 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5300 Perl_sv_len(pTHX_ register SV *sv)
5308 len = mg_length(sv);
5310 (void)SvPV_const(sv, len);
5315 =for apidoc sv_len_utf8
5317 Returns the number of characters in the string in an SV, counting wide
5318 UTF-8 bytes as a single character. Handles magic and type coercion.
5324 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5325 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5326 * (Note that the mg_len is not the length of the mg_ptr field.
5327 * This allows the cache to store the character length of the string without
5328 * needing to malloc() extra storage to attach to the mg_ptr.)
5333 Perl_sv_len_utf8(pTHX_ register SV *sv)
5339 return mg_length(sv);
5343 const U8 *s = (U8*)SvPV_const(sv, len);
5347 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5349 if (mg && mg->mg_len != -1) {
5351 if (PL_utf8cache < 0) {
5352 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5354 /* Need to turn the assertions off otherwise we may
5355 recurse infinitely while printing error messages.
5357 SAVEI8(PL_utf8cache);
5359 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5360 " real %"UVuf" for %"SVf,
5361 (UV) ulen, (UV) real, (void*)sv);
5366 ulen = Perl_utf8_length(aTHX_ s, s + len);
5367 if (!SvREADONLY(sv)) {
5369 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5370 &PL_vtbl_utf8, 0, 0);
5378 return Perl_utf8_length(aTHX_ s, s + len);
5382 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5385 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5388 const U8 *s = start;
5390 while (s < send && uoffset--)
5393 /* This is the existing behaviour. Possibly it should be a croak, as
5394 it's actually a bounds error */
5400 /* Given the length of the string in both bytes and UTF-8 characters, decide
5401 whether to walk forwards or backwards to find the byte corresponding to
5402 the passed in UTF-8 offset. */
5404 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5405 STRLEN uoffset, STRLEN uend)
5407 STRLEN backw = uend - uoffset;
5408 if (uoffset < 2 * backw) {
5409 /* The assumption is that going forwards is twice the speed of going
5410 forward (that's where the 2 * backw comes from).
5411 (The real figure of course depends on the UTF-8 data.) */
5412 return sv_pos_u2b_forwards(start, send, uoffset);
5417 while (UTF8_IS_CONTINUATION(*send))
5420 return send - start;
5423 /* For the string representation of the given scalar, find the byte
5424 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5425 give another position in the string, *before* the sought offset, which
5426 (which is always true, as 0, 0 is a valid pair of positions), which should
5427 help reduce the amount of linear searching.
5428 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5429 will be used to reduce the amount of linear searching. The cache will be
5430 created if necessary, and the found value offered to it for update. */
5432 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5433 const U8 *const send, STRLEN uoffset,
5434 STRLEN uoffset0, STRLEN boffset0) {
5435 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5438 assert (uoffset >= uoffset0);
5440 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5441 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5442 if ((*mgp)->mg_ptr) {
5443 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5444 if (cache[0] == uoffset) {
5445 /* An exact match. */
5448 if (cache[2] == uoffset) {
5449 /* An exact match. */
5453 if (cache[0] < uoffset) {
5454 /* The cache already knows part of the way. */
5455 if (cache[0] > uoffset0) {
5456 /* The cache knows more than the passed in pair */
5457 uoffset0 = cache[0];
5458 boffset0 = cache[1];
5460 if ((*mgp)->mg_len != -1) {
5461 /* And we know the end too. */
5463 + sv_pos_u2b_midway(start + boffset0, send,
5465 (*mgp)->mg_len - uoffset0);
5468 + sv_pos_u2b_forwards(start + boffset0,
5469 send, uoffset - uoffset0);
5472 else if (cache[2] < uoffset) {
5473 /* We're between the two cache entries. */
5474 if (cache[2] > uoffset0) {
5475 /* and the cache knows more than the passed in pair */
5476 uoffset0 = cache[2];
5477 boffset0 = cache[3];
5481 + sv_pos_u2b_midway(start + boffset0,
5484 cache[0] - uoffset0);
5487 + sv_pos_u2b_midway(start + boffset0,
5490 cache[2] - uoffset0);
5494 else if ((*mgp)->mg_len != -1) {
5495 /* If we can take advantage of a passed in offset, do so. */
5496 /* In fact, offset0 is either 0, or less than offset, so don't
5497 need to worry about the other possibility. */
5499 + sv_pos_u2b_midway(start + boffset0, send,
5501 (*mgp)->mg_len - uoffset0);
5506 if (!found || PL_utf8cache < 0) {
5507 const STRLEN real_boffset
5508 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5509 send, uoffset - uoffset0);
5511 if (found && PL_utf8cache < 0) {
5512 if (real_boffset != boffset) {
5513 /* Need to turn the assertions off otherwise we may recurse
5514 infinitely while printing error messages. */
5515 SAVEI8(PL_utf8cache);
5517 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5518 " real %"UVuf" for %"SVf,
5519 (UV) boffset, (UV) real_boffset, (void*)sv);
5522 boffset = real_boffset;
5525 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5531 =for apidoc sv_pos_u2b
5533 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5534 the start of the string, to a count of the equivalent number of bytes; if
5535 lenp is non-zero, it does the same to lenp, but this time starting from
5536 the offset, rather than from the start of the string. Handles magic and
5543 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5544 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5545 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5550 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5558 start = (U8*)SvPV_const(sv, len);
5560 STRLEN uoffset = (STRLEN) *offsetp;
5561 const U8 * const send = start + len;
5563 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5566 *offsetp = (I32) boffset;
5569 /* Convert the relative offset to absolute. */
5570 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5571 const STRLEN boffset2
5572 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5573 uoffset, boffset) - boffset;
5587 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5588 byte length pairing. The (byte) length of the total SV is passed in too,
5589 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5590 may not have updated SvCUR, so we can't rely on reading it directly.
5592 The proffered utf8/byte length pairing isn't used if the cache already has
5593 two pairs, and swapping either for the proffered pair would increase the
5594 RMS of the intervals between known byte offsets.
5596 The cache itself consists of 4 STRLEN values
5597 0: larger UTF-8 offset
5598 1: corresponding byte offset
5599 2: smaller UTF-8 offset
5600 3: corresponding byte offset
5602 Unused cache pairs have the value 0, 0.
5603 Keeping the cache "backwards" means that the invariant of
5604 cache[0] >= cache[2] is maintained even with empty slots, which means that
5605 the code that uses it doesn't need to worry if only 1 entry has actually
5606 been set to non-zero. It also makes the "position beyond the end of the
5607 cache" logic much simpler, as the first slot is always the one to start
5611 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5619 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5621 (*mgp)->mg_len = -1;
5625 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5626 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5627 (*mgp)->mg_ptr = (char *) cache;
5631 if (PL_utf8cache < 0) {
5632 const U8 *start = (const U8 *) SvPVX_const(sv);
5633 const U8 *const end = start + byte;
5634 STRLEN realutf8 = 0;
5636 while (start < end) {
5637 start += UTF8SKIP(start);
5641 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5642 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5643 doesn't? I don't know whether this difference was introduced with
5644 the caching code in 5.8.1. */
5646 if (realutf8 != utf8) {
5647 /* Need to turn the assertions off otherwise we may recurse
5648 infinitely while printing error messages. */
5649 SAVEI8(PL_utf8cache);
5651 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5652 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5656 /* Cache is held with the later position first, to simplify the code
5657 that deals with unbounded ends. */
5659 ASSERT_UTF8_CACHE(cache);
5660 if (cache[1] == 0) {
5661 /* Cache is totally empty */
5664 } else if (cache[3] == 0) {
5665 if (byte > cache[1]) {
5666 /* New one is larger, so goes first. */
5667 cache[2] = cache[0];
5668 cache[3] = cache[1];
5676 #define THREEWAY_SQUARE(a,b,c,d) \
5677 ((float)((d) - (c))) * ((float)((d) - (c))) \
5678 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5679 + ((float)((b) - (a))) * ((float)((b) - (a)))
5681 /* Cache has 2 slots in use, and we know three potential pairs.
5682 Keep the two that give the lowest RMS distance. Do the
5683 calcualation in bytes simply because we always know the byte
5684 length. squareroot has the same ordering as the positive value,
5685 so don't bother with the actual square root. */
5686 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5687 if (byte > cache[1]) {
5688 /* New position is after the existing pair of pairs. */
5689 const float keep_earlier
5690 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5691 const float keep_later
5692 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5694 if (keep_later < keep_earlier) {
5695 if (keep_later < existing) {
5696 cache[2] = cache[0];
5697 cache[3] = cache[1];
5703 if (keep_earlier < existing) {
5709 else if (byte > cache[3]) {
5710 /* New position is between the existing pair of pairs. */
5711 const float keep_earlier
5712 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5713 const float keep_later
5714 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5716 if (keep_later < keep_earlier) {
5717 if (keep_later < existing) {
5723 if (keep_earlier < existing) {
5730 /* New position is before the existing pair of pairs. */
5731 const float keep_earlier
5732 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5733 const float keep_later
5734 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5736 if (keep_later < keep_earlier) {
5737 if (keep_later < existing) {
5743 if (keep_earlier < existing) {
5744 cache[0] = cache[2];
5745 cache[1] = cache[3];
5752 ASSERT_UTF8_CACHE(cache);
5755 /* If we don't know the character offset of the end of a region, our only
5756 option is to walk forwards to the target byte offset. */
5758 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5761 while (s < target) {
5764 /* Call utf8n_to_uvchr() to validate the sequence
5765 * (unless a simple non-UTF character) */
5766 if (!UTF8_IS_INVARIANT(*s))
5767 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5778 /* We already know all of the way, now we may be able to walk back. The same
5779 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5780 backward is half the speed of walking forward. */
5782 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5785 const STRLEN forw = target - s;
5786 STRLEN backw = end - target;
5788 if (forw < 2 * backw) {
5789 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5792 while (end > target) {
5794 while (UTF8_IS_CONTINUATION(*end)) {
5803 =for apidoc sv_pos_b2u
5805 Converts the value pointed to by offsetp from a count of bytes from the
5806 start of the string, to a count of the equivalent number of UTF-8 chars.
5807 Handles magic and type coercion.
5813 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5814 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5819 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5822 const STRLEN byte = *offsetp;
5823 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5832 s = (const U8*)SvPV_const(sv, blen);
5835 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5839 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5840 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5842 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5843 if (cache[1] == byte) {
5844 /* An exact match. */
5845 *offsetp = cache[0];
5848 if (cache[3] == byte) {
5849 /* An exact match. */
5850 *offsetp = cache[2];
5854 if (cache[1] < byte) {
5855 /* We already know part of the way. */
5856 if (mg->mg_len != -1) {
5857 /* Actually, we know the end too. */
5859 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5860 s + blen, mg->mg_len - cache[0]);
5863 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5866 else if (cache[3] < byte) {
5867 /* We're between the two cached pairs, so we do the calculation
5868 offset by the byte/utf-8 positions for the earlier pair,
5869 then add the utf-8 characters from the string start to
5871 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5872 s + cache[1], cache[0] - cache[2])
5876 else { /* cache[3] > byte */
5877 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5881 ASSERT_UTF8_CACHE(cache);
5883 } else if (mg->mg_len != -1) {
5884 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5888 if (!found || PL_utf8cache < 0) {
5889 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5891 if (found && PL_utf8cache < 0) {
5892 if (len != real_len) {
5893 /* Need to turn the assertions off otherwise we may recurse
5894 infinitely while printing error messages. */
5895 SAVEI8(PL_utf8cache);
5897 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5898 " real %"UVuf" for %"SVf,
5899 (UV) len, (UV) real_len, (void*)sv);
5906 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5912 Returns a boolean indicating whether the strings in the two SVs are
5913 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5914 coerce its args to strings if necessary.
5920 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5929 SV* svrecode = NULL;
5936 /* if pv1 and pv2 are the same, second SvPV_const call may
5937 * invalidate pv1, so we may need to make a copy */
5938 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5939 pv1 = SvPV_const(sv1, cur1);
5940 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5941 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5943 pv1 = SvPV_const(sv1, cur1);
5951 pv2 = SvPV_const(sv2, cur2);
5953 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5954 /* Differing utf8ness.
5955 * Do not UTF8size the comparands as a side-effect. */
5958 svrecode = newSVpvn(pv2, cur2);
5959 sv_recode_to_utf8(svrecode, PL_encoding);
5960 pv2 = SvPV_const(svrecode, cur2);
5963 svrecode = newSVpvn(pv1, cur1);
5964 sv_recode_to_utf8(svrecode, PL_encoding);
5965 pv1 = SvPV_const(svrecode, cur1);
5967 /* Now both are in UTF-8. */
5969 SvREFCNT_dec(svrecode);
5974 bool is_utf8 = TRUE;
5977 /* sv1 is the UTF-8 one,
5978 * if is equal it must be downgrade-able */
5979 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5985 /* sv2 is the UTF-8 one,
5986 * if is equal it must be downgrade-able */
5987 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5993 /* Downgrade not possible - cannot be eq */
6001 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6003 SvREFCNT_dec(svrecode);
6013 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6014 string in C<sv1> is less than, equal to, or greater than the string in
6015 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6016 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6022 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6026 const char *pv1, *pv2;
6029 SV *svrecode = NULL;
6036 pv1 = SvPV_const(sv1, cur1);
6043 pv2 = SvPV_const(sv2, cur2);
6045 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6046 /* Differing utf8ness.
6047 * Do not UTF8size the comparands as a side-effect. */
6050 svrecode = newSVpvn(pv2, cur2);
6051 sv_recode_to_utf8(svrecode, PL_encoding);
6052 pv2 = SvPV_const(svrecode, cur2);
6055 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6060 svrecode = newSVpvn(pv1, cur1);
6061 sv_recode_to_utf8(svrecode, PL_encoding);
6062 pv1 = SvPV_const(svrecode, cur1);
6065 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6071 cmp = cur2 ? -1 : 0;
6075 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6078 cmp = retval < 0 ? -1 : 1;
6079 } else if (cur1 == cur2) {
6082 cmp = cur1 < cur2 ? -1 : 1;
6086 SvREFCNT_dec(svrecode);
6094 =for apidoc sv_cmp_locale
6096 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6097 'use bytes' aware, handles get magic, and will coerce its args to strings
6098 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6104 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6107 #ifdef USE_LOCALE_COLLATE
6113 if (PL_collation_standard)
6117 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6119 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6121 if (!pv1 || !len1) {
6132 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6135 return retval < 0 ? -1 : 1;
6138 * When the result of collation is equality, that doesn't mean
6139 * that there are no differences -- some locales exclude some
6140 * characters from consideration. So to avoid false equalities,
6141 * we use the raw string as a tiebreaker.
6147 #endif /* USE_LOCALE_COLLATE */
6149 return sv_cmp(sv1, sv2);
6153 #ifdef USE_LOCALE_COLLATE
6156 =for apidoc sv_collxfrm
6158 Add Collate Transform magic to an SV if it doesn't already have it.
6160 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6161 scalar data of the variable, but transformed to such a format that a normal
6162 memory comparison can be used to compare the data according to the locale
6169 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6174 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6175 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6181 Safefree(mg->mg_ptr);
6182 s = SvPV_const(sv, len);
6183 if ((xf = mem_collxfrm(s, len, &xlen))) {
6184 if (SvREADONLY(sv)) {
6187 return xf + sizeof(PL_collation_ix);
6190 #ifdef PERL_OLD_COPY_ON_WRITE
6192 sv_force_normal_flags(sv, 0);
6194 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6208 if (mg && mg->mg_ptr) {
6210 return mg->mg_ptr + sizeof(PL_collation_ix);
6218 #endif /* USE_LOCALE_COLLATE */
6223 Get a line from the filehandle and store it into the SV, optionally
6224 appending to the currently-stored string.
6230 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6235 register STDCHAR rslast;
6236 register STDCHAR *bp;
6241 if (SvTHINKFIRST(sv))
6242 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6243 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6245 However, perlbench says it's slower, because the existing swipe code
6246 is faster than copy on write.
6247 Swings and roundabouts. */
6248 SvUPGRADE(sv, SVt_PV);
6253 if (PerlIO_isutf8(fp)) {
6255 sv_utf8_upgrade_nomg(sv);
6256 sv_pos_u2b(sv,&append,0);
6258 } else if (SvUTF8(sv)) {
6259 SV * const tsv = newSV(0);
6260 sv_gets(tsv, fp, 0);
6261 sv_utf8_upgrade_nomg(tsv);
6262 SvCUR_set(sv,append);
6265 goto return_string_or_null;
6270 if (PerlIO_isutf8(fp))
6273 if (IN_PERL_COMPILETIME) {
6274 /* we always read code in line mode */
6278 else if (RsSNARF(PL_rs)) {
6279 /* If it is a regular disk file use size from stat() as estimate
6280 of amount we are going to read -- may result in mallocing
6281 more memory than we really need if the layers below reduce
6282 the size we read (e.g. CRLF or a gzip layer).
6285 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6286 const Off_t offset = PerlIO_tell(fp);
6287 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6288 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6294 else if (RsRECORD(PL_rs)) {
6299 /* Grab the size of the record we're getting */
6300 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6301 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6304 /* VMS wants read instead of fread, because fread doesn't respect */
6305 /* RMS record boundaries. This is not necessarily a good thing to be */
6306 /* doing, but we've got no other real choice - except avoid stdio
6307 as implementation - perhaps write a :vms layer ?
6309 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6311 bytesread = PerlIO_read(fp, buffer, recsize);
6315 SvCUR_set(sv, bytesread += append);
6316 buffer[bytesread] = '\0';
6317 goto return_string_or_null;
6319 else if (RsPARA(PL_rs)) {
6325 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6326 if (PerlIO_isutf8(fp)) {
6327 rsptr = SvPVutf8(PL_rs, rslen);
6330 if (SvUTF8(PL_rs)) {
6331 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6332 Perl_croak(aTHX_ "Wide character in $/");
6335 rsptr = SvPV_const(PL_rs, rslen);
6339 rslast = rslen ? rsptr[rslen - 1] : '\0';
6341 if (rspara) { /* have to do this both before and after */
6342 do { /* to make sure file boundaries work right */
6345 i = PerlIO_getc(fp);
6349 PerlIO_ungetc(fp,i);
6355 /* See if we know enough about I/O mechanism to cheat it ! */
6357 /* This used to be #ifdef test - it is made run-time test for ease
6358 of abstracting out stdio interface. One call should be cheap
6359 enough here - and may even be a macro allowing compile
6363 if (PerlIO_fast_gets(fp)) {
6366 * We're going to steal some values from the stdio struct
6367 * and put EVERYTHING in the innermost loop into registers.
6369 register STDCHAR *ptr;
6373 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6374 /* An ungetc()d char is handled separately from the regular
6375 * buffer, so we getc() it back out and stuff it in the buffer.
6377 i = PerlIO_getc(fp);
6378 if (i == EOF) return 0;
6379 *(--((*fp)->_ptr)) = (unsigned char) i;
6383 /* Here is some breathtakingly efficient cheating */
6385 cnt = PerlIO_get_cnt(fp); /* get count into register */
6386 /* make sure we have the room */
6387 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6388 /* Not room for all of it
6389 if we are looking for a separator and room for some
6391 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6392 /* just process what we have room for */
6393 shortbuffered = cnt - SvLEN(sv) + append + 1;
6394 cnt -= shortbuffered;
6398 /* remember that cnt can be negative */
6399 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6404 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6405 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6406 DEBUG_P(PerlIO_printf(Perl_debug_log,
6407 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6408 DEBUG_P(PerlIO_printf(Perl_debug_log,
6409 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6410 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6411 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6416 while (cnt > 0) { /* this | eat */
6418 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6419 goto thats_all_folks; /* screams | sed :-) */
6423 Copy(ptr, bp, cnt, char); /* this | eat */
6424 bp += cnt; /* screams | dust */
6425 ptr += cnt; /* louder | sed :-) */
6430 if (shortbuffered) { /* oh well, must extend */
6431 cnt = shortbuffered;
6433 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6435 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6436 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6440 DEBUG_P(PerlIO_printf(Perl_debug_log,
6441 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6442 PTR2UV(ptr),(long)cnt));
6443 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6445 DEBUG_P(PerlIO_printf(Perl_debug_log,
6446 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6447 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6448 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6450 /* This used to call 'filbuf' in stdio form, but as that behaves like
6451 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6452 another abstraction. */
6453 i = PerlIO_getc(fp); /* get more characters */
6455 DEBUG_P(PerlIO_printf(Perl_debug_log,
6456 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6457 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6458 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6460 cnt = PerlIO_get_cnt(fp);
6461 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6462 DEBUG_P(PerlIO_printf(Perl_debug_log,
6463 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6465 if (i == EOF) /* all done for ever? */
6466 goto thats_really_all_folks;
6468 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6470 SvGROW(sv, bpx + cnt + 2);
6471 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6473 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6475 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6476 goto thats_all_folks;
6480 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6481 memNE((char*)bp - rslen, rsptr, rslen))
6482 goto screamer; /* go back to the fray */
6483 thats_really_all_folks:
6485 cnt += shortbuffered;
6486 DEBUG_P(PerlIO_printf(Perl_debug_log,
6487 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6488 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6489 DEBUG_P(PerlIO_printf(Perl_debug_log,
6490 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6491 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6492 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6494 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6495 DEBUG_P(PerlIO_printf(Perl_debug_log,
6496 "Screamer: done, len=%ld, string=|%.*s|\n",
6497 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6501 /*The big, slow, and stupid way. */
6502 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6503 STDCHAR *buf = NULL;
6504 Newx(buf, 8192, STDCHAR);
6512 register const STDCHAR * const bpe = buf + sizeof(buf);
6514 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6515 ; /* keep reading */
6519 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6520 /* Accomodate broken VAXC compiler, which applies U8 cast to
6521 * both args of ?: operator, causing EOF to change into 255
6524 i = (U8)buf[cnt - 1];
6530 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6532 sv_catpvn(sv, (char *) buf, cnt);
6534 sv_setpvn(sv, (char *) buf, cnt);
6536 if (i != EOF && /* joy */
6538 SvCUR(sv) < rslen ||
6539 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6543 * If we're reading from a TTY and we get a short read,
6544 * indicating that the user hit his EOF character, we need
6545 * to notice it now, because if we try to read from the TTY
6546 * again, the EOF condition will disappear.
6548 * The comparison of cnt to sizeof(buf) is an optimization
6549 * that prevents unnecessary calls to feof().
6553 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6557 #ifdef USE_HEAP_INSTEAD_OF_STACK
6562 if (rspara) { /* have to do this both before and after */
6563 while (i != EOF) { /* to make sure file boundaries work right */
6564 i = PerlIO_getc(fp);
6566 PerlIO_ungetc(fp,i);
6572 return_string_or_null:
6573 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6579 Auto-increment of the value in the SV, doing string to numeric conversion
6580 if necessary. Handles 'get' magic.
6586 Perl_sv_inc(pTHX_ register SV *sv)
6595 if (SvTHINKFIRST(sv)) {
6597 sv_force_normal_flags(sv, 0);
6598 if (SvREADONLY(sv)) {
6599 if (IN_PERL_RUNTIME)
6600 Perl_croak(aTHX_ PL_no_modify);
6604 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6606 i = PTR2IV(SvRV(sv));
6611 flags = SvFLAGS(sv);
6612 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6613 /* It's (privately or publicly) a float, but not tested as an
6614 integer, so test it to see. */
6616 flags = SvFLAGS(sv);
6618 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6619 /* It's publicly an integer, or privately an integer-not-float */
6620 #ifdef PERL_PRESERVE_IVUV
6624 if (SvUVX(sv) == UV_MAX)
6625 sv_setnv(sv, UV_MAX_P1);
6627 (void)SvIOK_only_UV(sv);
6628 SvUV_set(sv, SvUVX(sv) + 1);
6630 if (SvIVX(sv) == IV_MAX)
6631 sv_setuv(sv, (UV)IV_MAX + 1);
6633 (void)SvIOK_only(sv);
6634 SvIV_set(sv, SvIVX(sv) + 1);
6639 if (flags & SVp_NOK) {
6640 (void)SvNOK_only(sv);
6641 SvNV_set(sv, SvNVX(sv) + 1.0);
6645 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6646 if ((flags & SVTYPEMASK) < SVt_PVIV)
6647 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6648 (void)SvIOK_only(sv);
6653 while (isALPHA(*d)) d++;
6654 while (isDIGIT(*d)) d++;
6656 #ifdef PERL_PRESERVE_IVUV
6657 /* Got to punt this as an integer if needs be, but we don't issue
6658 warnings. Probably ought to make the sv_iv_please() that does
6659 the conversion if possible, and silently. */
6660 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6661 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6662 /* Need to try really hard to see if it's an integer.
6663 9.22337203685478e+18 is an integer.
6664 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6665 so $a="9.22337203685478e+18"; $a+0; $a++
6666 needs to be the same as $a="9.22337203685478e+18"; $a++
6673 /* sv_2iv *should* have made this an NV */
6674 if (flags & SVp_NOK) {
6675 (void)SvNOK_only(sv);
6676 SvNV_set(sv, SvNVX(sv) + 1.0);
6679 /* I don't think we can get here. Maybe I should assert this
6680 And if we do get here I suspect that sv_setnv will croak. NWC
6682 #if defined(USE_LONG_DOUBLE)
6683 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",
6684 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6686 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6687 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6690 #endif /* PERL_PRESERVE_IVUV */
6691 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6695 while (d >= SvPVX_const(sv)) {
6703 /* MKS: The original code here died if letters weren't consecutive.
6704 * at least it didn't have to worry about non-C locales. The
6705 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6706 * arranged in order (although not consecutively) and that only
6707 * [A-Za-z] are accepted by isALPHA in the C locale.
6709 if (*d != 'z' && *d != 'Z') {
6710 do { ++*d; } while (!isALPHA(*d));
6713 *(d--) -= 'z' - 'a';
6718 *(d--) -= 'z' - 'a' + 1;
6722 /* oh,oh, the number grew */
6723 SvGROW(sv, SvCUR(sv) + 2);
6724 SvCUR_set(sv, SvCUR(sv) + 1);
6725 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6736 Auto-decrement of the value in the SV, doing string to numeric conversion
6737 if necessary. Handles 'get' magic.
6743 Perl_sv_dec(pTHX_ register SV *sv)
6751 if (SvTHINKFIRST(sv)) {
6753 sv_force_normal_flags(sv, 0);
6754 if (SvREADONLY(sv)) {
6755 if (IN_PERL_RUNTIME)
6756 Perl_croak(aTHX_ PL_no_modify);
6760 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6762 i = PTR2IV(SvRV(sv));
6767 /* Unlike sv_inc we don't have to worry about string-never-numbers
6768 and keeping them magic. But we mustn't warn on punting */
6769 flags = SvFLAGS(sv);
6770 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6771 /* It's publicly an integer, or privately an integer-not-float */
6772 #ifdef PERL_PRESERVE_IVUV
6776 if (SvUVX(sv) == 0) {
6777 (void)SvIOK_only(sv);
6781 (void)SvIOK_only_UV(sv);
6782 SvUV_set(sv, SvUVX(sv) - 1);
6785 if (SvIVX(sv) == IV_MIN)
6786 sv_setnv(sv, (NV)IV_MIN - 1.0);
6788 (void)SvIOK_only(sv);
6789 SvIV_set(sv, SvIVX(sv) - 1);
6794 if (flags & SVp_NOK) {
6795 SvNV_set(sv, SvNVX(sv) - 1.0);
6796 (void)SvNOK_only(sv);
6799 if (!(flags & SVp_POK)) {
6800 if ((flags & SVTYPEMASK) < SVt_PVIV)
6801 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6803 (void)SvIOK_only(sv);
6806 #ifdef PERL_PRESERVE_IVUV
6808 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6809 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6810 /* Need to try really hard to see if it's an integer.
6811 9.22337203685478e+18 is an integer.
6812 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6813 so $a="9.22337203685478e+18"; $a+0; $a--
6814 needs to be the same as $a="9.22337203685478e+18"; $a--
6821 /* sv_2iv *should* have made this an NV */
6822 if (flags & SVp_NOK) {
6823 (void)SvNOK_only(sv);
6824 SvNV_set(sv, SvNVX(sv) - 1.0);
6827 /* I don't think we can get here. Maybe I should assert this
6828 And if we do get here I suspect that sv_setnv will croak. NWC
6830 #if defined(USE_LONG_DOUBLE)
6831 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",
6832 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6834 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6835 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6839 #endif /* PERL_PRESERVE_IVUV */
6840 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6844 =for apidoc sv_mortalcopy
6846 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6847 The new SV is marked as mortal. It will be destroyed "soon", either by an
6848 explicit call to FREETMPS, or by an implicit call at places such as
6849 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6854 /* Make a string that will exist for the duration of the expression
6855 * evaluation. Actually, it may have to last longer than that, but
6856 * hopefully we won't free it until it has been assigned to a
6857 * permanent location. */
6860 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6866 sv_setsv(sv,oldstr);
6868 PL_tmps_stack[++PL_tmps_ix] = sv;
6874 =for apidoc sv_newmortal
6876 Creates a new null SV which is mortal. The reference count of the SV is
6877 set to 1. It will be destroyed "soon", either by an explicit call to
6878 FREETMPS, or by an implicit call at places such as statement boundaries.
6879 See also C<sv_mortalcopy> and C<sv_2mortal>.
6885 Perl_sv_newmortal(pTHX)
6891 SvFLAGS(sv) = SVs_TEMP;
6893 PL_tmps_stack[++PL_tmps_ix] = sv;
6898 =for apidoc sv_2mortal
6900 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6901 by an explicit call to FREETMPS, or by an implicit call at places such as
6902 statement boundaries. SvTEMP() is turned on which means that the SV's
6903 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6904 and C<sv_mortalcopy>.
6910 Perl_sv_2mortal(pTHX_ register SV *sv)
6915 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6918 PL_tmps_stack[++PL_tmps_ix] = sv;
6926 Creates a new SV and copies a string into it. The reference count for the
6927 SV is set to 1. If C<len> is zero, Perl will compute the length using
6928 strlen(). For efficiency, consider using C<newSVpvn> instead.
6934 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6940 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6945 =for apidoc newSVpvn
6947 Creates a new SV and copies a string into it. The reference count for the
6948 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6949 string. You are responsible for ensuring that the source string is at least
6950 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6956 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6962 sv_setpvn(sv,s,len);
6968 =for apidoc newSVhek
6970 Creates a new SV from the hash key structure. It will generate scalars that
6971 point to the shared string table where possible. Returns a new (undefined)
6972 SV if the hek is NULL.
6978 Perl_newSVhek(pTHX_ const HEK *hek)
6988 if (HEK_LEN(hek) == HEf_SVKEY) {
6989 return newSVsv(*(SV**)HEK_KEY(hek));
6991 const int flags = HEK_FLAGS(hek);
6992 if (flags & HVhek_WASUTF8) {
6994 Andreas would like keys he put in as utf8 to come back as utf8
6996 STRLEN utf8_len = HEK_LEN(hek);
6997 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6998 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7001 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7003 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7004 /* We don't have a pointer to the hv, so we have to replicate the
7005 flag into every HEK. This hv is using custom a hasing
7006 algorithm. Hence we can't return a shared string scalar, as
7007 that would contain the (wrong) hash value, and might get passed
7008 into an hv routine with a regular hash.
7009 Similarly, a hash that isn't using shared hash keys has to have
7010 the flag in every key so that we know not to try to call
7011 share_hek_kek on it. */
7013 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7018 /* This will be overwhelminly the most common case. */
7020 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7021 more efficient than sharepvn(). */
7025 sv_upgrade(sv, SVt_PV);
7026 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7027 SvCUR_set(sv, HEK_LEN(hek));
7040 =for apidoc newSVpvn_share
7042 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7043 table. If the string does not already exist in the table, it is created
7044 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7045 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7046 otherwise the hash is computed. The idea here is that as the string table
7047 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7048 hash lookup will avoid string compare.
7054 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7058 bool is_utf8 = FALSE;
7059 const char *const orig_src = src;
7062 STRLEN tmplen = -len;
7064 /* See the note in hv.c:hv_fetch() --jhi */
7065 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7069 PERL_HASH(hash, src, len);
7071 sv_upgrade(sv, SVt_PV);
7072 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7080 if (src != orig_src)
7086 #if defined(PERL_IMPLICIT_CONTEXT)
7088 /* pTHX_ magic can't cope with varargs, so this is a no-context
7089 * version of the main function, (which may itself be aliased to us).
7090 * Don't access this version directly.
7094 Perl_newSVpvf_nocontext(const char* pat, ...)
7099 va_start(args, pat);
7100 sv = vnewSVpvf(pat, &args);
7107 =for apidoc newSVpvf
7109 Creates a new SV and initializes it with the string formatted like
7116 Perl_newSVpvf(pTHX_ const char* pat, ...)
7120 va_start(args, pat);
7121 sv = vnewSVpvf(pat, &args);
7126 /* backend for newSVpvf() and newSVpvf_nocontext() */
7129 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7134 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7141 Creates a new SV and copies a floating point value into it.
7142 The reference count for the SV is set to 1.
7148 Perl_newSVnv(pTHX_ NV n)
7161 Creates a new SV and copies an integer into it. The reference count for the
7168 Perl_newSViv(pTHX_ IV i)
7181 Creates a new SV and copies an unsigned integer into it.
7182 The reference count for the SV is set to 1.
7188 Perl_newSVuv(pTHX_ UV u)
7199 =for apidoc newRV_noinc
7201 Creates an RV wrapper for an SV. The reference count for the original
7202 SV is B<not> incremented.
7208 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7214 sv_upgrade(sv, SVt_RV);
7216 SvRV_set(sv, tmpRef);
7221 /* newRV_inc is the official function name to use now.
7222 * newRV_inc is in fact #defined to newRV in sv.h
7226 Perl_newRV(pTHX_ SV *sv)
7229 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7235 Creates a new SV which is an exact duplicate of the original SV.
7242 Perl_newSVsv(pTHX_ register SV *old)
7249 if (SvTYPE(old) == SVTYPEMASK) {
7250 if (ckWARN_d(WARN_INTERNAL))
7251 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7255 /* SV_GMAGIC is the default for sv_setv()
7256 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7257 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7258 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7263 =for apidoc sv_reset
7265 Underlying implementation for the C<reset> Perl function.
7266 Note that the perl-level function is vaguely deprecated.
7272 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7275 char todo[PERL_UCHAR_MAX+1];
7280 if (!*s) { /* reset ?? searches */
7281 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7283 PMOP *pm = (PMOP *) mg->mg_obj;
7285 pm->op_pmdynflags &= ~PMdf_USED;
7292 /* reset variables */
7294 if (!HvARRAY(stash))
7297 Zero(todo, 256, char);
7300 I32 i = (unsigned char)*s;
7304 max = (unsigned char)*s++;
7305 for ( ; i <= max; i++) {
7308 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7310 for (entry = HvARRAY(stash)[i];
7312 entry = HeNEXT(entry))
7317 if (!todo[(U8)*HeKEY(entry)])
7319 gv = (GV*)HeVAL(entry);
7322 if (SvTHINKFIRST(sv)) {
7323 if (!SvREADONLY(sv) && SvROK(sv))
7325 /* XXX Is this continue a bug? Why should THINKFIRST
7326 exempt us from resetting arrays and hashes? */
7330 if (SvTYPE(sv) >= SVt_PV) {
7332 if (SvPVX_const(sv) != NULL)
7340 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7342 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7345 # if defined(USE_ENVIRON_ARRAY)
7348 # endif /* USE_ENVIRON_ARRAY */
7359 Using various gambits, try to get an IO from an SV: the IO slot if its a
7360 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7361 named after the PV if we're a string.
7367 Perl_sv_2io(pTHX_ SV *sv)
7372 switch (SvTYPE(sv)) {
7380 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7384 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7386 return sv_2io(SvRV(sv));
7387 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7393 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7402 Using various gambits, try to get a CV from an SV; in addition, try if
7403 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7404 The flags in C<lref> are passed to sv_fetchsv.
7410 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7421 switch (SvTYPE(sv)) {
7440 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7441 tryAMAGICunDEREF(to_cv);
7444 if (SvTYPE(sv) == SVt_PVCV) {
7453 Perl_croak(aTHX_ "Not a subroutine reference");
7458 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7464 /* Some flags to gv_fetchsv mean don't really create the GV */
7465 if (SvTYPE(gv) != SVt_PVGV) {
7471 if (lref && !GvCVu(gv)) {
7475 gv_efullname3(tmpsv, gv, NULL);
7476 /* XXX this is probably not what they think they're getting.
7477 * It has the same effect as "sub name;", i.e. just a forward
7479 newSUB(start_subparse(FALSE, 0),
7480 newSVOP(OP_CONST, 0, tmpsv),
7484 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7494 Returns true if the SV has a true value by Perl's rules.
7495 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7496 instead use an in-line version.
7502 Perl_sv_true(pTHX_ register SV *sv)
7507 register const XPV* const tXpv = (XPV*)SvANY(sv);
7509 (tXpv->xpv_cur > 1 ||
7510 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7517 return SvIVX(sv) != 0;
7520 return SvNVX(sv) != 0.0;
7522 return sv_2bool(sv);
7528 =for apidoc sv_pvn_force
7530 Get a sensible string out of the SV somehow.
7531 A private implementation of the C<SvPV_force> macro for compilers which
7532 can't cope with complex macro expressions. Always use the macro instead.
7534 =for apidoc sv_pvn_force_flags
7536 Get a sensible string out of the SV somehow.
7537 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7538 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7539 implemented in terms of this function.
7540 You normally want to use the various wrapper macros instead: see
7541 C<SvPV_force> and C<SvPV_force_nomg>
7547 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7550 if (SvTHINKFIRST(sv) && !SvROK(sv))
7551 sv_force_normal_flags(sv, 0);
7561 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7562 const char * const ref = sv_reftype(sv,0);
7564 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7565 ref, OP_NAME(PL_op));
7567 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7569 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7570 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7572 s = sv_2pv_flags(sv, &len, flags);
7576 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7579 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7580 SvGROW(sv, len + 1);
7581 Move(s,SvPVX(sv),len,char);
7586 SvPOK_on(sv); /* validate pointer */
7588 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7589 PTR2UV(sv),SvPVX_const(sv)));
7592 return SvPVX_mutable(sv);
7596 =for apidoc sv_pvbyten_force
7598 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7604 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7606 sv_pvn_force(sv,lp);
7607 sv_utf8_downgrade(sv,0);
7613 =for apidoc sv_pvutf8n_force
7615 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7621 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7623 sv_pvn_force(sv,lp);
7624 sv_utf8_upgrade(sv);
7630 =for apidoc sv_reftype
7632 Returns a string describing what the SV is a reference to.
7638 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7640 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7641 inside return suggests a const propagation bug in g++. */
7642 if (ob && SvOBJECT(sv)) {
7643 char * const name = HvNAME_get(SvSTASH(sv));
7644 return name ? name : (char *) "__ANON__";
7647 switch (SvTYPE(sv)) {
7664 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7665 /* tied lvalues should appear to be
7666 * scalars for backwards compatitbility */
7667 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7668 ? "SCALAR" : "LVALUE");
7669 case SVt_PVAV: return "ARRAY";
7670 case SVt_PVHV: return "HASH";
7671 case SVt_PVCV: return "CODE";
7672 case SVt_PVGV: return "GLOB";
7673 case SVt_PVFM: return "FORMAT";
7674 case SVt_PVIO: return "IO";
7675 default: return "UNKNOWN";
7681 =for apidoc sv_isobject
7683 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7684 object. If the SV is not an RV, or if the object is not blessed, then this
7691 Perl_sv_isobject(pTHX_ SV *sv)
7707 Returns a boolean indicating whether the SV is blessed into the specified
7708 class. This does not check for subtypes; use C<sv_derived_from> to verify
7709 an inheritance relationship.
7715 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7726 hvname = HvNAME_get(SvSTASH(sv));
7730 return strEQ(hvname, name);
7736 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7737 it will be upgraded to one. If C<classname> is non-null then the new SV will
7738 be blessed in the specified package. The new SV is returned and its
7739 reference count is 1.
7745 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7752 SV_CHECK_THINKFIRST_COW_DROP(rv);
7755 if (SvTYPE(rv) >= SVt_PVMG) {
7756 const U32 refcnt = SvREFCNT(rv);
7760 SvREFCNT(rv) = refcnt;
7762 sv_upgrade(rv, SVt_RV);
7763 } else if (SvROK(rv)) {
7764 SvREFCNT_dec(SvRV(rv));
7765 } else if (SvTYPE(rv) < SVt_RV)
7766 sv_upgrade(rv, SVt_RV);
7767 else if (SvTYPE(rv) > SVt_RV) {
7778 HV* const stash = gv_stashpv(classname, TRUE);
7779 (void)sv_bless(rv, stash);
7785 =for apidoc sv_setref_pv
7787 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7788 argument will be upgraded to an RV. That RV will be modified to point to
7789 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7790 into the SV. The C<classname> argument indicates the package for the
7791 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7792 will have a reference count of 1, and the RV will be returned.
7794 Do not use with other Perl types such as HV, AV, SV, CV, because those
7795 objects will become corrupted by the pointer copy process.
7797 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7803 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7807 sv_setsv(rv, &PL_sv_undef);
7811 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7816 =for apidoc sv_setref_iv
7818 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7819 argument will be upgraded to an RV. That RV will be modified to point to
7820 the new SV. The C<classname> argument indicates the package for the
7821 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7822 will have a reference count of 1, and the RV will be returned.
7828 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7830 sv_setiv(newSVrv(rv,classname), iv);
7835 =for apidoc sv_setref_uv
7837 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7838 argument will be upgraded to an RV. That RV will be modified to point to
7839 the new SV. The C<classname> argument indicates the package for the
7840 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7841 will have a reference count of 1, and the RV will be returned.
7847 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7849 sv_setuv(newSVrv(rv,classname), uv);
7854 =for apidoc sv_setref_nv
7856 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7857 argument will be upgraded to an RV. That RV will be modified to point to
7858 the new SV. The C<classname> argument indicates the package for the
7859 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7860 will have a reference count of 1, and the RV will be returned.
7866 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7868 sv_setnv(newSVrv(rv,classname), nv);
7873 =for apidoc sv_setref_pvn
7875 Copies a string into a new SV, optionally blessing the SV. The length of the
7876 string must be specified with C<n>. The C<rv> argument will be upgraded to
7877 an RV. That RV will be modified to point to the new SV. The C<classname>
7878 argument indicates the package for the blessing. Set C<classname> to
7879 C<NULL> to avoid the blessing. The new SV will have a reference count
7880 of 1, and the RV will be returned.
7882 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7888 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7890 sv_setpvn(newSVrv(rv,classname), pv, n);
7895 =for apidoc sv_bless
7897 Blesses an SV into a specified package. The SV must be an RV. The package
7898 must be designated by its stash (see C<gv_stashpv()>). The reference count
7899 of the SV is unaffected.
7905 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7910 Perl_croak(aTHX_ "Can't bless non-reference value");
7912 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7913 if (SvREADONLY(tmpRef))
7914 Perl_croak(aTHX_ PL_no_modify);
7915 if (SvOBJECT(tmpRef)) {
7916 if (SvTYPE(tmpRef) != SVt_PVIO)
7918 SvREFCNT_dec(SvSTASH(tmpRef));
7921 SvOBJECT_on(tmpRef);
7922 if (SvTYPE(tmpRef) != SVt_PVIO)
7924 SvUPGRADE(tmpRef, SVt_PVMG);
7925 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7932 if(SvSMAGICAL(tmpRef))
7933 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7941 /* Downgrades a PVGV to a PVMG.
7945 S_sv_unglob(pTHX_ SV *sv)
7949 SV * const temp = sv_newmortal();
7951 assert(SvTYPE(sv) == SVt_PVGV);
7953 gv_efullname3(temp, (GV *) sv, "*");
7959 sv_del_backref((SV*)GvSTASH(sv), sv);
7963 if (GvNAME_HEK(sv)) {
7964 unshare_hek(GvNAME_HEK(sv));
7968 /* need to keep SvANY(sv) in the right arena */
7969 xpvmg = new_XPVMG();
7970 StructCopy(SvANY(sv), xpvmg, XPVMG);
7971 del_XPVGV(SvANY(sv));
7974 SvFLAGS(sv) &= ~SVTYPEMASK;
7975 SvFLAGS(sv) |= SVt_PVMG;
7977 /* Intentionally not calling any local SET magic, as this isn't so much a
7978 set operation as merely an internal storage change. */
7979 sv_setsv_flags(sv, temp, 0);
7983 =for apidoc sv_unref_flags
7985 Unsets the RV status of the SV, and decrements the reference count of
7986 whatever was being referenced by the RV. This can almost be thought of
7987 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7988 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7989 (otherwise the decrementing is conditional on the reference count being
7990 different from one or the reference being a readonly SV).
7997 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7999 SV* const target = SvRV(ref);
8001 if (SvWEAKREF(ref)) {
8002 sv_del_backref(target, ref);
8004 SvRV_set(ref, NULL);
8007 SvRV_set(ref, NULL);
8009 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8010 assigned to as BEGIN {$a = \"Foo"} will fail. */
8011 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8012 SvREFCNT_dec(target);
8013 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8014 sv_2mortal(target); /* Schedule for freeing later */
8018 =for apidoc sv_untaint
8020 Untaint an SV. Use C<SvTAINTED_off> instead.
8025 Perl_sv_untaint(pTHX_ SV *sv)
8027 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8028 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8035 =for apidoc sv_tainted
8037 Test an SV for taintedness. Use C<SvTAINTED> instead.
8042 Perl_sv_tainted(pTHX_ SV *sv)
8044 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8045 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8046 if (mg && (mg->mg_len & 1) )
8053 =for apidoc sv_setpviv
8055 Copies an integer into the given SV, also updating its string value.
8056 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8062 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8064 char buf[TYPE_CHARS(UV)];
8066 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8068 sv_setpvn(sv, ptr, ebuf - ptr);
8072 =for apidoc sv_setpviv_mg
8074 Like C<sv_setpviv>, but also handles 'set' magic.
8080 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8086 #if defined(PERL_IMPLICIT_CONTEXT)
8088 /* pTHX_ magic can't cope with varargs, so this is a no-context
8089 * version of the main function, (which may itself be aliased to us).
8090 * Don't access this version directly.
8094 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8098 va_start(args, pat);
8099 sv_vsetpvf(sv, pat, &args);
8103 /* pTHX_ magic can't cope with varargs, so this is a no-context
8104 * version of the main function, (which may itself be aliased to us).
8105 * Don't access this version directly.
8109 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8113 va_start(args, pat);
8114 sv_vsetpvf_mg(sv, pat, &args);
8120 =for apidoc sv_setpvf
8122 Works like C<sv_catpvf> but copies the text into the SV instead of
8123 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8129 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8132 va_start(args, pat);
8133 sv_vsetpvf(sv, pat, &args);
8138 =for apidoc sv_vsetpvf
8140 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8141 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8143 Usually used via its frontend C<sv_setpvf>.
8149 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8151 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8155 =for apidoc sv_setpvf_mg
8157 Like C<sv_setpvf>, but also handles 'set' magic.
8163 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8166 va_start(args, pat);
8167 sv_vsetpvf_mg(sv, pat, &args);
8172 =for apidoc sv_vsetpvf_mg
8174 Like C<sv_vsetpvf>, but also handles 'set' magic.
8176 Usually used via its frontend C<sv_setpvf_mg>.
8182 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8184 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8188 #if defined(PERL_IMPLICIT_CONTEXT)
8190 /* pTHX_ magic can't cope with varargs, so this is a no-context
8191 * version of the main function, (which may itself be aliased to us).
8192 * Don't access this version directly.
8196 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8200 va_start(args, pat);
8201 sv_vcatpvf(sv, pat, &args);
8205 /* pTHX_ magic can't cope with varargs, so this is a no-context
8206 * version of the main function, (which may itself be aliased to us).
8207 * Don't access this version directly.
8211 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8215 va_start(args, pat);
8216 sv_vcatpvf_mg(sv, pat, &args);
8222 =for apidoc sv_catpvf
8224 Processes its arguments like C<sprintf> and appends the formatted
8225 output to an SV. If the appended data contains "wide" characters
8226 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8227 and characters >255 formatted with %c), the original SV might get
8228 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8229 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8230 valid UTF-8; if the original SV was bytes, the pattern should be too.
8235 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8238 va_start(args, pat);
8239 sv_vcatpvf(sv, pat, &args);
8244 =for apidoc sv_vcatpvf
8246 Processes its arguments like C<vsprintf> and appends the formatted output
8247 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8249 Usually used via its frontend C<sv_catpvf>.
8255 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8257 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8261 =for apidoc sv_catpvf_mg
8263 Like C<sv_catpvf>, but also handles 'set' magic.
8269 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8272 va_start(args, pat);
8273 sv_vcatpvf_mg(sv, pat, &args);
8278 =for apidoc sv_vcatpvf_mg
8280 Like C<sv_vcatpvf>, but also handles 'set' magic.
8282 Usually used via its frontend C<sv_catpvf_mg>.
8288 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8290 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8295 =for apidoc sv_vsetpvfn
8297 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8300 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8306 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8308 sv_setpvn(sv, "", 0);
8309 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8313 S_expect_number(pTHX_ char** pattern)
8317 switch (**pattern) {
8318 case '1': case '2': case '3':
8319 case '4': case '5': case '6':
8320 case '7': case '8': case '9':
8321 var = *(*pattern)++ - '0';
8322 while (isDIGIT(**pattern)) {
8323 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8325 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8333 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8335 const int neg = nv < 0;
8344 if (uv & 1 && uv == nv)
8345 uv--; /* Round to even */
8347 const unsigned dig = uv % 10;
8360 =for apidoc sv_vcatpvfn
8362 Processes its arguments like C<vsprintf> and appends the formatted output
8363 to an SV. Uses an array of SVs if the C style variable argument list is
8364 missing (NULL). When running with taint checks enabled, indicates via
8365 C<maybe_tainted> if results are untrustworthy (often due to the use of
8368 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8374 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8375 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8376 vec_utf8 = DO_UTF8(vecsv);
8378 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8381 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8389 static const char nullstr[] = "(null)";
8391 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8392 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8394 /* Times 4: a decimal digit takes more than 3 binary digits.
8395 * NV_DIG: mantissa takes than many decimal digits.
8396 * Plus 32: Playing safe. */
8397 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8398 /* large enough for "%#.#f" --chip */
8399 /* what about long double NVs? --jhi */
8401 PERL_UNUSED_ARG(maybe_tainted);
8403 /* no matter what, this is a string now */
8404 (void)SvPV_force(sv, origlen);
8406 /* special-case "", "%s", and "%-p" (SVf - see below) */
8409 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8411 const char * const s = va_arg(*args, char*);
8412 sv_catpv(sv, s ? s : nullstr);
8414 else if (svix < svmax) {
8415 sv_catsv(sv, *svargs);
8419 if (args && patlen == 3 && pat[0] == '%' &&
8420 pat[1] == '-' && pat[2] == 'p') {
8421 argsv = va_arg(*args, SV*);
8422 sv_catsv(sv, argsv);
8426 #ifndef USE_LONG_DOUBLE
8427 /* special-case "%.<number>[gf]" */
8428 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8429 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8430 unsigned digits = 0;
8434 while (*pp >= '0' && *pp <= '9')
8435 digits = 10 * digits + (*pp++ - '0');
8436 if (pp - pat == (int)patlen - 1) {
8444 /* Add check for digits != 0 because it seems that some
8445 gconverts are buggy in this case, and we don't yet have
8446 a Configure test for this. */
8447 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8448 /* 0, point, slack */
8449 Gconvert(nv, (int)digits, 0, ebuf);
8451 if (*ebuf) /* May return an empty string for digits==0 */
8454 } else if (!digits) {
8457 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8458 sv_catpvn(sv, p, l);
8464 #endif /* !USE_LONG_DOUBLE */
8466 if (!args && svix < svmax && DO_UTF8(*svargs))
8469 patend = (char*)pat + patlen;
8470 for (p = (char*)pat; p < patend; p = q) {
8473 bool vectorize = FALSE;
8474 bool vectorarg = FALSE;
8475 bool vec_utf8 = FALSE;
8481 bool has_precis = FALSE;
8483 const I32 osvix = svix;
8484 bool is_utf8 = FALSE; /* is this item utf8? */
8485 #ifdef HAS_LDBL_SPRINTF_BUG
8486 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8487 with sfio - Allen <allens@cpan.org> */
8488 bool fix_ldbl_sprintf_bug = FALSE;
8492 U8 utf8buf[UTF8_MAXBYTES+1];
8493 STRLEN esignlen = 0;
8495 const char *eptr = NULL;
8498 const U8 *vecstr = NULL;
8505 /* we need a long double target in case HAS_LONG_DOUBLE but
8508 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8516 const char *dotstr = ".";
8517 STRLEN dotstrlen = 1;
8518 I32 efix = 0; /* explicit format parameter index */
8519 I32 ewix = 0; /* explicit width index */
8520 I32 epix = 0; /* explicit precision index */
8521 I32 evix = 0; /* explicit vector index */
8522 bool asterisk = FALSE;
8524 /* echo everything up to the next format specification */
8525 for (q = p; q < patend && *q != '%'; ++q) ;
8527 if (has_utf8 && !pat_utf8)
8528 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8530 sv_catpvn(sv, p, q - p);
8537 We allow format specification elements in this order:
8538 \d+\$ explicit format parameter index
8540 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8541 0 flag (as above): repeated to allow "v02"
8542 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8543 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8545 [%bcdefginopsuxDFOUX] format (mandatory)
8550 As of perl5.9.3, printf format checking is on by default.
8551 Internally, perl uses %p formats to provide an escape to
8552 some extended formatting. This block deals with those
8553 extensions: if it does not match, (char*)q is reset and
8554 the normal format processing code is used.
8556 Currently defined extensions are:
8557 %p include pointer address (standard)
8558 %-p (SVf) include an SV (previously %_)
8559 %-<num>p include an SV with precision <num>
8560 %1p (VDf) include a v-string (as %vd)
8561 %<num>p reserved for future extensions
8563 Robin Barker 2005-07-14
8570 n = expect_number(&q);
8577 argsv = va_arg(*args, SV*);
8578 eptr = SvPVx_const(argsv, elen);
8584 else if (n == vdNUMBER) { /* VDf */
8591 if (ckWARN_d(WARN_INTERNAL))
8592 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8593 "internal %%<num>p might conflict with future printf extensions");
8599 if ( (width = expect_number(&q)) ) {
8640 if ( (ewix = expect_number(&q)) )
8649 if ((vectorarg = asterisk)) {
8662 width = expect_number(&q);
8668 vecsv = va_arg(*args, SV*);
8670 vecsv = (evix > 0 && evix <= svmax)
8671 ? svargs[evix-1] : &PL_sv_undef;
8673 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8675 dotstr = SvPV_const(vecsv, dotstrlen);
8676 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8677 bad with tied or overloaded values that return UTF8. */
8680 else if (has_utf8) {
8681 vecsv = sv_mortalcopy(vecsv);
8682 sv_utf8_upgrade(vecsv);
8683 dotstr = SvPV_const(vecsv, dotstrlen);
8690 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8691 vecsv = svargs[efix ? efix-1 : svix++];
8692 vecstr = (U8*)SvPV_const(vecsv,veclen);
8693 vec_utf8 = DO_UTF8(vecsv);
8695 /* if this is a version object, we need to convert
8696 * back into v-string notation and then let the
8697 * vectorize happen normally
8699 if (sv_derived_from(vecsv, "version")) {
8700 char *version = savesvpv(vecsv);
8701 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8702 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8703 "vector argument not supported with alpha versions");
8706 vecsv = sv_newmortal();
8707 /* scan_vstring is expected to be called during
8708 * tokenization, so we need to fake up the end
8709 * of the buffer for it
8711 PL_bufend = version + veclen;
8712 scan_vstring(version, vecsv);
8713 vecstr = (U8*)SvPV_const(vecsv, veclen);
8714 vec_utf8 = DO_UTF8(vecsv);
8726 i = va_arg(*args, int);
8728 i = (ewix ? ewix <= svmax : svix < svmax) ?
8729 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8731 width = (i < 0) ? -i : i;
8741 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8743 /* XXX: todo, support specified precision parameter */
8747 i = va_arg(*args, int);
8749 i = (ewix ? ewix <= svmax : svix < svmax)
8750 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8751 precis = (i < 0) ? 0 : i;
8756 precis = precis * 10 + (*q++ - '0');
8765 case 'I': /* Ix, I32x, and I64x */
8767 if (q[1] == '6' && q[2] == '4') {
8773 if (q[1] == '3' && q[2] == '2') {
8783 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8794 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8795 if (*(q + 1) == 'l') { /* lld, llf */
8821 if (!vectorize && !args) {
8823 const I32 i = efix-1;
8824 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8826 argsv = (svix >= 0 && svix < svmax)
8827 ? svargs[svix++] : &PL_sv_undef;
8838 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8840 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8842 eptr = (char*)utf8buf;
8843 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8857 eptr = va_arg(*args, char*);
8859 #ifdef MACOS_TRADITIONAL
8860 /* On MacOS, %#s format is used for Pascal strings */
8865 elen = strlen(eptr);
8867 eptr = (char *)nullstr;
8868 elen = sizeof nullstr - 1;
8872 eptr = SvPVx_const(argsv, elen);
8873 if (DO_UTF8(argsv)) {
8874 if (has_precis && precis < elen) {
8876 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8879 if (width) { /* fudge width (can't fudge elen) */
8880 width += elen - sv_len_utf8(argsv);
8887 if (has_precis && elen > precis)
8894 if (alt || vectorize)
8896 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8917 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8926 esignbuf[esignlen++] = plus;
8930 case 'h': iv = (short)va_arg(*args, int); break;
8931 case 'l': iv = va_arg(*args, long); break;
8932 case 'V': iv = va_arg(*args, IV); break;
8933 default: iv = va_arg(*args, int); break;
8935 case 'q': iv = va_arg(*args, Quad_t); break;
8940 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8942 case 'h': iv = (short)tiv; break;
8943 case 'l': iv = (long)tiv; break;
8945 default: iv = tiv; break;
8947 case 'q': iv = (Quad_t)tiv; break;
8951 if ( !vectorize ) /* we already set uv above */
8956 esignbuf[esignlen++] = plus;
8960 esignbuf[esignlen++] = '-';
9003 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9014 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9015 case 'l': uv = va_arg(*args, unsigned long); break;
9016 case 'V': uv = va_arg(*args, UV); break;
9017 default: uv = va_arg(*args, unsigned); break;
9019 case 'q': uv = va_arg(*args, Uquad_t); break;
9024 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9026 case 'h': uv = (unsigned short)tuv; break;
9027 case 'l': uv = (unsigned long)tuv; break;
9029 default: uv = tuv; break;
9031 case 'q': uv = (Uquad_t)tuv; break;
9038 char *ptr = ebuf + sizeof ebuf;
9039 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9045 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9051 esignbuf[esignlen++] = '0';
9052 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9060 if (alt && *ptr != '0')
9069 esignbuf[esignlen++] = '0';
9070 esignbuf[esignlen++] = 'b';
9073 default: /* it had better be ten or less */
9077 } while (uv /= base);
9080 elen = (ebuf + sizeof ebuf) - ptr;
9084 zeros = precis - elen;
9085 else if (precis == 0 && elen == 1 && *eptr == '0')
9091 /* FLOATING POINT */
9094 c = 'f'; /* maybe %F isn't supported here */
9102 /* This is evil, but floating point is even more evil */
9104 /* for SV-style calling, we can only get NV
9105 for C-style calling, we assume %f is double;
9106 for simplicity we allow any of %Lf, %llf, %qf for long double
9110 #if defined(USE_LONG_DOUBLE)
9114 /* [perl #20339] - we should accept and ignore %lf rather than die */
9118 #if defined(USE_LONG_DOUBLE)
9119 intsize = args ? 0 : 'q';
9123 #if defined(HAS_LONG_DOUBLE)
9132 /* now we need (long double) if intsize == 'q', else (double) */
9134 #if LONG_DOUBLESIZE > DOUBLESIZE
9136 va_arg(*args, long double) :
9137 va_arg(*args, double)
9139 va_arg(*args, double)
9144 if (c != 'e' && c != 'E') {
9146 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9147 will cast our (long double) to (double) */
9148 (void)Perl_frexp(nv, &i);
9149 if (i == PERL_INT_MIN)
9150 Perl_die(aTHX_ "panic: frexp");
9152 need = BIT_DIGITS(i);
9154 need += has_precis ? precis : 6; /* known default */
9159 #ifdef HAS_LDBL_SPRINTF_BUG
9160 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9161 with sfio - Allen <allens@cpan.org> */
9164 # define MY_DBL_MAX DBL_MAX
9165 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9166 # if DOUBLESIZE >= 8
9167 # define MY_DBL_MAX 1.7976931348623157E+308L
9169 # define MY_DBL_MAX 3.40282347E+38L
9173 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9174 # define MY_DBL_MAX_BUG 1L
9176 # define MY_DBL_MAX_BUG MY_DBL_MAX
9180 # define MY_DBL_MIN DBL_MIN
9181 # else /* XXX guessing! -Allen */
9182 # if DOUBLESIZE >= 8
9183 # define MY_DBL_MIN 2.2250738585072014E-308L
9185 # define MY_DBL_MIN 1.17549435E-38L
9189 if ((intsize == 'q') && (c == 'f') &&
9190 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9192 /* it's going to be short enough that
9193 * long double precision is not needed */
9195 if ((nv <= 0L) && (nv >= -0L))
9196 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9198 /* would use Perl_fp_class as a double-check but not
9199 * functional on IRIX - see perl.h comments */
9201 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9202 /* It's within the range that a double can represent */
9203 #if defined(DBL_MAX) && !defined(DBL_MIN)
9204 if ((nv >= ((long double)1/DBL_MAX)) ||
9205 (nv <= (-(long double)1/DBL_MAX)))
9207 fix_ldbl_sprintf_bug = TRUE;
9210 if (fix_ldbl_sprintf_bug == TRUE) {
9220 # undef MY_DBL_MAX_BUG
9223 #endif /* HAS_LDBL_SPRINTF_BUG */
9225 need += 20; /* fudge factor */
9226 if (PL_efloatsize < need) {
9227 Safefree(PL_efloatbuf);
9228 PL_efloatsize = need + 20; /* more fudge */
9229 Newx(PL_efloatbuf, PL_efloatsize, char);
9230 PL_efloatbuf[0] = '\0';
9233 if ( !(width || left || plus || alt) && fill != '0'
9234 && has_precis && intsize != 'q' ) { /* Shortcuts */
9235 /* See earlier comment about buggy Gconvert when digits,
9237 if ( c == 'g' && precis) {
9238 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9239 /* May return an empty string for digits==0 */
9240 if (*PL_efloatbuf) {
9241 elen = strlen(PL_efloatbuf);
9242 goto float_converted;
9244 } else if ( c == 'f' && !precis) {
9245 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9250 char *ptr = ebuf + sizeof ebuf;
9253 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9254 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9255 if (intsize == 'q') {
9256 /* Copy the one or more characters in a long double
9257 * format before the 'base' ([efgEFG]) character to
9258 * the format string. */
9259 static char const prifldbl[] = PERL_PRIfldbl;
9260 char const *p = prifldbl + sizeof(prifldbl) - 3;
9261 while (p >= prifldbl) { *--ptr = *p--; }
9266 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9271 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9283 /* No taint. Otherwise we are in the strange situation
9284 * where printf() taints but print($float) doesn't.
9286 #if defined(HAS_LONG_DOUBLE)
9287 elen = ((intsize == 'q')
9288 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9289 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9291 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9295 eptr = PL_efloatbuf;
9303 i = SvCUR(sv) - origlen;
9306 case 'h': *(va_arg(*args, short*)) = i; break;
9307 default: *(va_arg(*args, int*)) = i; break;
9308 case 'l': *(va_arg(*args, long*)) = i; break;
9309 case 'V': *(va_arg(*args, IV*)) = i; break;
9311 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9316 sv_setuv_mg(argsv, (UV)i);
9317 continue; /* not "break" */
9324 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9325 && ckWARN(WARN_PRINTF))
9327 SV * const msg = sv_newmortal();
9328 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9329 (PL_op->op_type == OP_PRTF) ? "" : "s");
9332 Perl_sv_catpvf(aTHX_ msg,
9333 "\"%%%c\"", c & 0xFF);
9335 Perl_sv_catpvf(aTHX_ msg,
9336 "\"%%\\%03"UVof"\"",
9339 sv_catpvs(msg, "end of string");
9340 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9343 /* output mangled stuff ... */
9349 /* ... right here, because formatting flags should not apply */
9350 SvGROW(sv, SvCUR(sv) + elen + 1);
9352 Copy(eptr, p, elen, char);
9355 SvCUR_set(sv, p - SvPVX_const(sv));
9357 continue; /* not "break" */
9360 if (is_utf8 != has_utf8) {
9363 sv_utf8_upgrade(sv);
9366 const STRLEN old_elen = elen;
9367 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9368 sv_utf8_upgrade(nsv);
9369 eptr = SvPVX_const(nsv);
9372 if (width) { /* fudge width (can't fudge elen) */
9373 width += elen - old_elen;
9379 have = esignlen + zeros + elen;
9381 Perl_croak_nocontext(PL_memory_wrap);
9383 need = (have > width ? have : width);
9386 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9387 Perl_croak_nocontext(PL_memory_wrap);
9388 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9390 if (esignlen && fill == '0') {
9392 for (i = 0; i < (int)esignlen; i++)
9396 memset(p, fill, gap);
9399 if (esignlen && fill != '0') {
9401 for (i = 0; i < (int)esignlen; i++)
9406 for (i = zeros; i; i--)
9410 Copy(eptr, p, elen, char);
9414 memset(p, ' ', gap);
9419 Copy(dotstr, p, dotstrlen, char);
9423 vectorize = FALSE; /* done iterating over vecstr */
9430 SvCUR_set(sv, p - SvPVX_const(sv));
9438 /* =========================================================================
9440 =head1 Cloning an interpreter
9442 All the macros and functions in this section are for the private use of
9443 the main function, perl_clone().
9445 The foo_dup() functions make an exact copy of an existing foo thinngy.
9446 During the course of a cloning, a hash table is used to map old addresses
9447 to new addresses. The table is created and manipulated with the
9448 ptr_table_* functions.
9452 ============================================================================*/
9455 #if defined(USE_ITHREADS)
9457 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9458 #ifndef GpREFCNT_inc
9459 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9463 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9464 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9465 please unmerge ss_dup. */
9466 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9467 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9468 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9469 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9470 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9471 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9472 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9473 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9474 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9475 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9476 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9477 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9478 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9479 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9482 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9483 regcomp.c. AMS 20010712 */
9486 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9488 return CALLREGDUPE(r,param);
9491 /* duplicate a file handle */
9494 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9498 PERL_UNUSED_ARG(type);
9501 return (PerlIO*)NULL;
9503 /* look for it in the table first */
9504 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9508 /* create anew and remember what it is */
9509 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9510 ptr_table_store(PL_ptr_table, fp, ret);
9514 /* duplicate a directory handle */
9517 Perl_dirp_dup(pTHX_ DIR *dp)
9519 PERL_UNUSED_CONTEXT;
9526 /* duplicate a typeglob */
9529 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9535 /* look for it in the table first */
9536 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9540 /* create anew and remember what it is */
9542 ptr_table_store(PL_ptr_table, gp, ret);
9545 ret->gp_refcnt = 0; /* must be before any other dups! */
9546 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9547 ret->gp_io = io_dup_inc(gp->gp_io, param);
9548 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9549 ret->gp_av = av_dup_inc(gp->gp_av, param);
9550 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9551 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9552 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9553 ret->gp_cvgen = gp->gp_cvgen;
9554 ret->gp_line = gp->gp_line;
9555 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9559 /* duplicate a chain of magic */
9562 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9564 MAGIC *mgprev = (MAGIC*)NULL;
9567 return (MAGIC*)NULL;
9568 /* look for it in the table first */
9569 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9573 for (; mg; mg = mg->mg_moremagic) {
9575 Newxz(nmg, 1, MAGIC);
9577 mgprev->mg_moremagic = nmg;
9580 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9581 nmg->mg_private = mg->mg_private;
9582 nmg->mg_type = mg->mg_type;
9583 nmg->mg_flags = mg->mg_flags;
9584 if (mg->mg_type == PERL_MAGIC_qr) {
9585 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9587 else if(mg->mg_type == PERL_MAGIC_backref) {
9588 /* The backref AV has its reference count deliberately bumped by
9590 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9592 else if (mg->mg_type == PERL_MAGIC_symtab) {
9593 nmg->mg_obj = mg->mg_obj;
9596 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9597 ? sv_dup_inc(mg->mg_obj, param)
9598 : sv_dup(mg->mg_obj, param);
9600 nmg->mg_len = mg->mg_len;
9601 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9602 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9603 if (mg->mg_len > 0) {
9604 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9605 if (mg->mg_type == PERL_MAGIC_overload_table &&
9606 AMT_AMAGIC((AMT*)mg->mg_ptr))
9608 const AMT * const amtp = (AMT*)mg->mg_ptr;
9609 AMT * const namtp = (AMT*)nmg->mg_ptr;
9611 for (i = 1; i < NofAMmeth; i++) {
9612 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9616 else if (mg->mg_len == HEf_SVKEY)
9617 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9619 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9620 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9627 /* create a new pointer-mapping table */
9630 Perl_ptr_table_new(pTHX)
9633 PERL_UNUSED_CONTEXT;
9635 Newxz(tbl, 1, PTR_TBL_t);
9638 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9642 #define PTR_TABLE_HASH(ptr) \
9643 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9646 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9647 following define) and at call to new_body_inline made below in
9648 Perl_ptr_table_store()
9651 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9653 /* map an existing pointer using a table */
9655 STATIC PTR_TBL_ENT_t *
9656 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9657 PTR_TBL_ENT_t *tblent;
9658 const UV hash = PTR_TABLE_HASH(sv);
9660 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9661 for (; tblent; tblent = tblent->next) {
9662 if (tblent->oldval == sv)
9669 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9671 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9672 PERL_UNUSED_CONTEXT;
9673 return tblent ? tblent->newval : NULL;
9676 /* add a new entry to a pointer-mapping table */
9679 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9681 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9682 PERL_UNUSED_CONTEXT;
9685 tblent->newval = newsv;
9687 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9689 new_body_inline(tblent, PTE_SVSLOT);
9691 tblent->oldval = oldsv;
9692 tblent->newval = newsv;
9693 tblent->next = tbl->tbl_ary[entry];
9694 tbl->tbl_ary[entry] = tblent;
9696 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9697 ptr_table_split(tbl);
9701 /* double the hash bucket size of an existing ptr table */
9704 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9706 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9707 const UV oldsize = tbl->tbl_max + 1;
9708 UV newsize = oldsize * 2;
9710 PERL_UNUSED_CONTEXT;
9712 Renew(ary, newsize, PTR_TBL_ENT_t*);
9713 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9714 tbl->tbl_max = --newsize;
9716 for (i=0; i < oldsize; i++, ary++) {
9717 PTR_TBL_ENT_t **curentp, **entp, *ent;
9720 curentp = ary + oldsize;
9721 for (entp = ary, ent = *ary; ent; ent = *entp) {
9722 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9724 ent->next = *curentp;
9734 /* remove all the entries from a ptr table */
9737 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9739 if (tbl && tbl->tbl_items) {
9740 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9741 UV riter = tbl->tbl_max;
9744 PTR_TBL_ENT_t *entry = array[riter];
9747 PTR_TBL_ENT_t * const oentry = entry;
9748 entry = entry->next;
9757 /* clear and free a ptr table */
9760 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9765 ptr_table_clear(tbl);
9766 Safefree(tbl->tbl_ary);
9772 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9775 SvRV_set(dstr, SvWEAKREF(sstr)
9776 ? sv_dup(SvRV(sstr), param)
9777 : sv_dup_inc(SvRV(sstr), param));
9780 else if (SvPVX_const(sstr)) {
9781 /* Has something there */
9783 /* Normal PV - clone whole allocated space */
9784 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9785 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9786 /* Not that normal - actually sstr is copy on write.
9787 But we are a true, independant SV, so: */
9788 SvREADONLY_off(dstr);
9793 /* Special case - not normally malloced for some reason */
9794 if (isGV_with_GP(sstr)) {
9795 /* Don't need to do anything here. */
9797 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9798 /* A "shared" PV - clone it as "shared" PV */
9800 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9804 /* Some other special case - random pointer */
9805 SvPV_set(dstr, SvPVX(sstr));
9811 if (SvTYPE(dstr) == SVt_RV)
9812 SvRV_set(dstr, NULL);
9814 SvPV_set(dstr, NULL);
9818 /* duplicate an SV of any type (including AV, HV etc) */
9821 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9826 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9828 /* look for it in the table first */
9829 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9833 if(param->flags & CLONEf_JOIN_IN) {
9834 /** We are joining here so we don't want do clone
9835 something that is bad **/
9836 if (SvTYPE(sstr) == SVt_PVHV) {
9837 const char * const hvname = HvNAME_get(sstr);
9839 /** don't clone stashes if they already exist **/
9840 return (SV*)gv_stashpv(hvname,0);
9844 /* create anew and remember what it is */
9847 #ifdef DEBUG_LEAKING_SCALARS
9848 dstr->sv_debug_optype = sstr->sv_debug_optype;
9849 dstr->sv_debug_line = sstr->sv_debug_line;
9850 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9851 dstr->sv_debug_cloned = 1;
9852 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9855 ptr_table_store(PL_ptr_table, sstr, dstr);
9858 SvFLAGS(dstr) = SvFLAGS(sstr);
9859 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9860 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9863 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9864 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9865 PL_watch_pvx, SvPVX_const(sstr));
9868 /* don't clone objects whose class has asked us not to */
9869 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9870 SvFLAGS(dstr) &= ~SVTYPEMASK;
9875 switch (SvTYPE(sstr)) {
9880 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9881 SvIV_set(dstr, SvIVX(sstr));
9884 SvANY(dstr) = new_XNV();
9885 SvNV_set(dstr, SvNVX(sstr));
9888 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9889 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9893 /* These are all the types that need complex bodies allocating. */
9895 const svtype sv_type = SvTYPE(sstr);
9896 const struct body_details *const sv_type_details
9897 = bodies_by_type + sv_type;
9901 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9905 if (GvUNIQUE((GV*)sstr)) {
9906 NOOP; /* Do sharing here, and fall through */
9919 assert(sv_type_details->body_size);
9920 if (sv_type_details->arena) {
9921 new_body_inline(new_body, sv_type);
9923 = (void*)((char*)new_body - sv_type_details->offset);
9925 new_body = new_NOARENA(sv_type_details);
9929 SvANY(dstr) = new_body;
9932 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9933 ((char*)SvANY(dstr)) + sv_type_details->offset,
9934 sv_type_details->copy, char);
9936 Copy(((char*)SvANY(sstr)),
9937 ((char*)SvANY(dstr)),
9938 sv_type_details->body_size + sv_type_details->offset, char);
9941 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9942 && !isGV_with_GP(dstr))
9943 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9945 /* The Copy above means that all the source (unduplicated) pointers
9946 are now in the destination. We can check the flags and the
9947 pointers in either, but it's possible that there's less cache
9948 missing by always going for the destination.
9949 FIXME - instrument and check that assumption */
9950 if (sv_type >= SVt_PVMG) {
9951 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9952 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9953 } else if (SvMAGIC(dstr))
9954 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9956 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9959 /* The cast silences a GCC warning about unhandled types. */
9960 switch ((int)sv_type) {
9972 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9973 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9974 LvTARG(dstr) = dstr;
9975 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9976 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9978 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9981 if (GvNAME_HEK(dstr))
9982 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9984 /* Don't call sv_add_backref here as it's going to be created
9985 as part of the magic cloning of the symbol table. */
9986 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9987 if(isGV_with_GP(sstr)) {
9988 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9989 at the point of this comment. */
9990 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9991 (void)GpREFCNT_inc(GvGP(dstr));
9993 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9996 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9997 if (IoOFP(dstr) == IoIFP(sstr))
9998 IoOFP(dstr) = IoIFP(dstr);
10000 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10001 /* PL_rsfp_filters entries have fake IoDIRP() */
10002 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10003 /* I have no idea why fake dirp (rsfps)
10004 should be treated differently but otherwise
10005 we end up with leaks -- sky*/
10006 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10007 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10008 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10010 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10011 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10012 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10013 if (IoDIRP(dstr)) {
10014 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10017 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10020 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10021 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10022 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10025 if (AvARRAY((AV*)sstr)) {
10026 SV **dst_ary, **src_ary;
10027 SSize_t items = AvFILLp((AV*)sstr) + 1;
10029 src_ary = AvARRAY((AV*)sstr);
10030 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10031 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10032 SvPV_set(dstr, (char*)dst_ary);
10033 AvALLOC((AV*)dstr) = dst_ary;
10034 if (AvREAL((AV*)sstr)) {
10035 while (items-- > 0)
10036 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10039 while (items-- > 0)
10040 *dst_ary++ = sv_dup(*src_ary++, param);
10042 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10043 while (items-- > 0) {
10044 *dst_ary++ = &PL_sv_undef;
10048 SvPV_set(dstr, NULL);
10049 AvALLOC((AV*)dstr) = (SV**)NULL;
10053 if (HvARRAY((HV*)sstr)) {
10055 const bool sharekeys = !!HvSHAREKEYS(sstr);
10056 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10057 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10059 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10060 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10062 HvARRAY(dstr) = (HE**)darray;
10063 while (i <= sxhv->xhv_max) {
10064 const HE * const source = HvARRAY(sstr)[i];
10065 HvARRAY(dstr)[i] = source
10066 ? he_dup(source, sharekeys, param) : 0;
10071 const struct xpvhv_aux * const saux = HvAUX(sstr);
10072 struct xpvhv_aux * const daux = HvAUX(dstr);
10073 /* This flag isn't copied. */
10074 /* SvOOK_on(hv) attacks the IV flags. */
10075 SvFLAGS(dstr) |= SVf_OOK;
10077 hvname = saux->xhv_name;
10078 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10080 daux->xhv_riter = saux->xhv_riter;
10081 daux->xhv_eiter = saux->xhv_eiter
10082 ? he_dup(saux->xhv_eiter,
10083 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10084 daux->xhv_backreferences =
10085 saux->xhv_backreferences
10086 ? (AV*) SvREFCNT_inc(
10087 sv_dup((SV*)saux->xhv_backreferences, param))
10089 /* Record stashes for possible cloning in Perl_clone(). */
10091 av_push(param->stashes, dstr);
10095 SvPV_set(dstr, NULL);
10098 if (!(param->flags & CLONEf_COPY_STACKS)) {
10102 /* NOTE: not refcounted */
10103 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10105 if (!CvISXSUB(dstr))
10106 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10108 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10109 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10110 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10111 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10113 /* don't dup if copying back - CvGV isn't refcounted, so the
10114 * duped GV may never be freed. A bit of a hack! DAPM */
10115 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10116 NULL : gv_dup(CvGV(dstr), param) ;
10117 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10119 CvWEAKOUTSIDE(sstr)
10120 ? cv_dup( CvOUTSIDE(dstr), param)
10121 : cv_dup_inc(CvOUTSIDE(dstr), param);
10122 if (!CvISXSUB(dstr))
10123 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10129 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10135 /* duplicate a context */
10138 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10140 PERL_CONTEXT *ncxs;
10143 return (PERL_CONTEXT*)NULL;
10145 /* look for it in the table first */
10146 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10150 /* create anew and remember what it is */
10151 Newxz(ncxs, max + 1, PERL_CONTEXT);
10152 ptr_table_store(PL_ptr_table, cxs, ncxs);
10155 PERL_CONTEXT * const cx = &cxs[ix];
10156 PERL_CONTEXT * const ncx = &ncxs[ix];
10157 ncx->cx_type = cx->cx_type;
10158 if (CxTYPE(cx) == CXt_SUBST) {
10159 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10162 ncx->blk_oldsp = cx->blk_oldsp;
10163 ncx->blk_oldcop = cx->blk_oldcop;
10164 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10165 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10166 ncx->blk_oldpm = cx->blk_oldpm;
10167 ncx->blk_gimme = cx->blk_gimme;
10168 switch (CxTYPE(cx)) {
10170 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10171 ? cv_dup_inc(cx->blk_sub.cv, param)
10172 : cv_dup(cx->blk_sub.cv,param));
10173 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10174 ? av_dup_inc(cx->blk_sub.argarray, param)
10176 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10177 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10178 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10179 ncx->blk_sub.lval = cx->blk_sub.lval;
10180 ncx->blk_sub.retop = cx->blk_sub.retop;
10181 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10182 cx->blk_sub.oldcomppad);
10185 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10186 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10187 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10188 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10189 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10190 ncx->blk_eval.retop = cx->blk_eval.retop;
10193 ncx->blk_loop.label = cx->blk_loop.label;
10194 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10195 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10196 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10197 ? cx->blk_loop.iterdata
10198 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10199 ncx->blk_loop.oldcomppad
10200 = (PAD*)ptr_table_fetch(PL_ptr_table,
10201 cx->blk_loop.oldcomppad);
10202 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10203 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10204 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10205 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10206 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10209 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10210 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10211 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10212 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10213 ncx->blk_sub.retop = cx->blk_sub.retop;
10225 /* duplicate a stack info structure */
10228 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10233 return (PERL_SI*)NULL;
10235 /* look for it in the table first */
10236 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10240 /* create anew and remember what it is */
10241 Newxz(nsi, 1, PERL_SI);
10242 ptr_table_store(PL_ptr_table, si, nsi);
10244 nsi->si_stack = av_dup_inc(si->si_stack, param);
10245 nsi->si_cxix = si->si_cxix;
10246 nsi->si_cxmax = si->si_cxmax;
10247 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10248 nsi->si_type = si->si_type;
10249 nsi->si_prev = si_dup(si->si_prev, param);
10250 nsi->si_next = si_dup(si->si_next, param);
10251 nsi->si_markoff = si->si_markoff;
10256 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10257 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10258 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10259 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10260 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10261 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10262 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10263 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10264 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10265 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10266 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10267 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10268 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10269 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10272 #define pv_dup_inc(p) SAVEPV(p)
10273 #define pv_dup(p) SAVEPV(p)
10274 #define svp_dup_inc(p,pp) any_dup(p,pp)
10276 /* map any object to the new equivent - either something in the
10277 * ptr table, or something in the interpreter structure
10281 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10286 return (void*)NULL;
10288 /* look for it in the table first */
10289 ret = ptr_table_fetch(PL_ptr_table, v);
10293 /* see if it is part of the interpreter structure */
10294 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10295 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10303 /* duplicate the save stack */
10306 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10308 ANY * const ss = proto_perl->Tsavestack;
10309 const I32 max = proto_perl->Tsavestack_max;
10310 I32 ix = proto_perl->Tsavestack_ix;
10322 void (*dptr) (void*);
10323 void (*dxptr) (pTHX_ void*);
10325 Newxz(nss, max, ANY);
10328 I32 i = POPINT(ss,ix);
10329 TOPINT(nss,ix) = i;
10331 case SAVEt_ITEM: /* normal string */
10332 case SAVEt_SV: /* scalar reference */
10333 sv = (SV*)POPPTR(ss,ix);
10334 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10335 sv = (SV*)POPPTR(ss,ix);
10336 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10338 case SAVEt_SHARED_PVREF: /* char* in shared space */
10339 c = (char*)POPPTR(ss,ix);
10340 TOPPTR(nss,ix) = savesharedpv(c);
10341 ptr = POPPTR(ss,ix);
10342 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10344 case SAVEt_GENERIC_SVREF: /* generic sv */
10345 case SAVEt_SVREF: /* scalar reference */
10346 sv = (SV*)POPPTR(ss,ix);
10347 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10348 ptr = POPPTR(ss,ix);
10349 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10351 case SAVEt_HV: /* hash reference */
10352 case SAVEt_AV: /* array reference */
10353 sv = (SV*) POPPTR(ss,ix);
10354 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10355 gv = (GV*)POPPTR(ss,ix);
10356 TOPPTR(nss,ix) = gv_dup(gv, param);
10358 case SAVEt_INT: /* int reference */
10359 ptr = POPPTR(ss,ix);
10360 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10361 intval = (int)POPINT(ss,ix);
10362 TOPINT(nss,ix) = intval;
10364 case SAVEt_LONG: /* long reference */
10365 ptr = POPPTR(ss,ix);
10366 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10367 longval = (long)POPLONG(ss,ix);
10368 TOPLONG(nss,ix) = longval;
10370 case SAVEt_I32: /* I32 reference */
10371 case SAVEt_I16: /* I16 reference */
10372 case SAVEt_I8: /* I8 reference */
10373 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10374 ptr = POPPTR(ss,ix);
10375 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10377 TOPINT(nss,ix) = i;
10379 case SAVEt_IV: /* IV reference */
10380 ptr = POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10383 TOPIV(nss,ix) = iv;
10385 case SAVEt_HPTR: /* HV* reference */
10386 case SAVEt_APTR: /* AV* reference */
10387 case SAVEt_SPTR: /* SV* reference */
10388 ptr = POPPTR(ss,ix);
10389 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10390 sv = (SV*)POPPTR(ss,ix);
10391 TOPPTR(nss,ix) = sv_dup(sv, param);
10393 case SAVEt_VPTR: /* random* reference */
10394 ptr = POPPTR(ss,ix);
10395 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10396 ptr = POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10399 case SAVEt_GENERIC_PVREF: /* generic char* */
10400 case SAVEt_PPTR: /* char* reference */
10401 ptr = POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10403 c = (char*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = pv_dup(c);
10407 gv = (GV*)POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = gv_dup(gv, param);
10410 case SAVEt_GP: /* scalar reference */
10411 gp = (GP*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10413 (void)GpREFCNT_inc(gp);
10414 gv = (GV*)POPPTR(ss,ix);
10415 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10416 c = (char*)POPPTR(ss,ix);
10417 TOPPTR(nss,ix) = pv_dup(c);
10419 TOPIV(nss,ix) = iv;
10421 TOPIV(nss,ix) = iv;
10424 case SAVEt_MORTALIZESV:
10425 sv = (SV*)POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10429 ptr = POPPTR(ss,ix);
10430 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10431 /* these are assumed to be refcounted properly */
10433 switch (((OP*)ptr)->op_type) {
10435 case OP_LEAVESUBLV:
10439 case OP_LEAVEWRITE:
10440 TOPPTR(nss,ix) = ptr;
10445 TOPPTR(nss,ix) = NULL;
10450 TOPPTR(nss,ix) = NULL;
10453 c = (char*)POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = pv_dup_inc(c);
10456 case SAVEt_CLEARSV:
10457 longval = POPLONG(ss,ix);
10458 TOPLONG(nss,ix) = longval;
10461 hv = (HV*)POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10463 c = (char*)POPPTR(ss,ix);
10464 TOPPTR(nss,ix) = pv_dup_inc(c);
10466 TOPINT(nss,ix) = i;
10468 case SAVEt_DESTRUCTOR:
10469 ptr = POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10471 dptr = POPDPTR(ss,ix);
10472 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10473 any_dup(FPTR2DPTR(void *, dptr),
10476 case SAVEt_DESTRUCTOR_X:
10477 ptr = POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10479 dxptr = POPDXPTR(ss,ix);
10480 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10481 any_dup(FPTR2DPTR(void *, dxptr),
10484 case SAVEt_REGCONTEXT:
10487 TOPINT(nss,ix) = i;
10490 case SAVEt_STACK_POS: /* Position on Perl stack */
10492 TOPINT(nss,ix) = i;
10494 case SAVEt_AELEM: /* array element */
10495 sv = (SV*)POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10498 TOPINT(nss,ix) = i;
10499 av = (AV*)POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = av_dup_inc(av, param);
10502 case SAVEt_HELEM: /* hash element */
10503 sv = (SV*)POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10505 sv = (SV*)POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10507 hv = (HV*)POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10511 ptr = POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = ptr;
10516 TOPINT(nss,ix) = i;
10517 ptr = POPPTR(ss,ix);
10520 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10521 HINTS_REFCNT_UNLOCK;
10523 TOPPTR(nss,ix) = ptr;
10524 if (i & HINT_LOCALIZE_HH) {
10525 hv = (HV*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10529 case SAVEt_COMPPAD:
10530 av = (AV*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = av_dup(av, param);
10534 longval = (long)POPLONG(ss,ix);
10535 TOPLONG(nss,ix) = longval;
10536 ptr = POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10538 sv = (SV*)POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = sv_dup(sv, param);
10542 ptr = POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10544 longval = (long)POPBOOL(ss,ix);
10545 TOPBOOL(nss,ix) = (bool)longval;
10547 case SAVEt_SET_SVFLAGS:
10549 TOPINT(nss,ix) = i;
10551 TOPINT(nss,ix) = i;
10552 sv = (SV*)POPPTR(ss,ix);
10553 TOPPTR(nss,ix) = sv_dup(sv, param);
10555 case SAVEt_RE_STATE:
10557 const struct re_save_state *const old_state
10558 = (struct re_save_state *)
10559 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10560 struct re_save_state *const new_state
10561 = (struct re_save_state *)
10562 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10564 Copy(old_state, new_state, 1, struct re_save_state);
10565 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10567 new_state->re_state_bostr
10568 = pv_dup(old_state->re_state_bostr);
10569 new_state->re_state_reginput
10570 = pv_dup(old_state->re_state_reginput);
10571 new_state->re_state_regeol
10572 = pv_dup(old_state->re_state_regeol);
10573 new_state->re_state_regstartp
10574 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10575 new_state->re_state_regendp
10576 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10577 new_state->re_state_reglastparen
10578 = (U32*) any_dup(old_state->re_state_reglastparen,
10580 new_state->re_state_reglastcloseparen
10581 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10583 /* XXX This just has to be broken. The old save_re_context
10584 code did SAVEGENERICPV(PL_reg_start_tmp);
10585 PL_reg_start_tmp is char **.
10586 Look above to what the dup code does for
10587 SAVEt_GENERIC_PVREF
10588 It can never have worked.
10589 So this is merely a faithful copy of the exiting bug: */
10590 new_state->re_state_reg_start_tmp
10591 = (char **) pv_dup((char *)
10592 old_state->re_state_reg_start_tmp);
10593 /* I assume that it only ever "worked" because no-one called
10594 (pseudo)fork while the regexp engine had re-entered itself.
10596 #ifdef PERL_OLD_COPY_ON_WRITE
10597 new_state->re_state_nrs
10598 = sv_dup(old_state->re_state_nrs, param);
10600 new_state->re_state_reg_magic
10601 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10603 new_state->re_state_reg_oldcurpm
10604 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10606 new_state->re_state_reg_curpm
10607 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10609 new_state->re_state_reg_oldsaved
10610 = pv_dup(old_state->re_state_reg_oldsaved);
10611 new_state->re_state_reg_poscache
10612 = pv_dup(old_state->re_state_reg_poscache);
10613 new_state->re_state_reg_starttry
10614 = pv_dup(old_state->re_state_reg_starttry);
10617 case SAVEt_COMPILE_WARNINGS:
10618 ptr = POPPTR(ss,ix);
10619 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10622 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10630 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10631 * flag to the result. This is done for each stash before cloning starts,
10632 * so we know which stashes want their objects cloned */
10635 do_mark_cloneable_stash(pTHX_ SV *sv)
10637 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10639 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10640 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10641 if (cloner && GvCV(cloner)) {
10648 XPUSHs(sv_2mortal(newSVhek(hvname)));
10650 call_sv((SV*)GvCV(cloner), G_SCALAR);
10657 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10665 =for apidoc perl_clone
10667 Create and return a new interpreter by cloning the current one.
10669 perl_clone takes these flags as parameters:
10671 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10672 without it we only clone the data and zero the stacks,
10673 with it we copy the stacks and the new perl interpreter is
10674 ready to run at the exact same point as the previous one.
10675 The pseudo-fork code uses COPY_STACKS while the
10676 threads->new doesn't.
10678 CLONEf_KEEP_PTR_TABLE
10679 perl_clone keeps a ptr_table with the pointer of the old
10680 variable as a key and the new variable as a value,
10681 this allows it to check if something has been cloned and not
10682 clone it again but rather just use the value and increase the
10683 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10684 the ptr_table using the function
10685 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10686 reason to keep it around is if you want to dup some of your own
10687 variable who are outside the graph perl scans, example of this
10688 code is in threads.xs create
10691 This is a win32 thing, it is ignored on unix, it tells perls
10692 win32host code (which is c++) to clone itself, this is needed on
10693 win32 if you want to run two threads at the same time,
10694 if you just want to do some stuff in a separate perl interpreter
10695 and then throw it away and return to the original one,
10696 you don't need to do anything.
10701 /* XXX the above needs expanding by someone who actually understands it ! */
10702 EXTERN_C PerlInterpreter *
10703 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10706 perl_clone(PerlInterpreter *proto_perl, UV flags)
10709 #ifdef PERL_IMPLICIT_SYS
10711 /* perlhost.h so we need to call into it
10712 to clone the host, CPerlHost should have a c interface, sky */
10714 if (flags & CLONEf_CLONE_HOST) {
10715 return perl_clone_host(proto_perl,flags);
10717 return perl_clone_using(proto_perl, flags,
10719 proto_perl->IMemShared,
10720 proto_perl->IMemParse,
10722 proto_perl->IStdIO,
10726 proto_perl->IProc);
10730 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10731 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10732 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10733 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10734 struct IPerlDir* ipD, struct IPerlSock* ipS,
10735 struct IPerlProc* ipP)
10737 /* XXX many of the string copies here can be optimized if they're
10738 * constants; they need to be allocated as common memory and just
10739 * their pointers copied. */
10742 CLONE_PARAMS clone_params;
10743 CLONE_PARAMS* const param = &clone_params;
10745 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10746 /* for each stash, determine whether its objects should be cloned */
10747 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10748 PERL_SET_THX(my_perl);
10751 PoisonNew(my_perl, 1, PerlInterpreter);
10757 PL_savestack_ix = 0;
10758 PL_savestack_max = -1;
10759 PL_sig_pending = 0;
10760 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10761 # else /* !DEBUGGING */
10762 Zero(my_perl, 1, PerlInterpreter);
10763 # endif /* DEBUGGING */
10765 /* host pointers */
10767 PL_MemShared = ipMS;
10768 PL_MemParse = ipMP;
10775 #else /* !PERL_IMPLICIT_SYS */
10777 CLONE_PARAMS clone_params;
10778 CLONE_PARAMS* param = &clone_params;
10779 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10780 /* for each stash, determine whether its objects should be cloned */
10781 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10782 PERL_SET_THX(my_perl);
10785 PoisonNew(my_perl, 1, PerlInterpreter);
10791 PL_savestack_ix = 0;
10792 PL_savestack_max = -1;
10793 PL_sig_pending = 0;
10794 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10795 # else /* !DEBUGGING */
10796 Zero(my_perl, 1, PerlInterpreter);
10797 # endif /* DEBUGGING */
10798 #endif /* PERL_IMPLICIT_SYS */
10799 param->flags = flags;
10800 param->proto_perl = proto_perl;
10802 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10804 PL_body_arenas = NULL;
10805 Zero(&PL_body_roots, 1, PL_body_roots);
10807 PL_nice_chunk = NULL;
10808 PL_nice_chunk_size = 0;
10810 PL_sv_objcount = 0;
10812 PL_sv_arenaroot = NULL;
10814 PL_debug = proto_perl->Idebug;
10816 PL_hash_seed = proto_perl->Ihash_seed;
10817 PL_rehash_seed = proto_perl->Irehash_seed;
10819 #ifdef USE_REENTRANT_API
10820 /* XXX: things like -Dm will segfault here in perlio, but doing
10821 * PERL_SET_CONTEXT(proto_perl);
10822 * breaks too many other things
10824 Perl_reentrant_init(aTHX);
10827 /* create SV map for pointer relocation */
10828 PL_ptr_table = ptr_table_new();
10830 /* initialize these special pointers as early as possible */
10831 SvANY(&PL_sv_undef) = NULL;
10832 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10833 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10834 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10836 SvANY(&PL_sv_no) = new_XPVNV();
10837 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10838 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10839 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10840 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10841 SvCUR_set(&PL_sv_no, 0);
10842 SvLEN_set(&PL_sv_no, 1);
10843 SvIV_set(&PL_sv_no, 0);
10844 SvNV_set(&PL_sv_no, 0);
10845 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10847 SvANY(&PL_sv_yes) = new_XPVNV();
10848 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10849 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10850 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10851 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10852 SvCUR_set(&PL_sv_yes, 1);
10853 SvLEN_set(&PL_sv_yes, 2);
10854 SvIV_set(&PL_sv_yes, 1);
10855 SvNV_set(&PL_sv_yes, 1);
10856 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10858 /* create (a non-shared!) shared string table */
10859 PL_strtab = newHV();
10860 HvSHAREKEYS_off(PL_strtab);
10861 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10862 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10864 PL_compiling = proto_perl->Icompiling;
10866 /* These two PVs will be free'd special way so must set them same way op.c does */
10867 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10868 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10870 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10871 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10873 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10874 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10875 if (PL_compiling.cop_hints_hash) {
10877 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10878 HINTS_REFCNT_UNLOCK;
10880 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10882 /* pseudo environmental stuff */
10883 PL_origargc = proto_perl->Iorigargc;
10884 PL_origargv = proto_perl->Iorigargv;
10886 param->stashes = newAV(); /* Setup array of objects to call clone on */
10888 /* Set tainting stuff before PerlIO_debug can possibly get called */
10889 PL_tainting = proto_perl->Itainting;
10890 PL_taint_warn = proto_perl->Itaint_warn;
10892 #ifdef PERLIO_LAYERS
10893 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10894 PerlIO_clone(aTHX_ proto_perl, param);
10897 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10898 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10899 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10900 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10901 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10902 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10905 PL_minus_c = proto_perl->Iminus_c;
10906 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10907 PL_localpatches = proto_perl->Ilocalpatches;
10908 PL_splitstr = proto_perl->Isplitstr;
10909 PL_preprocess = proto_perl->Ipreprocess;
10910 PL_minus_n = proto_perl->Iminus_n;
10911 PL_minus_p = proto_perl->Iminus_p;
10912 PL_minus_l = proto_perl->Iminus_l;
10913 PL_minus_a = proto_perl->Iminus_a;
10914 PL_minus_E = proto_perl->Iminus_E;
10915 PL_minus_F = proto_perl->Iminus_F;
10916 PL_doswitches = proto_perl->Idoswitches;
10917 PL_dowarn = proto_perl->Idowarn;
10918 PL_doextract = proto_perl->Idoextract;
10919 PL_sawampersand = proto_perl->Isawampersand;
10920 PL_unsafe = proto_perl->Iunsafe;
10921 PL_inplace = SAVEPV(proto_perl->Iinplace);
10922 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10923 PL_perldb = proto_perl->Iperldb;
10924 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10925 PL_exit_flags = proto_perl->Iexit_flags;
10927 /* magical thingies */
10928 /* XXX time(&PL_basetime) when asked for? */
10929 PL_basetime = proto_perl->Ibasetime;
10930 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10932 PL_maxsysfd = proto_perl->Imaxsysfd;
10933 PL_statusvalue = proto_perl->Istatusvalue;
10935 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10937 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10939 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10941 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10942 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10943 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10946 /* RE engine related */
10947 Zero(&PL_reg_state, 1, struct re_save_state);
10948 PL_reginterp_cnt = 0;
10949 PL_regmatch_slab = NULL;
10951 /* Clone the regex array */
10952 PL_regex_padav = newAV();
10954 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10955 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10957 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10958 for(i = 1; i <= len; i++) {
10959 const SV * const regex = regexen[i];
10962 ? sv_dup_inc(regex, param)
10964 newSViv(PTR2IV(re_dup(
10965 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10967 av_push(PL_regex_padav, sv);
10970 PL_regex_pad = AvARRAY(PL_regex_padav);
10972 /* shortcuts to various I/O objects */
10973 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10974 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10975 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10976 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10977 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10978 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10980 /* shortcuts to regexp stuff */
10981 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10983 /* shortcuts to misc objects */
10984 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10986 /* shortcuts to debugging objects */
10987 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10988 PL_DBline = gv_dup(proto_perl->IDBline, param);
10989 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10990 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10991 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10992 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10993 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10994 PL_lineary = av_dup(proto_perl->Ilineary, param);
10995 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10997 /* symbol tables */
10998 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10999 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11000 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11001 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11002 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11004 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11005 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11006 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11007 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11008 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11009 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11011 PL_sub_generation = proto_perl->Isub_generation;
11013 /* funky return mechanisms */
11014 PL_forkprocess = proto_perl->Iforkprocess;
11016 /* subprocess state */
11017 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11019 /* internal state */
11020 PL_maxo = proto_perl->Imaxo;
11021 if (proto_perl->Iop_mask)
11022 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11025 /* PL_asserting = proto_perl->Iasserting; */
11027 /* current interpreter roots */
11028 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11029 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11030 PL_main_start = proto_perl->Imain_start;
11031 PL_eval_root = proto_perl->Ieval_root;
11032 PL_eval_start = proto_perl->Ieval_start;
11034 /* runtime control stuff */
11035 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11036 PL_copline = proto_perl->Icopline;
11038 PL_filemode = proto_perl->Ifilemode;
11039 PL_lastfd = proto_perl->Ilastfd;
11040 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11043 PL_gensym = proto_perl->Igensym;
11044 PL_preambled = proto_perl->Ipreambled;
11045 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11046 PL_laststatval = proto_perl->Ilaststatval;
11047 PL_laststype = proto_perl->Ilaststype;
11050 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11052 /* interpreter atexit processing */
11053 PL_exitlistlen = proto_perl->Iexitlistlen;
11054 if (PL_exitlistlen) {
11055 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11056 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11059 PL_exitlist = (PerlExitListEntry*)NULL;
11061 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11062 if (PL_my_cxt_size) {
11063 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11064 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11067 PL_my_cxt_list = (void**)NULL;
11068 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11069 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11070 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11072 PL_profiledata = NULL;
11073 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11074 /* PL_rsfp_filters entries have fake IoDIRP() */
11075 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11077 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11079 PAD_CLONE_VARS(proto_perl, param);
11081 #ifdef HAVE_INTERP_INTERN
11082 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11085 /* more statics moved here */
11086 PL_generation = proto_perl->Igeneration;
11087 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11089 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11090 PL_in_clean_all = proto_perl->Iin_clean_all;
11092 PL_uid = proto_perl->Iuid;
11093 PL_euid = proto_perl->Ieuid;
11094 PL_gid = proto_perl->Igid;
11095 PL_egid = proto_perl->Iegid;
11096 PL_nomemok = proto_perl->Inomemok;
11097 PL_an = proto_perl->Ian;
11098 PL_evalseq = proto_perl->Ievalseq;
11099 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11100 PL_origalen = proto_perl->Iorigalen;
11101 #ifdef PERL_USES_PL_PIDSTATUS
11102 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11104 PL_osname = SAVEPV(proto_perl->Iosname);
11105 PL_sighandlerp = proto_perl->Isighandlerp;
11107 PL_runops = proto_perl->Irunops;
11109 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11112 PL_cshlen = proto_perl->Icshlen;
11113 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11116 PL_lex_state = proto_perl->Ilex_state;
11117 PL_lex_defer = proto_perl->Ilex_defer;
11118 PL_lex_expect = proto_perl->Ilex_expect;
11119 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11120 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11121 PL_lex_starts = proto_perl->Ilex_starts;
11122 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11123 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11124 PL_lex_op = proto_perl->Ilex_op;
11125 PL_lex_inpat = proto_perl->Ilex_inpat;
11126 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11127 PL_lex_brackets = proto_perl->Ilex_brackets;
11128 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11129 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11130 PL_lex_casemods = proto_perl->Ilex_casemods;
11131 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11132 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11135 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11136 PL_lasttoke = proto_perl->Ilasttoke;
11137 PL_realtokenstart = proto_perl->Irealtokenstart;
11138 PL_faketokens = proto_perl->Ifaketokens;
11139 PL_thismad = proto_perl->Ithismad;
11140 PL_thistoken = proto_perl->Ithistoken;
11141 PL_thisopen = proto_perl->Ithisopen;
11142 PL_thisstuff = proto_perl->Ithisstuff;
11143 PL_thisclose = proto_perl->Ithisclose;
11144 PL_thiswhite = proto_perl->Ithiswhite;
11145 PL_nextwhite = proto_perl->Inextwhite;
11146 PL_skipwhite = proto_perl->Iskipwhite;
11147 PL_endwhite = proto_perl->Iendwhite;
11148 PL_curforce = proto_perl->Icurforce;
11150 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11151 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11152 PL_nexttoke = proto_perl->Inexttoke;
11155 /* XXX This is probably masking the deeper issue of why
11156 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11157 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11158 * (A little debugging with a watchpoint on it may help.)
11160 if (SvANY(proto_perl->Ilinestr)) {
11161 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11162 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11163 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11164 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11165 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11166 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11167 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11168 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11169 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11172 PL_linestr = newSV(79);
11173 sv_upgrade(PL_linestr,SVt_PVIV);
11174 sv_setpvn(PL_linestr,"",0);
11175 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11177 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11178 PL_pending_ident = proto_perl->Ipending_ident;
11179 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11181 PL_expect = proto_perl->Iexpect;
11183 PL_multi_start = proto_perl->Imulti_start;
11184 PL_multi_end = proto_perl->Imulti_end;
11185 PL_multi_open = proto_perl->Imulti_open;
11186 PL_multi_close = proto_perl->Imulti_close;
11188 PL_error_count = proto_perl->Ierror_count;
11189 PL_subline = proto_perl->Isubline;
11190 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11192 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11193 if (SvANY(proto_perl->Ilinestr)) {
11194 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11195 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11196 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11197 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11198 PL_last_lop_op = proto_perl->Ilast_lop_op;
11201 PL_last_uni = SvPVX(PL_linestr);
11202 PL_last_lop = SvPVX(PL_linestr);
11203 PL_last_lop_op = 0;
11205 PL_in_my = proto_perl->Iin_my;
11206 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11208 PL_cryptseen = proto_perl->Icryptseen;
11211 PL_hints = proto_perl->Ihints;
11213 PL_amagic_generation = proto_perl->Iamagic_generation;
11215 #ifdef USE_LOCALE_COLLATE
11216 PL_collation_ix = proto_perl->Icollation_ix;
11217 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11218 PL_collation_standard = proto_perl->Icollation_standard;
11219 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11220 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11221 #endif /* USE_LOCALE_COLLATE */
11223 #ifdef USE_LOCALE_NUMERIC
11224 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11225 PL_numeric_standard = proto_perl->Inumeric_standard;
11226 PL_numeric_local = proto_perl->Inumeric_local;
11227 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11228 #endif /* !USE_LOCALE_NUMERIC */
11230 /* utf8 character classes */
11231 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11232 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11233 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11234 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11235 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11236 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11237 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11238 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11239 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11240 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11241 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11242 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11243 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11244 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11245 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11246 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11247 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11248 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11249 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11250 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11252 /* Did the locale setup indicate UTF-8? */
11253 PL_utf8locale = proto_perl->Iutf8locale;
11254 /* Unicode features (see perlrun/-C) */
11255 PL_unicode = proto_perl->Iunicode;
11257 /* Pre-5.8 signals control */
11258 PL_signals = proto_perl->Isignals;
11260 /* times() ticks per second */
11261 PL_clocktick = proto_perl->Iclocktick;
11263 /* Recursion stopper for PerlIO_find_layer */
11264 PL_in_load_module = proto_perl->Iin_load_module;
11266 /* sort() routine */
11267 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11269 /* Not really needed/useful since the reenrant_retint is "volatile",
11270 * but do it for consistency's sake. */
11271 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11273 /* Hooks to shared SVs and locks. */
11274 PL_sharehook = proto_perl->Isharehook;
11275 PL_lockhook = proto_perl->Ilockhook;
11276 PL_unlockhook = proto_perl->Iunlockhook;
11277 PL_threadhook = proto_perl->Ithreadhook;
11279 PL_runops_std = proto_perl->Irunops_std;
11280 PL_runops_dbg = proto_perl->Irunops_dbg;
11282 #ifdef THREADS_HAVE_PIDS
11283 PL_ppid = proto_perl->Ippid;
11287 PL_last_swash_hv = NULL; /* reinits on demand */
11288 PL_last_swash_klen = 0;
11289 PL_last_swash_key[0]= '\0';
11290 PL_last_swash_tmps = (U8*)NULL;
11291 PL_last_swash_slen = 0;
11293 PL_glob_index = proto_perl->Iglob_index;
11294 PL_srand_called = proto_perl->Isrand_called;
11295 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11296 PL_bitcount = NULL; /* reinits on demand */
11298 if (proto_perl->Ipsig_pend) {
11299 Newxz(PL_psig_pend, SIG_SIZE, int);
11302 PL_psig_pend = (int*)NULL;
11305 if (proto_perl->Ipsig_ptr) {
11306 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11307 Newxz(PL_psig_name, SIG_SIZE, SV*);
11308 for (i = 1; i < SIG_SIZE; i++) {
11309 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11310 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11314 PL_psig_ptr = (SV**)NULL;
11315 PL_psig_name = (SV**)NULL;
11318 /* thrdvar.h stuff */
11320 if (flags & CLONEf_COPY_STACKS) {
11321 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11322 PL_tmps_ix = proto_perl->Ttmps_ix;
11323 PL_tmps_max = proto_perl->Ttmps_max;
11324 PL_tmps_floor = proto_perl->Ttmps_floor;
11325 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11327 while (i <= PL_tmps_ix) {
11328 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11332 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11333 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11334 Newxz(PL_markstack, i, I32);
11335 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11336 - proto_perl->Tmarkstack);
11337 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11338 - proto_perl->Tmarkstack);
11339 Copy(proto_perl->Tmarkstack, PL_markstack,
11340 PL_markstack_ptr - PL_markstack + 1, I32);
11342 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11343 * NOTE: unlike the others! */
11344 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11345 PL_scopestack_max = proto_perl->Tscopestack_max;
11346 Newxz(PL_scopestack, PL_scopestack_max, I32);
11347 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11349 /* NOTE: si_dup() looks at PL_markstack */
11350 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11352 /* PL_curstack = PL_curstackinfo->si_stack; */
11353 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11354 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11356 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11357 PL_stack_base = AvARRAY(PL_curstack);
11358 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11359 - proto_perl->Tstack_base);
11360 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11362 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11363 * NOTE: unlike the others! */
11364 PL_savestack_ix = proto_perl->Tsavestack_ix;
11365 PL_savestack_max = proto_perl->Tsavestack_max;
11366 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11367 PL_savestack = ss_dup(proto_perl, param);
11371 ENTER; /* perl_destruct() wants to LEAVE; */
11373 /* although we're not duplicating the tmps stack, we should still
11374 * add entries for any SVs on the tmps stack that got cloned by a
11375 * non-refcount means (eg a temp in @_); otherwise they will be
11378 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11379 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11380 proto_perl->Ttmps_stack[i]);
11381 if (nsv && !SvREFCNT(nsv)) {
11383 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11388 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11389 PL_top_env = &PL_start_env;
11391 PL_op = proto_perl->Top;
11394 PL_Xpv = (XPV*)NULL;
11395 PL_na = proto_perl->Tna;
11397 PL_statbuf = proto_perl->Tstatbuf;
11398 PL_statcache = proto_perl->Tstatcache;
11399 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11400 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11402 PL_timesbuf = proto_perl->Ttimesbuf;
11405 PL_tainted = proto_perl->Ttainted;
11406 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11407 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11408 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11409 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11410 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11411 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11412 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11413 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11414 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11416 PL_restartop = proto_perl->Trestartop;
11417 PL_in_eval = proto_perl->Tin_eval;
11418 PL_delaymagic = proto_perl->Tdelaymagic;
11419 PL_dirty = proto_perl->Tdirty;
11420 PL_localizing = proto_perl->Tlocalizing;
11422 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11423 PL_hv_fetch_ent_mh = NULL;
11424 PL_modcount = proto_perl->Tmodcount;
11425 PL_lastgotoprobe = NULL;
11426 PL_dumpindent = proto_perl->Tdumpindent;
11428 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11429 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11430 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11431 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11432 PL_efloatbuf = NULL; /* reinits on demand */
11433 PL_efloatsize = 0; /* reinits on demand */
11437 PL_screamfirst = NULL;
11438 PL_screamnext = NULL;
11439 PL_maxscream = -1; /* reinits on demand */
11440 PL_lastscream = NULL;
11442 PL_watchaddr = NULL;
11445 PL_regdummy = proto_perl->Tregdummy;
11446 PL_colorset = 0; /* reinits PL_colors[] */
11447 /*PL_colors[6] = {0,0,0,0,0,0};*/
11451 /* Pluggable optimizer */
11452 PL_peepp = proto_perl->Tpeepp;
11454 PL_stashcache = newHV();
11456 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11457 ptr_table_free(PL_ptr_table);
11458 PL_ptr_table = NULL;
11461 /* Call the ->CLONE method, if it exists, for each of the stashes
11462 identified by sv_dup() above.
11464 while(av_len(param->stashes) != -1) {
11465 HV* const stash = (HV*) av_shift(param->stashes);
11466 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11467 if (cloner && GvCV(cloner)) {
11472 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11474 call_sv((SV*)GvCV(cloner), G_DISCARD);
11480 SvREFCNT_dec(param->stashes);
11482 /* orphaned? eg threads->new inside BEGIN or use */
11483 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11484 SvREFCNT_inc_simple_void(PL_compcv);
11485 SAVEFREESV(PL_compcv);
11491 #endif /* USE_ITHREADS */
11494 =head1 Unicode Support
11496 =for apidoc sv_recode_to_utf8
11498 The encoding is assumed to be an Encode object, on entry the PV
11499 of the sv is assumed to be octets in that encoding, and the sv
11500 will be converted into Unicode (and UTF-8).
11502 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11503 is not a reference, nothing is done to the sv. If the encoding is not
11504 an C<Encode::XS> Encoding object, bad things will happen.
11505 (See F<lib/encoding.pm> and L<Encode>).
11507 The PV of the sv is returned.
11512 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11515 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11529 Passing sv_yes is wrong - it needs to be or'ed set of constants
11530 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11531 remove converted chars from source.
11533 Both will default the value - let them.
11535 XPUSHs(&PL_sv_yes);
11538 call_method("decode", G_SCALAR);
11542 s = SvPV_const(uni, len);
11543 if (s != SvPVX_const(sv)) {
11544 SvGROW(sv, len + 1);
11545 Move(s, SvPVX(sv), len + 1, char);
11546 SvCUR_set(sv, len);
11553 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11557 =for apidoc sv_cat_decode
11559 The encoding is assumed to be an Encode object, the PV of the ssv is
11560 assumed to be octets in that encoding and decoding the input starts
11561 from the position which (PV + *offset) pointed to. The dsv will be
11562 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11563 when the string tstr appears in decoding output or the input ends on
11564 the PV of the ssv. The value which the offset points will be modified
11565 to the last input position on the ssv.
11567 Returns TRUE if the terminator was found, else returns FALSE.
11572 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11573 SV *ssv, int *offset, char *tstr, int tlen)
11577 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11588 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11589 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11591 call_method("cat_decode", G_SCALAR);
11593 ret = SvTRUE(TOPs);
11594 *offset = SvIV(offsv);
11600 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11605 /* ---------------------------------------------------------------------
11607 * support functions for report_uninit()
11610 /* the maxiumum size of array or hash where we will scan looking
11611 * for the undefined element that triggered the warning */
11613 #define FUV_MAX_SEARCH_SIZE 1000
11615 /* Look for an entry in the hash whose value has the same SV as val;
11616 * If so, return a mortal copy of the key. */
11619 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11622 register HE **array;
11625 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11626 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11629 array = HvARRAY(hv);
11631 for (i=HvMAX(hv); i>0; i--) {
11632 register HE *entry;
11633 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11634 if (HeVAL(entry) != val)
11636 if ( HeVAL(entry) == &PL_sv_undef ||
11637 HeVAL(entry) == &PL_sv_placeholder)
11641 if (HeKLEN(entry) == HEf_SVKEY)
11642 return sv_mortalcopy(HeKEY_sv(entry));
11643 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11649 /* Look for an entry in the array whose value has the same SV as val;
11650 * If so, return the index, otherwise return -1. */
11653 S_find_array_subscript(pTHX_ AV *av, SV* val)
11656 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11657 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11660 if (val != &PL_sv_undef) {
11661 SV ** const svp = AvARRAY(av);
11664 for (i=AvFILLp(av); i>=0; i--)
11671 /* S_varname(): return the name of a variable, optionally with a subscript.
11672 * If gv is non-zero, use the name of that global, along with gvtype (one
11673 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11674 * targ. Depending on the value of the subscript_type flag, return:
11677 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11678 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11679 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11680 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11683 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11684 SV* keyname, I32 aindex, int subscript_type)
11687 SV * const name = sv_newmortal();
11690 buffer[0] = gvtype;
11693 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11695 gv_fullname4(name, gv, buffer, 0);
11697 if ((unsigned int)SvPVX(name)[1] <= 26) {
11699 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11701 /* Swap the 1 unprintable control character for the 2 byte pretty
11702 version - ie substr($name, 1, 1) = $buffer; */
11703 sv_insert(name, 1, 1, buffer, 2);
11708 CV * const cv = find_runcv(&unused);
11712 if (!cv || !CvPADLIST(cv))
11714 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11715 sv = *av_fetch(av, targ, FALSE);
11716 /* SvLEN in a pad name is not to be trusted */
11717 sv_setpv(name, SvPV_nolen_const(sv));
11720 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11721 SV * const sv = newSV(0);
11722 *SvPVX(name) = '$';
11723 Perl_sv_catpvf(aTHX_ name, "{%s}",
11724 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11727 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11728 *SvPVX(name) = '$';
11729 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11731 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11732 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11739 =for apidoc find_uninit_var
11741 Find the name of the undefined variable (if any) that caused the operator o
11742 to issue a "Use of uninitialized value" warning.
11743 If match is true, only return a name if it's value matches uninit_sv.
11744 So roughly speaking, if a unary operator (such as OP_COS) generates a
11745 warning, then following the direct child of the op may yield an
11746 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11747 other hand, with OP_ADD there are two branches to follow, so we only print
11748 the variable name if we get an exact match.
11750 The name is returned as a mortal SV.
11752 Assumes that PL_op is the op that originally triggered the error, and that
11753 PL_comppad/PL_curpad points to the currently executing pad.
11759 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11767 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11768 uninit_sv == &PL_sv_placeholder)))
11771 switch (obase->op_type) {
11778 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11779 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11782 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11784 if (pad) { /* @lex, %lex */
11785 sv = PAD_SVl(obase->op_targ);
11789 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11790 /* @global, %global */
11791 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11794 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11796 else /* @{expr}, %{expr} */
11797 return find_uninit_var(cUNOPx(obase)->op_first,
11801 /* attempt to find a match within the aggregate */
11803 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11805 subscript_type = FUV_SUBSCRIPT_HASH;
11808 index = find_array_subscript((AV*)sv, uninit_sv);
11810 subscript_type = FUV_SUBSCRIPT_ARRAY;
11813 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11816 return varname(gv, hash ? '%' : '@', obase->op_targ,
11817 keysv, index, subscript_type);
11821 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11823 return varname(NULL, '$', obase->op_targ,
11824 NULL, 0, FUV_SUBSCRIPT_NONE);
11827 gv = cGVOPx_gv(obase);
11828 if (!gv || (match && GvSV(gv) != uninit_sv))
11830 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11833 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11836 av = (AV*)PAD_SV(obase->op_targ);
11837 if (!av || SvRMAGICAL(av))
11839 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11840 if (!svp || *svp != uninit_sv)
11843 return varname(NULL, '$', obase->op_targ,
11844 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11847 gv = cGVOPx_gv(obase);
11853 if (!av || SvRMAGICAL(av))
11855 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11856 if (!svp || *svp != uninit_sv)
11859 return varname(gv, '$', 0,
11860 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11865 o = cUNOPx(obase)->op_first;
11866 if (!o || o->op_type != OP_NULL ||
11867 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11869 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11873 if (PL_op == obase)
11874 /* $a[uninit_expr] or $h{uninit_expr} */
11875 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11878 o = cBINOPx(obase)->op_first;
11879 kid = cBINOPx(obase)->op_last;
11881 /* get the av or hv, and optionally the gv */
11883 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11884 sv = PAD_SV(o->op_targ);
11886 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11887 && cUNOPo->op_first->op_type == OP_GV)
11889 gv = cGVOPx_gv(cUNOPo->op_first);
11892 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11897 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11898 /* index is constant */
11902 if (obase->op_type == OP_HELEM) {
11903 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11904 if (!he || HeVAL(he) != uninit_sv)
11908 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11909 if (!svp || *svp != uninit_sv)
11913 if (obase->op_type == OP_HELEM)
11914 return varname(gv, '%', o->op_targ,
11915 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11917 return varname(gv, '@', o->op_targ, NULL,
11918 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11921 /* index is an expression;
11922 * attempt to find a match within the aggregate */
11923 if (obase->op_type == OP_HELEM) {
11924 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11926 return varname(gv, '%', o->op_targ,
11927 keysv, 0, FUV_SUBSCRIPT_HASH);
11930 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11932 return varname(gv, '@', o->op_targ,
11933 NULL, index, FUV_SUBSCRIPT_ARRAY);
11938 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11940 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11945 /* only examine RHS */
11946 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11949 o = cUNOPx(obase)->op_first;
11950 if (o->op_type == OP_PUSHMARK)
11953 if (!o->op_sibling) {
11954 /* one-arg version of open is highly magical */
11956 if (o->op_type == OP_GV) { /* open FOO; */
11958 if (match && GvSV(gv) != uninit_sv)
11960 return varname(gv, '$', 0,
11961 NULL, 0, FUV_SUBSCRIPT_NONE);
11963 /* other possibilities not handled are:
11964 * open $x; or open my $x; should return '${*$x}'
11965 * open expr; should return '$'.expr ideally
11971 /* ops where $_ may be an implicit arg */
11975 if ( !(obase->op_flags & OPf_STACKED)) {
11976 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11977 ? PAD_SVl(obase->op_targ)
11980 sv = sv_newmortal();
11981 sv_setpvn(sv, "$_", 2);
11989 /* skip filehandle as it can't produce 'undef' warning */
11990 o = cUNOPx(obase)->op_first;
11991 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11992 o = o->op_sibling->op_sibling;
11999 match = 1; /* XS or custom code could trigger random warnings */
12004 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12005 return sv_2mortal(newSVpvs("${$/}"));
12010 if (!(obase->op_flags & OPf_KIDS))
12012 o = cUNOPx(obase)->op_first;
12018 /* if all except one arg are constant, or have no side-effects,
12019 * or are optimized away, then it's unambiguous */
12021 for (kid=o; kid; kid = kid->op_sibling) {
12023 const OPCODE type = kid->op_type;
12024 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12025 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12026 || (type == OP_PUSHMARK)
12030 if (o2) { /* more than one found */
12037 return find_uninit_var(o2, uninit_sv, match);
12039 /* scan all args */
12041 sv = find_uninit_var(o, uninit_sv, 1);
12053 =for apidoc report_uninit
12055 Print appropriate "Use of uninitialized variable" warning
12061 Perl_report_uninit(pTHX_ SV* uninit_sv)
12065 SV* varname = NULL;
12067 varname = find_uninit_var(PL_op, uninit_sv,0);
12069 sv_insert(varname, 0, 0, " ", 1);
12071 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12072 varname ? SvPV_nolen_const(varname) : "",
12073 " in ", OP_DESC(PL_op));
12076 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12082 * c-indentation-style: bsd
12083 * c-basic-offset: 4
12084 * indent-tabs-mode: t
12087 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob