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) Poison(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
196 Poison(&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)
681 struct arena_desc* adesc;
682 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
685 /* shouldnt need this
686 if (!arena_size) arena_size = PERL_ARENA_SIZE;
689 /* may need new arena-set to hold new arena */
690 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
691 Newxz(newroot, 1, struct arena_set);
692 newroot->set_size = ARENAS_PER_SET;
693 newroot->next = *aroot;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
698 /* ok, now have arena-set with at least 1 empty/available arena-desc */
699 curr = (*aroot)->curr++;
700 adesc = &((*aroot)->set[curr]);
701 assert(!adesc->arena);
703 Newxz(adesc->arena, arena_size, char);
704 adesc->size = arena_size;
705 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
706 curr, adesc->arena, arena_size));
712 /* return a thing to the free list */
714 #define del_body(thing, root) \
716 void ** const thing_copy = (void **)thing;\
718 *thing_copy = *root; \
719 *root = (void*)thing_copy; \
725 =head1 SV-Body Allocation
727 Allocation of SV-bodies is similar to SV-heads, differing as follows;
728 the allocation mechanism is used for many body types, so is somewhat
729 more complicated, it uses arena-sets, and has no need for still-live
732 At the outermost level, (new|del)_X*V macros return bodies of the
733 appropriate type. These macros call either (new|del)_body_type or
734 (new|del)_body_allocated macro pairs, depending on specifics of the
735 type. Most body types use the former pair, the latter pair is used to
736 allocate body types with "ghost fields".
738 "ghost fields" are fields that are unused in certain types, and
739 consequently dont need to actually exist. They are declared because
740 they're part of a "base type", which allows use of functions as
741 methods. The simplest examples are AVs and HVs, 2 aggregate types
742 which don't use the fields which support SCALAR semantics.
744 For these types, the arenas are carved up into *_allocated size
745 chunks, we thus avoid wasted memory for those unaccessed members.
746 When bodies are allocated, we adjust the pointer back in memory by the
747 size of the bit not allocated, so it's as if we allocated the full
748 structure. (But things will all go boom if you write to the part that
749 is "not there", because you'll be overwriting the last members of the
750 preceding structure in memory.)
752 We calculate the correction using the STRUCT_OFFSET macro. For
753 example, if xpv_allocated is the same structure as XPV then the two
754 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
755 structure is smaller (no initial NV actually allocated) then the net
756 effect is to subtract the size of the NV from the pointer, to return a
757 new pointer as if an initial NV were actually allocated.
759 This is the same trick as was used for NV and IV bodies. Ironically it
760 doesn't need to be used for NV bodies any more, because NV is now at
761 the start of the structure. IV bodies don't need it either, because
762 they are no longer allocated.
764 In turn, the new_body_* allocators call S_new_body(), which invokes
765 new_body_inline macro, which takes a lock, and takes a body off the
766 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
767 necessary to refresh an empty list. Then the lock is released, and
768 the body is returned.
770 S_more_bodies calls get_arena(), and carves it up into an array of N
771 bodies, which it strings into a linked list. It looks up arena-size
772 and body-size from the body_details table described below, thus
773 supporting the multiple body-types.
775 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
776 the (new|del)_X*V macros are mapped directly to malloc/free.
782 For each sv-type, struct body_details bodies_by_type[] carries
783 parameters which control these aspects of SV handling:
785 Arena_size determines whether arenas are used for this body type, and if
786 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
787 zero, forcing individual mallocs and frees.
789 Body_size determines how big a body is, and therefore how many fit into
790 each arena. Offset carries the body-pointer adjustment needed for
791 *_allocated body types, and is used in *_allocated macros.
793 But its main purpose is to parameterize info needed in
794 Perl_sv_upgrade(). The info here dramatically simplifies the function
795 vs the implementation in 5.8.7, making it table-driven. All fields
796 are used for this, except for arena_size.
798 For the sv-types that have no bodies, arenas are not used, so those
799 PL_body_roots[sv_type] are unused, and can be overloaded. In
800 something of a special case, SVt_NULL is borrowed for HE arenas;
801 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
802 bodies_by_type[SVt_NULL] slot is not used, as the table is not
805 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
806 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
807 they can just use the same allocation semantics. At first, PTEs were
808 also overloaded to a non-body sv-type, but this yielded hard-to-find
809 malloc bugs, so was simplified by claiming a new slot. This choice
810 has no consequence at this time.
814 struct body_details {
815 U8 body_size; /* Size to allocate */
816 U8 copy; /* Size of structure to copy (may be shorter) */
818 unsigned int type : 4; /* We have space for a sanity check. */
819 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
820 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
821 unsigned int arena : 1; /* Allocated from an arena */
822 size_t arena_size; /* Size of arena to allocate */
830 /* With -DPURFIY we allocate everything directly, and don't use arenas.
831 This seems a rather elegant way to simplify some of the code below. */
832 #define HASARENA FALSE
834 #define HASARENA TRUE
836 #define NOARENA FALSE
838 /* Size the arenas to exactly fit a given number of bodies. A count
839 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
840 simplifying the default. If count > 0, the arena is sized to fit
841 only that many bodies, allowing arenas to be used for large, rare
842 bodies (XPVFM, XPVIO) without undue waste. The arena size is
843 limited by PERL_ARENA_SIZE, so we can safely oversize the
846 #define FIT_ARENA0(body_size) \
847 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
848 #define FIT_ARENAn(count,body_size) \
849 ( count * body_size <= PERL_ARENA_SIZE) \
850 ? count * body_size \
851 : FIT_ARENA0 (body_size)
852 #define FIT_ARENA(count,body_size) \
854 ? FIT_ARENAn (count, body_size) \
855 : FIT_ARENA0 (body_size)
857 /* A macro to work out the offset needed to subtract from a pointer to (say)
864 to make its members accessible via a pointer to (say)
874 #define relative_STRUCT_OFFSET(longer, shorter, member) \
875 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
877 /* Calculate the length to copy. Specifically work out the length less any
878 final padding the compiler needed to add. See the comment in sv_upgrade
879 for why copying the padding proved to be a bug. */
881 #define copy_length(type, last_member) \
882 STRUCT_OFFSET(type, last_member) \
883 + sizeof (((type*)SvANY((SV*)0))->last_member)
885 static const struct body_details bodies_by_type[] = {
886 { sizeof(HE), 0, 0, SVt_NULL,
887 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
889 /* IVs are in the head, so the allocation size is 0.
890 However, the slot is overloaded for PTEs. */
891 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
892 sizeof(IV), /* This is used to copy out the IV body. */
893 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
894 NOARENA /* IVS don't need an arena */,
895 /* But PTEs need to know the size of their arena */
896 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
901 FIT_ARENA(0, sizeof(NV)) },
903 /* RVs are in the head now. */
904 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(xpv_allocated),
908 copy_length(XPV, xpv_len)
909 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
914 { sizeof(xpviv_allocated),
915 copy_length(XPVIV, xiv_u)
916 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
917 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
921 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
922 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
925 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
929 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
933 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
934 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
937 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
938 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
940 { sizeof(xpvav_allocated),
941 copy_length(XPVAV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
943 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
946 { sizeof(xpvhv_allocated),
947 copy_length(XPVHV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
949 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
953 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
954 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
955 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
957 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
958 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
959 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
961 /* XPVIO is 84 bytes, fits 48x */
962 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
963 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
966 #define new_body_type(sv_type) \
967 (void *)((char *)S_new_body(aTHX_ sv_type))
969 #define del_body_type(p, sv_type) \
970 del_body(p, &PL_body_roots[sv_type])
973 #define new_body_allocated(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ sv_type) \
975 - bodies_by_type[sv_type].offset)
977 #define del_body_allocated(p, sv_type) \
978 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
981 #define my_safemalloc(s) (void*)safemalloc(s)
982 #define my_safecalloc(s) (void*)safecalloc(s, 1)
983 #define my_safefree(p) safefree((char*)p)
987 #define new_XNV() my_safemalloc(sizeof(XPVNV))
988 #define del_XNV(p) my_safefree(p)
990 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XPVNV(p) my_safefree(p)
993 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
994 #define del_XPVAV(p) my_safefree(p)
996 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
997 #define del_XPVHV(p) my_safefree(p)
999 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1000 #define del_XPVMG(p) my_safefree(p)
1002 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1003 #define del_XPVGV(p) my_safefree(p)
1007 #define new_XNV() new_body_type(SVt_NV)
1008 #define del_XNV(p) del_body_type(p, SVt_NV)
1010 #define new_XPVNV() new_body_type(SVt_PVNV)
1011 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1013 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1014 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1016 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1017 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1019 #define new_XPVMG() new_body_type(SVt_PVMG)
1020 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1022 #define new_XPVGV() new_body_type(SVt_PVGV)
1023 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1027 /* no arena for you! */
1029 #define new_NOARENA(details) \
1030 my_safemalloc((details)->body_size + (details)->offset)
1031 #define new_NOARENAZ(details) \
1032 my_safecalloc((details)->body_size + (details)->offset)
1035 static bool done_sanity_check;
1039 S_more_bodies (pTHX_ svtype sv_type)
1042 void ** const root = &PL_body_roots[sv_type];
1043 const struct body_details * const bdp = &bodies_by_type[sv_type];
1044 const size_t body_size = bdp->body_size;
1048 assert(bdp->arena_size);
1051 if (!done_sanity_check) {
1052 unsigned int i = SVt_LAST;
1054 done_sanity_check = TRUE;
1057 assert (bodies_by_type[i].type == i);
1061 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1063 end = start + bdp->arena_size - body_size;
1065 /* computed count doesnt reflect the 1st slot reservation */
1066 DEBUG_m(PerlIO_printf(Perl_debug_log,
1067 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1068 start, end, bdp->arena_size, sv_type, body_size,
1069 bdp->arena_size / body_size));
1071 *root = (void *)start;
1073 while (start < end) {
1074 char * const next = start + body_size;
1075 *(void**) start = (void *)next;
1078 *(void **)start = 0;
1083 /* grab a new thing from the free list, allocating more if necessary.
1084 The inline version is used for speed in hot routines, and the
1085 function using it serves the rest (unless PURIFY).
1087 #define new_body_inline(xpv, sv_type) \
1089 void ** const r3wt = &PL_body_roots[sv_type]; \
1091 xpv = *((void **)(r3wt)) \
1092 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1093 *(r3wt) = *(void**)(xpv); \
1100 S_new_body(pTHX_ svtype sv_type)
1104 new_body_inline(xpv, sv_type);
1111 =for apidoc sv_upgrade
1113 Upgrade an SV to a more complex form. Generally adds a new body type to the
1114 SV, then copies across as much information as possible from the old body.
1115 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1121 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1126 const U32 old_type = SvTYPE(sv);
1127 const struct body_details *new_type_details;
1128 const struct body_details *const old_type_details
1129 = bodies_by_type + old_type;
1131 if (new_type != SVt_PV && SvIsCOW(sv)) {
1132 sv_force_normal_flags(sv, 0);
1135 if (old_type == new_type)
1138 if (old_type > new_type)
1139 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1140 (int)old_type, (int)new_type);
1143 old_body = SvANY(sv);
1145 /* Copying structures onto other structures that have been neatly zeroed
1146 has a subtle gotcha. Consider XPVMG
1148 +------+------+------+------+------+-------+-------+
1149 | NV | CUR | LEN | IV | MAGIC | STASH |
1150 +------+------+------+------+------+-------+-------+
1151 0 4 8 12 16 20 24 28
1153 where NVs are aligned to 8 bytes, so that sizeof that structure is
1154 actually 32 bytes long, with 4 bytes of padding at the end:
1156 +------+------+------+------+------+-------+-------+------+
1157 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1158 +------+------+------+------+------+-------+-------+------+
1159 0 4 8 12 16 20 24 28 32
1161 so what happens if you allocate memory for this structure:
1163 +------+------+------+------+------+-------+-------+------+------+...
1164 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1165 +------+------+------+------+------+-------+-------+------+------+...
1166 0 4 8 12 16 20 24 28 32 36
1168 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1169 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1170 started out as zero once, but it's quite possible that it isn't. So now,
1171 rather than a nicely zeroed GP, you have it pointing somewhere random.
1174 (In fact, GP ends up pointing at a previous GP structure, because the
1175 principle cause of the padding in XPVMG getting garbage is a copy of
1176 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1178 So we are careful and work out the size of used parts of all the
1185 if (new_type < SVt_PVIV) {
1186 new_type = (new_type == SVt_NV)
1187 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1198 assert(new_type > SVt_PV);
1199 assert(SVt_IV < SVt_PV);
1200 assert(SVt_NV < SVt_PV);
1207 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1208 there's no way that it can be safely upgraded, because perl.c
1209 expects to Safefree(SvANY(PL_mess_sv)) */
1210 assert(sv != PL_mess_sv);
1211 /* This flag bit is used to mean other things in other scalar types.
1212 Given that it only has meaning inside the pad, it shouldn't be set
1213 on anything that can get upgraded. */
1214 assert(!SvPAD_TYPED(sv));
1217 if (old_type_details->cant_upgrade)
1218 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1219 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1221 new_type_details = bodies_by_type + new_type;
1223 SvFLAGS(sv) &= ~SVTYPEMASK;
1224 SvFLAGS(sv) |= new_type;
1226 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1227 the return statements above will have triggered. */
1228 assert (new_type != SVt_NULL);
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1236 assert(old_type == SVt_NULL);
1237 SvANY(sv) = new_XNV();
1241 assert(old_type == SVt_NULL);
1242 SvANY(sv) = &sv->sv_u.svu_rv;
1247 assert(new_type_details->body_size);
1250 assert(new_type_details->arena);
1251 assert(new_type_details->arena_size);
1252 /* This points to the start of the allocated area. */
1253 new_body_inline(new_body, new_type);
1254 Zero(new_body, new_type_details->body_size, char);
1255 new_body = ((char *)new_body) - new_type_details->offset;
1257 /* We always allocated the full length item with PURIFY. To do this
1258 we fake things so that arena is false for all 16 types.. */
1259 new_body = new_NOARENAZ(new_type_details);
1261 SvANY(sv) = new_body;
1262 if (new_type == SVt_PVAV) {
1268 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1269 The target created by newSVrv also is, and it can have magic.
1270 However, it never has SvPVX set.
1272 if (old_type >= SVt_RV) {
1273 assert(SvPVX_const(sv) == 0);
1276 /* Could put this in the else clause below, as PVMG must have SvPVX
1277 0 already (the assertion above) */
1280 if (old_type >= SVt_PVMG) {
1281 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1288 /* XXX Is this still needed? Was it ever needed? Surely as there is
1289 no route from NV to PVIV, NOK can never be true */
1290 assert(!SvNOKp(sv));
1302 assert(new_type_details->body_size);
1303 /* We always allocated the full length item with PURIFY. To do this
1304 we fake things so that arena is false for all 16 types.. */
1305 if(new_type_details->arena) {
1306 /* This points to the start of the allocated area. */
1307 new_body_inline(new_body, new_type);
1308 Zero(new_body, new_type_details->body_size, char);
1309 new_body = ((char *)new_body) - new_type_details->offset;
1311 new_body = new_NOARENAZ(new_type_details);
1313 SvANY(sv) = new_body;
1315 if (old_type_details->copy) {
1316 /* There is now the potential for an upgrade from something without
1317 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1318 int offset = old_type_details->offset;
1319 int length = old_type_details->copy;
1321 if (new_type_details->offset > old_type_details->offset) {
1323 = new_type_details->offset - old_type_details->offset;
1324 offset += difference;
1325 length -= difference;
1327 assert (length >= 0);
1329 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1333 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1334 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1335 * correct 0.0 for us. Otherwise, if the old body didn't have an
1336 * NV slot, but the new one does, then we need to initialise the
1337 * freshly created NV slot with whatever the correct bit pattern is
1339 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1343 if (new_type == SVt_PVIO)
1344 IoPAGE_LEN(sv) = 60;
1345 if (old_type < SVt_RV)
1349 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1350 (unsigned long)new_type);
1353 if (old_type_details->arena) {
1354 /* If there was an old body, then we need to free it.
1355 Note that there is an assumption that all bodies of types that
1356 can be upgraded came from arenas. Only the more complex non-
1357 upgradable types are allowed to be directly malloc()ed. */
1359 my_safefree(old_body);
1361 del_body((void*)((char*)old_body + old_type_details->offset),
1362 &PL_body_roots[old_type]);
1368 =for apidoc sv_backoff
1370 Remove any string offset. You should normally use the C<SvOOK_off> macro
1377 Perl_sv_backoff(pTHX_ register SV *sv)
1379 PERL_UNUSED_CONTEXT;
1381 assert(SvTYPE(sv) != SVt_PVHV);
1382 assert(SvTYPE(sv) != SVt_PVAV);
1384 const char * const s = SvPVX_const(sv);
1385 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1386 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1388 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1390 SvFLAGS(sv) &= ~SVf_OOK;
1397 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1398 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1399 Use the C<SvGROW> wrapper instead.
1405 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1409 if (PL_madskills && newlen >= 0x100000) {
1410 PerlIO_printf(Perl_debug_log,
1411 "Allocation too large: %"UVxf"\n", (UV)newlen);
1413 #ifdef HAS_64K_LIMIT
1414 if (newlen >= 0x10000) {
1415 PerlIO_printf(Perl_debug_log,
1416 "Allocation too large: %"UVxf"\n", (UV)newlen);
1419 #endif /* HAS_64K_LIMIT */
1422 if (SvTYPE(sv) < SVt_PV) {
1423 sv_upgrade(sv, SVt_PV);
1424 s = SvPVX_mutable(sv);
1426 else if (SvOOK(sv)) { /* pv is offset? */
1428 s = SvPVX_mutable(sv);
1429 if (newlen > SvLEN(sv))
1430 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1431 #ifdef HAS_64K_LIMIT
1432 if (newlen >= 0x10000)
1437 s = SvPVX_mutable(sv);
1439 if (newlen > SvLEN(sv)) { /* need more room? */
1440 newlen = PERL_STRLEN_ROUNDUP(newlen);
1441 if (SvLEN(sv) && s) {
1443 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1449 s = saferealloc(s, newlen);
1452 s = safemalloc(newlen);
1453 if (SvPVX_const(sv) && SvCUR(sv)) {
1454 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1458 SvLEN_set(sv, newlen);
1464 =for apidoc sv_setiv
1466 Copies an integer into the given SV, upgrading first if necessary.
1467 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1473 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1476 SV_CHECK_THINKFIRST_COW_DROP(sv);
1477 switch (SvTYPE(sv)) {
1479 sv_upgrade(sv, SVt_IV);
1482 sv_upgrade(sv, SVt_PVNV);
1486 sv_upgrade(sv, SVt_PVIV);
1495 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1498 (void)SvIOK_only(sv); /* validate number */
1504 =for apidoc sv_setiv_mg
1506 Like C<sv_setiv>, but also handles 'set' magic.
1512 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1519 =for apidoc sv_setuv
1521 Copies an unsigned integer into the given SV, upgrading first if necessary.
1522 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1528 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1530 /* With these two if statements:
1531 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1534 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1536 If you wish to remove them, please benchmark to see what the effect is
1538 if (u <= (UV)IV_MAX) {
1539 sv_setiv(sv, (IV)u);
1548 =for apidoc sv_setuv_mg
1550 Like C<sv_setuv>, but also handles 'set' magic.
1556 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1565 =for apidoc sv_setnv
1567 Copies a double into the given SV, upgrading first if necessary.
1568 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1574 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1577 SV_CHECK_THINKFIRST_COW_DROP(sv);
1578 switch (SvTYPE(sv)) {
1581 sv_upgrade(sv, SVt_NV);
1586 sv_upgrade(sv, SVt_PVNV);
1595 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1599 (void)SvNOK_only(sv); /* validate number */
1604 =for apidoc sv_setnv_mg
1606 Like C<sv_setnv>, but also handles 'set' magic.
1612 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1618 /* Print an "isn't numeric" warning, using a cleaned-up,
1619 * printable version of the offending string
1623 S_not_a_number(pTHX_ SV *sv)
1631 dsv = sv_2mortal(newSVpvs(""));
1632 pv = sv_uni_display(dsv, sv, 10, 0);
1635 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1636 /* each *s can expand to 4 chars + "...\0",
1637 i.e. need room for 8 chars */
1639 const char *s = SvPVX_const(sv);
1640 const char * const end = s + SvCUR(sv);
1641 for ( ; s < end && d < limit; s++ ) {
1643 if (ch & 128 && !isPRINT_LC(ch)) {
1652 else if (ch == '\r') {
1656 else if (ch == '\f') {
1660 else if (ch == '\\') {
1664 else if (ch == '\0') {
1668 else if (isPRINT_LC(ch))
1685 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1686 "Argument \"%s\" isn't numeric in %s", pv,
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric", pv);
1694 =for apidoc looks_like_number
1696 Test if the content of an SV looks like a number (or is a number).
1697 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1698 non-numeric warning), even if your atof() doesn't grok them.
1704 Perl_looks_like_number(pTHX_ SV *sv)
1706 register const char *sbegin;
1710 sbegin = SvPVX_const(sv);
1713 else if (SvPOKp(sv))
1714 sbegin = SvPV_const(sv, len);
1716 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1717 return grok_number(sbegin, len, NULL);
1721 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1723 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1724 SV *const buffer = sv_newmortal();
1726 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1729 gv_efullname3(buffer, gv, "*");
1730 SvFLAGS(gv) |= wasfake;
1733 /* We know that all GVs stringify to something that is not-a-number,
1734 so no need to test that. */
1735 if (ckWARN(WARN_NUMERIC))
1736 not_a_number(buffer);
1737 /* We just want something true to return, so that S_sv_2iuv_common
1738 can tail call us and return true. */
1741 return SvPV(buffer, *len);
1745 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1746 until proven guilty, assume that things are not that bad... */
1751 As 64 bit platforms often have an NV that doesn't preserve all bits of
1752 an IV (an assumption perl has been based on to date) it becomes necessary
1753 to remove the assumption that the NV always carries enough precision to
1754 recreate the IV whenever needed, and that the NV is the canonical form.
1755 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1756 precision as a side effect of conversion (which would lead to insanity
1757 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1758 1) to distinguish between IV/UV/NV slots that have cached a valid
1759 conversion where precision was lost and IV/UV/NV slots that have a
1760 valid conversion which has lost no precision
1761 2) to ensure that if a numeric conversion to one form is requested that
1762 would lose precision, the precise conversion (or differently
1763 imprecise conversion) is also performed and cached, to prevent
1764 requests for different numeric formats on the same SV causing
1765 lossy conversion chains. (lossless conversion chains are perfectly
1770 SvIOKp is true if the IV slot contains a valid value
1771 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1772 SvNOKp is true if the NV slot contains a valid value
1773 SvNOK is true only if the NV value is accurate
1776 while converting from PV to NV, check to see if converting that NV to an
1777 IV(or UV) would lose accuracy over a direct conversion from PV to
1778 IV(or UV). If it would, cache both conversions, return NV, but mark
1779 SV as IOK NOKp (ie not NOK).
1781 While converting from PV to IV, check to see if converting that IV to an
1782 NV would lose accuracy over a direct conversion from PV to NV. If it
1783 would, cache both conversions, flag similarly.
1785 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1786 correctly because if IV & NV were set NV *always* overruled.
1787 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1788 changes - now IV and NV together means that the two are interchangeable:
1789 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1791 The benefit of this is that operations such as pp_add know that if
1792 SvIOK is true for both left and right operands, then integer addition
1793 can be used instead of floating point (for cases where the result won't
1794 overflow). Before, floating point was always used, which could lead to
1795 loss of precision compared with integer addition.
1797 * making IV and NV equal status should make maths accurate on 64 bit
1799 * may speed up maths somewhat if pp_add and friends start to use
1800 integers when possible instead of fp. (Hopefully the overhead in
1801 looking for SvIOK and checking for overflow will not outweigh the
1802 fp to integer speedup)
1803 * will slow down integer operations (callers of SvIV) on "inaccurate"
1804 values, as the change from SvIOK to SvIOKp will cause a call into
1805 sv_2iv each time rather than a macro access direct to the IV slot
1806 * should speed up number->string conversion on integers as IV is
1807 favoured when IV and NV are equally accurate
1809 ####################################################################
1810 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1811 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1812 On the other hand, SvUOK is true iff UV.
1813 ####################################################################
1815 Your mileage will vary depending your CPU's relative fp to integer
1819 #ifndef NV_PRESERVES_UV
1820 # define IS_NUMBER_UNDERFLOW_IV 1
1821 # define IS_NUMBER_UNDERFLOW_UV 2
1822 # define IS_NUMBER_IV_AND_UV 2
1823 # define IS_NUMBER_OVERFLOW_IV 4
1824 # define IS_NUMBER_OVERFLOW_UV 5
1826 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1828 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1830 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1833 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));
1834 if (SvNVX(sv) < (NV)IV_MIN) {
1835 (void)SvIOKp_on(sv);
1837 SvIV_set(sv, IV_MIN);
1838 return IS_NUMBER_UNDERFLOW_IV;
1840 if (SvNVX(sv) > (NV)UV_MAX) {
1841 (void)SvIOKp_on(sv);
1844 SvUV_set(sv, UV_MAX);
1845 return IS_NUMBER_OVERFLOW_UV;
1847 (void)SvIOKp_on(sv);
1849 /* Can't use strtol etc to convert this string. (See truth table in
1851 if (SvNVX(sv) <= (UV)IV_MAX) {
1852 SvIV_set(sv, I_V(SvNVX(sv)));
1853 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1854 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1856 /* Integer is imprecise. NOK, IOKp */
1858 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1861 SvUV_set(sv, U_V(SvNVX(sv)));
1862 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1863 if (SvUVX(sv) == UV_MAX) {
1864 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1865 possibly be preserved by NV. Hence, it must be overflow.
1867 return IS_NUMBER_OVERFLOW_UV;
1869 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1871 /* Integer is imprecise. NOK, IOKp */
1873 return IS_NUMBER_OVERFLOW_IV;
1875 #endif /* !NV_PRESERVES_UV*/
1878 S_sv_2iuv_common(pTHX_ SV *sv) {
1881 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1882 * without also getting a cached IV/UV from it at the same time
1883 * (ie PV->NV conversion should detect loss of accuracy and cache
1884 * IV or UV at same time to avoid this. */
1885 /* IV-over-UV optimisation - choose to cache IV if possible */
1887 if (SvTYPE(sv) == SVt_NV)
1888 sv_upgrade(sv, SVt_PVNV);
1890 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1891 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1892 certainly cast into the IV range at IV_MAX, whereas the correct
1893 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1895 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1896 if (Perl_isnan(SvNVX(sv))) {
1902 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1903 SvIV_set(sv, I_V(SvNVX(sv)));
1904 if (SvNVX(sv) == (NV) SvIVX(sv)
1905 #ifndef NV_PRESERVES_UV
1906 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1907 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1908 /* Don't flag it as "accurately an integer" if the number
1909 came from a (by definition imprecise) NV operation, and
1910 we're outside the range of NV integer precision */
1913 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1914 DEBUG_c(PerlIO_printf(Perl_debug_log,
1915 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1921 /* IV not precise. No need to convert from PV, as NV
1922 conversion would already have cached IV if it detected
1923 that PV->IV would be better than PV->NV->IV
1924 flags already correct - don't set public IOK. */
1925 DEBUG_c(PerlIO_printf(Perl_debug_log,
1926 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1931 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1932 but the cast (NV)IV_MIN rounds to a the value less (more
1933 negative) than IV_MIN which happens to be equal to SvNVX ??
1934 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1935 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1936 (NV)UVX == NVX are both true, but the values differ. :-(
1937 Hopefully for 2s complement IV_MIN is something like
1938 0x8000000000000000 which will be exact. NWC */
1941 SvUV_set(sv, U_V(SvNVX(sv)));
1943 (SvNVX(sv) == (NV) SvUVX(sv))
1944 #ifndef NV_PRESERVES_UV
1945 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1946 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1947 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1948 /* Don't flag it as "accurately an integer" if the number
1949 came from a (by definition imprecise) NV operation, and
1950 we're outside the range of NV integer precision */
1955 DEBUG_c(PerlIO_printf(Perl_debug_log,
1956 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1962 else if (SvPOKp(sv) && SvLEN(sv)) {
1964 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1965 /* We want to avoid a possible problem when we cache an IV/ a UV which
1966 may be later translated to an NV, and the resulting NV is not
1967 the same as the direct translation of the initial string
1968 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1969 be careful to ensure that the value with the .456 is around if the
1970 NV value is requested in the future).
1972 This means that if we cache such an IV/a UV, we need to cache the
1973 NV as well. Moreover, we trade speed for space, and do not
1974 cache the NV if we are sure it's not needed.
1977 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1978 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1979 == IS_NUMBER_IN_UV) {
1980 /* It's definitely an integer, only upgrade to PVIV */
1981 if (SvTYPE(sv) < SVt_PVIV)
1982 sv_upgrade(sv, SVt_PVIV);
1984 } else if (SvTYPE(sv) < SVt_PVNV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 /* If NVs preserve UVs then we only use the UV value if we know that
1988 we aren't going to call atof() below. If NVs don't preserve UVs
1989 then the value returned may have more precision than atof() will
1990 return, even though value isn't perfectly accurate. */
1991 if ((numtype & (IS_NUMBER_IN_UV
1992 #ifdef NV_PRESERVES_UV
1995 )) == IS_NUMBER_IN_UV) {
1996 /* This won't turn off the public IOK flag if it was set above */
1997 (void)SvIOKp_on(sv);
1999 if (!(numtype & IS_NUMBER_NEG)) {
2001 if (value <= (UV)IV_MAX) {
2002 SvIV_set(sv, (IV)value);
2004 /* it didn't overflow, and it was positive. */
2005 SvUV_set(sv, value);
2009 /* 2s complement assumption */
2010 if (value <= (UV)IV_MIN) {
2011 SvIV_set(sv, -(IV)value);
2013 /* Too negative for an IV. This is a double upgrade, but
2014 I'm assuming it will be rare. */
2015 if (SvTYPE(sv) < SVt_PVNV)
2016 sv_upgrade(sv, SVt_PVNV);
2020 SvNV_set(sv, -(NV)value);
2021 SvIV_set(sv, IV_MIN);
2025 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2026 will be in the previous block to set the IV slot, and the next
2027 block to set the NV slot. So no else here. */
2029 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2030 != IS_NUMBER_IN_UV) {
2031 /* It wasn't an (integer that doesn't overflow the UV). */
2032 SvNV_set(sv, Atof(SvPVX_const(sv)));
2034 if (! numtype && ckWARN(WARN_NUMERIC))
2037 #if defined(USE_LONG_DOUBLE)
2038 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2039 PTR2UV(sv), SvNVX(sv)));
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2045 #ifdef NV_PRESERVES_UV
2046 (void)SvIOKp_on(sv);
2048 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2049 SvIV_set(sv, I_V(SvNVX(sv)));
2050 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2053 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2055 /* UV will not work better than IV */
2057 if (SvNVX(sv) > (NV)UV_MAX) {
2059 /* Integer is inaccurate. NOK, IOKp, is UV */
2060 SvUV_set(sv, UV_MAX);
2062 SvUV_set(sv, U_V(SvNVX(sv)));
2063 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2064 NV preservse UV so can do correct comparison. */
2065 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2068 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2073 #else /* NV_PRESERVES_UV */
2074 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2075 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2076 /* The IV/UV slot will have been set from value returned by
2077 grok_number above. The NV slot has just been set using
2080 assert (SvIOKp(sv));
2082 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2083 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2084 /* Small enough to preserve all bits. */
2085 (void)SvIOKp_on(sv);
2087 SvIV_set(sv, I_V(SvNVX(sv)));
2088 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2090 /* Assumption: first non-preserved integer is < IV_MAX,
2091 this NV is in the preserved range, therefore: */
2092 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2094 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);
2098 0 0 already failed to read UV.
2099 0 1 already failed to read UV.
2100 1 0 you won't get here in this case. IV/UV
2101 slot set, public IOK, Atof() unneeded.
2102 1 1 already read UV.
2103 so there's no point in sv_2iuv_non_preserve() attempting
2104 to use atol, strtol, strtoul etc. */
2105 sv_2iuv_non_preserve (sv, numtype);
2108 #endif /* NV_PRESERVES_UV */
2112 if (isGV_with_GP(sv)) {
2113 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2116 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2117 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2120 if (SvTYPE(sv) < SVt_IV)
2121 /* Typically the caller expects that sv_any is not NULL now. */
2122 sv_upgrade(sv, SVt_IV);
2123 /* Return 0 from the caller. */
2130 =for apidoc sv_2iv_flags
2132 Return the integer value of an SV, doing any necessary string
2133 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2134 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2140 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2145 if (SvGMAGICAL(sv)) {
2146 if (flags & SV_GMAGIC)
2151 return I_V(SvNVX(sv));
2153 if (SvPOKp(sv) && SvLEN(sv)) {
2156 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2158 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2159 == IS_NUMBER_IN_UV) {
2160 /* It's definitely an integer */
2161 if (numtype & IS_NUMBER_NEG) {
2162 if (value < (UV)IV_MIN)
2165 if (value < (UV)IV_MAX)
2170 if (ckWARN(WARN_NUMERIC))
2173 return I_V(Atof(SvPVX_const(sv)));
2178 assert(SvTYPE(sv) >= SVt_PVMG);
2179 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2180 } else if (SvTHINKFIRST(sv)) {
2184 SV * const tmpstr=AMG_CALLun(sv,numer);
2185 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2186 return SvIV(tmpstr);
2189 return PTR2IV(SvRV(sv));
2192 sv_force_normal_flags(sv, 0);
2194 if (SvREADONLY(sv) && !SvOK(sv)) {
2195 if (ckWARN(WARN_UNINITIALIZED))
2201 if (S_sv_2iuv_common(aTHX_ sv))
2204 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2205 PTR2UV(sv),SvIVX(sv)));
2206 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2210 =for apidoc sv_2uv_flags
2212 Return the unsigned integer value of an SV, doing any necessary string
2213 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2214 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2220 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2225 if (SvGMAGICAL(sv)) {
2226 if (flags & SV_GMAGIC)
2231 return U_V(SvNVX(sv));
2232 if (SvPOKp(sv) && SvLEN(sv)) {
2235 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2237 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2238 == IS_NUMBER_IN_UV) {
2239 /* It's definitely an integer */
2240 if (!(numtype & IS_NUMBER_NEG))
2244 if (ckWARN(WARN_NUMERIC))
2247 return U_V(Atof(SvPVX_const(sv)));
2252 assert(SvTYPE(sv) >= SVt_PVMG);
2253 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2254 } else if (SvTHINKFIRST(sv)) {
2258 SV *const tmpstr = AMG_CALLun(sv,numer);
2259 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2260 return SvUV(tmpstr);
2263 return PTR2UV(SvRV(sv));
2266 sv_force_normal_flags(sv, 0);
2268 if (SvREADONLY(sv) && !SvOK(sv)) {
2269 if (ckWARN(WARN_UNINITIALIZED))
2275 if (S_sv_2iuv_common(aTHX_ sv))
2279 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2280 PTR2UV(sv),SvUVX(sv)));
2281 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2287 Return the num value of an SV, doing any necessary string or integer
2288 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2295 Perl_sv_2nv(pTHX_ register SV *sv)
2300 if (SvGMAGICAL(sv)) {
2304 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2305 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2306 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2308 return Atof(SvPVX_const(sv));
2312 return (NV)SvUVX(sv);
2314 return (NV)SvIVX(sv);
2319 assert(SvTYPE(sv) >= SVt_PVMG);
2320 /* This falls through to the report_uninit near the end of the
2322 } else if (SvTHINKFIRST(sv)) {
2326 SV *const tmpstr = AMG_CALLun(sv,numer);
2327 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2328 return SvNV(tmpstr);
2331 return PTR2NV(SvRV(sv));
2334 sv_force_normal_flags(sv, 0);
2336 if (SvREADONLY(sv) && !SvOK(sv)) {
2337 if (ckWARN(WARN_UNINITIALIZED))
2342 if (SvTYPE(sv) < SVt_NV) {
2343 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2344 sv_upgrade(sv, SVt_NV);
2345 #ifdef USE_LONG_DOUBLE
2347 STORE_NUMERIC_LOCAL_SET_STANDARD();
2348 PerlIO_printf(Perl_debug_log,
2349 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2350 PTR2UV(sv), SvNVX(sv));
2351 RESTORE_NUMERIC_LOCAL();
2355 STORE_NUMERIC_LOCAL_SET_STANDARD();
2356 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2357 PTR2UV(sv), SvNVX(sv));
2358 RESTORE_NUMERIC_LOCAL();
2362 else if (SvTYPE(sv) < SVt_PVNV)
2363 sv_upgrade(sv, SVt_PVNV);
2368 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2369 #ifdef NV_PRESERVES_UV
2372 /* Only set the public NV OK flag if this NV preserves the IV */
2373 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2374 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2375 : (SvIVX(sv) == I_V(SvNVX(sv))))
2381 else if (SvPOKp(sv) && SvLEN(sv)) {
2383 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2384 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2386 #ifdef NV_PRESERVES_UV
2387 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2388 == IS_NUMBER_IN_UV) {
2389 /* It's definitely an integer */
2390 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2392 SvNV_set(sv, Atof(SvPVX_const(sv)));
2395 SvNV_set(sv, Atof(SvPVX_const(sv)));
2396 /* Only set the public NV OK flag if this NV preserves the value in
2397 the PV at least as well as an IV/UV would.
2398 Not sure how to do this 100% reliably. */
2399 /* if that shift count is out of range then Configure's test is
2400 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2402 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2403 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2404 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2405 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2406 /* Can't use strtol etc to convert this string, so don't try.
2407 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2410 /* value has been set. It may not be precise. */
2411 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2412 /* 2s complement assumption for (UV)IV_MIN */
2413 SvNOK_on(sv); /* Integer is too negative. */
2418 if (numtype & IS_NUMBER_NEG) {
2419 SvIV_set(sv, -(IV)value);
2420 } else if (value <= (UV)IV_MAX) {
2421 SvIV_set(sv, (IV)value);
2423 SvUV_set(sv, value);
2427 if (numtype & IS_NUMBER_NOT_INT) {
2428 /* I believe that even if the original PV had decimals,
2429 they are lost beyond the limit of the FP precision.
2430 However, neither is canonical, so both only get p
2431 flags. NWC, 2000/11/25 */
2432 /* Both already have p flags, so do nothing */
2434 const NV nv = SvNVX(sv);
2435 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2436 if (SvIVX(sv) == I_V(nv)) {
2439 /* It had no "." so it must be integer. */
2443 /* between IV_MAX and NV(UV_MAX).
2444 Could be slightly > UV_MAX */
2446 if (numtype & IS_NUMBER_NOT_INT) {
2447 /* UV and NV both imprecise. */
2449 const UV nv_as_uv = U_V(nv);
2451 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2460 #endif /* NV_PRESERVES_UV */
2463 if (isGV_with_GP(sv)) {
2464 glob_2inpuv((GV *)sv, NULL, TRUE);
2468 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2470 assert (SvTYPE(sv) >= SVt_NV);
2471 /* Typically the caller expects that sv_any is not NULL now. */
2472 /* XXX Ilya implies that this is a bug in callers that assume this
2473 and ideally should be fixed. */
2476 #if defined(USE_LONG_DOUBLE)
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2480 PTR2UV(sv), SvNVX(sv));
2481 RESTORE_NUMERIC_LOCAL();
2485 STORE_NUMERIC_LOCAL_SET_STANDARD();
2486 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2487 PTR2UV(sv), SvNVX(sv));
2488 RESTORE_NUMERIC_LOCAL();
2494 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2495 * UV as a string towards the end of buf, and return pointers to start and
2498 * We assume that buf is at least TYPE_CHARS(UV) long.
2502 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2504 char *ptr = buf + TYPE_CHARS(UV);
2505 char * const ebuf = ptr;
2518 *--ptr = '0' + (char)(uv % 10);
2526 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2527 * a regexp to its stringified form.
2531 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2533 const regexp * const re = (regexp *)mg->mg_obj;
2536 const char *fptr = "msix";
2541 bool need_newline = 0;
2542 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2544 while((ch = *fptr++)) {
2546 reflags[left++] = ch;
2549 reflags[right--] = ch;
2554 reflags[left] = '-';
2558 mg->mg_len = re->prelen + 4 + left;
2560 * If /x was used, we have to worry about a regex ending with a
2561 * comment later being embedded within another regex. If so, we don't
2562 * want this regex's "commentization" to leak out to the right part of
2563 * the enclosing regex, we must cap it with a newline.
2565 * So, if /x was used, we scan backwards from the end of the regex. If
2566 * we find a '#' before we find a newline, we need to add a newline
2567 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2568 * we don't need to add anything. -jfriedl
2570 if (PMf_EXTENDED & re->reganch) {
2571 const char *endptr = re->precomp + re->prelen;
2572 while (endptr >= re->precomp) {
2573 const char c = *(endptr--);
2575 break; /* don't need another */
2577 /* we end while in a comment, so we need a newline */
2578 mg->mg_len++; /* save space for it */
2579 need_newline = 1; /* note to add it */
2585 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2586 mg->mg_ptr[0] = '(';
2587 mg->mg_ptr[1] = '?';
2588 Copy(reflags, mg->mg_ptr+2, left, char);
2589 *(mg->mg_ptr+left+2) = ':';
2590 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2592 mg->mg_ptr[mg->mg_len - 2] = '\n';
2593 mg->mg_ptr[mg->mg_len - 1] = ')';
2594 mg->mg_ptr[mg->mg_len] = 0;
2596 PL_reginterp_cnt += re->program[0].next_off;
2598 if (re->reganch & ROPT_UTF8)
2608 =for apidoc sv_2pv_flags
2610 Returns a pointer to the string value of an SV, and sets *lp to its length.
2611 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2613 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2614 usually end up here too.
2620 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2630 if (SvGMAGICAL(sv)) {
2631 if (flags & SV_GMAGIC)
2636 if (flags & SV_MUTABLE_RETURN)
2637 return SvPVX_mutable(sv);
2638 if (flags & SV_CONST_RETURN)
2639 return (char *)SvPVX_const(sv);
2642 if (SvIOKp(sv) || SvNOKp(sv)) {
2643 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2647 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2648 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2650 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2657 #ifdef FIXNEGATIVEZERO
2658 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2664 SvUPGRADE(sv, SVt_PV);
2667 s = SvGROW_mutable(sv, len + 1);
2670 return memcpy(s, tbuf, len + 1);
2676 assert(SvTYPE(sv) >= SVt_PVMG);
2677 /* This falls through to the report_uninit near the end of the
2679 } else if (SvTHINKFIRST(sv)) {
2683 SV *const tmpstr = AMG_CALLun(sv,string);
2684 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2686 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2690 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2691 if (flags & SV_CONST_RETURN) {
2692 pv = (char *) SvPVX_const(tmpstr);
2694 pv = (flags & SV_MUTABLE_RETURN)
2695 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2698 *lp = SvCUR(tmpstr);
2700 pv = sv_2pv_flags(tmpstr, lp, flags);
2712 const SV *const referent = (SV*)SvRV(sv);
2715 tsv = sv_2mortal(newSVpvs("NULLREF"));
2716 } else if (SvTYPE(referent) == SVt_PVMG
2717 && ((SvFLAGS(referent) &
2718 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2719 == (SVs_OBJECT|SVs_SMG))
2720 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2721 return stringify_regexp(sv, mg, lp);
2723 const char *const typestr = sv_reftype(referent, 0);
2725 tsv = sv_newmortal();
2726 if (SvOBJECT(referent)) {
2727 const char *const name = HvNAME_get(SvSTASH(referent));
2728 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2729 name ? name : "__ANON__" , typestr,
2733 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2741 if (SvREADONLY(sv) && !SvOK(sv)) {
2742 if (ckWARN(WARN_UNINITIALIZED))
2749 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2750 /* I'm assuming that if both IV and NV are equally valid then
2751 converting the IV is going to be more efficient */
2752 const U32 isIOK = SvIOK(sv);
2753 const U32 isUIOK = SvIsUV(sv);
2754 char buf[TYPE_CHARS(UV)];
2757 if (SvTYPE(sv) < SVt_PVIV)
2758 sv_upgrade(sv, SVt_PVIV);
2759 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2760 /* inlined from sv_setpvn */
2761 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2762 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2763 SvCUR_set(sv, ebuf - ptr);
2773 else if (SvNOKp(sv)) {
2774 const int olderrno = errno;
2775 if (SvTYPE(sv) < SVt_PVNV)
2776 sv_upgrade(sv, SVt_PVNV);
2777 /* The +20 is pure guesswork. Configure test needed. --jhi */
2778 s = SvGROW_mutable(sv, NV_DIG + 20);
2779 /* some Xenix systems wipe out errno here */
2781 if (SvNVX(sv) == 0.0)
2782 (void)strcpy(s,"0");
2786 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2789 #ifdef FIXNEGATIVEZERO
2790 if (*s == '-' && s[1] == '0' && !s[2])
2800 if (isGV_with_GP(sv)) {
2801 return glob_2inpuv((GV *)sv, lp, FALSE);
2804 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2808 if (SvTYPE(sv) < SVt_PV)
2809 /* Typically the caller expects that sv_any is not NULL now. */
2810 sv_upgrade(sv, SVt_PV);
2814 const STRLEN len = s - SvPVX_const(sv);
2820 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2821 PTR2UV(sv),SvPVX_const(sv)));
2822 if (flags & SV_CONST_RETURN)
2823 return (char *)SvPVX_const(sv);
2824 if (flags & SV_MUTABLE_RETURN)
2825 return SvPVX_mutable(sv);
2830 =for apidoc sv_copypv
2832 Copies a stringified representation of the source SV into the
2833 destination SV. Automatically performs any necessary mg_get and
2834 coercion of numeric values into strings. Guaranteed to preserve
2835 UTF-8 flag even from overloaded objects. Similar in nature to
2836 sv_2pv[_flags] but operates directly on an SV instead of just the
2837 string. Mostly uses sv_2pv_flags to do its work, except when that
2838 would lose the UTF-8'ness of the PV.
2844 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2847 const char * const s = SvPV_const(ssv,len);
2848 sv_setpvn(dsv,s,len);
2856 =for apidoc sv_2pvbyte
2858 Return a pointer to the byte-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be downgraded from UTF-8 as a
2862 Usually accessed via the C<SvPVbyte> macro.
2868 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2870 sv_utf8_downgrade(sv,0);
2871 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2pvutf8
2877 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2878 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2880 Usually accessed via the C<SvPVutf8> macro.
2886 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2888 sv_utf8_upgrade(sv);
2889 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2894 =for apidoc sv_2bool
2896 This function is only called on magical items, and is only used by
2897 sv_true() or its macro equivalent.
2903 Perl_sv_2bool(pTHX_ register SV *sv)
2912 SV * const tmpsv = AMG_CALLun(sv,bool_);
2913 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2914 return (bool)SvTRUE(tmpsv);
2916 return SvRV(sv) != 0;
2919 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2921 (*sv->sv_u.svu_pv > '0' ||
2922 Xpvtmp->xpv_cur > 1 ||
2923 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2930 return SvIVX(sv) != 0;
2933 return SvNVX(sv) != 0.0;
2935 if (isGV_with_GP(sv))
2945 =for apidoc sv_utf8_upgrade
2947 Converts the PV of an SV to its UTF-8-encoded form.
2948 Forces the SV to string form if it is not already.
2949 Always sets the SvUTF8 flag to avoid future validity checks even
2950 if all the bytes have hibit clear.
2952 This is not as a general purpose byte encoding to Unicode interface:
2953 use the Encode extension for that.
2955 =for apidoc sv_utf8_upgrade_flags
2957 Converts the PV of an SV to its UTF-8-encoded form.
2958 Forces the SV to string form if it is not already.
2959 Always sets the SvUTF8 flag to avoid future validity checks even
2960 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2961 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2962 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2964 This is not as a general purpose byte encoding to Unicode interface:
2965 use the Encode extension for that.
2971 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2974 if (sv == &PL_sv_undef)
2978 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2979 (void) sv_2pv_flags(sv,&len, flags);
2983 (void) SvPV_force(sv,len);
2992 sv_force_normal_flags(sv, 0);
2995 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2996 sv_recode_to_utf8(sv, PL_encoding);
2997 else { /* Assume Latin-1/EBCDIC */
2998 /* This function could be much more efficient if we
2999 * had a FLAG in SVs to signal if there are any hibit
3000 * chars in the PV. Given that there isn't such a flag
3001 * make the loop as fast as possible. */
3002 const U8 * const s = (U8 *) SvPVX_const(sv);
3003 const U8 * const e = (U8 *) SvEND(sv);
3008 /* Check for hi bit */
3009 if (!NATIVE_IS_INVARIANT(ch)) {
3010 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3011 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3013 SvPV_free(sv); /* No longer using what was there before. */
3014 SvPV_set(sv, (char*)recoded);
3015 SvCUR_set(sv, len - 1);
3016 SvLEN_set(sv, len); /* No longer know the real size. */
3020 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3027 =for apidoc sv_utf8_downgrade
3029 Attempts to convert the PV of an SV from characters to bytes.
3030 If the PV contains a character beyond byte, this conversion will fail;
3031 in this case, either returns false or, if C<fail_ok> is not
3034 This is not as a general purpose Unicode to byte encoding interface:
3035 use the Encode extension for that.
3041 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3044 if (SvPOKp(sv) && SvUTF8(sv)) {
3050 sv_force_normal_flags(sv, 0);
3052 s = (U8 *) SvPV(sv, len);
3053 if (!utf8_to_bytes(s, &len)) {
3058 Perl_croak(aTHX_ "Wide character in %s",
3061 Perl_croak(aTHX_ "Wide character");
3072 =for apidoc sv_utf8_encode
3074 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3075 flag off so that it looks like octets again.
3081 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3083 (void) sv_utf8_upgrade(sv);
3085 sv_force_normal_flags(sv, 0);
3087 if (SvREADONLY(sv)) {
3088 Perl_croak(aTHX_ PL_no_modify);
3094 =for apidoc sv_utf8_decode
3096 If the PV of the SV is an octet sequence in UTF-8
3097 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3098 so that it looks like a character. If the PV contains only single-byte
3099 characters, the C<SvUTF8> flag stays being off.
3100 Scans PV for validity and returns false if the PV is invalid UTF-8.
3106 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3112 /* The octets may have got themselves encoded - get them back as
3115 if (!sv_utf8_downgrade(sv, TRUE))
3118 /* it is actually just a matter of turning the utf8 flag on, but
3119 * we want to make sure everything inside is valid utf8 first.
3121 c = (const U8 *) SvPVX_const(sv);
3122 if (!is_utf8_string(c, SvCUR(sv)+1))
3124 e = (const U8 *) SvEND(sv);
3127 if (!UTF8_IS_INVARIANT(ch)) {
3137 =for apidoc sv_setsv
3139 Copies the contents of the source SV C<ssv> into the destination SV
3140 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3141 function if the source SV needs to be reused. Does not handle 'set' magic.
3142 Loosely speaking, it performs a copy-by-value, obliterating any previous
3143 content of the destination.
3145 You probably want to use one of the assortment of wrappers, such as
3146 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3147 C<SvSetMagicSV_nosteal>.
3149 =for apidoc sv_setsv_flags
3151 Copies the contents of the source SV C<ssv> into the destination SV
3152 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3153 function if the source SV needs to be reused. Does not handle 'set' magic.
3154 Loosely speaking, it performs a copy-by-value, obliterating any previous
3155 content of the destination.
3156 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3157 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3158 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3159 and C<sv_setsv_nomg> are implemented in terms of this function.
3161 You probably want to use one of the assortment of wrappers, such as
3162 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3163 C<SvSetMagicSV_nosteal>.
3165 This is the primary function for copying scalars, and most other
3166 copy-ish functions and macros use this underneath.
3172 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3174 if (dtype != SVt_PVGV) {
3175 const char * const name = GvNAME(sstr);
3176 const STRLEN len = GvNAMELEN(sstr);
3177 /* don't upgrade SVt_PVLV: it can hold a glob */
3178 if (dtype != SVt_PVLV) {
3179 if (dtype >= SVt_PV) {
3185 sv_upgrade(dstr, SVt_PVGV);
3186 (void)SvOK_off(dstr);
3189 GvSTASH(dstr) = GvSTASH(sstr);
3191 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3192 gv_name_set((GV *)dstr, name, len, GV_ADD);
3193 SvFAKE_on(dstr); /* can coerce to non-glob */
3196 #ifdef GV_UNIQUE_CHECK
3197 if (GvUNIQUE((GV*)dstr)) {
3198 Perl_croak(aTHX_ PL_no_modify);
3204 (void)SvOK_off(dstr);
3206 GvINTRO_off(dstr); /* one-shot flag */
3207 GvGP(dstr) = gp_ref(GvGP(sstr));
3208 if (SvTAINTED(sstr))
3210 if (GvIMPORTED(dstr) != GVf_IMPORTED
3211 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3213 GvIMPORTED_on(dstr);
3220 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3221 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3223 const int intro = GvINTRO(dstr);
3226 const U32 stype = SvTYPE(sref);
3229 #ifdef GV_UNIQUE_CHECK
3230 if (GvUNIQUE((GV*)dstr)) {
3231 Perl_croak(aTHX_ PL_no_modify);
3236 GvINTRO_off(dstr); /* one-shot flag */
3237 GvLINE(dstr) = CopLINE(PL_curcop);
3238 GvEGV(dstr) = (GV*)dstr;
3243 location = (SV **) &GvCV(dstr);
3244 import_flag = GVf_IMPORTED_CV;
3247 location = (SV **) &GvHV(dstr);
3248 import_flag = GVf_IMPORTED_HV;
3251 location = (SV **) &GvAV(dstr);
3252 import_flag = GVf_IMPORTED_AV;
3255 location = (SV **) &GvIOp(dstr);
3258 location = (SV **) &GvFORM(dstr);
3260 location = &GvSV(dstr);
3261 import_flag = GVf_IMPORTED_SV;
3264 if (stype == SVt_PVCV) {
3265 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3266 SvREFCNT_dec(GvCV(dstr));
3268 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3269 PL_sub_generation++;
3272 SAVEGENERICSV(*location);
3276 if (stype == SVt_PVCV && *location != sref) {
3277 CV* const cv = (CV*)*location;
3279 if (!GvCVGEN((GV*)dstr) &&
3280 (CvROOT(cv) || CvXSUB(cv)))
3282 /* Redefining a sub - warning is mandatory if
3283 it was a const and its value changed. */
3284 if (CvCONST(cv) && CvCONST((CV*)sref)
3285 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3287 /* They are 2 constant subroutines generated from
3288 the same constant. This probably means that
3289 they are really the "same" proxy subroutine
3290 instantiated in 2 places. Most likely this is
3291 when a constant is exported twice. Don't warn.
3294 else if (ckWARN(WARN_REDEFINE)
3296 && (!CvCONST((CV*)sref)
3297 || sv_cmp(cv_const_sv(cv),
3298 cv_const_sv((CV*)sref))))) {
3299 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3301 ? "Constant subroutine %s::%s redefined"
3302 : "Subroutine %s::%s redefined",
3303 HvNAME_get(GvSTASH((GV*)dstr)),
3304 GvENAME((GV*)dstr));
3308 cv_ckproto(cv, (GV*)dstr,
3309 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3311 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3312 GvASSUMECV_on(dstr);
3313 PL_sub_generation++;
3316 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3317 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3318 GvFLAGS(dstr) |= import_flag;
3323 if (SvTAINTED(sstr))
3329 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3332 register U32 sflags;
3338 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3340 sstr = &PL_sv_undef;
3341 stype = SvTYPE(sstr);
3342 dtype = SvTYPE(dstr);
3347 /* need to nuke the magic */
3349 SvRMAGICAL_off(dstr);
3352 /* There's a lot of redundancy below but we're going for speed here */
3357 if (dtype != SVt_PVGV) {
3358 (void)SvOK_off(dstr);
3366 sv_upgrade(dstr, SVt_IV);
3371 sv_upgrade(dstr, SVt_PVIV);
3374 (void)SvIOK_only(dstr);
3375 SvIV_set(dstr, SvIVX(sstr));
3378 /* SvTAINTED can only be true if the SV has taint magic, which in
3379 turn means that the SV type is PVMG (or greater). This is the
3380 case statement for SVt_IV, so this cannot be true (whatever gcov
3382 assert(!SvTAINTED(sstr));
3392 sv_upgrade(dstr, SVt_NV);
3397 sv_upgrade(dstr, SVt_PVNV);
3400 SvNV_set(dstr, SvNVX(sstr));
3401 (void)SvNOK_only(dstr);
3402 /* SvTAINTED can only be true if the SV has taint magic, which in
3403 turn means that the SV type is PVMG (or greater). This is the
3404 case statement for SVt_NV, so this cannot be true (whatever gcov
3406 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_RV);
3416 #ifdef PERL_OLD_COPY_ON_WRITE
3417 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3418 if (dtype < SVt_PVIV)
3419 sv_upgrade(dstr, SVt_PVIV);
3426 sv_upgrade(dstr, SVt_PV);
3429 if (dtype < SVt_PVIV)
3430 sv_upgrade(dstr, SVt_PVIV);
3433 if (dtype < SVt_PVNV)
3434 sv_upgrade(dstr, SVt_PVNV);
3438 const char * const type = sv_reftype(sstr,0);
3440 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3442 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3447 if (dtype <= SVt_PVGV) {
3448 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3456 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3458 if ((int)SvTYPE(sstr) != stype) {
3459 stype = SvTYPE(sstr);
3460 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3461 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3466 if (stype == SVt_PVLV)
3467 SvUPGRADE(dstr, SVt_PVNV);
3469 SvUPGRADE(dstr, (U32)stype);
3472 /* dstr may have been upgraded. */
3473 dtype = SvTYPE(dstr);
3474 sflags = SvFLAGS(sstr);
3476 if (sflags & SVf_ROK) {
3477 if (dtype == SVt_PVGV &&
3478 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3481 if (GvIMPORTED(dstr) != GVf_IMPORTED
3482 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3484 GvIMPORTED_on(dstr);
3489 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3493 if (dtype >= SVt_PV) {
3494 if (dtype == SVt_PVGV) {
3495 S_glob_assign_ref(aTHX_ dstr, sstr);
3498 if (SvPVX_const(dstr)) {
3504 (void)SvOK_off(dstr);
3505 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3506 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3507 assert(!(sflags & SVp_NOK));
3508 assert(!(sflags & SVp_IOK));
3509 assert(!(sflags & SVf_NOK));
3510 assert(!(sflags & SVf_IOK));
3512 else if (dtype == SVt_PVGV) {
3513 if (!(sflags & SVf_OK)) {
3514 if (ckWARN(WARN_MISC))
3515 Perl_warner(aTHX_ packWARN(WARN_MISC),
3516 "Undefined value assigned to typeglob");
3519 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3520 if (dstr != (SV*)gv) {
3523 GvGP(dstr) = gp_ref(GvGP(gv));
3527 else if (sflags & SVp_POK) {
3531 * Check to see if we can just swipe the string. If so, it's a
3532 * possible small lose on short strings, but a big win on long ones.
3533 * It might even be a win on short strings if SvPVX_const(dstr)
3534 * has to be allocated and SvPVX_const(sstr) has to be freed.
3537 /* Whichever path we take through the next code, we want this true,
3538 and doing it now facilitates the COW check. */
3539 (void)SvPOK_only(dstr);
3542 /* We're not already COW */
3543 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3544 #ifndef PERL_OLD_COPY_ON_WRITE
3545 /* or we are, but dstr isn't a suitable target. */
3546 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3551 (sflags & SVs_TEMP) && /* slated for free anyway? */
3552 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3553 (!(flags & SV_NOSTEAL)) &&
3554 /* and we're allowed to steal temps */
3555 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3556 SvLEN(sstr) && /* and really is a string */
3557 /* and won't be needed again, potentially */
3558 !(PL_op && PL_op->op_type == OP_AASSIGN))
3559 #ifdef PERL_OLD_COPY_ON_WRITE
3560 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3561 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3562 && SvTYPE(sstr) >= SVt_PVIV)
3565 /* Failed the swipe test, and it's not a shared hash key either.
3566 Have to copy the string. */
3567 STRLEN len = SvCUR(sstr);
3568 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3569 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3570 SvCUR_set(dstr, len);
3571 *SvEND(dstr) = '\0';
3573 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3575 /* Either it's a shared hash key, or it's suitable for
3576 copy-on-write or we can swipe the string. */
3578 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3582 #ifdef PERL_OLD_COPY_ON_WRITE
3584 /* I believe I should acquire a global SV mutex if
3585 it's a COW sv (not a shared hash key) to stop
3586 it going un copy-on-write.
3587 If the source SV has gone un copy on write between up there
3588 and down here, then (assert() that) it is of the correct
3589 form to make it copy on write again */
3590 if ((sflags & (SVf_FAKE | SVf_READONLY))
3591 != (SVf_FAKE | SVf_READONLY)) {
3592 SvREADONLY_on(sstr);
3594 /* Make the source SV into a loop of 1.
3595 (about to become 2) */
3596 SV_COW_NEXT_SV_SET(sstr, sstr);
3600 /* Initial code is common. */
3601 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3606 /* making another shared SV. */
3607 STRLEN cur = SvCUR(sstr);
3608 STRLEN len = SvLEN(sstr);
3609 #ifdef PERL_OLD_COPY_ON_WRITE
3611 assert (SvTYPE(dstr) >= SVt_PVIV);
3612 /* SvIsCOW_normal */
3613 /* splice us in between source and next-after-source. */
3614 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3615 SV_COW_NEXT_SV_SET(sstr, dstr);
3616 SvPV_set(dstr, SvPVX_mutable(sstr));
3620 /* SvIsCOW_shared_hash */
3621 DEBUG_C(PerlIO_printf(Perl_debug_log,
3622 "Copy on write: Sharing hash\n"));
3624 assert (SvTYPE(dstr) >= SVt_PV);
3626 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3628 SvLEN_set(dstr, len);
3629 SvCUR_set(dstr, cur);
3630 SvREADONLY_on(dstr);
3632 /* Relesase a global SV mutex. */
3635 { /* Passes the swipe test. */
3636 SvPV_set(dstr, SvPVX_mutable(sstr));
3637 SvLEN_set(dstr, SvLEN(sstr));
3638 SvCUR_set(dstr, SvCUR(sstr));
3641 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3642 SvPV_set(sstr, NULL);
3648 if (sflags & SVp_NOK) {
3649 SvNV_set(dstr, SvNVX(sstr));
3651 if (sflags & SVp_IOK) {
3652 SvRELEASE_IVX(dstr);
3653 SvIV_set(dstr, SvIVX(sstr));
3654 /* Must do this otherwise some other overloaded use of 0x80000000
3655 gets confused. I guess SVpbm_VALID */
3656 if (sflags & SVf_IVisUV)
3659 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3662 const MAGIC * const smg = SvVOK(sstr);
3664 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3665 smg->mg_ptr, smg->mg_len);
3666 SvRMAGICAL_on(dstr);
3670 else if (sflags & (SVp_IOK|SVp_NOK)) {
3671 (void)SvOK_off(dstr);
3672 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3674 if (sflags & SVp_IOK) {
3675 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3676 SvIV_set(dstr, SvIVX(sstr));
3678 if (sflags & SVp_NOK) {
3679 SvNV_set(dstr, SvNVX(sstr));
3683 if (isGV_with_GP(sstr)) {
3684 /* This stringification rule for globs is spread in 3 places.
3685 This feels bad. FIXME. */
3686 const U32 wasfake = sflags & SVf_FAKE;
3688 /* FAKE globs can get coerced, so need to turn this off
3689 temporarily if it is on. */
3691 gv_efullname3(dstr, (GV *)sstr, "*");
3692 SvFLAGS(sstr) |= wasfake;
3693 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3696 (void)SvOK_off(dstr);
3698 if (SvTAINTED(sstr))
3703 =for apidoc sv_setsv_mg
3705 Like C<sv_setsv>, but also handles 'set' magic.
3711 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3713 sv_setsv(dstr,sstr);
3717 #ifdef PERL_OLD_COPY_ON_WRITE
3719 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3721 STRLEN cur = SvCUR(sstr);
3722 STRLEN len = SvLEN(sstr);
3723 register char *new_pv;
3726 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3734 if (SvTHINKFIRST(dstr))
3735 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3736 else if (SvPVX_const(dstr))
3737 Safefree(SvPVX_const(dstr));
3741 SvUPGRADE(dstr, SVt_PVIV);
3743 assert (SvPOK(sstr));
3744 assert (SvPOKp(sstr));
3745 assert (!SvIOK(sstr));
3746 assert (!SvIOKp(sstr));
3747 assert (!SvNOK(sstr));
3748 assert (!SvNOKp(sstr));
3750 if (SvIsCOW(sstr)) {
3752 if (SvLEN(sstr) == 0) {
3753 /* source is a COW shared hash key. */
3754 DEBUG_C(PerlIO_printf(Perl_debug_log,
3755 "Fast copy on write: Sharing hash\n"));
3756 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3759 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3761 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3762 SvUPGRADE(sstr, SVt_PVIV);
3763 SvREADONLY_on(sstr);
3765 DEBUG_C(PerlIO_printf(Perl_debug_log,
3766 "Fast copy on write: Converting sstr to COW\n"));
3767 SV_COW_NEXT_SV_SET(dstr, sstr);
3769 SV_COW_NEXT_SV_SET(sstr, dstr);
3770 new_pv = SvPVX_mutable(sstr);
3773 SvPV_set(dstr, new_pv);
3774 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3777 SvLEN_set(dstr, len);
3778 SvCUR_set(dstr, cur);
3787 =for apidoc sv_setpvn
3789 Copies a string into an SV. The C<len> parameter indicates the number of
3790 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3791 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3797 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3800 register char *dptr;
3802 SV_CHECK_THINKFIRST_COW_DROP(sv);
3808 /* len is STRLEN which is unsigned, need to copy to signed */
3811 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3813 SvUPGRADE(sv, SVt_PV);
3815 dptr = SvGROW(sv, len + 1);
3816 Move(ptr,dptr,len,char);
3819 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3824 =for apidoc sv_setpvn_mg
3826 Like C<sv_setpvn>, but also handles 'set' magic.
3832 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3834 sv_setpvn(sv,ptr,len);
3839 =for apidoc sv_setpv
3841 Copies a string into an SV. The string must be null-terminated. Does not
3842 handle 'set' magic. See C<sv_setpv_mg>.
3848 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3851 register STRLEN len;
3853 SV_CHECK_THINKFIRST_COW_DROP(sv);
3859 SvUPGRADE(sv, SVt_PV);
3861 SvGROW(sv, len + 1);
3862 Move(ptr,SvPVX(sv),len+1,char);
3864 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3869 =for apidoc sv_setpv_mg
3871 Like C<sv_setpv>, but also handles 'set' magic.
3877 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3884 =for apidoc sv_usepvn
3886 Tells an SV to use C<ptr> to find its string value. Normally the string is
3887 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3888 The C<ptr> should point to memory that was allocated by C<malloc>. The
3889 string length, C<len>, must be supplied. This function will realloc the
3890 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3891 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3892 See C<sv_usepvn_mg>.
3898 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3902 SV_CHECK_THINKFIRST_COW_DROP(sv);
3903 SvUPGRADE(sv, SVt_PV);
3908 if (SvPVX_const(sv))
3911 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3912 ptr = saferealloc (ptr, allocate);
3915 SvLEN_set(sv, allocate);
3917 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3922 =for apidoc sv_usepvn_mg
3924 Like C<sv_usepvn>, but also handles 'set' magic.
3930 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3932 sv_usepvn(sv,ptr,len);
3936 #ifdef PERL_OLD_COPY_ON_WRITE
3937 /* Need to do this *after* making the SV normal, as we need the buffer
3938 pointer to remain valid until after we've copied it. If we let go too early,
3939 another thread could invalidate it by unsharing last of the same hash key
3940 (which it can do by means other than releasing copy-on-write Svs)
3941 or by changing the other copy-on-write SVs in the loop. */
3943 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3945 if (len) { /* this SV was SvIsCOW_normal(sv) */
3946 /* we need to find the SV pointing to us. */
3947 SV *current = SV_COW_NEXT_SV(after);
3949 if (current == sv) {
3950 /* The SV we point to points back to us (there were only two of us
3952 Hence other SV is no longer copy on write either. */
3954 SvREADONLY_off(after);
3956 /* We need to follow the pointers around the loop. */
3958 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3961 /* don't loop forever if the structure is bust, and we have
3962 a pointer into a closed loop. */
3963 assert (current != after);
3964 assert (SvPVX_const(current) == pvx);
3966 /* Make the SV before us point to the SV after us. */
3967 SV_COW_NEXT_SV_SET(current, after);
3970 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3975 Perl_sv_release_IVX(pTHX_ register SV *sv)
3978 sv_force_normal_flags(sv, 0);
3984 =for apidoc sv_force_normal_flags
3986 Undo various types of fakery on an SV: if the PV is a shared string, make
3987 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3988 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3989 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3990 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3991 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3992 set to some other value.) In addition, the C<flags> parameter gets passed to
3993 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3994 with flags set to 0.
4000 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4003 #ifdef PERL_OLD_COPY_ON_WRITE
4004 if (SvREADONLY(sv)) {
4005 /* At this point I believe I should acquire a global SV mutex. */
4007 const char * const pvx = SvPVX_const(sv);
4008 const STRLEN len = SvLEN(sv);
4009 const STRLEN cur = SvCUR(sv);
4010 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4012 PerlIO_printf(Perl_debug_log,
4013 "Copy on write: Force normal %ld\n",
4019 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4022 if (flags & SV_COW_DROP_PV) {
4023 /* OK, so we don't need to copy our buffer. */
4026 SvGROW(sv, cur + 1);
4027 Move(pvx,SvPVX(sv),cur,char);
4031 sv_release_COW(sv, pvx, len, next);
4036 else if (IN_PERL_RUNTIME)
4037 Perl_croak(aTHX_ PL_no_modify);
4038 /* At this point I believe that I can drop the global SV mutex. */
4041 if (SvREADONLY(sv)) {
4043 const char * const pvx = SvPVX_const(sv);
4044 const STRLEN len = SvCUR(sv);
4049 SvGROW(sv, len + 1);
4050 Move(pvx,SvPVX(sv),len,char);
4052 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4054 else if (IN_PERL_RUNTIME)
4055 Perl_croak(aTHX_ PL_no_modify);
4059 sv_unref_flags(sv, flags);
4060 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4067 Efficient removal of characters from the beginning of the string buffer.
4068 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4069 the string buffer. The C<ptr> becomes the first character of the adjusted
4070 string. Uses the "OOK hack".
4071 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4072 refer to the same chunk of data.
4078 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4080 register STRLEN delta;
4081 if (!ptr || !SvPOKp(sv))
4083 delta = ptr - SvPVX_const(sv);
4084 SV_CHECK_THINKFIRST(sv);
4085 if (SvTYPE(sv) < SVt_PVIV)
4086 sv_upgrade(sv,SVt_PVIV);
4089 if (!SvLEN(sv)) { /* make copy of shared string */
4090 const char *pvx = SvPVX_const(sv);
4091 const STRLEN len = SvCUR(sv);
4092 SvGROW(sv, len + 1);
4093 Move(pvx,SvPVX(sv),len,char);
4097 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4098 and we do that anyway inside the SvNIOK_off
4100 SvFLAGS(sv) |= SVf_OOK;
4103 SvLEN_set(sv, SvLEN(sv) - delta);
4104 SvCUR_set(sv, SvCUR(sv) - delta);
4105 SvPV_set(sv, SvPVX(sv) + delta);
4106 SvIV_set(sv, SvIVX(sv) + delta);
4110 =for apidoc sv_catpvn
4112 Concatenates the string onto the end of the string which is in the SV. The
4113 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4114 status set, then the bytes appended should be valid UTF-8.
4115 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4117 =for apidoc sv_catpvn_flags
4119 Concatenates the string onto the end of the string which is in the SV. The
4120 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4121 status set, then the bytes appended should be valid UTF-8.
4122 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4123 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4124 in terms of this function.
4130 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4134 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4136 SvGROW(dsv, dlen + slen + 1);
4138 sstr = SvPVX_const(dsv);
4139 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4140 SvCUR_set(dsv, SvCUR(dsv) + slen);
4142 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4144 if (flags & SV_SMAGIC)
4149 =for apidoc sv_catsv
4151 Concatenates the string from SV C<ssv> onto the end of the string in
4152 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4153 not 'set' magic. See C<sv_catsv_mg>.
4155 =for apidoc sv_catsv_flags
4157 Concatenates the string from SV C<ssv> onto the end of the string in
4158 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4159 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4160 and C<sv_catsv_nomg> are implemented in terms of this function.
4165 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4170 const char *spv = SvPV_const(ssv, slen);
4172 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4173 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4174 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4175 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4176 dsv->sv_flags doesn't have that bit set.
4177 Andy Dougherty 12 Oct 2001
4179 const I32 sutf8 = DO_UTF8(ssv);
4182 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4184 dutf8 = DO_UTF8(dsv);
4186 if (dutf8 != sutf8) {
4188 /* Not modifying source SV, so taking a temporary copy. */
4189 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4191 sv_utf8_upgrade(csv);
4192 spv = SvPV_const(csv, slen);
4195 sv_utf8_upgrade_nomg(dsv);
4197 sv_catpvn_nomg(dsv, spv, slen);
4200 if (flags & SV_SMAGIC)
4205 =for apidoc sv_catpv
4207 Concatenates the string onto the end of the string which is in the SV.
4208 If the SV has the UTF-8 status set, then the bytes appended should be
4209 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4214 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4217 register STRLEN len;
4223 junk = SvPV_force(sv, tlen);
4225 SvGROW(sv, tlen + len + 1);
4227 ptr = SvPVX_const(sv);
4228 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4229 SvCUR_set(sv, SvCUR(sv) + len);
4230 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4235 =for apidoc sv_catpv_mg
4237 Like C<sv_catpv>, but also handles 'set' magic.
4243 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4252 Creates a new SV. A non-zero C<len> parameter indicates the number of
4253 bytes of preallocated string space the SV should have. An extra byte for a
4254 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4255 space is allocated.) The reference count for the new SV is set to 1.
4257 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4258 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4259 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4260 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4261 modules supporting older perls.
4267 Perl_newSV(pTHX_ STRLEN len)
4274 sv_upgrade(sv, SVt_PV);
4275 SvGROW(sv, len + 1);
4280 =for apidoc sv_magicext
4282 Adds magic to an SV, upgrading it if necessary. Applies the
4283 supplied vtable and returns a pointer to the magic added.
4285 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4286 In particular, you can add magic to SvREADONLY SVs, and add more than
4287 one instance of the same 'how'.
4289 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4290 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4291 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4292 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4294 (This is now used as a subroutine by C<sv_magic>.)
4299 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4300 const char* name, I32 namlen)
4305 if (SvTYPE(sv) < SVt_PVMG) {
4306 SvUPGRADE(sv, SVt_PVMG);
4308 Newxz(mg, 1, MAGIC);
4309 mg->mg_moremagic = SvMAGIC(sv);
4310 SvMAGIC_set(sv, mg);
4312 /* Sometimes a magic contains a reference loop, where the sv and
4313 object refer to each other. To prevent a reference loop that
4314 would prevent such objects being freed, we look for such loops
4315 and if we find one we avoid incrementing the object refcount.
4317 Note we cannot do this to avoid self-tie loops as intervening RV must
4318 have its REFCNT incremented to keep it in existence.
4321 if (!obj || obj == sv ||
4322 how == PERL_MAGIC_arylen ||
4323 how == PERL_MAGIC_qr ||
4324 how == PERL_MAGIC_symtab ||
4325 (SvTYPE(obj) == SVt_PVGV &&
4326 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4327 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4328 GvFORM(obj) == (CV*)sv)))
4333 mg->mg_obj = SvREFCNT_inc_simple(obj);
4334 mg->mg_flags |= MGf_REFCOUNTED;
4337 /* Normal self-ties simply pass a null object, and instead of
4338 using mg_obj directly, use the SvTIED_obj macro to produce a
4339 new RV as needed. For glob "self-ties", we are tieing the PVIO
4340 with an RV obj pointing to the glob containing the PVIO. In
4341 this case, to avoid a reference loop, we need to weaken the
4345 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4346 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4352 mg->mg_len = namlen;
4355 mg->mg_ptr = savepvn(name, namlen);
4356 else if (namlen == HEf_SVKEY)
4357 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4359 mg->mg_ptr = (char *) name;
4361 mg->mg_virtual = vtable;
4365 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4370 =for apidoc sv_magic
4372 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4373 then adds a new magic item of type C<how> to the head of the magic list.
4375 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4376 handling of the C<name> and C<namlen> arguments.
4378 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4379 to add more than one instance of the same 'how'.
4385 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4391 #ifdef PERL_OLD_COPY_ON_WRITE
4393 sv_force_normal_flags(sv, 0);
4395 if (SvREADONLY(sv)) {
4397 /* its okay to attach magic to shared strings; the subsequent
4398 * upgrade to PVMG will unshare the string */
4399 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4402 && how != PERL_MAGIC_regex_global
4403 && how != PERL_MAGIC_bm
4404 && how != PERL_MAGIC_fm
4405 && how != PERL_MAGIC_sv
4406 && how != PERL_MAGIC_backref
4409 Perl_croak(aTHX_ PL_no_modify);
4412 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4413 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4414 /* sv_magic() refuses to add a magic of the same 'how' as an
4417 if (how == PERL_MAGIC_taint) {
4419 /* Any scalar which already had taint magic on which someone
4420 (erroneously?) did SvIOK_on() or similar will now be
4421 incorrectly sporting public "OK" flags. */
4422 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4430 vtable = &PL_vtbl_sv;
4432 case PERL_MAGIC_overload:
4433 vtable = &PL_vtbl_amagic;
4435 case PERL_MAGIC_overload_elem:
4436 vtable = &PL_vtbl_amagicelem;
4438 case PERL_MAGIC_overload_table:
4439 vtable = &PL_vtbl_ovrld;
4442 vtable = &PL_vtbl_bm;
4444 case PERL_MAGIC_regdata:
4445 vtable = &PL_vtbl_regdata;
4447 case PERL_MAGIC_regdatum:
4448 vtable = &PL_vtbl_regdatum;
4450 case PERL_MAGIC_env:
4451 vtable = &PL_vtbl_env;
4454 vtable = &PL_vtbl_fm;
4456 case PERL_MAGIC_envelem:
4457 vtable = &PL_vtbl_envelem;
4459 case PERL_MAGIC_regex_global:
4460 vtable = &PL_vtbl_mglob;
4462 case PERL_MAGIC_isa:
4463 vtable = &PL_vtbl_isa;
4465 case PERL_MAGIC_isaelem:
4466 vtable = &PL_vtbl_isaelem;
4468 case PERL_MAGIC_nkeys:
4469 vtable = &PL_vtbl_nkeys;
4471 case PERL_MAGIC_dbfile:
4474 case PERL_MAGIC_dbline:
4475 vtable = &PL_vtbl_dbline;
4477 #ifdef USE_LOCALE_COLLATE
4478 case PERL_MAGIC_collxfrm:
4479 vtable = &PL_vtbl_collxfrm;
4481 #endif /* USE_LOCALE_COLLATE */
4482 case PERL_MAGIC_tied:
4483 vtable = &PL_vtbl_pack;
4485 case PERL_MAGIC_tiedelem:
4486 case PERL_MAGIC_tiedscalar:
4487 vtable = &PL_vtbl_packelem;
4490 vtable = &PL_vtbl_regexp;
4492 case PERL_MAGIC_sig:
4493 vtable = &PL_vtbl_sig;
4495 case PERL_MAGIC_sigelem:
4496 vtable = &PL_vtbl_sigelem;
4498 case PERL_MAGIC_taint:
4499 vtable = &PL_vtbl_taint;
4501 case PERL_MAGIC_uvar:
4502 vtable = &PL_vtbl_uvar;
4504 case PERL_MAGIC_vec:
4505 vtable = &PL_vtbl_vec;
4507 case PERL_MAGIC_arylen_p:
4508 case PERL_MAGIC_rhash:
4509 case PERL_MAGIC_symtab:
4510 case PERL_MAGIC_vstring:
4513 case PERL_MAGIC_utf8:
4514 vtable = &PL_vtbl_utf8;
4516 case PERL_MAGIC_substr:
4517 vtable = &PL_vtbl_substr;
4519 case PERL_MAGIC_defelem:
4520 vtable = &PL_vtbl_defelem;
4522 case PERL_MAGIC_arylen:
4523 vtable = &PL_vtbl_arylen;
4525 case PERL_MAGIC_pos:
4526 vtable = &PL_vtbl_pos;
4528 case PERL_MAGIC_backref:
4529 vtable = &PL_vtbl_backref;
4531 case PERL_MAGIC_ext:
4532 /* Reserved for use by extensions not perl internals. */
4533 /* Useful for attaching extension internal data to perl vars. */
4534 /* Note that multiple extensions may clash if magical scalars */
4535 /* etc holding private data from one are passed to another. */
4539 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4542 /* Rest of work is done else where */
4543 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4546 case PERL_MAGIC_taint:
4549 case PERL_MAGIC_ext:
4550 case PERL_MAGIC_dbfile:
4557 =for apidoc sv_unmagic
4559 Removes all magic of type C<type> from an SV.
4565 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4569 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4571 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4572 for (mg = *mgp; mg; mg = *mgp) {
4573 if (mg->mg_type == type) {
4574 const MGVTBL* const vtbl = mg->mg_virtual;
4575 *mgp = mg->mg_moremagic;
4576 if (vtbl && vtbl->svt_free)
4577 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4578 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4580 Safefree(mg->mg_ptr);
4581 else if (mg->mg_len == HEf_SVKEY)
4582 SvREFCNT_dec((SV*)mg->mg_ptr);
4583 else if (mg->mg_type == PERL_MAGIC_utf8)
4584 Safefree(mg->mg_ptr);
4586 if (mg->mg_flags & MGf_REFCOUNTED)
4587 SvREFCNT_dec(mg->mg_obj);
4591 mgp = &mg->mg_moremagic;
4595 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4596 SvMAGIC_set(sv, NULL);
4603 =for apidoc sv_rvweaken
4605 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4606 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4607 push a back-reference to this RV onto the array of backreferences
4608 associated with that magic.
4614 Perl_sv_rvweaken(pTHX_ SV *sv)
4617 if (!SvOK(sv)) /* let undefs pass */
4620 Perl_croak(aTHX_ "Can't weaken a nonreference");
4621 else if (SvWEAKREF(sv)) {
4622 if (ckWARN(WARN_MISC))
4623 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4627 Perl_sv_add_backref(aTHX_ tsv, sv);
4633 /* Give tsv backref magic if it hasn't already got it, then push a
4634 * back-reference to sv onto the array associated with the backref magic.
4638 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4643 if (SvTYPE(tsv) == SVt_PVHV) {
4644 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4648 /* There is no AV in the offical place - try a fixup. */
4649 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4652 /* Aha. They've got it stowed in magic. Bring it back. */
4653 av = (AV*)mg->mg_obj;
4654 /* Stop mg_free decreasing the refernce count. */
4656 /* Stop mg_free even calling the destructor, given that
4657 there's no AV to free up. */
4659 sv_unmagic(tsv, PERL_MAGIC_backref);
4663 SvREFCNT_inc_simple_void(av);
4668 const MAGIC *const mg
4669 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4671 av = (AV*)mg->mg_obj;
4675 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4676 /* av now has a refcnt of 2, which avoids it getting freed
4677 * before us during global cleanup. The extra ref is removed
4678 * by magic_killbackrefs() when tsv is being freed */
4681 if (AvFILLp(av) >= AvMAX(av)) {
4682 av_extend(av, AvFILLp(av)+1);
4684 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4687 /* delete a back-reference to ourselves from the backref magic associated
4688 * with the SV we point to.
4692 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4699 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4700 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4701 /* We mustn't attempt to "fix up" the hash here by moving the
4702 backreference array back to the hv_aux structure, as that is stored
4703 in the main HvARRAY(), and hfreentries assumes that no-one
4704 reallocates HvARRAY() while it is running. */
4707 const MAGIC *const mg
4708 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4710 av = (AV *)mg->mg_obj;
4713 if (PL_in_clean_all)
4715 Perl_croak(aTHX_ "panic: del_backref");
4722 /* We shouldn't be in here more than once, but for paranoia reasons lets
4724 for (i = AvFILLp(av); i >= 0; i--) {
4726 const SSize_t fill = AvFILLp(av);
4728 /* We weren't the last entry.
4729 An unordered list has this property that you can take the
4730 last element off the end to fill the hole, and it's still
4731 an unordered list :-)
4736 AvFILLp(av) = fill - 1;
4742 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4744 SV **svp = AvARRAY(av);
4746 PERL_UNUSED_ARG(sv);
4748 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4749 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4750 if (svp && !SvIS_FREED(av)) {
4751 SV *const *const last = svp + AvFILLp(av);
4753 while (svp <= last) {
4755 SV *const referrer = *svp;
4756 if (SvWEAKREF(referrer)) {
4757 /* XXX Should we check that it hasn't changed? */
4758 SvRV_set(referrer, 0);
4760 SvWEAKREF_off(referrer);
4761 } else if (SvTYPE(referrer) == SVt_PVGV ||
4762 SvTYPE(referrer) == SVt_PVLV) {
4763 /* You lookin' at me? */
4764 assert(GvSTASH(referrer));
4765 assert(GvSTASH(referrer) == (HV*)sv);
4766 GvSTASH(referrer) = 0;
4769 "panic: magic_killbackrefs (flags=%"UVxf")",
4770 (UV)SvFLAGS(referrer));
4778 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4783 =for apidoc sv_insert
4785 Inserts a string at the specified offset/length within the SV. Similar to
4786 the Perl substr() function.
4792 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4797 register char *midend;
4798 register char *bigend;
4804 Perl_croak(aTHX_ "Can't modify non-existent substring");
4805 SvPV_force(bigstr, curlen);
4806 (void)SvPOK_only_UTF8(bigstr);
4807 if (offset + len > curlen) {
4808 SvGROW(bigstr, offset+len+1);
4809 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4810 SvCUR_set(bigstr, offset+len);
4814 i = littlelen - len;
4815 if (i > 0) { /* string might grow */
4816 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4817 mid = big + offset + len;
4818 midend = bigend = big + SvCUR(bigstr);
4821 while (midend > mid) /* shove everything down */
4822 *--bigend = *--midend;
4823 Move(little,big+offset,littlelen,char);
4824 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4829 Move(little,SvPVX(bigstr)+offset,len,char);
4834 big = SvPVX(bigstr);
4837 bigend = big + SvCUR(bigstr);
4839 if (midend > bigend)
4840 Perl_croak(aTHX_ "panic: sv_insert");
4842 if (mid - big > bigend - midend) { /* faster to shorten from end */
4844 Move(little, mid, littlelen,char);
4847 i = bigend - midend;
4849 Move(midend, mid, i,char);
4853 SvCUR_set(bigstr, mid - big);
4855 else if ((i = mid - big)) { /* faster from front */
4856 midend -= littlelen;
4858 sv_chop(bigstr,midend-i);
4863 Move(little, mid, littlelen,char);
4865 else if (littlelen) {
4866 midend -= littlelen;
4867 sv_chop(bigstr,midend);
4868 Move(little,midend,littlelen,char);
4871 sv_chop(bigstr,midend);
4877 =for apidoc sv_replace
4879 Make the first argument a copy of the second, then delete the original.
4880 The target SV physically takes over ownership of the body of the source SV
4881 and inherits its flags; however, the target keeps any magic it owns,
4882 and any magic in the source is discarded.
4883 Note that this is a rather specialist SV copying operation; most of the
4884 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4890 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4893 const U32 refcnt = SvREFCNT(sv);
4894 SV_CHECK_THINKFIRST_COW_DROP(sv);
4895 if (SvREFCNT(nsv) != 1) {
4896 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4897 UVuf " != 1)", (UV) SvREFCNT(nsv));
4899 if (SvMAGICAL(sv)) {
4903 sv_upgrade(nsv, SVt_PVMG);
4904 SvMAGIC_set(nsv, SvMAGIC(sv));
4905 SvFLAGS(nsv) |= SvMAGICAL(sv);
4907 SvMAGIC_set(sv, NULL);
4911 assert(!SvREFCNT(sv));
4912 #ifdef DEBUG_LEAKING_SCALARS
4913 sv->sv_flags = nsv->sv_flags;
4914 sv->sv_any = nsv->sv_any;
4915 sv->sv_refcnt = nsv->sv_refcnt;
4916 sv->sv_u = nsv->sv_u;
4918 StructCopy(nsv,sv,SV);
4920 /* Currently could join these into one piece of pointer arithmetic, but
4921 it would be unclear. */
4922 if(SvTYPE(sv) == SVt_IV)
4924 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4925 else if (SvTYPE(sv) == SVt_RV) {
4926 SvANY(sv) = &sv->sv_u.svu_rv;
4930 #ifdef PERL_OLD_COPY_ON_WRITE
4931 if (SvIsCOW_normal(nsv)) {
4932 /* We need to follow the pointers around the loop to make the
4933 previous SV point to sv, rather than nsv. */
4936 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4939 assert(SvPVX_const(current) == SvPVX_const(nsv));
4941 /* Make the SV before us point to the SV after us. */
4943 PerlIO_printf(Perl_debug_log, "previous is\n");
4945 PerlIO_printf(Perl_debug_log,
4946 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4947 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4949 SV_COW_NEXT_SV_SET(current, sv);
4952 SvREFCNT(sv) = refcnt;
4953 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4959 =for apidoc sv_clear
4961 Clear an SV: call any destructors, free up any memory used by the body,
4962 and free the body itself. The SV's head is I<not> freed, although
4963 its type is set to all 1's so that it won't inadvertently be assumed
4964 to be live during global destruction etc.
4965 This function should only be called when REFCNT is zero. Most of the time
4966 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4973 Perl_sv_clear(pTHX_ register SV *sv)
4976 const U32 type = SvTYPE(sv);
4977 const struct body_details *const sv_type_details
4978 = bodies_by_type + type;
4981 assert(SvREFCNT(sv) == 0);
4983 if (type <= SVt_IV) {
4984 /* See the comment in sv.h about the collusion between this early
4985 return and the overloading of the NULL and IV slots in the size
4991 if (PL_defstash) { /* Still have a symbol table? */
4996 stash = SvSTASH(sv);
4997 destructor = StashHANDLER(stash,DESTROY);
4999 SV* const tmpref = newRV(sv);
5000 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5002 PUSHSTACKi(PERLSI_DESTROY);
5007 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5013 if(SvREFCNT(tmpref) < 2) {
5014 /* tmpref is not kept alive! */
5016 SvRV_set(tmpref, NULL);
5019 SvREFCNT_dec(tmpref);
5021 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5025 if (PL_in_clean_objs)
5026 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5028 /* DESTROY gave object new lease on life */
5034 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5035 SvOBJECT_off(sv); /* Curse the object. */
5036 if (type != SVt_PVIO)
5037 --PL_sv_objcount; /* XXX Might want something more general */
5040 if (type >= SVt_PVMG) {
5042 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5043 (ourstash = OURSTASH(sv))) {
5044 SvREFCNT_dec(ourstash);
5045 } else if (SvMAGIC(sv))
5047 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5048 SvREFCNT_dec(SvSTASH(sv));
5053 IoIFP(sv) != PerlIO_stdin() &&
5054 IoIFP(sv) != PerlIO_stdout() &&
5055 IoIFP(sv) != PerlIO_stderr())
5057 io_close((IO*)sv, FALSE);
5059 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5060 PerlDir_close(IoDIRP(sv));
5061 IoDIRP(sv) = (DIR*)NULL;
5062 Safefree(IoTOP_NAME(sv));
5063 Safefree(IoFMT_NAME(sv));
5064 Safefree(IoBOTTOM_NAME(sv));
5073 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5080 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5081 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5082 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5083 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5085 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5086 SvREFCNT_dec(LvTARG(sv));
5090 if (GvNAME_HEK(sv)) {
5091 unshare_hek(GvNAME_HEK(sv));
5093 /* If we're in a stash, we don't own a reference to it. However it does
5094 have a back reference to us, which needs to be cleared. */
5096 sv_del_backref((SV*)GvSTASH(sv), sv);
5101 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5103 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5104 /* Don't even bother with turning off the OOK flag. */
5109 SV * const target = SvRV(sv);
5111 sv_del_backref(target, sv);
5113 SvREFCNT_dec(target);
5115 #ifdef PERL_OLD_COPY_ON_WRITE
5116 else if (SvPVX_const(sv)) {
5118 /* I believe I need to grab the global SV mutex here and
5119 then recheck the COW status. */
5121 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5124 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5125 SV_COW_NEXT_SV(sv));
5126 /* And drop it here. */
5128 } else if (SvLEN(sv)) {
5129 Safefree(SvPVX_const(sv));
5133 else if (SvPVX_const(sv) && SvLEN(sv))
5134 Safefree(SvPVX_mutable(sv));
5135 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5136 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5145 SvFLAGS(sv) &= SVf_BREAK;
5146 SvFLAGS(sv) |= SVTYPEMASK;
5148 if (sv_type_details->arena) {
5149 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5150 &PL_body_roots[type]);
5152 else if (sv_type_details->body_size) {
5153 my_safefree(SvANY(sv));
5158 =for apidoc sv_newref
5160 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5167 Perl_sv_newref(pTHX_ SV *sv)
5169 PERL_UNUSED_CONTEXT;
5178 Decrement an SV's reference count, and if it drops to zero, call
5179 C<sv_clear> to invoke destructors and free up any memory used by
5180 the body; finally, deallocate the SV's head itself.
5181 Normally called via a wrapper macro C<SvREFCNT_dec>.
5187 Perl_sv_free(pTHX_ SV *sv)
5192 if (SvREFCNT(sv) == 0) {
5193 if (SvFLAGS(sv) & SVf_BREAK)
5194 /* this SV's refcnt has been artificially decremented to
5195 * trigger cleanup */
5197 if (PL_in_clean_all) /* All is fair */
5199 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5200 /* make sure SvREFCNT(sv)==0 happens very seldom */
5201 SvREFCNT(sv) = (~(U32)0)/2;
5204 if (ckWARN_d(WARN_INTERNAL)) {
5205 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5206 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5207 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5208 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5209 Perl_dump_sv_child(aTHX_ sv);
5214 if (--(SvREFCNT(sv)) > 0)
5216 Perl_sv_free2(aTHX_ sv);
5220 Perl_sv_free2(pTHX_ SV *sv)
5225 if (ckWARN_d(WARN_DEBUGGING))
5226 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5227 "Attempt to free temp prematurely: SV 0x%"UVxf
5228 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5232 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5233 /* make sure SvREFCNT(sv)==0 happens very seldom */
5234 SvREFCNT(sv) = (~(U32)0)/2;
5245 Returns the length of the string in the SV. Handles magic and type
5246 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5252 Perl_sv_len(pTHX_ register SV *sv)
5260 len = mg_length(sv);
5262 (void)SvPV_const(sv, len);
5267 =for apidoc sv_len_utf8
5269 Returns the number of characters in the string in an SV, counting wide
5270 UTF-8 bytes as a single character. Handles magic and type coercion.
5276 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5277 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5278 * (Note that the mg_len is not the length of the mg_ptr field.)
5283 Perl_sv_len_utf8(pTHX_ register SV *sv)
5289 return mg_length(sv);
5293 const U8 *s = (U8*)SvPV_const(sv, len);
5297 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5299 if (mg && mg->mg_len != -1) {
5301 if (PL_utf8cache < 0) {
5302 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5304 /* Need to turn the assertions off otherwise we may
5305 recurse infinitely while printing error messages.
5307 SAVEI8(PL_utf8cache);
5309 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5310 " real %"UVf" for %"SVf,
5311 (UV) ulen, (UV) real, sv);
5316 ulen = Perl_utf8_length(aTHX_ s, s + len);
5317 if (!SvREADONLY(sv)) {
5319 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5320 &PL_vtbl_utf8, 0, 0);
5328 return Perl_utf8_length(aTHX_ s, s + len);
5333 =for apidoc sv_pos_u2b
5335 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5336 the start of the string, to a count of the equivalent number of bytes; if
5337 lenp is non-zero, it does the same to lenp, but this time starting from
5338 the offset, rather than from the start of the string. Handles magic and
5345 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5346 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5347 * byte offsets. See also the comments of S_utf8_mg_pos().
5352 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5355 const U8 *s = start;
5357 while (s < send && uoffset--)
5360 /* This is the existing behaviour. Possibly it should be a croak, as
5361 it's actually a bounds error */
5369 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5370 STRLEN uoffset, STRLEN uend)
5372 STRLEN backw = uend - uoffset;
5373 if (uoffset < 2 * backw) {
5374 /* The assumption is that going forwards is twice the speed of going
5375 forward (that's where the 2 * backw comes from).
5376 (The real figure of course depends on the UTF-8 data.) */
5377 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5382 while (UTF8_IS_CONTINUATION(*send))
5385 return send - start;
5389 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5390 const U8 *const send, STRLEN uoffset,
5391 STRLEN uoffset0, STRLEN boffset0) {
5395 assert (uoffset >= uoffset0);
5397 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5398 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5399 if ((*mgp)->mg_ptr) {
5400 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5401 if (cache[0] == uoffset) {
5402 /* An exact match. */
5405 if (cache[2] == uoffset) {
5406 /* An exact match. */
5410 if (cache[0] < uoffset) {
5411 /* The cache already knows part of the way. */
5412 if (cache[0] > uoffset0) {
5413 /* The cache knows more than the passed in pair */
5414 uoffset0 = cache[0];
5415 boffset0 = cache[1];
5417 if ((*mgp)->mg_len != -1) {
5418 /* And we know the end too. */
5420 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5422 (*mgp)->mg_len - uoffset0);
5425 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5426 send, uoffset - uoffset0);
5429 else if (cache[2] < uoffset) {
5430 /* We're between the two cache entries. */
5431 if (cache[2] > uoffset0) {
5432 /* and the cache knows more than the passed in pair */
5433 uoffset0 = cache[2];
5434 boffset0 = cache[3];
5438 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5441 cache[0] - uoffset0);
5444 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5447 cache[2] - uoffset0);
5451 else if ((*mgp)->mg_len != -1) {
5452 /* If we can take advantage of a passed in offset, do so. */
5453 /* In fact, offset0 is either 0, or less than offset, so don't
5454 need to worry about the other possibility. */
5456 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5458 (*mgp)->mg_len - uoffset0);
5463 if (!found || PL_utf8cache < 0) {
5464 const STRLEN real_boffset
5465 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5466 send, uoffset - uoffset0);
5468 if (found && PL_utf8cache < 0) {
5469 if (real_boffset != boffset) {
5470 /* Need to turn the assertions off otherwise we may recurse
5471 infinitely while printing error messages. */
5472 SAVEI8(PL_utf8cache);
5474 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5475 " real %"UVf" for %"SVf,
5476 (UV) boffset, (UV) real_boffset, sv);
5479 boffset = real_boffset;
5482 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5487 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5495 start = (U8*)SvPV_const(sv, len);
5497 STRLEN uoffset = (STRLEN) *offsetp;
5498 const U8 * const send = start + len;
5500 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5503 *offsetp = (I32) boffset;
5506 /* Convert the relative offset to absolute. */
5507 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5509 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5510 uoffset, boffset) - boffset;
5525 =for apidoc sv_pos_b2u
5527 Converts the value pointed to by offsetp from a count of bytes from the
5528 start of the string, to a count of the equivalent number of UTF-8 chars.
5529 Handles magic and type coercion.
5535 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5536 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5542 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5550 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5552 (*mgp)->mg_len = -1;
5556 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5557 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5558 (*mgp)->mg_ptr = (char *) cache;
5562 if (PL_utf8cache < 0) {
5563 const U8 *start = (const U8 *) SvPVX_const(sv);
5564 const U8 *const end = start + byte;
5565 STRLEN realutf8 = 0;
5567 while (start < end) {
5568 start += UTF8SKIP(start);
5572 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5573 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5574 doesn't? I don't know whether this difference was introduced with
5575 the caching code in 5.8.1. */
5577 if (realutf8 != utf8) {
5578 /* Need to turn the assertions off otherwise we may recurse
5579 infinitely while printing error messages. */
5580 SAVEI8(PL_utf8cache);
5582 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5583 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5587 /* Cache is held with the later position first, to simplify the code
5588 that deals with unbounded ends. */
5590 ASSERT_UTF8_CACHE(cache);
5591 if (cache[1] == 0) {
5592 /* Cache is totally empty */
5595 } else if (cache[3] == 0) {
5596 if (byte > cache[1]) {
5597 /* New one is larger, so goes first. */
5598 cache[2] = cache[0];
5599 cache[3] = cache[1];
5607 #define THREEWAY_SQUARE(a,b,c,d) \
5608 ((float)((d) - (c))) * ((float)((d) - (c))) \
5609 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5610 + ((float)((b) - (a))) * ((float)((b) - (a)))
5612 /* Cache has 2 slots in use, and we know three potential pairs.
5613 Keep the two that give the lowest RMS distance. Do the
5614 calcualation in bytes simply because we always know the byte
5615 length. squareroot has the same ordering as the positive value,
5616 so don't bother with the actual square root. */
5617 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5618 if (byte > cache[1]) {
5619 /* New position is after the existing pair of pairs. */
5620 const float keep_earlier
5621 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5622 const float keep_later
5623 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5625 if (keep_later < keep_earlier) {
5626 if (keep_later < existing) {
5627 cache[2] = cache[0];
5628 cache[3] = cache[1];
5634 if (keep_earlier < existing) {
5640 else if (byte > cache[3]) {
5641 /* New position is between the existing pair of pairs. */
5642 const float keep_earlier
5643 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5644 const float keep_later
5645 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5647 if (keep_later < keep_earlier) {
5648 if (keep_later < existing) {
5654 if (keep_earlier < existing) {
5661 /* New position is before the existing pair of pairs. */
5662 const float keep_earlier
5663 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5664 const float keep_later
5665 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5667 if (keep_later < keep_earlier) {
5668 if (keep_later < existing) {
5674 if (keep_earlier < existing) {
5675 cache[0] = cache[2];
5676 cache[1] = cache[3];
5683 ASSERT_UTF8_CACHE(cache);
5686 /* If we don't know the character offset of the end of a region, our only
5687 option is to walk forwards to the target byte offset. */
5689 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5692 while (s < target) {
5695 /* Call utf8n_to_uvchr() to validate the sequence
5696 * (unless a simple non-UTF character) */
5697 if (!UTF8_IS_INVARIANT(*s))
5698 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5709 /* We already know all of the way, now we may be able to walk back. The same
5710 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5711 backward is half the speed of walking forward. */
5713 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5716 const STRLEN forw = target - s;
5717 STRLEN backw = end - target;
5719 if (forw < 2 * backw) {
5720 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5723 while (end > target) {
5725 while (UTF8_IS_CONTINUATION(*end)) {
5734 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5737 const STRLEN byte = *offsetp;
5746 s = (const U8*)SvPV_const(sv, blen);
5749 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5753 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5754 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5756 STRLEN *cache = (STRLEN *) mg->mg_ptr;
5757 if (cache[1] == byte) {
5758 /* An exact match. */
5759 *offsetp = cache[0];
5762 if (cache[3] == byte) {
5763 /* An exact match. */
5764 *offsetp = cache[2];
5768 if (cache[1] < byte) {
5769 /* We already know part of the way. */
5770 if (mg->mg_len != -1) {
5771 /* Actually, we know the end too. */
5773 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5774 s + blen, mg->mg_len - cache[0]);
5777 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5780 else if (cache[3] < byte) {
5781 /* We're between the two cached pairs, so we do the calculation
5782 offset by the byte/utf-8 positions for the earlier pair,
5783 then add the utf-8 characters from the string start to
5785 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5786 s + cache[1], cache[0] - cache[2])
5790 else { /* cache[3] > byte */
5791 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5795 ASSERT_UTF8_CACHE(cache);
5796 if (PL_utf8cache < 0) {
5797 const STRLEN reallen = S_sv_pos_b2u_forwards(aTHX_ s, send);
5799 if (len != reallen) {
5800 /* Need to turn the assertions off otherwise we may recurse
5801 infinitely while printing error messages. */
5802 SAVEI8(PL_utf8cache);
5804 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5805 " real %"UVf" for %"SVf,
5806 (UV) len, (UV) reallen, sv);
5809 } else if (mg->mg_len != -1) {
5810 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5812 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5816 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5820 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5826 Returns a boolean indicating whether the strings in the two SVs are
5827 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5828 coerce its args to strings if necessary.
5834 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5843 SV* svrecode = NULL;
5850 pv1 = SvPV_const(sv1, cur1);
5857 pv2 = SvPV_const(sv2, cur2);
5859 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5860 /* Differing utf8ness.
5861 * Do not UTF8size the comparands as a side-effect. */
5864 svrecode = newSVpvn(pv2, cur2);
5865 sv_recode_to_utf8(svrecode, PL_encoding);
5866 pv2 = SvPV_const(svrecode, cur2);
5869 svrecode = newSVpvn(pv1, cur1);
5870 sv_recode_to_utf8(svrecode, PL_encoding);
5871 pv1 = SvPV_const(svrecode, cur1);
5873 /* Now both are in UTF-8. */
5875 SvREFCNT_dec(svrecode);
5880 bool is_utf8 = TRUE;
5883 /* sv1 is the UTF-8 one,
5884 * if is equal it must be downgrade-able */
5885 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5891 /* sv2 is the UTF-8 one,
5892 * if is equal it must be downgrade-able */
5893 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5899 /* Downgrade not possible - cannot be eq */
5907 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5909 SvREFCNT_dec(svrecode);
5919 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5920 string in C<sv1> is less than, equal to, or greater than the string in
5921 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5922 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5928 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5932 const char *pv1, *pv2;
5935 SV *svrecode = NULL;
5942 pv1 = SvPV_const(sv1, cur1);
5949 pv2 = SvPV_const(sv2, cur2);
5951 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5952 /* Differing utf8ness.
5953 * Do not UTF8size the comparands as a side-effect. */
5956 svrecode = newSVpvn(pv2, cur2);
5957 sv_recode_to_utf8(svrecode, PL_encoding);
5958 pv2 = SvPV_const(svrecode, cur2);
5961 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5966 svrecode = newSVpvn(pv1, cur1);
5967 sv_recode_to_utf8(svrecode, PL_encoding);
5968 pv1 = SvPV_const(svrecode, cur1);
5971 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5977 cmp = cur2 ? -1 : 0;
5981 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5984 cmp = retval < 0 ? -1 : 1;
5985 } else if (cur1 == cur2) {
5988 cmp = cur1 < cur2 ? -1 : 1;
5992 SvREFCNT_dec(svrecode);
6000 =for apidoc sv_cmp_locale
6002 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6003 'use bytes' aware, handles get magic, and will coerce its args to strings
6004 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6010 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6013 #ifdef USE_LOCALE_COLLATE
6019 if (PL_collation_standard)
6023 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6025 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6027 if (!pv1 || !len1) {
6038 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6041 return retval < 0 ? -1 : 1;
6044 * When the result of collation is equality, that doesn't mean
6045 * that there are no differences -- some locales exclude some
6046 * characters from consideration. So to avoid false equalities,
6047 * we use the raw string as a tiebreaker.
6053 #endif /* USE_LOCALE_COLLATE */
6055 return sv_cmp(sv1, sv2);
6059 #ifdef USE_LOCALE_COLLATE
6062 =for apidoc sv_collxfrm
6064 Add Collate Transform magic to an SV if it doesn't already have it.
6066 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6067 scalar data of the variable, but transformed to such a format that a normal
6068 memory comparison can be used to compare the data according to the locale
6075 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6080 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6081 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6087 Safefree(mg->mg_ptr);
6088 s = SvPV_const(sv, len);
6089 if ((xf = mem_collxfrm(s, len, &xlen))) {
6090 if (SvREADONLY(sv)) {
6093 return xf + sizeof(PL_collation_ix);
6096 #ifdef PERL_OLD_COPY_ON_WRITE
6098 sv_force_normal_flags(sv, 0);
6100 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6114 if (mg && mg->mg_ptr) {
6116 return mg->mg_ptr + sizeof(PL_collation_ix);
6124 #endif /* USE_LOCALE_COLLATE */
6129 Get a line from the filehandle and store it into the SV, optionally
6130 appending to the currently-stored string.
6136 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6141 register STDCHAR rslast;
6142 register STDCHAR *bp;
6148 if (SvTHINKFIRST(sv))
6149 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6150 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6152 However, perlbench says it's slower, because the existing swipe code
6153 is faster than copy on write.
6154 Swings and roundabouts. */
6155 SvUPGRADE(sv, SVt_PV);
6160 if (PerlIO_isutf8(fp)) {
6162 sv_utf8_upgrade_nomg(sv);
6163 sv_pos_u2b(sv,&append,0);
6165 } else if (SvUTF8(sv)) {
6166 SV * const tsv = newSV(0);
6167 sv_gets(tsv, fp, 0);
6168 sv_utf8_upgrade_nomg(tsv);
6169 SvCUR_set(sv,append);
6172 goto return_string_or_null;
6177 if (PerlIO_isutf8(fp))
6180 if (IN_PERL_COMPILETIME) {
6181 /* we always read code in line mode */
6185 else if (RsSNARF(PL_rs)) {
6186 /* If it is a regular disk file use size from stat() as estimate
6187 of amount we are going to read - may result in malloc-ing
6188 more memory than we realy need if layers bellow reduce
6189 size we read (e.g. CRLF or a gzip layer)
6192 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6193 const Off_t offset = PerlIO_tell(fp);
6194 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6195 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6201 else if (RsRECORD(PL_rs)) {
6205 /* Grab the size of the record we're getting */
6206 recsize = SvIV(SvRV(PL_rs));
6207 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6210 /* VMS wants read instead of fread, because fread doesn't respect */
6211 /* RMS record boundaries. This is not necessarily a good thing to be */
6212 /* doing, but we've got no other real choice - except avoid stdio
6213 as implementation - perhaps write a :vms layer ?
6215 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6217 bytesread = PerlIO_read(fp, buffer, recsize);
6221 SvCUR_set(sv, bytesread += append);
6222 buffer[bytesread] = '\0';
6223 goto return_string_or_null;
6225 else if (RsPARA(PL_rs)) {
6231 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6232 if (PerlIO_isutf8(fp)) {
6233 rsptr = SvPVutf8(PL_rs, rslen);
6236 if (SvUTF8(PL_rs)) {
6237 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6238 Perl_croak(aTHX_ "Wide character in $/");
6241 rsptr = SvPV_const(PL_rs, rslen);
6245 rslast = rslen ? rsptr[rslen - 1] : '\0';
6247 if (rspara) { /* have to do this both before and after */
6248 do { /* to make sure file boundaries work right */
6251 i = PerlIO_getc(fp);
6255 PerlIO_ungetc(fp,i);
6261 /* See if we know enough about I/O mechanism to cheat it ! */
6263 /* This used to be #ifdef test - it is made run-time test for ease
6264 of abstracting out stdio interface. One call should be cheap
6265 enough here - and may even be a macro allowing compile
6269 if (PerlIO_fast_gets(fp)) {
6272 * We're going to steal some values from the stdio struct
6273 * and put EVERYTHING in the innermost loop into registers.
6275 register STDCHAR *ptr;
6279 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6280 /* An ungetc()d char is handled separately from the regular
6281 * buffer, so we getc() it back out and stuff it in the buffer.
6283 i = PerlIO_getc(fp);
6284 if (i == EOF) return 0;
6285 *(--((*fp)->_ptr)) = (unsigned char) i;
6289 /* Here is some breathtakingly efficient cheating */
6291 cnt = PerlIO_get_cnt(fp); /* get count into register */
6292 /* make sure we have the room */
6293 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6294 /* Not room for all of it
6295 if we are looking for a separator and room for some
6297 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6298 /* just process what we have room for */
6299 shortbuffered = cnt - SvLEN(sv) + append + 1;
6300 cnt -= shortbuffered;
6304 /* remember that cnt can be negative */
6305 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6310 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6311 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6312 DEBUG_P(PerlIO_printf(Perl_debug_log,
6313 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6314 DEBUG_P(PerlIO_printf(Perl_debug_log,
6315 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6316 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6317 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6322 while (cnt > 0) { /* this | eat */
6324 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6325 goto thats_all_folks; /* screams | sed :-) */
6329 Copy(ptr, bp, cnt, char); /* this | eat */
6330 bp += cnt; /* screams | dust */
6331 ptr += cnt; /* louder | sed :-) */
6336 if (shortbuffered) { /* oh well, must extend */
6337 cnt = shortbuffered;
6339 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6341 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6342 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6346 DEBUG_P(PerlIO_printf(Perl_debug_log,
6347 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6348 PTR2UV(ptr),(long)cnt));
6349 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6351 DEBUG_P(PerlIO_printf(Perl_debug_log,
6352 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6353 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6354 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6356 /* This used to call 'filbuf' in stdio form, but as that behaves like
6357 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6358 another abstraction. */
6359 i = PerlIO_getc(fp); /* get more characters */
6361 DEBUG_P(PerlIO_printf(Perl_debug_log,
6362 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6363 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6364 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6366 cnt = PerlIO_get_cnt(fp);
6367 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6368 DEBUG_P(PerlIO_printf(Perl_debug_log,
6369 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6371 if (i == EOF) /* all done for ever? */
6372 goto thats_really_all_folks;
6374 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6376 SvGROW(sv, bpx + cnt + 2);
6377 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6379 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6381 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6382 goto thats_all_folks;
6386 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6387 memNE((char*)bp - rslen, rsptr, rslen))
6388 goto screamer; /* go back to the fray */
6389 thats_really_all_folks:
6391 cnt += shortbuffered;
6392 DEBUG_P(PerlIO_printf(Perl_debug_log,
6393 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6394 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6395 DEBUG_P(PerlIO_printf(Perl_debug_log,
6396 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6397 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6398 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6400 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6401 DEBUG_P(PerlIO_printf(Perl_debug_log,
6402 "Screamer: done, len=%ld, string=|%.*s|\n",
6403 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6407 /*The big, slow, and stupid way. */
6408 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6409 STDCHAR *buf = NULL;
6410 Newx(buf, 8192, STDCHAR);
6418 register const STDCHAR * const bpe = buf + sizeof(buf);
6420 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6421 ; /* keep reading */
6425 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6426 /* Accomodate broken VAXC compiler, which applies U8 cast to
6427 * both args of ?: operator, causing EOF to change into 255
6430 i = (U8)buf[cnt - 1];
6436 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6438 sv_catpvn(sv, (char *) buf, cnt);
6440 sv_setpvn(sv, (char *) buf, cnt);
6442 if (i != EOF && /* joy */
6444 SvCUR(sv) < rslen ||
6445 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6449 * If we're reading from a TTY and we get a short read,
6450 * indicating that the user hit his EOF character, we need
6451 * to notice it now, because if we try to read from the TTY
6452 * again, the EOF condition will disappear.
6454 * The comparison of cnt to sizeof(buf) is an optimization
6455 * that prevents unnecessary calls to feof().
6459 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6463 #ifdef USE_HEAP_INSTEAD_OF_STACK
6468 if (rspara) { /* have to do this both before and after */
6469 while (i != EOF) { /* to make sure file boundaries work right */
6470 i = PerlIO_getc(fp);
6472 PerlIO_ungetc(fp,i);
6478 return_string_or_null:
6479 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6485 Auto-increment of the value in the SV, doing string to numeric conversion
6486 if necessary. Handles 'get' magic.
6492 Perl_sv_inc(pTHX_ register SV *sv)
6501 if (SvTHINKFIRST(sv)) {
6503 sv_force_normal_flags(sv, 0);
6504 if (SvREADONLY(sv)) {
6505 if (IN_PERL_RUNTIME)
6506 Perl_croak(aTHX_ PL_no_modify);
6510 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6512 i = PTR2IV(SvRV(sv));
6517 flags = SvFLAGS(sv);
6518 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6519 /* It's (privately or publicly) a float, but not tested as an
6520 integer, so test it to see. */
6522 flags = SvFLAGS(sv);
6524 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6525 /* It's publicly an integer, or privately an integer-not-float */
6526 #ifdef PERL_PRESERVE_IVUV
6530 if (SvUVX(sv) == UV_MAX)
6531 sv_setnv(sv, UV_MAX_P1);
6533 (void)SvIOK_only_UV(sv);
6534 SvUV_set(sv, SvUVX(sv) + 1);
6536 if (SvIVX(sv) == IV_MAX)
6537 sv_setuv(sv, (UV)IV_MAX + 1);
6539 (void)SvIOK_only(sv);
6540 SvIV_set(sv, SvIVX(sv) + 1);
6545 if (flags & SVp_NOK) {
6546 (void)SvNOK_only(sv);
6547 SvNV_set(sv, SvNVX(sv) + 1.0);
6551 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6552 if ((flags & SVTYPEMASK) < SVt_PVIV)
6553 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6554 (void)SvIOK_only(sv);
6559 while (isALPHA(*d)) d++;
6560 while (isDIGIT(*d)) d++;
6562 #ifdef PERL_PRESERVE_IVUV
6563 /* Got to punt this as an integer if needs be, but we don't issue
6564 warnings. Probably ought to make the sv_iv_please() that does
6565 the conversion if possible, and silently. */
6566 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6567 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6568 /* Need to try really hard to see if it's an integer.
6569 9.22337203685478e+18 is an integer.
6570 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6571 so $a="9.22337203685478e+18"; $a+0; $a++
6572 needs to be the same as $a="9.22337203685478e+18"; $a++
6579 /* sv_2iv *should* have made this an NV */
6580 if (flags & SVp_NOK) {
6581 (void)SvNOK_only(sv);
6582 SvNV_set(sv, SvNVX(sv) + 1.0);
6585 /* I don't think we can get here. Maybe I should assert this
6586 And if we do get here I suspect that sv_setnv will croak. NWC
6588 #if defined(USE_LONG_DOUBLE)
6589 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",
6590 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6592 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6593 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6596 #endif /* PERL_PRESERVE_IVUV */
6597 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6601 while (d >= SvPVX_const(sv)) {
6609 /* MKS: The original code here died if letters weren't consecutive.
6610 * at least it didn't have to worry about non-C locales. The
6611 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6612 * arranged in order (although not consecutively) and that only
6613 * [A-Za-z] are accepted by isALPHA in the C locale.
6615 if (*d != 'z' && *d != 'Z') {
6616 do { ++*d; } while (!isALPHA(*d));
6619 *(d--) -= 'z' - 'a';
6624 *(d--) -= 'z' - 'a' + 1;
6628 /* oh,oh, the number grew */
6629 SvGROW(sv, SvCUR(sv) + 2);
6630 SvCUR_set(sv, SvCUR(sv) + 1);
6631 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6642 Auto-decrement of the value in the SV, doing string to numeric conversion
6643 if necessary. Handles 'get' magic.
6649 Perl_sv_dec(pTHX_ register SV *sv)
6657 if (SvTHINKFIRST(sv)) {
6659 sv_force_normal_flags(sv, 0);
6660 if (SvREADONLY(sv)) {
6661 if (IN_PERL_RUNTIME)
6662 Perl_croak(aTHX_ PL_no_modify);
6666 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6668 i = PTR2IV(SvRV(sv));
6673 /* Unlike sv_inc we don't have to worry about string-never-numbers
6674 and keeping them magic. But we mustn't warn on punting */
6675 flags = SvFLAGS(sv);
6676 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6677 /* It's publicly an integer, or privately an integer-not-float */
6678 #ifdef PERL_PRESERVE_IVUV
6682 if (SvUVX(sv) == 0) {
6683 (void)SvIOK_only(sv);
6687 (void)SvIOK_only_UV(sv);
6688 SvUV_set(sv, SvUVX(sv) - 1);
6691 if (SvIVX(sv) == IV_MIN)
6692 sv_setnv(sv, (NV)IV_MIN - 1.0);
6694 (void)SvIOK_only(sv);
6695 SvIV_set(sv, SvIVX(sv) - 1);
6700 if (flags & SVp_NOK) {
6701 SvNV_set(sv, SvNVX(sv) - 1.0);
6702 (void)SvNOK_only(sv);
6705 if (!(flags & SVp_POK)) {
6706 if ((flags & SVTYPEMASK) < SVt_PVIV)
6707 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6709 (void)SvIOK_only(sv);
6712 #ifdef PERL_PRESERVE_IVUV
6714 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6715 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6716 /* Need to try really hard to see if it's an integer.
6717 9.22337203685478e+18 is an integer.
6718 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6719 so $a="9.22337203685478e+18"; $a+0; $a--
6720 needs to be the same as $a="9.22337203685478e+18"; $a--
6727 /* sv_2iv *should* have made this an NV */
6728 if (flags & SVp_NOK) {
6729 (void)SvNOK_only(sv);
6730 SvNV_set(sv, SvNVX(sv) - 1.0);
6733 /* I don't think we can get here. Maybe I should assert this
6734 And if we do get here I suspect that sv_setnv will croak. NWC
6736 #if defined(USE_LONG_DOUBLE)
6737 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",
6738 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6740 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6741 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6745 #endif /* PERL_PRESERVE_IVUV */
6746 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6750 =for apidoc sv_mortalcopy
6752 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6753 The new SV is marked as mortal. It will be destroyed "soon", either by an
6754 explicit call to FREETMPS, or by an implicit call at places such as
6755 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6760 /* Make a string that will exist for the duration of the expression
6761 * evaluation. Actually, it may have to last longer than that, but
6762 * hopefully we won't free it until it has been assigned to a
6763 * permanent location. */
6766 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6772 sv_setsv(sv,oldstr);
6774 PL_tmps_stack[++PL_tmps_ix] = sv;
6780 =for apidoc sv_newmortal
6782 Creates a new null SV which is mortal. The reference count of the SV is
6783 set to 1. It will be destroyed "soon", either by an explicit call to
6784 FREETMPS, or by an implicit call at places such as statement boundaries.
6785 See also C<sv_mortalcopy> and C<sv_2mortal>.
6791 Perl_sv_newmortal(pTHX)
6797 SvFLAGS(sv) = SVs_TEMP;
6799 PL_tmps_stack[++PL_tmps_ix] = sv;
6804 =for apidoc sv_2mortal
6806 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6807 by an explicit call to FREETMPS, or by an implicit call at places such as
6808 statement boundaries. SvTEMP() is turned on which means that the SV's
6809 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6810 and C<sv_mortalcopy>.
6816 Perl_sv_2mortal(pTHX_ register SV *sv)
6821 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6824 PL_tmps_stack[++PL_tmps_ix] = sv;
6832 Creates a new SV and copies a string into it. The reference count for the
6833 SV is set to 1. If C<len> is zero, Perl will compute the length using
6834 strlen(). For efficiency, consider using C<newSVpvn> instead.
6840 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6846 sv_setpvn(sv,s,len ? len : strlen(s));
6851 =for apidoc newSVpvn
6853 Creates a new SV and copies a string into it. The reference count for the
6854 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6855 string. You are responsible for ensuring that the source string is at least
6856 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6862 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6868 sv_setpvn(sv,s,len);
6874 =for apidoc newSVhek
6876 Creates a new SV from the hash key structure. It will generate scalars that
6877 point to the shared string table where possible. Returns a new (undefined)
6878 SV if the hek is NULL.
6884 Perl_newSVhek(pTHX_ const HEK *hek)
6894 if (HEK_LEN(hek) == HEf_SVKEY) {
6895 return newSVsv(*(SV**)HEK_KEY(hek));
6897 const int flags = HEK_FLAGS(hek);
6898 if (flags & HVhek_WASUTF8) {
6900 Andreas would like keys he put in as utf8 to come back as utf8
6902 STRLEN utf8_len = HEK_LEN(hek);
6903 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6904 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6907 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6909 } else if (flags & HVhek_REHASH) {
6910 /* We don't have a pointer to the hv, so we have to replicate the
6911 flag into every HEK. This hv is using custom a hasing
6912 algorithm. Hence we can't return a shared string scalar, as
6913 that would contain the (wrong) hash value, and might get passed
6914 into an hv routine with a regular hash */
6916 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6921 /* This will be overwhelminly the most common case. */
6922 return newSVpvn_share(HEK_KEY(hek),
6923 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6929 =for apidoc newSVpvn_share
6931 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6932 table. If the string does not already exist in the table, it is created
6933 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6934 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6935 otherwise the hash is computed. The idea here is that as the string table
6936 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6937 hash lookup will avoid string compare.
6943 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6947 bool is_utf8 = FALSE;
6949 STRLEN tmplen = -len;
6951 /* See the note in hv.c:hv_fetch() --jhi */
6952 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6956 PERL_HASH(hash, src, len);
6958 sv_upgrade(sv, SVt_PV);
6959 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6971 #if defined(PERL_IMPLICIT_CONTEXT)
6973 /* pTHX_ magic can't cope with varargs, so this is a no-context
6974 * version of the main function, (which may itself be aliased to us).
6975 * Don't access this version directly.
6979 Perl_newSVpvf_nocontext(const char* pat, ...)
6984 va_start(args, pat);
6985 sv = vnewSVpvf(pat, &args);
6992 =for apidoc newSVpvf
6994 Creates a new SV and initializes it with the string formatted like
7001 Perl_newSVpvf(pTHX_ const char* pat, ...)
7005 va_start(args, pat);
7006 sv = vnewSVpvf(pat, &args);
7011 /* backend for newSVpvf() and newSVpvf_nocontext() */
7014 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7019 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7026 Creates a new SV and copies a floating point value into it.
7027 The reference count for the SV is set to 1.
7033 Perl_newSVnv(pTHX_ NV n)
7046 Creates a new SV and copies an integer into it. The reference count for the
7053 Perl_newSViv(pTHX_ IV i)
7066 Creates a new SV and copies an unsigned integer into it.
7067 The reference count for the SV is set to 1.
7073 Perl_newSVuv(pTHX_ UV u)
7084 =for apidoc newRV_noinc
7086 Creates an RV wrapper for an SV. The reference count for the original
7087 SV is B<not> incremented.
7093 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7099 sv_upgrade(sv, SVt_RV);
7101 SvRV_set(sv, tmpRef);
7106 /* newRV_inc is the official function name to use now.
7107 * newRV_inc is in fact #defined to newRV in sv.h
7111 Perl_newRV(pTHX_ SV *sv)
7114 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7120 Creates a new SV which is an exact duplicate of the original SV.
7127 Perl_newSVsv(pTHX_ register SV *old)
7134 if (SvTYPE(old) == SVTYPEMASK) {
7135 if (ckWARN_d(WARN_INTERNAL))
7136 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7140 /* SV_GMAGIC is the default for sv_setv()
7141 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7142 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7143 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7148 =for apidoc sv_reset
7150 Underlying implementation for the C<reset> Perl function.
7151 Note that the perl-level function is vaguely deprecated.
7157 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7160 char todo[PERL_UCHAR_MAX+1];
7165 if (!*s) { /* reset ?? searches */
7166 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7168 PMOP *pm = (PMOP *) mg->mg_obj;
7170 pm->op_pmdynflags &= ~PMdf_USED;
7177 /* reset variables */
7179 if (!HvARRAY(stash))
7182 Zero(todo, 256, char);
7185 I32 i = (unsigned char)*s;
7189 max = (unsigned char)*s++;
7190 for ( ; i <= max; i++) {
7193 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7195 for (entry = HvARRAY(stash)[i];
7197 entry = HeNEXT(entry))
7202 if (!todo[(U8)*HeKEY(entry)])
7204 gv = (GV*)HeVAL(entry);
7207 if (SvTHINKFIRST(sv)) {
7208 if (!SvREADONLY(sv) && SvROK(sv))
7210 /* XXX Is this continue a bug? Why should THINKFIRST
7211 exempt us from resetting arrays and hashes? */
7215 if (SvTYPE(sv) >= SVt_PV) {
7217 if (SvPVX_const(sv) != NULL)
7225 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7227 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7230 # if defined(USE_ENVIRON_ARRAY)
7233 # endif /* USE_ENVIRON_ARRAY */
7244 Using various gambits, try to get an IO from an SV: the IO slot if its a
7245 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7246 named after the PV if we're a string.
7252 Perl_sv_2io(pTHX_ SV *sv)
7257 switch (SvTYPE(sv)) {
7265 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7269 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7271 return sv_2io(SvRV(sv));
7272 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7278 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7287 Using various gambits, try to get a CV from an SV; in addition, try if
7288 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7289 The flags in C<lref> are passed to sv_fetchsv.
7295 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7306 switch (SvTYPE(sv)) {
7325 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7326 tryAMAGICunDEREF(to_cv);
7329 if (SvTYPE(sv) == SVt_PVCV) {
7338 Perl_croak(aTHX_ "Not a subroutine reference");
7343 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7349 /* Some flags to gv_fetchsv mean don't really create the GV */
7350 if (SvTYPE(gv) != SVt_PVGV) {
7356 if (lref && !GvCVu(gv)) {
7360 gv_efullname3(tmpsv, gv, NULL);
7361 /* XXX this is probably not what they think they're getting.
7362 * It has the same effect as "sub name;", i.e. just a forward
7364 newSUB(start_subparse(FALSE, 0),
7365 newSVOP(OP_CONST, 0, tmpsv),
7369 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7379 Returns true if the SV has a true value by Perl's rules.
7380 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7381 instead use an in-line version.
7387 Perl_sv_true(pTHX_ register SV *sv)
7392 register const XPV* const tXpv = (XPV*)SvANY(sv);
7394 (tXpv->xpv_cur > 1 ||
7395 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7402 return SvIVX(sv) != 0;
7405 return SvNVX(sv) != 0.0;
7407 return sv_2bool(sv);
7413 =for apidoc sv_pvn_force
7415 Get a sensible string out of the SV somehow.
7416 A private implementation of the C<SvPV_force> macro for compilers which
7417 can't cope with complex macro expressions. Always use the macro instead.
7419 =for apidoc sv_pvn_force_flags
7421 Get a sensible string out of the SV somehow.
7422 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7423 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7424 implemented in terms of this function.
7425 You normally want to use the various wrapper macros instead: see
7426 C<SvPV_force> and C<SvPV_force_nomg>
7432 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7435 if (SvTHINKFIRST(sv) && !SvROK(sv))
7436 sv_force_normal_flags(sv, 0);
7446 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7447 const char * const ref = sv_reftype(sv,0);
7449 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7450 ref, OP_NAME(PL_op));
7452 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7454 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7455 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7457 s = sv_2pv_flags(sv, &len, flags);
7461 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7464 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7465 SvGROW(sv, len + 1);
7466 Move(s,SvPVX(sv),len,char);
7471 SvPOK_on(sv); /* validate pointer */
7473 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7474 PTR2UV(sv),SvPVX_const(sv)));
7477 return SvPVX_mutable(sv);
7481 =for apidoc sv_pvbyten_force
7483 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7489 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7491 sv_pvn_force(sv,lp);
7492 sv_utf8_downgrade(sv,0);
7498 =for apidoc sv_pvutf8n_force
7500 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7506 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7508 sv_pvn_force(sv,lp);
7509 sv_utf8_upgrade(sv);
7515 =for apidoc sv_reftype
7517 Returns a string describing what the SV is a reference to.
7523 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7525 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7526 inside return suggests a const propagation bug in g++. */
7527 if (ob && SvOBJECT(sv)) {
7528 char * const name = HvNAME_get(SvSTASH(sv));
7529 return name ? name : (char *) "__ANON__";
7532 switch (SvTYPE(sv)) {
7549 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7550 /* tied lvalues should appear to be
7551 * scalars for backwards compatitbility */
7552 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7553 ? "SCALAR" : "LVALUE");
7554 case SVt_PVAV: return "ARRAY";
7555 case SVt_PVHV: return "HASH";
7556 case SVt_PVCV: return "CODE";
7557 case SVt_PVGV: return "GLOB";
7558 case SVt_PVFM: return "FORMAT";
7559 case SVt_PVIO: return "IO";
7560 default: return "UNKNOWN";
7566 =for apidoc sv_isobject
7568 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7569 object. If the SV is not an RV, or if the object is not blessed, then this
7576 Perl_sv_isobject(pTHX_ SV *sv)
7592 Returns a boolean indicating whether the SV is blessed into the specified
7593 class. This does not check for subtypes; use C<sv_derived_from> to verify
7594 an inheritance relationship.
7600 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7611 hvname = HvNAME_get(SvSTASH(sv));
7615 return strEQ(hvname, name);
7621 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7622 it will be upgraded to one. If C<classname> is non-null then the new SV will
7623 be blessed in the specified package. The new SV is returned and its
7624 reference count is 1.
7630 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7637 SV_CHECK_THINKFIRST_COW_DROP(rv);
7640 if (SvTYPE(rv) >= SVt_PVMG) {
7641 const U32 refcnt = SvREFCNT(rv);
7645 SvREFCNT(rv) = refcnt;
7648 if (SvTYPE(rv) < SVt_RV)
7649 sv_upgrade(rv, SVt_RV);
7650 else if (SvTYPE(rv) > SVt_RV) {
7661 HV* const stash = gv_stashpv(classname, TRUE);
7662 (void)sv_bless(rv, stash);
7668 =for apidoc sv_setref_pv
7670 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7671 argument will be upgraded to an RV. That RV will be modified to point to
7672 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7673 into the SV. The C<classname> argument indicates the package for the
7674 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7675 will have a reference count of 1, and the RV will be returned.
7677 Do not use with other Perl types such as HV, AV, SV, CV, because those
7678 objects will become corrupted by the pointer copy process.
7680 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7686 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7690 sv_setsv(rv, &PL_sv_undef);
7694 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7699 =for apidoc sv_setref_iv
7701 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7702 argument will be upgraded to an RV. That RV will be modified to point to
7703 the new SV. The C<classname> argument indicates the package for the
7704 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7705 will have a reference count of 1, and the RV will be returned.
7711 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7713 sv_setiv(newSVrv(rv,classname), iv);
7718 =for apidoc sv_setref_uv
7720 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7721 argument will be upgraded to an RV. That RV will be modified to point to
7722 the new SV. The C<classname> argument indicates the package for the
7723 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7724 will have a reference count of 1, and the RV will be returned.
7730 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7732 sv_setuv(newSVrv(rv,classname), uv);
7737 =for apidoc sv_setref_nv
7739 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7740 argument will be upgraded to an RV. That RV will be modified to point to
7741 the new SV. The C<classname> argument indicates the package for the
7742 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7743 will have a reference count of 1, and the RV will be returned.
7749 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7751 sv_setnv(newSVrv(rv,classname), nv);
7756 =for apidoc sv_setref_pvn
7758 Copies a string into a new SV, optionally blessing the SV. The length of the
7759 string must be specified with C<n>. The C<rv> argument will be upgraded to
7760 an RV. That RV will be modified to point to the new SV. The C<classname>
7761 argument indicates the package for the blessing. Set C<classname> to
7762 C<NULL> to avoid the blessing. The new SV will have a reference count
7763 of 1, and the RV will be returned.
7765 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7771 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7773 sv_setpvn(newSVrv(rv,classname), pv, n);
7778 =for apidoc sv_bless
7780 Blesses an SV into a specified package. The SV must be an RV. The package
7781 must be designated by its stash (see C<gv_stashpv()>). The reference count
7782 of the SV is unaffected.
7788 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7793 Perl_croak(aTHX_ "Can't bless non-reference value");
7795 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7796 if (SvREADONLY(tmpRef))
7797 Perl_croak(aTHX_ PL_no_modify);
7798 if (SvOBJECT(tmpRef)) {
7799 if (SvTYPE(tmpRef) != SVt_PVIO)
7801 SvREFCNT_dec(SvSTASH(tmpRef));
7804 SvOBJECT_on(tmpRef);
7805 if (SvTYPE(tmpRef) != SVt_PVIO)
7807 SvUPGRADE(tmpRef, SVt_PVMG);
7808 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7815 if(SvSMAGICAL(tmpRef))
7816 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7824 /* Downgrades a PVGV to a PVMG.
7828 S_sv_unglob(pTHX_ SV *sv)
7832 SV * const temp = sv_newmortal();
7834 assert(SvTYPE(sv) == SVt_PVGV);
7836 gv_efullname3(temp, (GV *) sv, "*");
7842 sv_del_backref((SV*)GvSTASH(sv), sv);
7846 if (GvNAME_HEK(sv)) {
7847 unshare_hek(GvNAME_HEK(sv));
7851 /* need to keep SvANY(sv) in the right arena */
7852 xpvmg = new_XPVMG();
7853 StructCopy(SvANY(sv), xpvmg, XPVMG);
7854 del_XPVGV(SvANY(sv));
7857 SvFLAGS(sv) &= ~SVTYPEMASK;
7858 SvFLAGS(sv) |= SVt_PVMG;
7860 /* Intentionally not calling any local SET magic, as this isn't so much a
7861 set operation as merely an internal storage change. */
7862 sv_setsv_flags(sv, temp, 0);
7866 =for apidoc sv_unref_flags
7868 Unsets the RV status of the SV, and decrements the reference count of
7869 whatever was being referenced by the RV. This can almost be thought of
7870 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7871 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7872 (otherwise the decrementing is conditional on the reference count being
7873 different from one or the reference being a readonly SV).
7880 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7882 SV* const target = SvRV(ref);
7884 if (SvWEAKREF(ref)) {
7885 sv_del_backref(target, ref);
7887 SvRV_set(ref, NULL);
7890 SvRV_set(ref, NULL);
7892 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7893 assigned to as BEGIN {$a = \"Foo"} will fail. */
7894 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7895 SvREFCNT_dec(target);
7896 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7897 sv_2mortal(target); /* Schedule for freeing later */
7901 =for apidoc sv_untaint
7903 Untaint an SV. Use C<SvTAINTED_off> instead.
7908 Perl_sv_untaint(pTHX_ SV *sv)
7910 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7911 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7918 =for apidoc sv_tainted
7920 Test an SV for taintedness. Use C<SvTAINTED> instead.
7925 Perl_sv_tainted(pTHX_ SV *sv)
7927 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7928 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7929 if (mg && (mg->mg_len & 1) )
7936 =for apidoc sv_setpviv
7938 Copies an integer into the given SV, also updating its string value.
7939 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7945 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7947 char buf[TYPE_CHARS(UV)];
7949 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7951 sv_setpvn(sv, ptr, ebuf - ptr);
7955 =for apidoc sv_setpviv_mg
7957 Like C<sv_setpviv>, but also handles 'set' magic.
7963 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7969 #if defined(PERL_IMPLICIT_CONTEXT)
7971 /* pTHX_ magic can't cope with varargs, so this is a no-context
7972 * version of the main function, (which may itself be aliased to us).
7973 * Don't access this version directly.
7977 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7981 va_start(args, pat);
7982 sv_vsetpvf(sv, pat, &args);
7986 /* pTHX_ magic can't cope with varargs, so this is a no-context
7987 * version of the main function, (which may itself be aliased to us).
7988 * Don't access this version directly.
7992 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7996 va_start(args, pat);
7997 sv_vsetpvf_mg(sv, pat, &args);
8003 =for apidoc sv_setpvf
8005 Works like C<sv_catpvf> but copies the text into the SV instead of
8006 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8012 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8015 va_start(args, pat);
8016 sv_vsetpvf(sv, pat, &args);
8021 =for apidoc sv_vsetpvf
8023 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8024 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8026 Usually used via its frontend C<sv_setpvf>.
8032 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8034 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8038 =for apidoc sv_setpvf_mg
8040 Like C<sv_setpvf>, but also handles 'set' magic.
8046 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8049 va_start(args, pat);
8050 sv_vsetpvf_mg(sv, pat, &args);
8055 =for apidoc sv_vsetpvf_mg
8057 Like C<sv_vsetpvf>, but also handles 'set' magic.
8059 Usually used via its frontend C<sv_setpvf_mg>.
8065 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8067 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8071 #if defined(PERL_IMPLICIT_CONTEXT)
8073 /* pTHX_ magic can't cope with varargs, so this is a no-context
8074 * version of the main function, (which may itself be aliased to us).
8075 * Don't access this version directly.
8079 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8083 va_start(args, pat);
8084 sv_vcatpvf(sv, pat, &args);
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_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8098 va_start(args, pat);
8099 sv_vcatpvf_mg(sv, pat, &args);
8105 =for apidoc sv_catpvf
8107 Processes its arguments like C<sprintf> and appends the formatted
8108 output to an SV. If the appended data contains "wide" characters
8109 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8110 and characters >255 formatted with %c), the original SV might get
8111 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8112 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8113 valid UTF-8; if the original SV was bytes, the pattern should be too.
8118 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8121 va_start(args, pat);
8122 sv_vcatpvf(sv, pat, &args);
8127 =for apidoc sv_vcatpvf
8129 Processes its arguments like C<vsprintf> and appends the formatted output
8130 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8132 Usually used via its frontend C<sv_catpvf>.
8138 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8140 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8144 =for apidoc sv_catpvf_mg
8146 Like C<sv_catpvf>, but also handles 'set' magic.
8152 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8155 va_start(args, pat);
8156 sv_vcatpvf_mg(sv, pat, &args);
8161 =for apidoc sv_vcatpvf_mg
8163 Like C<sv_vcatpvf>, but also handles 'set' magic.
8165 Usually used via its frontend C<sv_catpvf_mg>.
8171 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8173 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8178 =for apidoc sv_vsetpvfn
8180 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8183 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8189 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8191 sv_setpvn(sv, "", 0);
8192 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8196 S_expect_number(pTHX_ char** pattern)
8200 switch (**pattern) {
8201 case '1': case '2': case '3':
8202 case '4': case '5': case '6':
8203 case '7': case '8': case '9':
8204 var = *(*pattern)++ - '0';
8205 while (isDIGIT(**pattern)) {
8206 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8208 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8216 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8218 const int neg = nv < 0;
8227 if (uv & 1 && uv == nv)
8228 uv--; /* Round to even */
8230 const unsigned dig = uv % 10;
8243 =for apidoc sv_vcatpvfn
8245 Processes its arguments like C<vsprintf> and appends the formatted output
8246 to an SV. Uses an array of SVs if the C style variable argument list is
8247 missing (NULL). When running with taint checks enabled, indicates via
8248 C<maybe_tainted> if results are untrustworthy (often due to the use of
8251 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8257 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8258 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8259 vec_utf8 = DO_UTF8(vecsv);
8261 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8264 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8272 static const char nullstr[] = "(null)";
8274 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8275 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8277 /* Times 4: a decimal digit takes more than 3 binary digits.
8278 * NV_DIG: mantissa takes than many decimal digits.
8279 * Plus 32: Playing safe. */
8280 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8281 /* large enough for "%#.#f" --chip */
8282 /* what about long double NVs? --jhi */
8284 PERL_UNUSED_ARG(maybe_tainted);
8286 /* no matter what, this is a string now */
8287 (void)SvPV_force(sv, origlen);
8289 /* special-case "", "%s", and "%-p" (SVf - see below) */
8292 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8294 const char * const s = va_arg(*args, char*);
8295 sv_catpv(sv, s ? s : nullstr);
8297 else if (svix < svmax) {
8298 sv_catsv(sv, *svargs);
8302 if (args && patlen == 3 && pat[0] == '%' &&
8303 pat[1] == '-' && pat[2] == 'p') {
8304 argsv = va_arg(*args, SV*);
8305 sv_catsv(sv, argsv);
8309 #ifndef USE_LONG_DOUBLE
8310 /* special-case "%.<number>[gf]" */
8311 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8312 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8313 unsigned digits = 0;
8317 while (*pp >= '0' && *pp <= '9')
8318 digits = 10 * digits + (*pp++ - '0');
8319 if (pp - pat == (int)patlen - 1) {
8327 /* Add check for digits != 0 because it seems that some
8328 gconverts are buggy in this case, and we don't yet have
8329 a Configure test for this. */
8330 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8331 /* 0, point, slack */
8332 Gconvert(nv, (int)digits, 0, ebuf);
8334 if (*ebuf) /* May return an empty string for digits==0 */
8337 } else if (!digits) {
8340 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8341 sv_catpvn(sv, p, l);
8347 #endif /* !USE_LONG_DOUBLE */
8349 if (!args && svix < svmax && DO_UTF8(*svargs))
8352 patend = (char*)pat + patlen;
8353 for (p = (char*)pat; p < patend; p = q) {
8356 bool vectorize = FALSE;
8357 bool vectorarg = FALSE;
8358 bool vec_utf8 = FALSE;
8364 bool has_precis = FALSE;
8366 const I32 osvix = svix;
8367 bool is_utf8 = FALSE; /* is this item utf8? */
8368 #ifdef HAS_LDBL_SPRINTF_BUG
8369 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8370 with sfio - Allen <allens@cpan.org> */
8371 bool fix_ldbl_sprintf_bug = FALSE;
8375 U8 utf8buf[UTF8_MAXBYTES+1];
8376 STRLEN esignlen = 0;
8378 const char *eptr = NULL;
8381 const U8 *vecstr = NULL;
8388 /* we need a long double target in case HAS_LONG_DOUBLE but
8391 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8399 const char *dotstr = ".";
8400 STRLEN dotstrlen = 1;
8401 I32 efix = 0; /* explicit format parameter index */
8402 I32 ewix = 0; /* explicit width index */
8403 I32 epix = 0; /* explicit precision index */
8404 I32 evix = 0; /* explicit vector index */
8405 bool asterisk = FALSE;
8407 /* echo everything up to the next format specification */
8408 for (q = p; q < patend && *q != '%'; ++q) ;
8410 if (has_utf8 && !pat_utf8)
8411 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8413 sv_catpvn(sv, p, q - p);
8420 We allow format specification elements in this order:
8421 \d+\$ explicit format parameter index
8423 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8424 0 flag (as above): repeated to allow "v02"
8425 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8426 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8428 [%bcdefginopsuxDFOUX] format (mandatory)
8433 As of perl5.9.3, printf format checking is on by default.
8434 Internally, perl uses %p formats to provide an escape to
8435 some extended formatting. This block deals with those
8436 extensions: if it does not match, (char*)q is reset and
8437 the normal format processing code is used.
8439 Currently defined extensions are:
8440 %p include pointer address (standard)
8441 %-p (SVf) include an SV (previously %_)
8442 %-<num>p include an SV with precision <num>
8443 %1p (VDf) include a v-string (as %vd)
8444 %<num>p reserved for future extensions
8446 Robin Barker 2005-07-14
8453 n = expect_number(&q);
8460 argsv = va_arg(*args, SV*);
8461 eptr = SvPVx_const(argsv, elen);
8467 else if (n == vdNUMBER) { /* VDf */
8474 if (ckWARN_d(WARN_INTERNAL))
8475 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8476 "internal %%<num>p might conflict with future printf extensions");
8482 if ( (width = expect_number(&q)) ) {
8523 if ( (ewix = expect_number(&q)) )
8532 if ((vectorarg = asterisk)) {
8545 width = expect_number(&q);
8551 vecsv = va_arg(*args, SV*);
8553 vecsv = (evix > 0 && evix <= svmax)
8554 ? svargs[evix-1] : &PL_sv_undef;
8556 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8558 dotstr = SvPV_const(vecsv, dotstrlen);
8559 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8560 bad with tied or overloaded values that return UTF8. */
8563 else if (has_utf8) {
8564 vecsv = sv_mortalcopy(vecsv);
8565 sv_utf8_upgrade(vecsv);
8566 dotstr = SvPV_const(vecsv, dotstrlen);
8573 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8574 vecsv = svargs[efix ? efix-1 : svix++];
8575 vecstr = (U8*)SvPV_const(vecsv,veclen);
8576 vec_utf8 = DO_UTF8(vecsv);
8578 /* if this is a version object, we need to convert
8579 * back into v-string notation and then let the
8580 * vectorize happen normally
8582 if (sv_derived_from(vecsv, "version")) {
8583 char *version = savesvpv(vecsv);
8584 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8585 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8586 "vector argument not supported with alpha versions");
8589 vecsv = sv_newmortal();
8590 /* scan_vstring is expected to be called during
8591 * tokenization, so we need to fake up the end
8592 * of the buffer for it
8594 PL_bufend = version + veclen;
8595 scan_vstring(version, vecsv);
8596 vecstr = (U8*)SvPV_const(vecsv, veclen);
8597 vec_utf8 = DO_UTF8(vecsv);
8609 i = va_arg(*args, int);
8611 i = (ewix ? ewix <= svmax : svix < svmax) ?
8612 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8614 width = (i < 0) ? -i : i;
8624 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8626 /* XXX: todo, support specified precision parameter */
8630 i = va_arg(*args, int);
8632 i = (ewix ? ewix <= svmax : svix < svmax)
8633 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8634 precis = (i < 0) ? 0 : i;
8639 precis = precis * 10 + (*q++ - '0');
8648 case 'I': /* Ix, I32x, and I64x */
8650 if (q[1] == '6' && q[2] == '4') {
8656 if (q[1] == '3' && q[2] == '2') {
8666 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8677 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8678 if (*(q + 1) == 'l') { /* lld, llf */
8704 if (!vectorize && !args) {
8706 const I32 i = efix-1;
8707 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8709 argsv = (svix >= 0 && svix < svmax)
8710 ? svargs[svix++] : &PL_sv_undef;
8721 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8723 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8725 eptr = (char*)utf8buf;
8726 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8740 eptr = va_arg(*args, char*);
8742 #ifdef MACOS_TRADITIONAL
8743 /* On MacOS, %#s format is used for Pascal strings */
8748 elen = strlen(eptr);
8750 eptr = (char *)nullstr;
8751 elen = sizeof nullstr - 1;
8755 eptr = SvPVx_const(argsv, elen);
8756 if (DO_UTF8(argsv)) {
8757 if (has_precis && precis < elen) {
8759 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8762 if (width) { /* fudge width (can't fudge elen) */
8763 width += elen - sv_len_utf8(argsv);
8770 if (has_precis && elen > precis)
8777 if (alt || vectorize)
8779 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8800 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8809 esignbuf[esignlen++] = plus;
8813 case 'h': iv = (short)va_arg(*args, int); break;
8814 case 'l': iv = va_arg(*args, long); break;
8815 case 'V': iv = va_arg(*args, IV); break;
8816 default: iv = va_arg(*args, int); break;
8818 case 'q': iv = va_arg(*args, Quad_t); break;
8823 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8825 case 'h': iv = (short)tiv; break;
8826 case 'l': iv = (long)tiv; break;
8828 default: iv = tiv; break;
8830 case 'q': iv = (Quad_t)tiv; break;
8834 if ( !vectorize ) /* we already set uv above */
8839 esignbuf[esignlen++] = plus;
8843 esignbuf[esignlen++] = '-';
8886 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8897 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8898 case 'l': uv = va_arg(*args, unsigned long); break;
8899 case 'V': uv = va_arg(*args, UV); break;
8900 default: uv = va_arg(*args, unsigned); break;
8902 case 'q': uv = va_arg(*args, Uquad_t); break;
8907 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8909 case 'h': uv = (unsigned short)tuv; break;
8910 case 'l': uv = (unsigned long)tuv; break;
8912 default: uv = tuv; break;
8914 case 'q': uv = (Uquad_t)tuv; break;
8921 char *ptr = ebuf + sizeof ebuf;
8927 p = (char*)((c == 'X')
8928 ? "0123456789ABCDEF" : "0123456789abcdef");
8934 esignbuf[esignlen++] = '0';
8935 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8943 if (alt && *ptr != '0')
8954 esignbuf[esignlen++] = '0';
8955 esignbuf[esignlen++] = 'b';
8958 default: /* it had better be ten or less */
8962 } while (uv /= base);
8965 elen = (ebuf + sizeof ebuf) - ptr;
8969 zeros = precis - elen;
8970 else if (precis == 0 && elen == 1 && *eptr == '0')
8976 /* FLOATING POINT */
8979 c = 'f'; /* maybe %F isn't supported here */
8987 /* This is evil, but floating point is even more evil */
8989 /* for SV-style calling, we can only get NV
8990 for C-style calling, we assume %f is double;
8991 for simplicity we allow any of %Lf, %llf, %qf for long double
8995 #if defined(USE_LONG_DOUBLE)
8999 /* [perl #20339] - we should accept and ignore %lf rather than die */
9003 #if defined(USE_LONG_DOUBLE)
9004 intsize = args ? 0 : 'q';
9008 #if defined(HAS_LONG_DOUBLE)
9017 /* now we need (long double) if intsize == 'q', else (double) */
9019 #if LONG_DOUBLESIZE > DOUBLESIZE
9021 va_arg(*args, long double) :
9022 va_arg(*args, double)
9024 va_arg(*args, double)
9029 if (c != 'e' && c != 'E') {
9031 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9032 will cast our (long double) to (double) */
9033 (void)Perl_frexp(nv, &i);
9034 if (i == PERL_INT_MIN)
9035 Perl_die(aTHX_ "panic: frexp");
9037 need = BIT_DIGITS(i);
9039 need += has_precis ? precis : 6; /* known default */
9044 #ifdef HAS_LDBL_SPRINTF_BUG
9045 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9046 with sfio - Allen <allens@cpan.org> */
9049 # define MY_DBL_MAX DBL_MAX
9050 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9051 # if DOUBLESIZE >= 8
9052 # define MY_DBL_MAX 1.7976931348623157E+308L
9054 # define MY_DBL_MAX 3.40282347E+38L
9058 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9059 # define MY_DBL_MAX_BUG 1L
9061 # define MY_DBL_MAX_BUG MY_DBL_MAX
9065 # define MY_DBL_MIN DBL_MIN
9066 # else /* XXX guessing! -Allen */
9067 # if DOUBLESIZE >= 8
9068 # define MY_DBL_MIN 2.2250738585072014E-308L
9070 # define MY_DBL_MIN 1.17549435E-38L
9074 if ((intsize == 'q') && (c == 'f') &&
9075 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9077 /* it's going to be short enough that
9078 * long double precision is not needed */
9080 if ((nv <= 0L) && (nv >= -0L))
9081 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9083 /* would use Perl_fp_class as a double-check but not
9084 * functional on IRIX - see perl.h comments */
9086 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9087 /* It's within the range that a double can represent */
9088 #if defined(DBL_MAX) && !defined(DBL_MIN)
9089 if ((nv >= ((long double)1/DBL_MAX)) ||
9090 (nv <= (-(long double)1/DBL_MAX)))
9092 fix_ldbl_sprintf_bug = TRUE;
9095 if (fix_ldbl_sprintf_bug == TRUE) {
9105 # undef MY_DBL_MAX_BUG
9108 #endif /* HAS_LDBL_SPRINTF_BUG */
9110 need += 20; /* fudge factor */
9111 if (PL_efloatsize < need) {
9112 Safefree(PL_efloatbuf);
9113 PL_efloatsize = need + 20; /* more fudge */
9114 Newx(PL_efloatbuf, PL_efloatsize, char);
9115 PL_efloatbuf[0] = '\0';
9118 if ( !(width || left || plus || alt) && fill != '0'
9119 && has_precis && intsize != 'q' ) { /* Shortcuts */
9120 /* See earlier comment about buggy Gconvert when digits,
9122 if ( c == 'g' && precis) {
9123 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9124 /* May return an empty string for digits==0 */
9125 if (*PL_efloatbuf) {
9126 elen = strlen(PL_efloatbuf);
9127 goto float_converted;
9129 } else if ( c == 'f' && !precis) {
9130 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9135 char *ptr = ebuf + sizeof ebuf;
9138 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9139 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9140 if (intsize == 'q') {
9141 /* Copy the one or more characters in a long double
9142 * format before the 'base' ([efgEFG]) character to
9143 * the format string. */
9144 static char const prifldbl[] = PERL_PRIfldbl;
9145 char const *p = prifldbl + sizeof(prifldbl) - 3;
9146 while (p >= prifldbl) { *--ptr = *p--; }
9151 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9156 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9168 /* No taint. Otherwise we are in the strange situation
9169 * where printf() taints but print($float) doesn't.
9171 #if defined(HAS_LONG_DOUBLE)
9172 elen = ((intsize == 'q')
9173 ? my_sprintf(PL_efloatbuf, ptr, nv)
9174 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9176 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9180 eptr = PL_efloatbuf;
9188 i = SvCUR(sv) - origlen;
9191 case 'h': *(va_arg(*args, short*)) = i; break;
9192 default: *(va_arg(*args, int*)) = i; break;
9193 case 'l': *(va_arg(*args, long*)) = i; break;
9194 case 'V': *(va_arg(*args, IV*)) = i; break;
9196 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9201 sv_setuv_mg(argsv, (UV)i);
9202 continue; /* not "break" */
9209 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9210 && ckWARN(WARN_PRINTF))
9212 SV * const msg = sv_newmortal();
9213 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9214 (PL_op->op_type == OP_PRTF) ? "" : "s");
9217 Perl_sv_catpvf(aTHX_ msg,
9218 "\"%%%c\"", c & 0xFF);
9220 Perl_sv_catpvf(aTHX_ msg,
9221 "\"%%\\%03"UVof"\"",
9224 sv_catpvs(msg, "end of string");
9225 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9228 /* output mangled stuff ... */
9234 /* ... right here, because formatting flags should not apply */
9235 SvGROW(sv, SvCUR(sv) + elen + 1);
9237 Copy(eptr, p, elen, char);
9240 SvCUR_set(sv, p - SvPVX_const(sv));
9242 continue; /* not "break" */
9245 /* calculate width before utf8_upgrade changes it */
9246 have = esignlen + zeros + elen;
9248 Perl_croak_nocontext(PL_memory_wrap);
9250 if (is_utf8 != has_utf8) {
9253 sv_utf8_upgrade(sv);
9256 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9257 sv_utf8_upgrade(nsv);
9258 eptr = SvPVX_const(nsv);
9261 SvGROW(sv, SvCUR(sv) + elen + 1);
9266 need = (have > width ? have : width);
9269 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9270 Perl_croak_nocontext(PL_memory_wrap);
9271 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9273 if (esignlen && fill == '0') {
9275 for (i = 0; i < (int)esignlen; i++)
9279 memset(p, fill, gap);
9282 if (esignlen && fill != '0') {
9284 for (i = 0; i < (int)esignlen; i++)
9289 for (i = zeros; i; i--)
9293 Copy(eptr, p, elen, char);
9297 memset(p, ' ', gap);
9302 Copy(dotstr, p, dotstrlen, char);
9306 vectorize = FALSE; /* done iterating over vecstr */
9313 SvCUR_set(sv, p - SvPVX_const(sv));
9321 /* =========================================================================
9323 =head1 Cloning an interpreter
9325 All the macros and functions in this section are for the private use of
9326 the main function, perl_clone().
9328 The foo_dup() functions make an exact copy of an existing foo thinngy.
9329 During the course of a cloning, a hash table is used to map old addresses
9330 to new addresses. The table is created and manipulated with the
9331 ptr_table_* functions.
9335 ============================================================================*/
9338 #if defined(USE_ITHREADS)
9340 #ifndef GpREFCNT_inc
9341 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9345 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9346 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9347 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9348 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9349 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9350 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9351 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9352 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9353 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9354 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9355 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9356 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9357 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9358 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9361 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9362 regcomp.c. AMS 20010712 */
9365 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9370 struct reg_substr_datum *s;
9373 return (REGEXP *)NULL;
9375 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9378 len = r->offsets[0];
9379 npar = r->nparens+1;
9381 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9382 Copy(r->program, ret->program, len+1, regnode);
9384 Newx(ret->startp, npar, I32);
9385 Copy(r->startp, ret->startp, npar, I32);
9386 Newx(ret->endp, npar, I32);
9387 Copy(r->startp, ret->startp, npar, I32);
9389 Newx(ret->substrs, 1, struct reg_substr_data);
9390 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9391 s->min_offset = r->substrs->data[i].min_offset;
9392 s->max_offset = r->substrs->data[i].max_offset;
9393 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9394 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9397 ret->regstclass = NULL;
9400 const int count = r->data->count;
9403 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9404 char, struct reg_data);
9405 Newx(d->what, count, U8);
9408 for (i = 0; i < count; i++) {
9409 d->what[i] = r->data->what[i];
9410 switch (d->what[i]) {
9411 /* legal options are one of: sfpont
9412 see also regcomp.h and pregfree() */
9414 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9417 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9420 /* This is cheating. */
9421 Newx(d->data[i], 1, struct regnode_charclass_class);
9422 StructCopy(r->data->data[i], d->data[i],
9423 struct regnode_charclass_class);
9424 ret->regstclass = (regnode*)d->data[i];
9427 /* Compiled op trees are readonly, and can thus be
9428 shared without duplication. */
9430 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9434 d->data[i] = r->data->data[i];
9437 d->data[i] = r->data->data[i];
9439 ((reg_trie_data*)d->data[i])->refcount++;
9443 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9452 Newx(ret->offsets, 2*len+1, U32);
9453 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9455 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9456 ret->refcnt = r->refcnt;
9457 ret->minlen = r->minlen;
9458 ret->prelen = r->prelen;
9459 ret->nparens = r->nparens;
9460 ret->lastparen = r->lastparen;
9461 ret->lastcloseparen = r->lastcloseparen;
9462 ret->reganch = r->reganch;
9464 ret->sublen = r->sublen;
9466 if (RX_MATCH_COPIED(ret))
9467 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9470 #ifdef PERL_OLD_COPY_ON_WRITE
9471 ret->saved_copy = NULL;
9474 ptr_table_store(PL_ptr_table, r, ret);
9478 /* duplicate a file handle */
9481 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9485 PERL_UNUSED_ARG(type);
9488 return (PerlIO*)NULL;
9490 /* look for it in the table first */
9491 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9495 /* create anew and remember what it is */
9496 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9497 ptr_table_store(PL_ptr_table, fp, ret);
9501 /* duplicate a directory handle */
9504 Perl_dirp_dup(pTHX_ DIR *dp)
9506 PERL_UNUSED_CONTEXT;
9513 /* duplicate a typeglob */
9516 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9522 /* look for it in the table first */
9523 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9527 /* create anew and remember what it is */
9529 ptr_table_store(PL_ptr_table, gp, ret);
9532 ret->gp_refcnt = 0; /* must be before any other dups! */
9533 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9534 ret->gp_io = io_dup_inc(gp->gp_io, param);
9535 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9536 ret->gp_av = av_dup_inc(gp->gp_av, param);
9537 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9538 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9539 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9540 ret->gp_cvgen = gp->gp_cvgen;
9541 ret->gp_line = gp->gp_line;
9542 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9546 /* duplicate a chain of magic */
9549 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9551 MAGIC *mgprev = (MAGIC*)NULL;
9554 return (MAGIC*)NULL;
9555 /* look for it in the table first */
9556 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9560 for (; mg; mg = mg->mg_moremagic) {
9562 Newxz(nmg, 1, MAGIC);
9564 mgprev->mg_moremagic = nmg;
9567 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9568 nmg->mg_private = mg->mg_private;
9569 nmg->mg_type = mg->mg_type;
9570 nmg->mg_flags = mg->mg_flags;
9571 if (mg->mg_type == PERL_MAGIC_qr) {
9572 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9574 else if(mg->mg_type == PERL_MAGIC_backref) {
9575 /* The backref AV has its reference count deliberately bumped by
9577 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9579 else if (mg->mg_type == PERL_MAGIC_symtab) {
9580 nmg->mg_obj = mg->mg_obj;
9583 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9584 ? sv_dup_inc(mg->mg_obj, param)
9585 : sv_dup(mg->mg_obj, param);
9587 nmg->mg_len = mg->mg_len;
9588 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9589 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9590 if (mg->mg_len > 0) {
9591 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9592 if (mg->mg_type == PERL_MAGIC_overload_table &&
9593 AMT_AMAGIC((AMT*)mg->mg_ptr))
9595 const AMT * const amtp = (AMT*)mg->mg_ptr;
9596 AMT * const namtp = (AMT*)nmg->mg_ptr;
9598 for (i = 1; i < NofAMmeth; i++) {
9599 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9603 else if (mg->mg_len == HEf_SVKEY)
9604 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9606 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9607 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9614 /* create a new pointer-mapping table */
9617 Perl_ptr_table_new(pTHX)
9620 PERL_UNUSED_CONTEXT;
9622 Newxz(tbl, 1, PTR_TBL_t);
9625 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9629 #define PTR_TABLE_HASH(ptr) \
9630 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9633 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9634 following define) and at call to new_body_inline made below in
9635 Perl_ptr_table_store()
9638 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9640 /* map an existing pointer using a table */
9642 STATIC PTR_TBL_ENT_t *
9643 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9644 PTR_TBL_ENT_t *tblent;
9645 const UV hash = PTR_TABLE_HASH(sv);
9647 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9648 for (; tblent; tblent = tblent->next) {
9649 if (tblent->oldval == sv)
9656 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9658 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9659 PERL_UNUSED_CONTEXT;
9660 return tblent ? tblent->newval : (void *) 0;
9663 /* add a new entry to a pointer-mapping table */
9666 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9668 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9669 PERL_UNUSED_CONTEXT;
9672 tblent->newval = newsv;
9674 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9676 new_body_inline(tblent, PTE_SVSLOT);
9678 tblent->oldval = oldsv;
9679 tblent->newval = newsv;
9680 tblent->next = tbl->tbl_ary[entry];
9681 tbl->tbl_ary[entry] = tblent;
9683 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9684 ptr_table_split(tbl);
9688 /* double the hash bucket size of an existing ptr table */
9691 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9693 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9694 const UV oldsize = tbl->tbl_max + 1;
9695 UV newsize = oldsize * 2;
9697 PERL_UNUSED_CONTEXT;
9699 Renew(ary, newsize, PTR_TBL_ENT_t*);
9700 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9701 tbl->tbl_max = --newsize;
9703 for (i=0; i < oldsize; i++, ary++) {
9704 PTR_TBL_ENT_t **curentp, **entp, *ent;
9707 curentp = ary + oldsize;
9708 for (entp = ary, ent = *ary; ent; ent = *entp) {
9709 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9711 ent->next = *curentp;
9721 /* remove all the entries from a ptr table */
9724 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9726 if (tbl && tbl->tbl_items) {
9727 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9728 UV riter = tbl->tbl_max;
9731 PTR_TBL_ENT_t *entry = array[riter];
9734 PTR_TBL_ENT_t * const oentry = entry;
9735 entry = entry->next;
9744 /* clear and free a ptr table */
9747 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9752 ptr_table_clear(tbl);
9753 Safefree(tbl->tbl_ary);
9759 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9762 SvRV_set(dstr, SvWEAKREF(sstr)
9763 ? sv_dup(SvRV(sstr), param)
9764 : sv_dup_inc(SvRV(sstr), param));
9767 else if (SvPVX_const(sstr)) {
9768 /* Has something there */
9770 /* Normal PV - clone whole allocated space */
9771 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9772 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9773 /* Not that normal - actually sstr is copy on write.
9774 But we are a true, independant SV, so: */
9775 SvREADONLY_off(dstr);
9780 /* Special case - not normally malloced for some reason */
9781 if (isGV_with_GP(sstr)) {
9782 /* Don't need to do anything here. */
9784 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9785 /* A "shared" PV - clone it as "shared" PV */
9787 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9791 /* Some other special case - random pointer */
9792 SvPV_set(dstr, SvPVX(sstr));
9798 if (SvTYPE(dstr) == SVt_RV)
9799 SvRV_set(dstr, NULL);
9801 SvPV_set(dstr, NULL);
9805 /* duplicate an SV of any type (including AV, HV etc) */
9808 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9813 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9815 /* look for it in the table first */
9816 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9820 if(param->flags & CLONEf_JOIN_IN) {
9821 /** We are joining here so we don't want do clone
9822 something that is bad **/
9823 if (SvTYPE(sstr) == SVt_PVHV) {
9824 const char * const hvname = HvNAME_get(sstr);
9826 /** don't clone stashes if they already exist **/
9827 return (SV*)gv_stashpv(hvname,0);
9831 /* create anew and remember what it is */
9834 #ifdef DEBUG_LEAKING_SCALARS
9835 dstr->sv_debug_optype = sstr->sv_debug_optype;
9836 dstr->sv_debug_line = sstr->sv_debug_line;
9837 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9838 dstr->sv_debug_cloned = 1;
9839 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9842 ptr_table_store(PL_ptr_table, sstr, dstr);
9845 SvFLAGS(dstr) = SvFLAGS(sstr);
9846 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9847 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9850 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9851 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9852 PL_watch_pvx, SvPVX_const(sstr));
9855 /* don't clone objects whose class has asked us not to */
9856 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9857 SvFLAGS(dstr) &= ~SVTYPEMASK;
9862 switch (SvTYPE(sstr)) {
9867 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9868 SvIV_set(dstr, SvIVX(sstr));
9871 SvANY(dstr) = new_XNV();
9872 SvNV_set(dstr, SvNVX(sstr));
9875 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9876 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9880 /* These are all the types that need complex bodies allocating. */
9882 const svtype sv_type = SvTYPE(sstr);
9883 const struct body_details *const sv_type_details
9884 = bodies_by_type + sv_type;
9888 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9892 if (GvUNIQUE((GV*)sstr)) {
9893 /*EMPTY*/; /* Do sharing here, and fall through */
9906 assert(sv_type_details->body_size);
9907 if (sv_type_details->arena) {
9908 new_body_inline(new_body, sv_type);
9910 = (void*)((char*)new_body - sv_type_details->offset);
9912 new_body = new_NOARENA(sv_type_details);
9916 SvANY(dstr) = new_body;
9919 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9920 ((char*)SvANY(dstr)) + sv_type_details->offset,
9921 sv_type_details->copy, char);
9923 Copy(((char*)SvANY(sstr)),
9924 ((char*)SvANY(dstr)),
9925 sv_type_details->body_size + sv_type_details->offset, char);
9928 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9929 && !isGV_with_GP(dstr))
9930 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9932 /* The Copy above means that all the source (unduplicated) pointers
9933 are now in the destination. We can check the flags and the
9934 pointers in either, but it's possible that there's less cache
9935 missing by always going for the destination.
9936 FIXME - instrument and check that assumption */
9937 if (sv_type >= SVt_PVMG) {
9939 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9940 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9941 } else if (SvMAGIC(dstr))
9942 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9944 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9947 /* The cast silences a GCC warning about unhandled types. */
9948 switch ((int)sv_type) {
9960 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9961 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9962 LvTARG(dstr) = dstr;
9963 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9964 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9966 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9969 if (GvNAME_HEK(dstr))
9970 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9972 /* Don't call sv_add_backref here as it's going to be created
9973 as part of the magic cloning of the symbol table. */
9974 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9975 if(isGV_with_GP(sstr)) {
9976 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9977 at the point of this comment. */
9978 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9979 (void)GpREFCNT_inc(GvGP(dstr));
9981 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9984 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9985 if (IoOFP(dstr) == IoIFP(sstr))
9986 IoOFP(dstr) = IoIFP(dstr);
9988 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9989 /* PL_rsfp_filters entries have fake IoDIRP() */
9990 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9991 /* I have no idea why fake dirp (rsfps)
9992 should be treated differently but otherwise
9993 we end up with leaks -- sky*/
9994 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9995 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9996 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9998 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9999 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10000 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10001 if (IoDIRP(dstr)) {
10002 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10005 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10008 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10009 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10010 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10013 if (AvARRAY((AV*)sstr)) {
10014 SV **dst_ary, **src_ary;
10015 SSize_t items = AvFILLp((AV*)sstr) + 1;
10017 src_ary = AvARRAY((AV*)sstr);
10018 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10019 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10020 SvPV_set(dstr, (char*)dst_ary);
10021 AvALLOC((AV*)dstr) = dst_ary;
10022 if (AvREAL((AV*)sstr)) {
10023 while (items-- > 0)
10024 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10027 while (items-- > 0)
10028 *dst_ary++ = sv_dup(*src_ary++, param);
10030 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10031 while (items-- > 0) {
10032 *dst_ary++ = &PL_sv_undef;
10036 SvPV_set(dstr, NULL);
10037 AvALLOC((AV*)dstr) = (SV**)NULL;
10042 HEK *hvname = NULL;
10044 if (HvARRAY((HV*)sstr)) {
10046 const bool sharekeys = !!HvSHAREKEYS(sstr);
10047 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10048 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10050 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10051 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10053 HvARRAY(dstr) = (HE**)darray;
10054 while (i <= sxhv->xhv_max) {
10055 const HE *source = HvARRAY(sstr)[i];
10056 HvARRAY(dstr)[i] = source
10057 ? he_dup(source, sharekeys, param) : 0;
10061 struct xpvhv_aux * const saux = HvAUX(sstr);
10062 struct xpvhv_aux * const daux = HvAUX(dstr);
10063 /* This flag isn't copied. */
10064 /* SvOOK_on(hv) attacks the IV flags. */
10065 SvFLAGS(dstr) |= SVf_OOK;
10067 hvname = saux->xhv_name;
10069 = hvname ? hek_dup(hvname, param) : hvname;
10071 daux->xhv_riter = saux->xhv_riter;
10072 daux->xhv_eiter = saux->xhv_eiter
10073 ? he_dup(saux->xhv_eiter,
10074 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10075 daux->xhv_backreferences = saux->xhv_backreferences
10076 ? (AV*) SvREFCNT_inc(
10078 xhv_backreferences,
10084 SvPV_set(dstr, NULL);
10086 /* Record stashes for possible cloning in Perl_clone(). */
10088 av_push(param->stashes, dstr);
10092 if (!(param->flags & CLONEf_COPY_STACKS)) {
10096 /* NOTE: not refcounted */
10097 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10099 if (!CvISXSUB(dstr))
10100 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10102 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10103 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10104 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10105 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10107 /* don't dup if copying back - CvGV isn't refcounted, so the
10108 * duped GV may never be freed. A bit of a hack! DAPM */
10109 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10110 NULL : gv_dup(CvGV(dstr), param) ;
10111 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10113 CvWEAKOUTSIDE(sstr)
10114 ? cv_dup( CvOUTSIDE(dstr), param)
10115 : cv_dup_inc(CvOUTSIDE(dstr), param);
10116 if (!CvISXSUB(dstr))
10117 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10123 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10129 /* duplicate a context */
10132 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10134 PERL_CONTEXT *ncxs;
10137 return (PERL_CONTEXT*)NULL;
10139 /* look for it in the table first */
10140 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10144 /* create anew and remember what it is */
10145 Newxz(ncxs, max + 1, PERL_CONTEXT);
10146 ptr_table_store(PL_ptr_table, cxs, ncxs);
10149 PERL_CONTEXT * const cx = &cxs[ix];
10150 PERL_CONTEXT * const ncx = &ncxs[ix];
10151 ncx->cx_type = cx->cx_type;
10152 if (CxTYPE(cx) == CXt_SUBST) {
10153 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10156 ncx->blk_oldsp = cx->blk_oldsp;
10157 ncx->blk_oldcop = cx->blk_oldcop;
10158 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10159 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10160 ncx->blk_oldpm = cx->blk_oldpm;
10161 ncx->blk_gimme = cx->blk_gimme;
10162 switch (CxTYPE(cx)) {
10164 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10165 ? cv_dup_inc(cx->blk_sub.cv, param)
10166 : cv_dup(cx->blk_sub.cv,param));
10167 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10168 ? av_dup_inc(cx->blk_sub.argarray, param)
10170 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10171 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10172 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10173 ncx->blk_sub.lval = cx->blk_sub.lval;
10174 ncx->blk_sub.retop = cx->blk_sub.retop;
10177 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10178 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10179 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10180 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10181 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10182 ncx->blk_eval.retop = cx->blk_eval.retop;
10185 ncx->blk_loop.label = cx->blk_loop.label;
10186 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10187 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10188 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10189 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10190 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10191 ? cx->blk_loop.iterdata
10192 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10193 ncx->blk_loop.oldcomppad
10194 = (PAD*)ptr_table_fetch(PL_ptr_table,
10195 cx->blk_loop.oldcomppad);
10196 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10197 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10198 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10199 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10200 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10203 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10204 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10205 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10206 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10207 ncx->blk_sub.retop = cx->blk_sub.retop;
10219 /* duplicate a stack info structure */
10222 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10227 return (PERL_SI*)NULL;
10229 /* look for it in the table first */
10230 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10234 /* create anew and remember what it is */
10235 Newxz(nsi, 1, PERL_SI);
10236 ptr_table_store(PL_ptr_table, si, nsi);
10238 nsi->si_stack = av_dup_inc(si->si_stack, param);
10239 nsi->si_cxix = si->si_cxix;
10240 nsi->si_cxmax = si->si_cxmax;
10241 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10242 nsi->si_type = si->si_type;
10243 nsi->si_prev = si_dup(si->si_prev, param);
10244 nsi->si_next = si_dup(si->si_next, param);
10245 nsi->si_markoff = si->si_markoff;
10250 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10251 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10252 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10253 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10254 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10255 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10256 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10257 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10258 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10259 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10260 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10261 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10262 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10263 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10266 #define pv_dup_inc(p) SAVEPV(p)
10267 #define pv_dup(p) SAVEPV(p)
10268 #define svp_dup_inc(p,pp) any_dup(p,pp)
10270 /* map any object to the new equivent - either something in the
10271 * ptr table, or something in the interpreter structure
10275 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10280 return (void*)NULL;
10282 /* look for it in the table first */
10283 ret = ptr_table_fetch(PL_ptr_table, v);
10287 /* see if it is part of the interpreter structure */
10288 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10289 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10297 /* duplicate the save stack */
10300 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10302 ANY * const ss = proto_perl->Tsavestack;
10303 const I32 max = proto_perl->Tsavestack_max;
10304 I32 ix = proto_perl->Tsavestack_ix;
10316 void (*dptr) (void*);
10317 void (*dxptr) (pTHX_ void*);
10319 Newxz(nss, max, ANY);
10322 I32 i = POPINT(ss,ix);
10323 TOPINT(nss,ix) = i;
10325 case SAVEt_ITEM: /* normal string */
10326 sv = (SV*)POPPTR(ss,ix);
10327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10328 sv = (SV*)POPPTR(ss,ix);
10329 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10331 case SAVEt_SV: /* scalar reference */
10332 sv = (SV*)POPPTR(ss,ix);
10333 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10334 gv = (GV*)POPPTR(ss,ix);
10335 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10337 case SAVEt_GENERIC_PVREF: /* generic char* */
10338 c = (char*)POPPTR(ss,ix);
10339 TOPPTR(nss,ix) = pv_dup(c);
10340 ptr = POPPTR(ss,ix);
10341 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10343 case SAVEt_SHARED_PVREF: /* char* in shared space */
10344 c = (char*)POPPTR(ss,ix);
10345 TOPPTR(nss,ix) = savesharedpv(c);
10346 ptr = POPPTR(ss,ix);
10347 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10349 case SAVEt_GENERIC_SVREF: /* generic sv */
10350 case SAVEt_SVREF: /* scalar reference */
10351 sv = (SV*)POPPTR(ss,ix);
10352 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10353 ptr = POPPTR(ss,ix);
10354 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10356 case SAVEt_AV: /* array reference */
10357 av = (AV*)POPPTR(ss,ix);
10358 TOPPTR(nss,ix) = av_dup_inc(av, param);
10359 gv = (GV*)POPPTR(ss,ix);
10360 TOPPTR(nss,ix) = gv_dup(gv, param);
10362 case SAVEt_HV: /* hash reference */
10363 hv = (HV*)POPPTR(ss,ix);
10364 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10365 gv = (GV*)POPPTR(ss,ix);
10366 TOPPTR(nss,ix) = gv_dup(gv, param);
10368 case SAVEt_INT: /* int reference */
10369 ptr = POPPTR(ss,ix);
10370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10371 intval = (int)POPINT(ss,ix);
10372 TOPINT(nss,ix) = intval;
10374 case SAVEt_LONG: /* long reference */
10375 ptr = POPPTR(ss,ix);
10376 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10377 longval = (long)POPLONG(ss,ix);
10378 TOPLONG(nss,ix) = longval;
10380 case SAVEt_I32: /* I32 reference */
10381 case SAVEt_I16: /* I16 reference */
10382 case SAVEt_I8: /* I8 reference */
10383 ptr = POPPTR(ss,ix);
10384 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10386 TOPINT(nss,ix) = i;
10388 case SAVEt_IV: /* IV reference */
10389 ptr = POPPTR(ss,ix);
10390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10392 TOPIV(nss,ix) = iv;
10394 case SAVEt_SPTR: /* SV* reference */
10395 ptr = POPPTR(ss,ix);
10396 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10397 sv = (SV*)POPPTR(ss,ix);
10398 TOPPTR(nss,ix) = sv_dup(sv, param);
10400 case SAVEt_VPTR: /* random* reference */
10401 ptr = POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10403 ptr = POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10406 case SAVEt_PPTR: /* char* reference */
10407 ptr = POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10409 c = (char*)POPPTR(ss,ix);
10410 TOPPTR(nss,ix) = pv_dup(c);
10412 case SAVEt_HPTR: /* HV* reference */
10413 ptr = POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10415 hv = (HV*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = hv_dup(hv, param);
10418 case SAVEt_APTR: /* AV* reference */
10419 ptr = POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10421 av = (AV*)POPPTR(ss,ix);
10422 TOPPTR(nss,ix) = av_dup(av, param);
10425 gv = (GV*)POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = gv_dup(gv, param);
10428 case SAVEt_GP: /* scalar reference */
10429 gp = (GP*)POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10431 (void)GpREFCNT_inc(gp);
10432 gv = (GV*)POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10434 c = (char*)POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = pv_dup(c);
10437 TOPIV(nss,ix) = iv;
10439 TOPIV(nss,ix) = iv;
10442 case SAVEt_MORTALIZESV:
10443 sv = (SV*)POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10447 ptr = POPPTR(ss,ix);
10448 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10449 /* these are assumed to be refcounted properly */
10451 switch (((OP*)ptr)->op_type) {
10453 case OP_LEAVESUBLV:
10457 case OP_LEAVEWRITE:
10458 TOPPTR(nss,ix) = ptr;
10463 TOPPTR(nss,ix) = NULL;
10468 TOPPTR(nss,ix) = NULL;
10471 c = (char*)POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = pv_dup_inc(c);
10474 case SAVEt_CLEARSV:
10475 longval = POPLONG(ss,ix);
10476 TOPLONG(nss,ix) = longval;
10479 hv = (HV*)POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10481 c = (char*)POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = pv_dup_inc(c);
10484 TOPINT(nss,ix) = i;
10486 case SAVEt_DESTRUCTOR:
10487 ptr = POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10489 dptr = POPDPTR(ss,ix);
10490 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10491 any_dup(FPTR2DPTR(void *, dptr),
10494 case SAVEt_DESTRUCTOR_X:
10495 ptr = POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10497 dxptr = POPDXPTR(ss,ix);
10498 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10499 any_dup(FPTR2DPTR(void *, dxptr),
10502 case SAVEt_REGCONTEXT:
10505 TOPINT(nss,ix) = i;
10508 case SAVEt_STACK_POS: /* Position on Perl stack */
10510 TOPINT(nss,ix) = i;
10512 case SAVEt_AELEM: /* array element */
10513 sv = (SV*)POPPTR(ss,ix);
10514 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10516 TOPINT(nss,ix) = i;
10517 av = (AV*)POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = av_dup_inc(av, param);
10520 case SAVEt_HELEM: /* hash element */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10523 sv = (SV*)POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10525 hv = (HV*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10529 ptr = POPPTR(ss,ix);
10530 TOPPTR(nss,ix) = ptr;
10534 TOPINT(nss,ix) = i;
10536 case SAVEt_COMPPAD:
10537 av = (AV*)POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = av_dup(av, param);
10541 longval = (long)POPLONG(ss,ix);
10542 TOPLONG(nss,ix) = longval;
10543 ptr = POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10545 sv = (SV*)POPPTR(ss,ix);
10546 TOPPTR(nss,ix) = sv_dup(sv, param);
10549 ptr = POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10551 longval = (long)POPBOOL(ss,ix);
10552 TOPBOOL(nss,ix) = (bool)longval;
10554 case SAVEt_SET_SVFLAGS:
10556 TOPINT(nss,ix) = i;
10558 TOPINT(nss,ix) = i;
10559 sv = (SV*)POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = sv_dup(sv, param);
10563 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10571 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10572 * flag to the result. This is done for each stash before cloning starts,
10573 * so we know which stashes want their objects cloned */
10576 do_mark_cloneable_stash(pTHX_ SV *sv)
10578 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10580 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10581 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10582 if (cloner && GvCV(cloner)) {
10589 XPUSHs(sv_2mortal(newSVhek(hvname)));
10591 call_sv((SV*)GvCV(cloner), G_SCALAR);
10598 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10606 =for apidoc perl_clone
10608 Create and return a new interpreter by cloning the current one.
10610 perl_clone takes these flags as parameters:
10612 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10613 without it we only clone the data and zero the stacks,
10614 with it we copy the stacks and the new perl interpreter is
10615 ready to run at the exact same point as the previous one.
10616 The pseudo-fork code uses COPY_STACKS while the
10617 threads->new doesn't.
10619 CLONEf_KEEP_PTR_TABLE
10620 perl_clone keeps a ptr_table with the pointer of the old
10621 variable as a key and the new variable as a value,
10622 this allows it to check if something has been cloned and not
10623 clone it again but rather just use the value and increase the
10624 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10625 the ptr_table using the function
10626 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10627 reason to keep it around is if you want to dup some of your own
10628 variable who are outside the graph perl scans, example of this
10629 code is in threads.xs create
10632 This is a win32 thing, it is ignored on unix, it tells perls
10633 win32host code (which is c++) to clone itself, this is needed on
10634 win32 if you want to run two threads at the same time,
10635 if you just want to do some stuff in a separate perl interpreter
10636 and then throw it away and return to the original one,
10637 you don't need to do anything.
10642 /* XXX the above needs expanding by someone who actually understands it ! */
10643 EXTERN_C PerlInterpreter *
10644 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10647 perl_clone(PerlInterpreter *proto_perl, UV flags)
10650 #ifdef PERL_IMPLICIT_SYS
10652 /* perlhost.h so we need to call into it
10653 to clone the host, CPerlHost should have a c interface, sky */
10655 if (flags & CLONEf_CLONE_HOST) {
10656 return perl_clone_host(proto_perl,flags);
10658 return perl_clone_using(proto_perl, flags,
10660 proto_perl->IMemShared,
10661 proto_perl->IMemParse,
10663 proto_perl->IStdIO,
10667 proto_perl->IProc);
10671 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10672 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10673 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10674 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10675 struct IPerlDir* ipD, struct IPerlSock* ipS,
10676 struct IPerlProc* ipP)
10678 /* XXX many of the string copies here can be optimized if they're
10679 * constants; they need to be allocated as common memory and just
10680 * their pointers copied. */
10683 CLONE_PARAMS clone_params;
10684 CLONE_PARAMS* const param = &clone_params;
10686 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10687 /* for each stash, determine whether its objects should be cloned */
10688 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10689 PERL_SET_THX(my_perl);
10692 Poison(my_perl, 1, PerlInterpreter);
10698 PL_savestack_ix = 0;
10699 PL_savestack_max = -1;
10700 PL_sig_pending = 0;
10701 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10702 # else /* !DEBUGGING */
10703 Zero(my_perl, 1, PerlInterpreter);
10704 # endif /* DEBUGGING */
10706 /* host pointers */
10708 PL_MemShared = ipMS;
10709 PL_MemParse = ipMP;
10716 #else /* !PERL_IMPLICIT_SYS */
10718 CLONE_PARAMS clone_params;
10719 CLONE_PARAMS* param = &clone_params;
10720 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10721 /* for each stash, determine whether its objects should be cloned */
10722 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10723 PERL_SET_THX(my_perl);
10726 Poison(my_perl, 1, PerlInterpreter);
10732 PL_savestack_ix = 0;
10733 PL_savestack_max = -1;
10734 PL_sig_pending = 0;
10735 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10736 # else /* !DEBUGGING */
10737 Zero(my_perl, 1, PerlInterpreter);
10738 # endif /* DEBUGGING */
10739 #endif /* PERL_IMPLICIT_SYS */
10740 param->flags = flags;
10741 param->proto_perl = proto_perl;
10743 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10745 PL_body_arenas = NULL;
10746 Zero(&PL_body_roots, 1, PL_body_roots);
10748 PL_nice_chunk = NULL;
10749 PL_nice_chunk_size = 0;
10751 PL_sv_objcount = 0;
10753 PL_sv_arenaroot = NULL;
10755 PL_debug = proto_perl->Idebug;
10757 PL_hash_seed = proto_perl->Ihash_seed;
10758 PL_rehash_seed = proto_perl->Irehash_seed;
10760 #ifdef USE_REENTRANT_API
10761 /* XXX: things like -Dm will segfault here in perlio, but doing
10762 * PERL_SET_CONTEXT(proto_perl);
10763 * breaks too many other things
10765 Perl_reentrant_init(aTHX);
10768 /* create SV map for pointer relocation */
10769 PL_ptr_table = ptr_table_new();
10771 /* initialize these special pointers as early as possible */
10772 SvANY(&PL_sv_undef) = NULL;
10773 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10774 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10775 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10777 SvANY(&PL_sv_no) = new_XPVNV();
10778 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10779 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10780 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10781 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10782 SvCUR_set(&PL_sv_no, 0);
10783 SvLEN_set(&PL_sv_no, 1);
10784 SvIV_set(&PL_sv_no, 0);
10785 SvNV_set(&PL_sv_no, 0);
10786 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10788 SvANY(&PL_sv_yes) = new_XPVNV();
10789 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10790 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10791 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10792 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10793 SvCUR_set(&PL_sv_yes, 1);
10794 SvLEN_set(&PL_sv_yes, 2);
10795 SvIV_set(&PL_sv_yes, 1);
10796 SvNV_set(&PL_sv_yes, 1);
10797 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10799 /* create (a non-shared!) shared string table */
10800 PL_strtab = newHV();
10801 HvSHAREKEYS_off(PL_strtab);
10802 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10803 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10805 PL_compiling = proto_perl->Icompiling;
10807 /* These two PVs will be free'd special way so must set them same way op.c does */
10808 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10809 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10811 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10812 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10814 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10815 if (!specialWARN(PL_compiling.cop_warnings))
10816 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10817 if (!specialCopIO(PL_compiling.cop_io))
10818 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10819 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10821 /* pseudo environmental stuff */
10822 PL_origargc = proto_perl->Iorigargc;
10823 PL_origargv = proto_perl->Iorigargv;
10825 param->stashes = newAV(); /* Setup array of objects to call clone on */
10827 /* Set tainting stuff before PerlIO_debug can possibly get called */
10828 PL_tainting = proto_perl->Itainting;
10829 PL_taint_warn = proto_perl->Itaint_warn;
10831 #ifdef PERLIO_LAYERS
10832 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10833 PerlIO_clone(aTHX_ proto_perl, param);
10836 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10837 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10838 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10839 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10840 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10841 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10844 PL_minus_c = proto_perl->Iminus_c;
10845 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10846 PL_localpatches = proto_perl->Ilocalpatches;
10847 PL_splitstr = proto_perl->Isplitstr;
10848 PL_preprocess = proto_perl->Ipreprocess;
10849 PL_minus_n = proto_perl->Iminus_n;
10850 PL_minus_p = proto_perl->Iminus_p;
10851 PL_minus_l = proto_perl->Iminus_l;
10852 PL_minus_a = proto_perl->Iminus_a;
10853 PL_minus_E = proto_perl->Iminus_E;
10854 PL_minus_F = proto_perl->Iminus_F;
10855 PL_doswitches = proto_perl->Idoswitches;
10856 PL_dowarn = proto_perl->Idowarn;
10857 PL_doextract = proto_perl->Idoextract;
10858 PL_sawampersand = proto_perl->Isawampersand;
10859 PL_unsafe = proto_perl->Iunsafe;
10860 PL_inplace = SAVEPV(proto_perl->Iinplace);
10861 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10862 PL_perldb = proto_perl->Iperldb;
10863 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10864 PL_exit_flags = proto_perl->Iexit_flags;
10866 /* magical thingies */
10867 /* XXX time(&PL_basetime) when asked for? */
10868 PL_basetime = proto_perl->Ibasetime;
10869 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10871 PL_maxsysfd = proto_perl->Imaxsysfd;
10872 PL_multiline = proto_perl->Imultiline;
10873 PL_statusvalue = proto_perl->Istatusvalue;
10875 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10877 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10879 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10881 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10882 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10883 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10885 /* Clone the regex array */
10886 PL_regex_padav = newAV();
10888 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10889 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10891 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10892 for(i = 1; i <= len; i++) {
10893 const SV * const regex = regexen[i];
10896 ? sv_dup_inc(regex, param)
10898 newSViv(PTR2IV(re_dup(
10899 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10901 av_push(PL_regex_padav, sv);
10904 PL_regex_pad = AvARRAY(PL_regex_padav);
10906 /* shortcuts to various I/O objects */
10907 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10908 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10909 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10910 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10911 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10912 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10914 /* shortcuts to regexp stuff */
10915 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10917 /* shortcuts to misc objects */
10918 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10920 /* shortcuts to debugging objects */
10921 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10922 PL_DBline = gv_dup(proto_perl->IDBline, param);
10923 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10924 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10925 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10926 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10927 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10928 PL_lineary = av_dup(proto_perl->Ilineary, param);
10929 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10931 /* symbol tables */
10932 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10933 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10934 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10935 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10936 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10938 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10939 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10940 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10941 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10942 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10943 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10945 PL_sub_generation = proto_perl->Isub_generation;
10947 /* funky return mechanisms */
10948 PL_forkprocess = proto_perl->Iforkprocess;
10950 /* subprocess state */
10951 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10953 /* internal state */
10954 PL_maxo = proto_perl->Imaxo;
10955 if (proto_perl->Iop_mask)
10956 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10959 /* PL_asserting = proto_perl->Iasserting; */
10961 /* current interpreter roots */
10962 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10963 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10964 PL_main_start = proto_perl->Imain_start;
10965 PL_eval_root = proto_perl->Ieval_root;
10966 PL_eval_start = proto_perl->Ieval_start;
10968 /* runtime control stuff */
10969 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10970 PL_copline = proto_perl->Icopline;
10972 PL_filemode = proto_perl->Ifilemode;
10973 PL_lastfd = proto_perl->Ilastfd;
10974 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10977 PL_gensym = proto_perl->Igensym;
10978 PL_preambled = proto_perl->Ipreambled;
10979 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10980 PL_laststatval = proto_perl->Ilaststatval;
10981 PL_laststype = proto_perl->Ilaststype;
10984 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10986 /* interpreter atexit processing */
10987 PL_exitlistlen = proto_perl->Iexitlistlen;
10988 if (PL_exitlistlen) {
10989 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10990 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10993 PL_exitlist = (PerlExitListEntry*)NULL;
10995 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10996 if (PL_my_cxt_size) {
10997 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10998 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11001 PL_my_cxt_list = (void**)NULL;
11002 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11003 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11004 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11006 PL_profiledata = NULL;
11007 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11008 /* PL_rsfp_filters entries have fake IoDIRP() */
11009 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11011 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11013 PAD_CLONE_VARS(proto_perl, param);
11015 #ifdef HAVE_INTERP_INTERN
11016 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11019 /* more statics moved here */
11020 PL_generation = proto_perl->Igeneration;
11021 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11023 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11024 PL_in_clean_all = proto_perl->Iin_clean_all;
11026 PL_uid = proto_perl->Iuid;
11027 PL_euid = proto_perl->Ieuid;
11028 PL_gid = proto_perl->Igid;
11029 PL_egid = proto_perl->Iegid;
11030 PL_nomemok = proto_perl->Inomemok;
11031 PL_an = proto_perl->Ian;
11032 PL_evalseq = proto_perl->Ievalseq;
11033 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11034 PL_origalen = proto_perl->Iorigalen;
11035 #ifdef PERL_USES_PL_PIDSTATUS
11036 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11038 PL_osname = SAVEPV(proto_perl->Iosname);
11039 PL_sighandlerp = proto_perl->Isighandlerp;
11041 PL_runops = proto_perl->Irunops;
11043 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11046 PL_cshlen = proto_perl->Icshlen;
11047 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11050 PL_lex_state = proto_perl->Ilex_state;
11051 PL_lex_defer = proto_perl->Ilex_defer;
11052 PL_lex_expect = proto_perl->Ilex_expect;
11053 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11054 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11055 PL_lex_starts = proto_perl->Ilex_starts;
11056 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11057 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11058 PL_lex_op = proto_perl->Ilex_op;
11059 PL_lex_inpat = proto_perl->Ilex_inpat;
11060 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11061 PL_lex_brackets = proto_perl->Ilex_brackets;
11062 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11063 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11064 PL_lex_casemods = proto_perl->Ilex_casemods;
11065 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11066 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11069 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11070 PL_lasttoke = proto_perl->Ilasttoke;
11071 PL_realtokenstart = proto_perl->Irealtokenstart;
11072 PL_faketokens = proto_perl->Ifaketokens;
11073 PL_thismad = proto_perl->Ithismad;
11074 PL_thistoken = proto_perl->Ithistoken;
11075 PL_thisopen = proto_perl->Ithisopen;
11076 PL_thisstuff = proto_perl->Ithisstuff;
11077 PL_thisclose = proto_perl->Ithisclose;
11078 PL_thiswhite = proto_perl->Ithiswhite;
11079 PL_nextwhite = proto_perl->Inextwhite;
11080 PL_skipwhite = proto_perl->Iskipwhite;
11081 PL_endwhite = proto_perl->Iendwhite;
11082 PL_curforce = proto_perl->Icurforce;
11084 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11085 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11086 PL_nexttoke = proto_perl->Inexttoke;
11089 /* XXX This is probably masking the deeper issue of why
11090 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11091 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11092 * (A little debugging with a watchpoint on it may help.)
11094 if (SvANY(proto_perl->Ilinestr)) {
11095 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11096 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11097 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11098 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11099 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11100 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11101 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11102 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11103 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11106 PL_linestr = newSV(79);
11107 sv_upgrade(PL_linestr,SVt_PVIV);
11108 sv_setpvn(PL_linestr,"",0);
11109 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11111 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11112 PL_pending_ident = proto_perl->Ipending_ident;
11113 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11115 PL_expect = proto_perl->Iexpect;
11117 PL_multi_start = proto_perl->Imulti_start;
11118 PL_multi_end = proto_perl->Imulti_end;
11119 PL_multi_open = proto_perl->Imulti_open;
11120 PL_multi_close = proto_perl->Imulti_close;
11122 PL_error_count = proto_perl->Ierror_count;
11123 PL_subline = proto_perl->Isubline;
11124 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11126 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11127 if (SvANY(proto_perl->Ilinestr)) {
11128 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11129 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11130 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11131 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11132 PL_last_lop_op = proto_perl->Ilast_lop_op;
11135 PL_last_uni = SvPVX(PL_linestr);
11136 PL_last_lop = SvPVX(PL_linestr);
11137 PL_last_lop_op = 0;
11139 PL_in_my = proto_perl->Iin_my;
11140 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11142 PL_cryptseen = proto_perl->Icryptseen;
11145 PL_hints = proto_perl->Ihints;
11147 PL_amagic_generation = proto_perl->Iamagic_generation;
11149 #ifdef USE_LOCALE_COLLATE
11150 PL_collation_ix = proto_perl->Icollation_ix;
11151 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11152 PL_collation_standard = proto_perl->Icollation_standard;
11153 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11154 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11155 #endif /* USE_LOCALE_COLLATE */
11157 #ifdef USE_LOCALE_NUMERIC
11158 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11159 PL_numeric_standard = proto_perl->Inumeric_standard;
11160 PL_numeric_local = proto_perl->Inumeric_local;
11161 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11162 #endif /* !USE_LOCALE_NUMERIC */
11164 /* utf8 character classes */
11165 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11166 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11167 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11168 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11169 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11170 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11171 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11172 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11173 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11174 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11175 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11176 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11177 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11178 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11179 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11180 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11181 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11182 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11183 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11184 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11186 /* Did the locale setup indicate UTF-8? */
11187 PL_utf8locale = proto_perl->Iutf8locale;
11188 /* Unicode features (see perlrun/-C) */
11189 PL_unicode = proto_perl->Iunicode;
11191 /* Pre-5.8 signals control */
11192 PL_signals = proto_perl->Isignals;
11194 /* times() ticks per second */
11195 PL_clocktick = proto_perl->Iclocktick;
11197 /* Recursion stopper for PerlIO_find_layer */
11198 PL_in_load_module = proto_perl->Iin_load_module;
11200 /* sort() routine */
11201 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11203 /* Not really needed/useful since the reenrant_retint is "volatile",
11204 * but do it for consistency's sake. */
11205 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11207 /* Hooks to shared SVs and locks. */
11208 PL_sharehook = proto_perl->Isharehook;
11209 PL_lockhook = proto_perl->Ilockhook;
11210 PL_unlockhook = proto_perl->Iunlockhook;
11211 PL_threadhook = proto_perl->Ithreadhook;
11213 PL_runops_std = proto_perl->Irunops_std;
11214 PL_runops_dbg = proto_perl->Irunops_dbg;
11216 #ifdef THREADS_HAVE_PIDS
11217 PL_ppid = proto_perl->Ippid;
11221 PL_last_swash_hv = NULL; /* reinits on demand */
11222 PL_last_swash_klen = 0;
11223 PL_last_swash_key[0]= '\0';
11224 PL_last_swash_tmps = (U8*)NULL;
11225 PL_last_swash_slen = 0;
11227 PL_glob_index = proto_perl->Iglob_index;
11228 PL_srand_called = proto_perl->Isrand_called;
11229 PL_uudmap['M'] = 0; /* reinits on demand */
11230 PL_bitcount = NULL; /* reinits on demand */
11232 if (proto_perl->Ipsig_pend) {
11233 Newxz(PL_psig_pend, SIG_SIZE, int);
11236 PL_psig_pend = (int*)NULL;
11239 if (proto_perl->Ipsig_ptr) {
11240 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11241 Newxz(PL_psig_name, SIG_SIZE, SV*);
11242 for (i = 1; i < SIG_SIZE; i++) {
11243 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11244 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11248 PL_psig_ptr = (SV**)NULL;
11249 PL_psig_name = (SV**)NULL;
11252 /* thrdvar.h stuff */
11254 if (flags & CLONEf_COPY_STACKS) {
11255 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11256 PL_tmps_ix = proto_perl->Ttmps_ix;
11257 PL_tmps_max = proto_perl->Ttmps_max;
11258 PL_tmps_floor = proto_perl->Ttmps_floor;
11259 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11261 while (i <= PL_tmps_ix) {
11262 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11266 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11267 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11268 Newxz(PL_markstack, i, I32);
11269 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11270 - proto_perl->Tmarkstack);
11271 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11272 - proto_perl->Tmarkstack);
11273 Copy(proto_perl->Tmarkstack, PL_markstack,
11274 PL_markstack_ptr - PL_markstack + 1, I32);
11276 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11277 * NOTE: unlike the others! */
11278 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11279 PL_scopestack_max = proto_perl->Tscopestack_max;
11280 Newxz(PL_scopestack, PL_scopestack_max, I32);
11281 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11283 /* NOTE: si_dup() looks at PL_markstack */
11284 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11286 /* PL_curstack = PL_curstackinfo->si_stack; */
11287 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11288 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11290 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11291 PL_stack_base = AvARRAY(PL_curstack);
11292 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11293 - proto_perl->Tstack_base);
11294 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11296 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11297 * NOTE: unlike the others! */
11298 PL_savestack_ix = proto_perl->Tsavestack_ix;
11299 PL_savestack_max = proto_perl->Tsavestack_max;
11300 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11301 PL_savestack = ss_dup(proto_perl, param);
11305 ENTER; /* perl_destruct() wants to LEAVE; */
11307 /* although we're not duplicating the tmps stack, we should still
11308 * add entries for any SVs on the tmps stack that got cloned by a
11309 * non-refcount means (eg a temp in @_); otherwise they will be
11312 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11313 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11314 proto_perl->Ttmps_stack[i]);
11315 if (nsv && !SvREFCNT(nsv)) {
11317 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11322 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11323 PL_top_env = &PL_start_env;
11325 PL_op = proto_perl->Top;
11328 PL_Xpv = (XPV*)NULL;
11329 PL_na = proto_perl->Tna;
11331 PL_statbuf = proto_perl->Tstatbuf;
11332 PL_statcache = proto_perl->Tstatcache;
11333 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11334 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11336 PL_timesbuf = proto_perl->Ttimesbuf;
11339 PL_tainted = proto_perl->Ttainted;
11340 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11341 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11342 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11343 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11344 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11345 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11346 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11347 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11348 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11350 PL_restartop = proto_perl->Trestartop;
11351 PL_in_eval = proto_perl->Tin_eval;
11352 PL_delaymagic = proto_perl->Tdelaymagic;
11353 PL_dirty = proto_perl->Tdirty;
11354 PL_localizing = proto_perl->Tlocalizing;
11356 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11357 PL_hv_fetch_ent_mh = NULL;
11358 PL_modcount = proto_perl->Tmodcount;
11359 PL_lastgotoprobe = NULL;
11360 PL_dumpindent = proto_perl->Tdumpindent;
11362 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11363 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11364 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11365 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11366 PL_efloatbuf = NULL; /* reinits on demand */
11367 PL_efloatsize = 0; /* reinits on demand */
11371 PL_screamfirst = NULL;
11372 PL_screamnext = NULL;
11373 PL_maxscream = -1; /* reinits on demand */
11374 PL_lastscream = NULL;
11376 PL_watchaddr = NULL;
11379 PL_regdummy = proto_perl->Tregdummy;
11380 PL_regprecomp = NULL;
11383 PL_colorset = 0; /* reinits PL_colors[] */
11384 /*PL_colors[6] = {0,0,0,0,0,0};*/
11385 PL_reginput = NULL;
11388 PL_regstartp = (I32*)NULL;
11389 PL_regendp = (I32*)NULL;
11390 PL_reglastparen = (U32*)NULL;
11391 PL_reglastcloseparen = (U32*)NULL;
11393 PL_reg_start_tmp = (char**)NULL;
11394 PL_reg_start_tmpl = 0;
11395 PL_regdata = (struct reg_data*)NULL;
11398 PL_reg_eval_set = 0;
11400 PL_regprogram = (regnode*)NULL;
11402 PL_regcc = (CURCUR*)NULL;
11403 PL_reg_call_cc = (struct re_cc_state*)NULL;
11404 PL_reg_re = (regexp*)NULL;
11405 PL_reg_ganch = NULL;
11407 PL_reg_match_utf8 = FALSE;
11408 PL_reg_magic = (MAGIC*)NULL;
11410 PL_reg_oldcurpm = (PMOP*)NULL;
11411 PL_reg_curpm = (PMOP*)NULL;
11412 PL_reg_oldsaved = NULL;
11413 PL_reg_oldsavedlen = 0;
11414 #ifdef PERL_OLD_COPY_ON_WRITE
11417 PL_reg_maxiter = 0;
11418 PL_reg_leftiter = 0;
11419 PL_reg_poscache = NULL;
11420 PL_reg_poscache_size= 0;
11422 /* RE engine - function pointers */
11423 PL_regcompp = proto_perl->Tregcompp;
11424 PL_regexecp = proto_perl->Tregexecp;
11425 PL_regint_start = proto_perl->Tregint_start;
11426 PL_regint_string = proto_perl->Tregint_string;
11427 PL_regfree = proto_perl->Tregfree;
11429 PL_reginterp_cnt = 0;
11430 PL_reg_starttry = 0;
11432 /* Pluggable optimizer */
11433 PL_peepp = proto_perl->Tpeepp;
11435 PL_stashcache = newHV();
11437 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11438 ptr_table_free(PL_ptr_table);
11439 PL_ptr_table = NULL;
11442 /* Call the ->CLONE method, if it exists, for each of the stashes
11443 identified by sv_dup() above.
11445 while(av_len(param->stashes) != -1) {
11446 HV* const stash = (HV*) av_shift(param->stashes);
11447 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11448 if (cloner && GvCV(cloner)) {
11453 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11455 call_sv((SV*)GvCV(cloner), G_DISCARD);
11461 SvREFCNT_dec(param->stashes);
11463 /* orphaned? eg threads->new inside BEGIN or use */
11464 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11465 SvREFCNT_inc_simple_void(PL_compcv);
11466 SAVEFREESV(PL_compcv);
11472 #endif /* USE_ITHREADS */
11475 =head1 Unicode Support
11477 =for apidoc sv_recode_to_utf8
11479 The encoding is assumed to be an Encode object, on entry the PV
11480 of the sv is assumed to be octets in that encoding, and the sv
11481 will be converted into Unicode (and UTF-8).
11483 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11484 is not a reference, nothing is done to the sv. If the encoding is not
11485 an C<Encode::XS> Encoding object, bad things will happen.
11486 (See F<lib/encoding.pm> and L<Encode>).
11488 The PV of the sv is returned.
11493 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11496 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11510 Passing sv_yes is wrong - it needs to be or'ed set of constants
11511 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11512 remove converted chars from source.
11514 Both will default the value - let them.
11516 XPUSHs(&PL_sv_yes);
11519 call_method("decode", G_SCALAR);
11523 s = SvPV_const(uni, len);
11524 if (s != SvPVX_const(sv)) {
11525 SvGROW(sv, len + 1);
11526 Move(s, SvPVX(sv), len + 1, char);
11527 SvCUR_set(sv, len);
11534 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11538 =for apidoc sv_cat_decode
11540 The encoding is assumed to be an Encode object, the PV of the ssv is
11541 assumed to be octets in that encoding and decoding the input starts
11542 from the position which (PV + *offset) pointed to. The dsv will be
11543 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11544 when the string tstr appears in decoding output or the input ends on
11545 the PV of the ssv. The value which the offset points will be modified
11546 to the last input position on the ssv.
11548 Returns TRUE if the terminator was found, else returns FALSE.
11553 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11554 SV *ssv, int *offset, char *tstr, int tlen)
11558 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11569 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11570 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11572 call_method("cat_decode", G_SCALAR);
11574 ret = SvTRUE(TOPs);
11575 *offset = SvIV(offsv);
11581 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11586 /* ---------------------------------------------------------------------
11588 * support functions for report_uninit()
11591 /* the maxiumum size of array or hash where we will scan looking
11592 * for the undefined element that triggered the warning */
11594 #define FUV_MAX_SEARCH_SIZE 1000
11596 /* Look for an entry in the hash whose value has the same SV as val;
11597 * If so, return a mortal copy of the key. */
11600 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11603 register HE **array;
11606 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11607 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11610 array = HvARRAY(hv);
11612 for (i=HvMAX(hv); i>0; i--) {
11613 register HE *entry;
11614 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11615 if (HeVAL(entry) != val)
11617 if ( HeVAL(entry) == &PL_sv_undef ||
11618 HeVAL(entry) == &PL_sv_placeholder)
11622 if (HeKLEN(entry) == HEf_SVKEY)
11623 return sv_mortalcopy(HeKEY_sv(entry));
11624 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11630 /* Look for an entry in the array whose value has the same SV as val;
11631 * If so, return the index, otherwise return -1. */
11634 S_find_array_subscript(pTHX_ AV *av, SV* val)
11639 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11640 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11644 for (i=AvFILLp(av); i>=0; i--) {
11645 if (svp[i] == val && svp[i] != &PL_sv_undef)
11651 /* S_varname(): return the name of a variable, optionally with a subscript.
11652 * If gv is non-zero, use the name of that global, along with gvtype (one
11653 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11654 * targ. Depending on the value of the subscript_type flag, return:
11657 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11658 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11659 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11660 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11663 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11664 SV* keyname, I32 aindex, int subscript_type)
11667 SV * const name = sv_newmortal();
11670 buffer[0] = gvtype;
11673 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11675 gv_fullname4(name, gv, buffer, 0);
11677 if ((unsigned int)SvPVX(name)[1] <= 26) {
11679 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11681 /* Swap the 1 unprintable control character for the 2 byte pretty
11682 version - ie substr($name, 1, 1) = $buffer; */
11683 sv_insert(name, 1, 1, buffer, 2);
11688 CV * const cv = find_runcv(&unused);
11692 if (!cv || !CvPADLIST(cv))
11694 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11695 sv = *av_fetch(av, targ, FALSE);
11696 /* SvLEN in a pad name is not to be trusted */
11697 sv_setpv(name, SvPV_nolen_const(sv));
11700 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11701 SV * const sv = newSV(0);
11702 *SvPVX(name) = '$';
11703 Perl_sv_catpvf(aTHX_ name, "{%s}",
11704 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11707 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11708 *SvPVX(name) = '$';
11709 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11711 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11712 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11719 =for apidoc find_uninit_var
11721 Find the name of the undefined variable (if any) that caused the operator o
11722 to issue a "Use of uninitialized value" warning.
11723 If match is true, only return a name if it's value matches uninit_sv.
11724 So roughly speaking, if a unary operator (such as OP_COS) generates a
11725 warning, then following the direct child of the op may yield an
11726 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11727 other hand, with OP_ADD there are two branches to follow, so we only print
11728 the variable name if we get an exact match.
11730 The name is returned as a mortal SV.
11732 Assumes that PL_op is the op that originally triggered the error, and that
11733 PL_comppad/PL_curpad points to the currently executing pad.
11739 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11747 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11748 uninit_sv == &PL_sv_placeholder)))
11751 switch (obase->op_type) {
11758 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11759 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11762 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11764 if (pad) { /* @lex, %lex */
11765 sv = PAD_SVl(obase->op_targ);
11769 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11770 /* @global, %global */
11771 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11774 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11776 else /* @{expr}, %{expr} */
11777 return find_uninit_var(cUNOPx(obase)->op_first,
11781 /* attempt to find a match within the aggregate */
11783 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11785 subscript_type = FUV_SUBSCRIPT_HASH;
11788 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11790 subscript_type = FUV_SUBSCRIPT_ARRAY;
11793 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11796 return varname(gv, hash ? '%' : '@', obase->op_targ,
11797 keysv, index, subscript_type);
11801 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11803 return varname(NULL, '$', obase->op_targ,
11804 NULL, 0, FUV_SUBSCRIPT_NONE);
11807 gv = cGVOPx_gv(obase);
11808 if (!gv || (match && GvSV(gv) != uninit_sv))
11810 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11813 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11816 av = (AV*)PAD_SV(obase->op_targ);
11817 if (!av || SvRMAGICAL(av))
11819 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11820 if (!svp || *svp != uninit_sv)
11823 return varname(NULL, '$', obase->op_targ,
11824 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11827 gv = cGVOPx_gv(obase);
11833 if (!av || SvRMAGICAL(av))
11835 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11836 if (!svp || *svp != uninit_sv)
11839 return varname(gv, '$', 0,
11840 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11845 o = cUNOPx(obase)->op_first;
11846 if (!o || o->op_type != OP_NULL ||
11847 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11849 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11853 if (PL_op == obase)
11854 /* $a[uninit_expr] or $h{uninit_expr} */
11855 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11858 o = cBINOPx(obase)->op_first;
11859 kid = cBINOPx(obase)->op_last;
11861 /* get the av or hv, and optionally the gv */
11863 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11864 sv = PAD_SV(o->op_targ);
11866 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11867 && cUNOPo->op_first->op_type == OP_GV)
11869 gv = cGVOPx_gv(cUNOPo->op_first);
11872 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11877 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11878 /* index is constant */
11882 if (obase->op_type == OP_HELEM) {
11883 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11884 if (!he || HeVAL(he) != uninit_sv)
11888 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11889 if (!svp || *svp != uninit_sv)
11893 if (obase->op_type == OP_HELEM)
11894 return varname(gv, '%', o->op_targ,
11895 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11897 return varname(gv, '@', o->op_targ, NULL,
11898 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11901 /* index is an expression;
11902 * attempt to find a match within the aggregate */
11903 if (obase->op_type == OP_HELEM) {
11904 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11906 return varname(gv, '%', o->op_targ,
11907 keysv, 0, FUV_SUBSCRIPT_HASH);
11910 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11912 return varname(gv, '@', o->op_targ,
11913 NULL, index, FUV_SUBSCRIPT_ARRAY);
11918 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11920 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11925 /* only examine RHS */
11926 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11929 o = cUNOPx(obase)->op_first;
11930 if (o->op_type == OP_PUSHMARK)
11933 if (!o->op_sibling) {
11934 /* one-arg version of open is highly magical */
11936 if (o->op_type == OP_GV) { /* open FOO; */
11938 if (match && GvSV(gv) != uninit_sv)
11940 return varname(gv, '$', 0,
11941 NULL, 0, FUV_SUBSCRIPT_NONE);
11943 /* other possibilities not handled are:
11944 * open $x; or open my $x; should return '${*$x}'
11945 * open expr; should return '$'.expr ideally
11951 /* ops where $_ may be an implicit arg */
11955 if ( !(obase->op_flags & OPf_STACKED)) {
11956 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11957 ? PAD_SVl(obase->op_targ)
11960 sv = sv_newmortal();
11961 sv_setpvn(sv, "$_", 2);
11969 /* skip filehandle as it can't produce 'undef' warning */
11970 o = cUNOPx(obase)->op_first;
11971 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11972 o = o->op_sibling->op_sibling;
11979 match = 1; /* XS or custom code could trigger random warnings */
11984 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11985 return sv_2mortal(newSVpvs("${$/}"));
11990 if (!(obase->op_flags & OPf_KIDS))
11992 o = cUNOPx(obase)->op_first;
11998 /* if all except one arg are constant, or have no side-effects,
11999 * or are optimized away, then it's unambiguous */
12001 for (kid=o; kid; kid = kid->op_sibling) {
12003 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12004 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12005 || (kid->op_type == OP_PUSHMARK)
12009 if (o2) { /* more than one found */
12016 return find_uninit_var(o2, uninit_sv, match);
12018 /* scan all args */
12020 sv = find_uninit_var(o, uninit_sv, 1);
12032 =for apidoc report_uninit
12034 Print appropriate "Use of uninitialized variable" warning
12040 Perl_report_uninit(pTHX_ SV* uninit_sv)
12044 SV* varname = NULL;
12046 varname = find_uninit_var(PL_op, uninit_sv,0);
12048 sv_insert(varname, 0, 0, " ", 1);
12050 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12051 varname ? SvPV_nolen_const(varname) : "",
12052 " in ", OP_DESC(PL_op));
12055 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12061 * c-indentation-style: bsd
12062 * c-basic-offset: 4
12063 * indent-tabs-mode: t
12066 * ex: set ts=8 sts=4 sw=4 noet: