3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
1280 /* Could put this in the else clause below, as PVMG must have SvPVX
1281 0 already (the assertion above) */
1284 if (old_type >= SVt_PVMG) {
1285 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1286 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 /* XXX Is this still needed? Was it ever needed? Surely as there is
1293 no route from NV to PVIV, NOK can never be true */
1294 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = (char*)saferealloc(s, newlen);
1456 s = (char*)safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1855 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1856 if (SvNVX(sv) < (NV)IV_MIN) {
1857 (void)SvIOKp_on(sv);
1859 SvIV_set(sv, IV_MIN);
1860 return IS_NUMBER_UNDERFLOW_IV;
1862 if (SvNVX(sv) > (NV)UV_MAX) {
1863 (void)SvIOKp_on(sv);
1866 SvUV_set(sv, UV_MAX);
1867 return IS_NUMBER_OVERFLOW_UV;
1869 (void)SvIOKp_on(sv);
1871 /* Can't use strtol etc to convert this string. (See truth table in
1873 if (SvNVX(sv) <= (UV)IV_MAX) {
1874 SvIV_set(sv, I_V(SvNVX(sv)));
1875 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1876 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1878 /* Integer is imprecise. NOK, IOKp */
1880 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1883 SvUV_set(sv, U_V(SvNVX(sv)));
1884 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1885 if (SvUVX(sv) == UV_MAX) {
1886 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1887 possibly be preserved by NV. Hence, it must be overflow.
1889 return IS_NUMBER_OVERFLOW_UV;
1891 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1893 /* Integer is imprecise. NOK, IOKp */
1895 return IS_NUMBER_OVERFLOW_IV;
1897 #endif /* !NV_PRESERVES_UV*/
1900 S_sv_2iuv_common(pTHX_ SV *sv) {
1903 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1904 * without also getting a cached IV/UV from it at the same time
1905 * (ie PV->NV conversion should detect loss of accuracy and cache
1906 * IV or UV at same time to avoid this. */
1907 /* IV-over-UV optimisation - choose to cache IV if possible */
1909 if (SvTYPE(sv) == SVt_NV)
1910 sv_upgrade(sv, SVt_PVNV);
1912 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1913 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1914 certainly cast into the IV range at IV_MAX, whereas the correct
1915 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1917 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1918 if (Perl_isnan(SvNVX(sv))) {
1924 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1925 SvIV_set(sv, I_V(SvNVX(sv)));
1926 if (SvNVX(sv) == (NV) SvIVX(sv)
1927 #ifndef NV_PRESERVES_UV
1928 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1929 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1930 /* Don't flag it as "accurately an integer" if the number
1931 came from a (by definition imprecise) NV operation, and
1932 we're outside the range of NV integer precision */
1935 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1943 /* IV not precise. No need to convert from PV, as NV
1944 conversion would already have cached IV if it detected
1945 that PV->IV would be better than PV->NV->IV
1946 flags already correct - don't set public IOK. */
1947 DEBUG_c(PerlIO_printf(Perl_debug_log,
1948 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1953 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1954 but the cast (NV)IV_MIN rounds to a the value less (more
1955 negative) than IV_MIN which happens to be equal to SvNVX ??
1956 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1957 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1958 (NV)UVX == NVX are both true, but the values differ. :-(
1959 Hopefully for 2s complement IV_MIN is something like
1960 0x8000000000000000 which will be exact. NWC */
1963 SvUV_set(sv, U_V(SvNVX(sv)));
1965 (SvNVX(sv) == (NV) SvUVX(sv))
1966 #ifndef NV_PRESERVES_UV
1967 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1968 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1969 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1970 /* Don't flag it as "accurately an integer" if the number
1971 came from a (by definition imprecise) NV operation, and
1972 we're outside the range of NV integer precision */
1977 DEBUG_c(PerlIO_printf(Perl_debug_log,
1978 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1984 else if (SvPOKp(sv) && SvLEN(sv)) {
1986 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1987 /* We want to avoid a possible problem when we cache an IV/ a UV which
1988 may be later translated to an NV, and the resulting NV is not
1989 the same as the direct translation of the initial string
1990 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1991 be careful to ensure that the value with the .456 is around if the
1992 NV value is requested in the future).
1994 This means that if we cache such an IV/a UV, we need to cache the
1995 NV as well. Moreover, we trade speed for space, and do not
1996 cache the NV if we are sure it's not needed.
1999 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2000 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2001 == IS_NUMBER_IN_UV) {
2002 /* It's definitely an integer, only upgrade to PVIV */
2003 if (SvTYPE(sv) < SVt_PVIV)
2004 sv_upgrade(sv, SVt_PVIV);
2006 } else if (SvTYPE(sv) < SVt_PVNV)
2007 sv_upgrade(sv, SVt_PVNV);
2009 /* If NVs preserve UVs then we only use the UV value if we know that
2010 we aren't going to call atof() below. If NVs don't preserve UVs
2011 then the value returned may have more precision than atof() will
2012 return, even though value isn't perfectly accurate. */
2013 if ((numtype & (IS_NUMBER_IN_UV
2014 #ifdef NV_PRESERVES_UV
2017 )) == IS_NUMBER_IN_UV) {
2018 /* This won't turn off the public IOK flag if it was set above */
2019 (void)SvIOKp_on(sv);
2021 if (!(numtype & IS_NUMBER_NEG)) {
2023 if (value <= (UV)IV_MAX) {
2024 SvIV_set(sv, (IV)value);
2026 /* it didn't overflow, and it was positive. */
2027 SvUV_set(sv, value);
2031 /* 2s complement assumption */
2032 if (value <= (UV)IV_MIN) {
2033 SvIV_set(sv, -(IV)value);
2035 /* Too negative for an IV. This is a double upgrade, but
2036 I'm assuming it will be rare. */
2037 if (SvTYPE(sv) < SVt_PVNV)
2038 sv_upgrade(sv, SVt_PVNV);
2042 SvNV_set(sv, -(NV)value);
2043 SvIV_set(sv, IV_MIN);
2047 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2048 will be in the previous block to set the IV slot, and the next
2049 block to set the NV slot. So no else here. */
2051 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2052 != IS_NUMBER_IN_UV) {
2053 /* It wasn't an (integer that doesn't overflow the UV). */
2054 SvNV_set(sv, Atof(SvPVX_const(sv)));
2056 if (! numtype && ckWARN(WARN_NUMERIC))
2059 #if defined(USE_LONG_DOUBLE)
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2067 #ifdef NV_PRESERVES_UV
2068 (void)SvIOKp_on(sv);
2070 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2071 SvIV_set(sv, I_V(SvNVX(sv)));
2072 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2075 NOOP; /* Integer is imprecise. NOK, IOKp */
2077 /* UV will not work better than IV */
2079 if (SvNVX(sv) > (NV)UV_MAX) {
2081 /* Integer is inaccurate. NOK, IOKp, is UV */
2082 SvUV_set(sv, UV_MAX);
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2085 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2086 NV preservse UV so can do correct comparison. */
2087 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2090 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2095 #else /* NV_PRESERVES_UV */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2098 /* The IV/UV slot will have been set from value returned by
2099 grok_number above. The NV slot has just been set using
2102 assert (SvIOKp(sv));
2104 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2105 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2106 /* Small enough to preserve all bits. */
2107 (void)SvIOKp_on(sv);
2109 SvIV_set(sv, I_V(SvNVX(sv)));
2110 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2112 /* Assumption: first non-preserved integer is < IV_MAX,
2113 this NV is in the preserved range, therefore: */
2114 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2116 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2120 0 0 already failed to read UV.
2121 0 1 already failed to read UV.
2122 1 0 you won't get here in this case. IV/UV
2123 slot set, public IOK, Atof() unneeded.
2124 1 1 already read UV.
2125 so there's no point in sv_2iuv_non_preserve() attempting
2126 to use atol, strtol, strtoul etc. */
2127 sv_2iuv_non_preserve (sv, numtype);
2130 #endif /* NV_PRESERVES_UV */
2134 if (isGV_with_GP(sv))
2135 return glob_2number((GV *)sv);
2137 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2138 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2141 if (SvTYPE(sv) < SVt_IV)
2142 /* Typically the caller expects that sv_any is not NULL now. */
2143 sv_upgrade(sv, SVt_IV);
2144 /* Return 0 from the caller. */
2151 =for apidoc sv_2iv_flags
2153 Return the integer value of an SV, doing any necessary string
2154 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2155 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2161 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2166 if (SvGMAGICAL(sv)) {
2167 if (flags & SV_GMAGIC)
2172 return I_V(SvNVX(sv));
2174 if (SvPOKp(sv) && SvLEN(sv)) {
2177 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == IS_NUMBER_IN_UV) {
2181 /* It's definitely an integer */
2182 if (numtype & IS_NUMBER_NEG) {
2183 if (value < (UV)IV_MIN)
2186 if (value < (UV)IV_MAX)
2191 if (ckWARN(WARN_NUMERIC))
2194 return I_V(Atof(SvPVX_const(sv)));
2199 assert(SvTYPE(sv) >= SVt_PVMG);
2200 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2201 } else if (SvTHINKFIRST(sv)) {
2205 SV * const tmpstr=AMG_CALLun(sv,numer);
2206 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207 return SvIV(tmpstr);
2210 return PTR2IV(SvRV(sv));
2213 sv_force_normal_flags(sv, 0);
2215 if (SvREADONLY(sv) && !SvOK(sv)) {
2216 if (ckWARN(WARN_UNINITIALIZED))
2222 if (S_sv_2iuv_common(aTHX_ sv))
2225 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226 PTR2UV(sv),SvIVX(sv)));
2227 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2231 =for apidoc sv_2uv_flags
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2246 if (SvGMAGICAL(sv)) {
2247 if (flags & SV_GMAGIC)
2252 return U_V(SvNVX(sv));
2253 if (SvPOKp(sv) && SvLEN(sv)) {
2256 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2258 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2259 == IS_NUMBER_IN_UV) {
2260 /* It's definitely an integer */
2261 if (!(numtype & IS_NUMBER_NEG))
2265 if (ckWARN(WARN_NUMERIC))
2268 return U_V(Atof(SvPVX_const(sv)));
2273 assert(SvTYPE(sv) >= SVt_PVMG);
2274 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2275 } else if (SvTHINKFIRST(sv)) {
2279 SV *const tmpstr = AMG_CALLun(sv,numer);
2280 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2281 return SvUV(tmpstr);
2284 return PTR2UV(SvRV(sv));
2287 sv_force_normal_flags(sv, 0);
2289 if (SvREADONLY(sv) && !SvOK(sv)) {
2290 if (ckWARN(WARN_UNINITIALIZED))
2296 if (S_sv_2iuv_common(aTHX_ sv))
2300 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2301 PTR2UV(sv),SvUVX(sv)));
2302 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2308 Return the num value of an SV, doing any necessary string or integer
2309 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2316 Perl_sv_2nv(pTHX_ register SV *sv)
2321 if (SvGMAGICAL(sv)) {
2325 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2326 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2327 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2329 return Atof(SvPVX_const(sv));
2333 return (NV)SvUVX(sv);
2335 return (NV)SvIVX(sv);
2340 assert(SvTYPE(sv) >= SVt_PVMG);
2341 /* This falls through to the report_uninit near the end of the
2343 } else if (SvTHINKFIRST(sv)) {
2347 SV *const tmpstr = AMG_CALLun(sv,numer);
2348 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2349 return SvNV(tmpstr);
2352 return PTR2NV(SvRV(sv));
2355 sv_force_normal_flags(sv, 0);
2357 if (SvREADONLY(sv) && !SvOK(sv)) {
2358 if (ckWARN(WARN_UNINITIALIZED))
2363 if (SvTYPE(sv) < SVt_NV) {
2364 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2365 sv_upgrade(sv, SVt_NV);
2366 #ifdef USE_LONG_DOUBLE
2368 STORE_NUMERIC_LOCAL_SET_STANDARD();
2369 PerlIO_printf(Perl_debug_log,
2370 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2371 PTR2UV(sv), SvNVX(sv));
2372 RESTORE_NUMERIC_LOCAL();
2376 STORE_NUMERIC_LOCAL_SET_STANDARD();
2377 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2378 PTR2UV(sv), SvNVX(sv));
2379 RESTORE_NUMERIC_LOCAL();
2383 else if (SvTYPE(sv) < SVt_PVNV)
2384 sv_upgrade(sv, SVt_PVNV);
2389 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2390 #ifdef NV_PRESERVES_UV
2393 /* Only set the public NV OK flag if this NV preserves the IV */
2394 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2395 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2396 : (SvIVX(sv) == I_V(SvNVX(sv))))
2402 else if (SvPOKp(sv) && SvLEN(sv)) {
2404 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2405 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2407 #ifdef NV_PRESERVES_UV
2408 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2409 == IS_NUMBER_IN_UV) {
2410 /* It's definitely an integer */
2411 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 SvNV_set(sv, Atof(SvPVX_const(sv)));
2417 /* Only set the public NV OK flag if this NV preserves the value in
2418 the PV at least as well as an IV/UV would.
2419 Not sure how to do this 100% reliably. */
2420 /* if that shift count is out of range then Configure's test is
2421 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2423 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2424 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2425 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2426 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2427 /* Can't use strtol etc to convert this string, so don't try.
2428 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2431 /* value has been set. It may not be precise. */
2432 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2433 /* 2s complement assumption for (UV)IV_MIN */
2434 SvNOK_on(sv); /* Integer is too negative. */
2439 if (numtype & IS_NUMBER_NEG) {
2440 SvIV_set(sv, -(IV)value);
2441 } else if (value <= (UV)IV_MAX) {
2442 SvIV_set(sv, (IV)value);
2444 SvUV_set(sv, value);
2448 if (numtype & IS_NUMBER_NOT_INT) {
2449 /* I believe that even if the original PV had decimals,
2450 they are lost beyond the limit of the FP precision.
2451 However, neither is canonical, so both only get p
2452 flags. NWC, 2000/11/25 */
2453 /* Both already have p flags, so do nothing */
2455 const NV nv = SvNVX(sv);
2456 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2457 if (SvIVX(sv) == I_V(nv)) {
2460 /* It had no "." so it must be integer. */
2464 /* between IV_MAX and NV(UV_MAX).
2465 Could be slightly > UV_MAX */
2467 if (numtype & IS_NUMBER_NOT_INT) {
2468 /* UV and NV both imprecise. */
2470 const UV nv_as_uv = U_V(nv);
2472 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2481 #endif /* NV_PRESERVES_UV */
2484 if (isGV_with_GP(sv)) {
2485 glob_2number((GV *)sv);
2489 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2491 assert (SvTYPE(sv) >= SVt_NV);
2492 /* Typically the caller expects that sv_any is not NULL now. */
2493 /* XXX Ilya implies that this is a bug in callers that assume this
2494 and ideally should be fixed. */
2497 #if defined(USE_LONG_DOUBLE)
2499 STORE_NUMERIC_LOCAL_SET_STANDARD();
2500 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2501 PTR2UV(sv), SvNVX(sv));
2502 RESTORE_NUMERIC_LOCAL();
2506 STORE_NUMERIC_LOCAL_SET_STANDARD();
2507 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2508 PTR2UV(sv), SvNVX(sv));
2509 RESTORE_NUMERIC_LOCAL();
2515 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2516 * UV as a string towards the end of buf, and return pointers to start and
2519 * We assume that buf is at least TYPE_CHARS(UV) long.
2523 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2525 char *ptr = buf + TYPE_CHARS(UV);
2526 char * const ebuf = ptr;
2539 *--ptr = '0' + (char)(uv % 10);
2547 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2548 * a regexp to its stringified form.
2552 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2554 const regexp * const re = (regexp *)mg->mg_obj;
2557 const char *fptr = "msix";
2562 bool need_newline = 0;
2563 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2565 while((ch = *fptr++)) {
2567 reflags[left++] = ch;
2570 reflags[right--] = ch;
2575 reflags[left] = '-';
2579 mg->mg_len = re->prelen + 4 + left;
2581 * If /x was used, we have to worry about a regex ending with a
2582 * comment later being embedded within another regex. If so, we don't
2583 * want this regex's "commentization" to leak out to the right part of
2584 * the enclosing regex, we must cap it with a newline.
2586 * So, if /x was used, we scan backwards from the end of the regex. If
2587 * we find a '#' before we find a newline, we need to add a newline
2588 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2589 * we don't need to add anything. -jfriedl
2591 if (PMf_EXTENDED & re->reganch) {
2592 const char *endptr = re->precomp + re->prelen;
2593 while (endptr >= re->precomp) {
2594 const char c = *(endptr--);
2596 break; /* don't need another */
2598 /* we end while in a comment, so we need a newline */
2599 mg->mg_len++; /* save space for it */
2600 need_newline = 1; /* note to add it */
2606 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2607 mg->mg_ptr[0] = '(';
2608 mg->mg_ptr[1] = '?';
2609 Copy(reflags, mg->mg_ptr+2, left, char);
2610 *(mg->mg_ptr+left+2) = ':';
2611 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2613 mg->mg_ptr[mg->mg_len - 2] = '\n';
2614 mg->mg_ptr[mg->mg_len - 1] = ')';
2615 mg->mg_ptr[mg->mg_len] = 0;
2617 PL_reginterp_cnt += re->program[0].next_off;
2619 if (re->reganch & ROPT_UTF8)
2629 =for apidoc sv_2pv_flags
2631 Returns a pointer to the string value of an SV, and sets *lp to its length.
2632 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2634 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2635 usually end up here too.
2641 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2651 if (SvGMAGICAL(sv)) {
2652 if (flags & SV_GMAGIC)
2657 if (flags & SV_MUTABLE_RETURN)
2658 return SvPVX_mutable(sv);
2659 if (flags & SV_CONST_RETURN)
2660 return (char *)SvPVX_const(sv);
2663 if (SvIOKp(sv) || SvNOKp(sv)) {
2664 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2669 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2670 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2672 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2679 #ifdef FIXNEGATIVEZERO
2680 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2686 SvUPGRADE(sv, SVt_PV);
2689 s = SvGROW_mutable(sv, len + 1);
2692 return (char*)memcpy(s, tbuf, len + 1);
2698 assert(SvTYPE(sv) >= SVt_PVMG);
2699 /* This falls through to the report_uninit near the end of the
2701 } else if (SvTHINKFIRST(sv)) {
2705 SV *const tmpstr = AMG_CALLun(sv,string);
2706 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2708 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2712 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2713 if (flags & SV_CONST_RETURN) {
2714 pv = (char *) SvPVX_const(tmpstr);
2716 pv = (flags & SV_MUTABLE_RETURN)
2717 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2720 *lp = SvCUR(tmpstr);
2722 pv = sv_2pv_flags(tmpstr, lp, flags);
2734 const SV *const referent = (SV*)SvRV(sv);
2737 tsv = sv_2mortal(newSVpvs("NULLREF"));
2738 } else if (SvTYPE(referent) == SVt_PVMG
2739 && ((SvFLAGS(referent) &
2740 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2741 == (SVs_OBJECT|SVs_SMG))
2742 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2743 return stringify_regexp(sv, mg, lp);
2745 const char *const typestr = sv_reftype(referent, 0);
2747 tsv = sv_newmortal();
2748 if (SvOBJECT(referent)) {
2749 const char *const name = HvNAME_get(SvSTASH(referent));
2750 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2751 name ? name : "__ANON__" , typestr,
2755 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2763 if (SvREADONLY(sv) && !SvOK(sv)) {
2764 if (ckWARN(WARN_UNINITIALIZED))
2771 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2772 /* I'm assuming that if both IV and NV are equally valid then
2773 converting the IV is going to be more efficient */
2774 const U32 isIOK = SvIOK(sv);
2775 const U32 isUIOK = SvIsUV(sv);
2776 char buf[TYPE_CHARS(UV)];
2779 if (SvTYPE(sv) < SVt_PVIV)
2780 sv_upgrade(sv, SVt_PVIV);
2781 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2782 /* inlined from sv_setpvn */
2783 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2784 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2785 SvCUR_set(sv, ebuf - ptr);
2795 else if (SvNOKp(sv)) {
2796 const int olderrno = errno;
2797 if (SvTYPE(sv) < SVt_PVNV)
2798 sv_upgrade(sv, SVt_PVNV);
2799 /* The +20 is pure guesswork. Configure test needed. --jhi */
2800 s = SvGROW_mutable(sv, NV_DIG + 20);
2801 /* some Xenix systems wipe out errno here */
2803 if (SvNVX(sv) == 0.0)
2804 my_strlcpy(s, "0", SvLEN(sv));
2808 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2811 #ifdef FIXNEGATIVEZERO
2812 if (*s == '-' && s[1] == '0' && !s[2])
2813 my_strlcpy(s, "0", SvLEN(s));
2822 if (isGV_with_GP(sv))
2823 return glob_2pv((GV *)sv, lp);
2825 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2829 if (SvTYPE(sv) < SVt_PV)
2830 /* Typically the caller expects that sv_any is not NULL now. */
2831 sv_upgrade(sv, SVt_PV);
2835 const STRLEN len = s - SvPVX_const(sv);
2841 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2842 PTR2UV(sv),SvPVX_const(sv)));
2843 if (flags & SV_CONST_RETURN)
2844 return (char *)SvPVX_const(sv);
2845 if (flags & SV_MUTABLE_RETURN)
2846 return SvPVX_mutable(sv);
2851 =for apidoc sv_copypv
2853 Copies a stringified representation of the source SV into the
2854 destination SV. Automatically performs any necessary mg_get and
2855 coercion of numeric values into strings. Guaranteed to preserve
2856 UTF-8 flag even from overloaded objects. Similar in nature to
2857 sv_2pv[_flags] but operates directly on an SV instead of just the
2858 string. Mostly uses sv_2pv_flags to do its work, except when that
2859 would lose the UTF-8'ness of the PV.
2865 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2868 const char * const s = SvPV_const(ssv,len);
2869 sv_setpvn(dsv,s,len);
2877 =for apidoc sv_2pvbyte
2879 Return a pointer to the byte-encoded representation of the SV, and set *lp
2880 to its length. May cause the SV to be downgraded from UTF-8 as a
2883 Usually accessed via the C<SvPVbyte> macro.
2889 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2891 sv_utf8_downgrade(sv,0);
2892 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2896 =for apidoc sv_2pvutf8
2898 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2899 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2901 Usually accessed via the C<SvPVutf8> macro.
2907 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2909 sv_utf8_upgrade(sv);
2910 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2915 =for apidoc sv_2bool
2917 This function is only called on magical items, and is only used by
2918 sv_true() or its macro equivalent.
2924 Perl_sv_2bool(pTHX_ register SV *sv)
2933 SV * const tmpsv = AMG_CALLun(sv,bool_);
2934 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2935 return (bool)SvTRUE(tmpsv);
2937 return SvRV(sv) != 0;
2940 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2942 (*sv->sv_u.svu_pv > '0' ||
2943 Xpvtmp->xpv_cur > 1 ||
2944 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2951 return SvIVX(sv) != 0;
2954 return SvNVX(sv) != 0.0;
2956 if (isGV_with_GP(sv))
2966 =for apidoc sv_utf8_upgrade
2968 Converts the PV of an SV to its UTF-8-encoded form.
2969 Forces the SV to string form if it is not already.
2970 Always sets the SvUTF8 flag to avoid future validity checks even
2971 if all the bytes have hibit clear.
2973 This is not as a general purpose byte encoding to Unicode interface:
2974 use the Encode extension for that.
2976 =for apidoc sv_utf8_upgrade_flags
2978 Converts the PV of an SV to its UTF-8-encoded form.
2979 Forces the SV to string form if it is not already.
2980 Always sets the SvUTF8 flag to avoid future validity checks even
2981 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2982 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2983 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2985 This is not as a general purpose byte encoding to Unicode interface:
2986 use the Encode extension for that.
2992 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2995 if (sv == &PL_sv_undef)
2999 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3000 (void) sv_2pv_flags(sv,&len, flags);
3004 (void) SvPV_force(sv,len);
3013 sv_force_normal_flags(sv, 0);
3016 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3017 sv_recode_to_utf8(sv, PL_encoding);
3018 else { /* Assume Latin-1/EBCDIC */
3019 /* This function could be much more efficient if we
3020 * had a FLAG in SVs to signal if there are any hibit
3021 * chars in the PV. Given that there isn't such a flag
3022 * make the loop as fast as possible. */
3023 const U8 * const s = (U8 *) SvPVX_const(sv);
3024 const U8 * const e = (U8 *) SvEND(sv);
3029 /* Check for hi bit */
3030 if (!NATIVE_IS_INVARIANT(ch)) {
3031 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3032 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3034 SvPV_free(sv); /* No longer using what was there before. */
3035 SvPV_set(sv, (char*)recoded);
3036 SvCUR_set(sv, len - 1);
3037 SvLEN_set(sv, len); /* No longer know the real size. */
3041 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3048 =for apidoc sv_utf8_downgrade
3050 Attempts to convert the PV of an SV from characters to bytes.
3051 If the PV contains a character beyond byte, this conversion will fail;
3052 in this case, either returns false or, if C<fail_ok> is not
3055 This is not as a general purpose Unicode to byte encoding interface:
3056 use the Encode extension for that.
3062 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3065 if (SvPOKp(sv) && SvUTF8(sv)) {
3071 sv_force_normal_flags(sv, 0);
3073 s = (U8 *) SvPV(sv, len);
3074 if (!utf8_to_bytes(s, &len)) {
3079 Perl_croak(aTHX_ "Wide character in %s",
3082 Perl_croak(aTHX_ "Wide character");
3093 =for apidoc sv_utf8_encode
3095 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3096 flag off so that it looks like octets again.
3102 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3105 sv_force_normal_flags(sv, 0);
3107 if (SvREADONLY(sv)) {
3108 Perl_croak(aTHX_ PL_no_modify);
3110 (void) sv_utf8_upgrade(sv);
3115 =for apidoc sv_utf8_decode
3117 If the PV of the SV is an octet sequence in UTF-8
3118 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3119 so that it looks like a character. If the PV contains only single-byte
3120 characters, the C<SvUTF8> flag stays being off.
3121 Scans PV for validity and returns false if the PV is invalid UTF-8.
3127 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3133 /* The octets may have got themselves encoded - get them back as
3136 if (!sv_utf8_downgrade(sv, TRUE))
3139 /* it is actually just a matter of turning the utf8 flag on, but
3140 * we want to make sure everything inside is valid utf8 first.
3142 c = (const U8 *) SvPVX_const(sv);
3143 if (!is_utf8_string(c, SvCUR(sv)+1))
3145 e = (const U8 *) SvEND(sv);
3148 if (!UTF8_IS_INVARIANT(ch)) {
3158 =for apidoc sv_setsv
3160 Copies the contents of the source SV C<ssv> into the destination SV
3161 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3162 function if the source SV needs to be reused. Does not handle 'set' magic.
3163 Loosely speaking, it performs a copy-by-value, obliterating any previous
3164 content of the destination.
3166 You probably want to use one of the assortment of wrappers, such as
3167 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3168 C<SvSetMagicSV_nosteal>.
3170 =for apidoc sv_setsv_flags
3172 Copies the contents of the source SV C<ssv> into the destination SV
3173 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3174 function if the source SV needs to be reused. Does not handle 'set' magic.
3175 Loosely speaking, it performs a copy-by-value, obliterating any previous
3176 content of the destination.
3177 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3178 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3179 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3180 and C<sv_setsv_nomg> are implemented in terms of this function.
3182 You probably want to use one of the assortment of wrappers, such as
3183 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3184 C<SvSetMagicSV_nosteal>.
3186 This is the primary function for copying scalars, and most other
3187 copy-ish functions and macros use this underneath.
3193 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3195 if (dtype != SVt_PVGV) {
3196 const char * const name = GvNAME(sstr);
3197 const STRLEN len = GvNAMELEN(sstr);
3198 /* don't upgrade SVt_PVLV: it can hold a glob */
3199 if (dtype != SVt_PVLV) {
3200 if (dtype >= SVt_PV) {
3206 sv_upgrade(dstr, SVt_PVGV);
3207 (void)SvOK_off(dstr);
3210 GvSTASH(dstr) = GvSTASH(sstr);
3212 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3213 gv_name_set((GV *)dstr, name, len, GV_ADD);
3214 SvFAKE_on(dstr); /* can coerce to non-glob */
3217 #ifdef GV_UNIQUE_CHECK
3218 if (GvUNIQUE((GV*)dstr)) {
3219 Perl_croak(aTHX_ PL_no_modify);
3225 (void)SvOK_off(dstr);
3227 GvINTRO_off(dstr); /* one-shot flag */
3228 GvGP(dstr) = gp_ref(GvGP(sstr));
3229 if (SvTAINTED(sstr))
3231 if (GvIMPORTED(dstr) != GVf_IMPORTED
3232 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3234 GvIMPORTED_on(dstr);
3241 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3242 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3244 const int intro = GvINTRO(dstr);
3247 const U32 stype = SvTYPE(sref);
3250 #ifdef GV_UNIQUE_CHECK
3251 if (GvUNIQUE((GV*)dstr)) {
3252 Perl_croak(aTHX_ PL_no_modify);
3257 GvINTRO_off(dstr); /* one-shot flag */
3258 GvLINE(dstr) = CopLINE(PL_curcop);
3259 GvEGV(dstr) = (GV*)dstr;
3264 location = (SV **) &GvCV(dstr);
3265 import_flag = GVf_IMPORTED_CV;
3268 location = (SV **) &GvHV(dstr);
3269 import_flag = GVf_IMPORTED_HV;
3272 location = (SV **) &GvAV(dstr);
3273 import_flag = GVf_IMPORTED_AV;
3276 location = (SV **) &GvIOp(dstr);
3279 location = (SV **) &GvFORM(dstr);
3281 location = &GvSV(dstr);
3282 import_flag = GVf_IMPORTED_SV;
3285 if (stype == SVt_PVCV) {
3286 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3287 SvREFCNT_dec(GvCV(dstr));
3289 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3290 PL_sub_generation++;
3293 SAVEGENERICSV(*location);
3297 if (stype == SVt_PVCV && *location != sref) {
3298 CV* const cv = (CV*)*location;
3300 if (!GvCVGEN((GV*)dstr) &&
3301 (CvROOT(cv) || CvXSUB(cv)))
3303 /* Redefining a sub - warning is mandatory if
3304 it was a const and its value changed. */
3305 if (CvCONST(cv) && CvCONST((CV*)sref)
3306 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3308 /* They are 2 constant subroutines generated from
3309 the same constant. This probably means that
3310 they are really the "same" proxy subroutine
3311 instantiated in 2 places. Most likely this is
3312 when a constant is exported twice. Don't warn.
3315 else if (ckWARN(WARN_REDEFINE)
3317 && (!CvCONST((CV*)sref)
3318 || sv_cmp(cv_const_sv(cv),
3319 cv_const_sv((CV*)sref))))) {
3320 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3323 ? "Constant subroutine %s::%s redefined"
3324 : "Subroutine %s::%s redefined"),
3325 HvNAME_get(GvSTASH((GV*)dstr)),
3326 GvENAME((GV*)dstr));
3330 cv_ckproto_len(cv, (GV*)dstr,
3331 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3332 SvPOK(sref) ? SvCUR(sref) : 0);
3334 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3335 GvASSUMECV_on(dstr);
3336 PL_sub_generation++;
3339 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3340 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3341 GvFLAGS(dstr) |= import_flag;
3346 if (SvTAINTED(sstr))
3352 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3355 register U32 sflags;
3357 register svtype stype;
3361 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3363 sstr = &PL_sv_undef;
3364 stype = SvTYPE(sstr);
3365 dtype = SvTYPE(dstr);
3370 /* need to nuke the magic */
3372 SvRMAGICAL_off(dstr);
3375 /* There's a lot of redundancy below but we're going for speed here */
3380 if (dtype != SVt_PVGV) {
3381 (void)SvOK_off(dstr);
3389 sv_upgrade(dstr, SVt_IV);
3394 sv_upgrade(dstr, SVt_PVIV);
3397 (void)SvIOK_only(dstr);
3398 SvIV_set(dstr, SvIVX(sstr));
3401 /* SvTAINTED can only be true if the SV has taint magic, which in
3402 turn means that the SV type is PVMG (or greater). This is the
3403 case statement for SVt_IV, so this cannot be true (whatever gcov
3405 assert(!SvTAINTED(sstr));
3415 sv_upgrade(dstr, SVt_NV);
3420 sv_upgrade(dstr, SVt_PVNV);
3423 SvNV_set(dstr, SvNVX(sstr));
3424 (void)SvNOK_only(dstr);
3425 /* SvTAINTED can only be true if the SV has taint magic, which in
3426 turn means that the SV type is PVMG (or greater). This is the
3427 case statement for SVt_NV, so this cannot be true (whatever gcov
3429 assert(!SvTAINTED(sstr));
3436 sv_upgrade(dstr, SVt_RV);
3439 #ifdef PERL_OLD_COPY_ON_WRITE
3440 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3449 sv_upgrade(dstr, SVt_PV);
3452 if (dtype < SVt_PVIV)
3453 sv_upgrade(dstr, SVt_PVIV);
3456 if (dtype < SVt_PVNV)
3457 sv_upgrade(dstr, SVt_PVNV);
3461 const char * const type = sv_reftype(sstr,0);
3463 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3465 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3470 if (dtype <= SVt_PVGV) {
3471 glob_assign_glob(dstr, sstr, dtype);
3479 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3481 if (SvTYPE(sstr) != stype) {
3482 stype = SvTYPE(sstr);
3483 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3484 glob_assign_glob(dstr, sstr, dtype);
3489 if (stype == SVt_PVLV)
3490 SvUPGRADE(dstr, SVt_PVNV);
3492 SvUPGRADE(dstr, (svtype)stype);
3495 /* dstr may have been upgraded. */
3496 dtype = SvTYPE(dstr);
3497 sflags = SvFLAGS(sstr);
3499 if (sflags & SVf_ROK) {
3500 if (dtype == SVt_PVGV &&
3501 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3504 if (GvIMPORTED(dstr) != GVf_IMPORTED
3505 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3507 GvIMPORTED_on(dstr);
3512 glob_assign_glob(dstr, sstr, dtype);
3516 if (dtype >= SVt_PV) {
3517 if (dtype == SVt_PVGV) {
3518 glob_assign_ref(dstr, sstr);
3521 if (SvPVX_const(dstr)) {
3527 (void)SvOK_off(dstr);
3528 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3529 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3530 assert(!(sflags & SVp_NOK));
3531 assert(!(sflags & SVp_IOK));
3532 assert(!(sflags & SVf_NOK));
3533 assert(!(sflags & SVf_IOK));
3535 else if (dtype == SVt_PVGV) {
3536 if (!(sflags & SVf_OK)) {
3537 if (ckWARN(WARN_MISC))
3538 Perl_warner(aTHX_ packWARN(WARN_MISC),
3539 "Undefined value assigned to typeglob");
3542 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3543 if (dstr != (SV*)gv) {
3546 GvGP(dstr) = gp_ref(GvGP(gv));
3550 else if (sflags & SVp_POK) {
3554 * Check to see if we can just swipe the string. If so, it's a
3555 * possible small lose on short strings, but a big win on long ones.
3556 * It might even be a win on short strings if SvPVX_const(dstr)
3557 * has to be allocated and SvPVX_const(sstr) has to be freed.
3560 /* Whichever path we take through the next code, we want this true,
3561 and doing it now facilitates the COW check. */
3562 (void)SvPOK_only(dstr);
3565 /* We're not already COW */
3566 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3567 #ifndef PERL_OLD_COPY_ON_WRITE
3568 /* or we are, but dstr isn't a suitable target. */
3569 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3574 (sflags & SVs_TEMP) && /* slated for free anyway? */
3575 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3576 (!(flags & SV_NOSTEAL)) &&
3577 /* and we're allowed to steal temps */
3578 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3579 SvLEN(sstr) && /* and really is a string */
3580 /* and won't be needed again, potentially */
3581 !(PL_op && PL_op->op_type == OP_AASSIGN))
3582 #ifdef PERL_OLD_COPY_ON_WRITE
3583 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3584 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3585 && SvTYPE(sstr) >= SVt_PVIV)
3588 /* Failed the swipe test, and it's not a shared hash key either.
3589 Have to copy the string. */
3590 STRLEN len = SvCUR(sstr);
3591 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3592 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3593 SvCUR_set(dstr, len);
3594 *SvEND(dstr) = '\0';
3596 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3598 /* Either it's a shared hash key, or it's suitable for
3599 copy-on-write or we can swipe the string. */
3601 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3605 #ifdef PERL_OLD_COPY_ON_WRITE
3607 /* I believe I should acquire a global SV mutex if
3608 it's a COW sv (not a shared hash key) to stop
3609 it going un copy-on-write.
3610 If the source SV has gone un copy on write between up there
3611 and down here, then (assert() that) it is of the correct
3612 form to make it copy on write again */
3613 if ((sflags & (SVf_FAKE | SVf_READONLY))
3614 != (SVf_FAKE | SVf_READONLY)) {
3615 SvREADONLY_on(sstr);
3617 /* Make the source SV into a loop of 1.
3618 (about to become 2) */
3619 SV_COW_NEXT_SV_SET(sstr, sstr);
3623 /* Initial code is common. */
3624 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3629 /* making another shared SV. */
3630 STRLEN cur = SvCUR(sstr);
3631 STRLEN len = SvLEN(sstr);
3632 #ifdef PERL_OLD_COPY_ON_WRITE
3634 assert (SvTYPE(dstr) >= SVt_PVIV);
3635 /* SvIsCOW_normal */
3636 /* splice us in between source and next-after-source. */
3637 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3638 SV_COW_NEXT_SV_SET(sstr, dstr);
3639 SvPV_set(dstr, SvPVX_mutable(sstr));
3643 /* SvIsCOW_shared_hash */
3644 DEBUG_C(PerlIO_printf(Perl_debug_log,
3645 "Copy on write: Sharing hash\n"));
3647 assert (SvTYPE(dstr) >= SVt_PV);
3649 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3651 SvLEN_set(dstr, len);
3652 SvCUR_set(dstr, cur);
3653 SvREADONLY_on(dstr);
3655 /* Relesase a global SV mutex. */
3658 { /* Passes the swipe test. */
3659 SvPV_set(dstr, SvPVX_mutable(sstr));
3660 SvLEN_set(dstr, SvLEN(sstr));
3661 SvCUR_set(dstr, SvCUR(sstr));
3664 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3665 SvPV_set(sstr, NULL);
3671 if (sflags & SVp_NOK) {
3672 SvNV_set(dstr, SvNVX(sstr));
3674 if (sflags & SVp_IOK) {
3675 SvRELEASE_IVX(dstr);
3676 SvIV_set(dstr, SvIVX(sstr));
3677 /* Must do this otherwise some other overloaded use of 0x80000000
3678 gets confused. I guess SVpbm_VALID */
3679 if (sflags & SVf_IVisUV)
3682 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3685 const MAGIC * const smg = SvVSTRING_mg(sstr);
3687 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3688 smg->mg_ptr, smg->mg_len);
3689 SvRMAGICAL_on(dstr);
3693 else if (sflags & (SVp_IOK|SVp_NOK)) {
3694 (void)SvOK_off(dstr);
3695 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3697 if (sflags & SVp_IOK) {
3698 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3699 SvIV_set(dstr, SvIVX(sstr));
3701 if (sflags & SVp_NOK) {
3702 SvNV_set(dstr, SvNVX(sstr));
3706 if (isGV_with_GP(sstr)) {
3707 /* This stringification rule for globs is spread in 3 places.
3708 This feels bad. FIXME. */
3709 const U32 wasfake = sflags & SVf_FAKE;
3711 /* FAKE globs can get coerced, so need to turn this off
3712 temporarily if it is on. */
3714 gv_efullname3(dstr, (GV *)sstr, "*");
3715 SvFLAGS(sstr) |= wasfake;
3716 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3719 (void)SvOK_off(dstr);
3721 if (SvTAINTED(sstr))
3726 =for apidoc sv_setsv_mg
3728 Like C<sv_setsv>, but also handles 'set' magic.
3734 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3736 sv_setsv(dstr,sstr);
3740 #ifdef PERL_OLD_COPY_ON_WRITE
3742 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3744 STRLEN cur = SvCUR(sstr);
3745 STRLEN len = SvLEN(sstr);
3746 register char *new_pv;
3749 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3757 if (SvTHINKFIRST(dstr))
3758 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3759 else if (SvPVX_const(dstr))
3760 Safefree(SvPVX_const(dstr));
3764 SvUPGRADE(dstr, SVt_PVIV);
3766 assert (SvPOK(sstr));
3767 assert (SvPOKp(sstr));
3768 assert (!SvIOK(sstr));
3769 assert (!SvIOKp(sstr));
3770 assert (!SvNOK(sstr));
3771 assert (!SvNOKp(sstr));
3773 if (SvIsCOW(sstr)) {
3775 if (SvLEN(sstr) == 0) {
3776 /* source is a COW shared hash key. */
3777 DEBUG_C(PerlIO_printf(Perl_debug_log,
3778 "Fast copy on write: Sharing hash\n"));
3779 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3782 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3784 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3785 SvUPGRADE(sstr, SVt_PVIV);
3786 SvREADONLY_on(sstr);
3788 DEBUG_C(PerlIO_printf(Perl_debug_log,
3789 "Fast copy on write: Converting sstr to COW\n"));
3790 SV_COW_NEXT_SV_SET(dstr, sstr);
3792 SV_COW_NEXT_SV_SET(sstr, dstr);
3793 new_pv = SvPVX_mutable(sstr);
3796 SvPV_set(dstr, new_pv);
3797 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3800 SvLEN_set(dstr, len);
3801 SvCUR_set(dstr, cur);
3810 =for apidoc sv_setpvn
3812 Copies a string into an SV. The C<len> parameter indicates the number of
3813 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3814 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3820 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3823 register char *dptr;
3825 SV_CHECK_THINKFIRST_COW_DROP(sv);
3831 /* len is STRLEN which is unsigned, need to copy to signed */
3834 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3836 SvUPGRADE(sv, SVt_PV);
3838 dptr = SvGROW(sv, len + 1);
3839 Move(ptr,dptr,len,char);
3842 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3847 =for apidoc sv_setpvn_mg
3849 Like C<sv_setpvn>, but also handles 'set' magic.
3855 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3857 sv_setpvn(sv,ptr,len);
3862 =for apidoc sv_setpv
3864 Copies a string into an SV. The string must be null-terminated. Does not
3865 handle 'set' magic. See C<sv_setpv_mg>.
3871 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3874 register STRLEN len;
3876 SV_CHECK_THINKFIRST_COW_DROP(sv);
3882 SvUPGRADE(sv, SVt_PV);
3884 SvGROW(sv, len + 1);
3885 Move(ptr,SvPVX(sv),len+1,char);
3887 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3892 =for apidoc sv_setpv_mg
3894 Like C<sv_setpv>, but also handles 'set' magic.
3900 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3907 =for apidoc sv_usepvn_flags
3909 Tells an SV to use C<ptr> to find its string value. Normally the
3910 string is stored inside the SV but sv_usepvn allows the SV to use an
3911 outside string. The C<ptr> should point to memory that was allocated
3912 by C<malloc>. The string length, C<len>, must be supplied. By default
3913 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3914 so that pointer should not be freed or used by the programmer after
3915 giving it to sv_usepvn, and neither should any pointers from "behind"
3916 that pointer (e.g. ptr + 1) be used.
3918 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3919 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3920 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3921 C<len>, and already meets the requirements for storing in C<SvPVX>)
3927 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3931 SV_CHECK_THINKFIRST_COW_DROP(sv);
3932 SvUPGRADE(sv, SVt_PV);
3935 if (flags & SV_SMAGIC)
3939 if (SvPVX_const(sv))
3943 if (flags & SV_HAS_TRAILING_NUL)
3944 assert(ptr[len] == '\0');
3947 allocate = (flags & SV_HAS_TRAILING_NUL)
3948 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3949 if (flags & SV_HAS_TRAILING_NUL) {
3950 /* It's long enough - do nothing.
3951 Specfically Perl_newCONSTSUB is relying on this. */
3954 /* Force a move to shake out bugs in callers. */
3955 char *new_ptr = (char*)safemalloc(allocate);
3956 Copy(ptr, new_ptr, len, char);
3957 PoisonFree(ptr,len,char);
3961 ptr = (char*) saferealloc (ptr, allocate);
3966 SvLEN_set(sv, allocate);
3967 if (!(flags & SV_HAS_TRAILING_NUL)) {
3970 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3972 if (flags & SV_SMAGIC)
3976 #ifdef PERL_OLD_COPY_ON_WRITE
3977 /* Need to do this *after* making the SV normal, as we need the buffer
3978 pointer to remain valid until after we've copied it. If we let go too early,
3979 another thread could invalidate it by unsharing last of the same hash key
3980 (which it can do by means other than releasing copy-on-write Svs)
3981 or by changing the other copy-on-write SVs in the loop. */
3983 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3985 if (len) { /* this SV was SvIsCOW_normal(sv) */
3986 /* we need to find the SV pointing to us. */
3987 SV *current = SV_COW_NEXT_SV(after);
3989 if (current == sv) {
3990 /* The SV we point to points back to us (there were only two of us
3992 Hence other SV is no longer copy on write either. */
3994 SvREADONLY_off(after);
3996 /* We need to follow the pointers around the loop. */
3998 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4001 /* don't loop forever if the structure is bust, and we have
4002 a pointer into a closed loop. */
4003 assert (current != after);
4004 assert (SvPVX_const(current) == pvx);
4006 /* Make the SV before us point to the SV after us. */
4007 SV_COW_NEXT_SV_SET(current, after);
4010 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4015 Perl_sv_release_IVX(pTHX_ register SV *sv)
4018 sv_force_normal_flags(sv, 0);
4024 =for apidoc sv_force_normal_flags
4026 Undo various types of fakery on an SV: if the PV is a shared string, make
4027 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4028 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4029 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4030 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4031 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4032 set to some other value.) In addition, the C<flags> parameter gets passed to
4033 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4034 with flags set to 0.
4040 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4043 #ifdef PERL_OLD_COPY_ON_WRITE
4044 if (SvREADONLY(sv)) {
4045 /* At this point I believe I should acquire a global SV mutex. */
4047 const char * const pvx = SvPVX_const(sv);
4048 const STRLEN len = SvLEN(sv);
4049 const STRLEN cur = SvCUR(sv);
4050 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4052 PerlIO_printf(Perl_debug_log,
4053 "Copy on write: Force normal %ld\n",
4059 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4062 if (flags & SV_COW_DROP_PV) {
4063 /* OK, so we don't need to copy our buffer. */
4066 SvGROW(sv, cur + 1);
4067 Move(pvx,SvPVX(sv),cur,char);
4071 sv_release_COW(sv, pvx, len, next);
4076 else if (IN_PERL_RUNTIME)
4077 Perl_croak(aTHX_ PL_no_modify);
4078 /* At this point I believe that I can drop the global SV mutex. */
4081 if (SvREADONLY(sv)) {
4083 const char * const pvx = SvPVX_const(sv);
4084 const STRLEN len = SvCUR(sv);
4089 SvGROW(sv, len + 1);
4090 Move(pvx,SvPVX(sv),len,char);
4092 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4094 else if (IN_PERL_RUNTIME)
4095 Perl_croak(aTHX_ PL_no_modify);
4099 sv_unref_flags(sv, flags);
4100 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4107 Efficient removal of characters from the beginning of the string buffer.
4108 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4109 the string buffer. The C<ptr> becomes the first character of the adjusted
4110 string. Uses the "OOK hack".
4111 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4112 refer to the same chunk of data.
4118 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4120 register STRLEN delta;
4121 if (!ptr || !SvPOKp(sv))
4123 delta = ptr - SvPVX_const(sv);
4124 SV_CHECK_THINKFIRST(sv);
4125 if (SvTYPE(sv) < SVt_PVIV)
4126 sv_upgrade(sv,SVt_PVIV);
4129 if (!SvLEN(sv)) { /* make copy of shared string */
4130 const char *pvx = SvPVX_const(sv);
4131 const STRLEN len = SvCUR(sv);
4132 SvGROW(sv, len + 1);
4133 Move(pvx,SvPVX(sv),len,char);
4137 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4138 and we do that anyway inside the SvNIOK_off
4140 SvFLAGS(sv) |= SVf_OOK;
4143 SvLEN_set(sv, SvLEN(sv) - delta);
4144 SvCUR_set(sv, SvCUR(sv) - delta);
4145 SvPV_set(sv, SvPVX(sv) + delta);
4146 SvIV_set(sv, SvIVX(sv) + delta);
4150 =for apidoc sv_catpvn
4152 Concatenates the string onto the end of the string which is in the SV. The
4153 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4154 status set, then the bytes appended should be valid UTF-8.
4155 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4157 =for apidoc sv_catpvn_flags
4159 Concatenates the string onto the end of the string which is in the SV. The
4160 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4161 status set, then the bytes appended should be valid UTF-8.
4162 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4163 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4164 in terms of this function.
4170 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4174 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4176 SvGROW(dsv, dlen + slen + 1);
4178 sstr = SvPVX_const(dsv);
4179 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4180 SvCUR_set(dsv, SvCUR(dsv) + slen);
4182 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4184 if (flags & SV_SMAGIC)
4189 =for apidoc sv_catsv
4191 Concatenates the string from SV C<ssv> onto the end of the string in
4192 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4193 not 'set' magic. See C<sv_catsv_mg>.
4195 =for apidoc sv_catsv_flags
4197 Concatenates the string from SV C<ssv> onto the end of the string in
4198 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4199 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4200 and C<sv_catsv_nomg> are implemented in terms of this function.
4205 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4210 const char *spv = SvPV_const(ssv, slen);
4212 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4213 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4214 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4215 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4216 dsv->sv_flags doesn't have that bit set.
4217 Andy Dougherty 12 Oct 2001
4219 const I32 sutf8 = DO_UTF8(ssv);
4222 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4224 dutf8 = DO_UTF8(dsv);
4226 if (dutf8 != sutf8) {
4228 /* Not modifying source SV, so taking a temporary copy. */
4229 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4231 sv_utf8_upgrade(csv);
4232 spv = SvPV_const(csv, slen);
4235 sv_utf8_upgrade_nomg(dsv);
4237 sv_catpvn_nomg(dsv, spv, slen);
4240 if (flags & SV_SMAGIC)
4245 =for apidoc sv_catpv
4247 Concatenates the string onto the end of the string which is in the SV.
4248 If the SV has the UTF-8 status set, then the bytes appended should be
4249 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4254 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4257 register STRLEN len;
4263 junk = SvPV_force(sv, tlen);
4265 SvGROW(sv, tlen + len + 1);
4267 ptr = SvPVX_const(sv);
4268 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4269 SvCUR_set(sv, SvCUR(sv) + len);
4270 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4275 =for apidoc sv_catpv_mg
4277 Like C<sv_catpv>, but also handles 'set' magic.
4283 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4292 Creates a new SV. A non-zero C<len> parameter indicates the number of
4293 bytes of preallocated string space the SV should have. An extra byte for a
4294 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4295 space is allocated.) The reference count for the new SV is set to 1.
4297 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4298 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4299 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4300 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4301 modules supporting older perls.
4307 Perl_newSV(pTHX_ STRLEN len)
4314 sv_upgrade(sv, SVt_PV);
4315 SvGROW(sv, len + 1);
4320 =for apidoc sv_magicext
4322 Adds magic to an SV, upgrading it if necessary. Applies the
4323 supplied vtable and returns a pointer to the magic added.
4325 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4326 In particular, you can add magic to SvREADONLY SVs, and add more than
4327 one instance of the same 'how'.
4329 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4330 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4331 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4332 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4334 (This is now used as a subroutine by C<sv_magic>.)
4339 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4340 const char* name, I32 namlen)
4345 if (SvTYPE(sv) < SVt_PVMG) {
4346 SvUPGRADE(sv, SVt_PVMG);
4348 Newxz(mg, 1, MAGIC);
4349 mg->mg_moremagic = SvMAGIC(sv);
4350 SvMAGIC_set(sv, mg);
4352 /* Sometimes a magic contains a reference loop, where the sv and
4353 object refer to each other. To prevent a reference loop that
4354 would prevent such objects being freed, we look for such loops
4355 and if we find one we avoid incrementing the object refcount.
4357 Note we cannot do this to avoid self-tie loops as intervening RV must
4358 have its REFCNT incremented to keep it in existence.
4361 if (!obj || obj == sv ||
4362 how == PERL_MAGIC_arylen ||
4363 how == PERL_MAGIC_qr ||
4364 how == PERL_MAGIC_symtab ||
4365 (SvTYPE(obj) == SVt_PVGV &&
4366 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4367 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4368 GvFORM(obj) == (CV*)sv)))
4373 mg->mg_obj = SvREFCNT_inc_simple(obj);
4374 mg->mg_flags |= MGf_REFCOUNTED;
4377 /* Normal self-ties simply pass a null object, and instead of
4378 using mg_obj directly, use the SvTIED_obj macro to produce a
4379 new RV as needed. For glob "self-ties", we are tieing the PVIO
4380 with an RV obj pointing to the glob containing the PVIO. In
4381 this case, to avoid a reference loop, we need to weaken the
4385 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4386 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4392 mg->mg_len = namlen;
4395 mg->mg_ptr = savepvn(name, namlen);
4396 else if (namlen == HEf_SVKEY)
4397 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4399 mg->mg_ptr = (char *) name;
4401 mg->mg_virtual = vtable;
4405 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4410 =for apidoc sv_magic
4412 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4413 then adds a new magic item of type C<how> to the head of the magic list.
4415 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4416 handling of the C<name> and C<namlen> arguments.
4418 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4419 to add more than one instance of the same 'how'.
4425 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4431 #ifdef PERL_OLD_COPY_ON_WRITE
4433 sv_force_normal_flags(sv, 0);
4435 if (SvREADONLY(sv)) {
4437 /* its okay to attach magic to shared strings; the subsequent
4438 * upgrade to PVMG will unshare the string */
4439 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4442 && how != PERL_MAGIC_regex_global
4443 && how != PERL_MAGIC_bm
4444 && how != PERL_MAGIC_fm
4445 && how != PERL_MAGIC_sv
4446 && how != PERL_MAGIC_backref
4449 Perl_croak(aTHX_ PL_no_modify);
4452 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4453 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4454 /* sv_magic() refuses to add a magic of the same 'how' as an
4457 if (how == PERL_MAGIC_taint) {
4459 /* Any scalar which already had taint magic on which someone
4460 (erroneously?) did SvIOK_on() or similar will now be
4461 incorrectly sporting public "OK" flags. */
4462 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4470 vtable = &PL_vtbl_sv;
4472 case PERL_MAGIC_overload:
4473 vtable = &PL_vtbl_amagic;
4475 case PERL_MAGIC_overload_elem:
4476 vtable = &PL_vtbl_amagicelem;
4478 case PERL_MAGIC_overload_table:
4479 vtable = &PL_vtbl_ovrld;
4482 vtable = &PL_vtbl_bm;
4484 case PERL_MAGIC_regdata:
4485 vtable = &PL_vtbl_regdata;
4487 case PERL_MAGIC_regdatum:
4488 vtable = &PL_vtbl_regdatum;
4490 case PERL_MAGIC_env:
4491 vtable = &PL_vtbl_env;
4494 vtable = &PL_vtbl_fm;
4496 case PERL_MAGIC_envelem:
4497 vtable = &PL_vtbl_envelem;
4499 case PERL_MAGIC_regex_global:
4500 vtable = &PL_vtbl_mglob;
4502 case PERL_MAGIC_isa:
4503 vtable = &PL_vtbl_isa;
4505 case PERL_MAGIC_isaelem:
4506 vtable = &PL_vtbl_isaelem;
4508 case PERL_MAGIC_nkeys:
4509 vtable = &PL_vtbl_nkeys;
4511 case PERL_MAGIC_dbfile:
4514 case PERL_MAGIC_dbline:
4515 vtable = &PL_vtbl_dbline;
4517 #ifdef USE_LOCALE_COLLATE
4518 case PERL_MAGIC_collxfrm:
4519 vtable = &PL_vtbl_collxfrm;
4521 #endif /* USE_LOCALE_COLLATE */
4522 case PERL_MAGIC_tied:
4523 vtable = &PL_vtbl_pack;
4525 case PERL_MAGIC_tiedelem:
4526 case PERL_MAGIC_tiedscalar:
4527 vtable = &PL_vtbl_packelem;
4530 vtable = &PL_vtbl_regexp;
4532 case PERL_MAGIC_hints:
4533 /* As this vtable is all NULL, we can reuse it. */
4534 case PERL_MAGIC_sig:
4535 vtable = &PL_vtbl_sig;
4537 case PERL_MAGIC_sigelem:
4538 vtable = &PL_vtbl_sigelem;
4540 case PERL_MAGIC_taint:
4541 vtable = &PL_vtbl_taint;
4543 case PERL_MAGIC_uvar:
4544 vtable = &PL_vtbl_uvar;
4546 case PERL_MAGIC_vec:
4547 vtable = &PL_vtbl_vec;
4549 case PERL_MAGIC_arylen_p:
4550 case PERL_MAGIC_rhash:
4551 case PERL_MAGIC_symtab:
4552 case PERL_MAGIC_vstring:
4555 case PERL_MAGIC_utf8:
4556 vtable = &PL_vtbl_utf8;
4558 case PERL_MAGIC_substr:
4559 vtable = &PL_vtbl_substr;
4561 case PERL_MAGIC_defelem:
4562 vtable = &PL_vtbl_defelem;
4564 case PERL_MAGIC_arylen:
4565 vtable = &PL_vtbl_arylen;
4567 case PERL_MAGIC_pos:
4568 vtable = &PL_vtbl_pos;
4570 case PERL_MAGIC_backref:
4571 vtable = &PL_vtbl_backref;
4573 case PERL_MAGIC_hintselem:
4574 vtable = &PL_vtbl_hintselem;
4576 case PERL_MAGIC_ext:
4577 /* Reserved for use by extensions not perl internals. */
4578 /* Useful for attaching extension internal data to perl vars. */
4579 /* Note that multiple extensions may clash if magical scalars */
4580 /* etc holding private data from one are passed to another. */
4584 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4587 /* Rest of work is done else where */
4588 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4591 case PERL_MAGIC_taint:
4594 case PERL_MAGIC_ext:
4595 case PERL_MAGIC_dbfile:
4602 =for apidoc sv_unmagic
4604 Removes all magic of type C<type> from an SV.
4610 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4614 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4616 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4617 for (mg = *mgp; mg; mg = *mgp) {
4618 if (mg->mg_type == type) {
4619 const MGVTBL* const vtbl = mg->mg_virtual;
4620 *mgp = mg->mg_moremagic;
4621 if (vtbl && vtbl->svt_free)
4622 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4623 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4625 Safefree(mg->mg_ptr);
4626 else if (mg->mg_len == HEf_SVKEY)
4627 SvREFCNT_dec((SV*)mg->mg_ptr);
4628 else if (mg->mg_type == PERL_MAGIC_utf8)
4629 Safefree(mg->mg_ptr);
4631 if (mg->mg_flags & MGf_REFCOUNTED)
4632 SvREFCNT_dec(mg->mg_obj);
4636 mgp = &mg->mg_moremagic;
4640 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4641 SvMAGIC_set(sv, NULL);
4648 =for apidoc sv_rvweaken
4650 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4651 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4652 push a back-reference to this RV onto the array of backreferences
4653 associated with that magic. If the RV is magical, set magic will be
4654 called after the RV is cleared.
4660 Perl_sv_rvweaken(pTHX_ SV *sv)
4663 if (!SvOK(sv)) /* let undefs pass */
4666 Perl_croak(aTHX_ "Can't weaken a nonreference");
4667 else if (SvWEAKREF(sv)) {
4668 if (ckWARN(WARN_MISC))
4669 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4673 Perl_sv_add_backref(aTHX_ tsv, sv);
4679 /* Give tsv backref magic if it hasn't already got it, then push a
4680 * back-reference to sv onto the array associated with the backref magic.
4684 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4689 if (SvTYPE(tsv) == SVt_PVHV) {
4690 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4694 /* There is no AV in the offical place - try a fixup. */
4695 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4698 /* Aha. They've got it stowed in magic. Bring it back. */
4699 av = (AV*)mg->mg_obj;
4700 /* Stop mg_free decreasing the refernce count. */
4702 /* Stop mg_free even calling the destructor, given that
4703 there's no AV to free up. */
4705 sv_unmagic(tsv, PERL_MAGIC_backref);
4709 SvREFCNT_inc_simple_void(av);
4714 const MAGIC *const mg
4715 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4717 av = (AV*)mg->mg_obj;
4721 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4722 /* av now has a refcnt of 2, which avoids it getting freed
4723 * before us during global cleanup. The extra ref is removed
4724 * by magic_killbackrefs() when tsv is being freed */
4727 if (AvFILLp(av) >= AvMAX(av)) {
4728 av_extend(av, AvFILLp(av)+1);
4730 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4733 /* delete a back-reference to ourselves from the backref magic associated
4734 * with the SV we point to.
4738 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4745 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4746 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4747 /* We mustn't attempt to "fix up" the hash here by moving the
4748 backreference array back to the hv_aux structure, as that is stored
4749 in the main HvARRAY(), and hfreentries assumes that no-one
4750 reallocates HvARRAY() while it is running. */
4753 const MAGIC *const mg
4754 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4756 av = (AV *)mg->mg_obj;
4759 if (PL_in_clean_all)
4761 Perl_croak(aTHX_ "panic: del_backref");
4768 /* We shouldn't be in here more than once, but for paranoia reasons lets
4770 for (i = AvFILLp(av); i >= 0; i--) {
4772 const SSize_t fill = AvFILLp(av);
4774 /* We weren't the last entry.
4775 An unordered list has this property that you can take the
4776 last element off the end to fill the hole, and it's still
4777 an unordered list :-)
4782 AvFILLp(av) = fill - 1;
4788 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4790 SV **svp = AvARRAY(av);
4792 PERL_UNUSED_ARG(sv);
4794 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4795 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4796 if (svp && !SvIS_FREED(av)) {
4797 SV *const *const last = svp + AvFILLp(av);
4799 while (svp <= last) {
4801 SV *const referrer = *svp;
4802 if (SvWEAKREF(referrer)) {
4803 /* XXX Should we check that it hasn't changed? */
4804 SvRV_set(referrer, 0);
4806 SvWEAKREF_off(referrer);
4807 SvSETMAGIC(referrer);
4808 } else if (SvTYPE(referrer) == SVt_PVGV ||
4809 SvTYPE(referrer) == SVt_PVLV) {
4810 /* You lookin' at me? */
4811 assert(GvSTASH(referrer));
4812 assert(GvSTASH(referrer) == (HV*)sv);
4813 GvSTASH(referrer) = 0;
4816 "panic: magic_killbackrefs (flags=%"UVxf")",
4817 (UV)SvFLAGS(referrer));
4825 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4830 =for apidoc sv_insert
4832 Inserts a string at the specified offset/length within the SV. Similar to
4833 the Perl substr() function.
4839 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4844 register char *midend;
4845 register char *bigend;
4851 Perl_croak(aTHX_ "Can't modify non-existent substring");
4852 SvPV_force(bigstr, curlen);
4853 (void)SvPOK_only_UTF8(bigstr);
4854 if (offset + len > curlen) {
4855 SvGROW(bigstr, offset+len+1);
4856 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4857 SvCUR_set(bigstr, offset+len);
4861 i = littlelen - len;
4862 if (i > 0) { /* string might grow */
4863 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4864 mid = big + offset + len;
4865 midend = bigend = big + SvCUR(bigstr);
4868 while (midend > mid) /* shove everything down */
4869 *--bigend = *--midend;
4870 Move(little,big+offset,littlelen,char);
4871 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4876 Move(little,SvPVX(bigstr)+offset,len,char);
4881 big = SvPVX(bigstr);
4884 bigend = big + SvCUR(bigstr);
4886 if (midend > bigend)
4887 Perl_croak(aTHX_ "panic: sv_insert");
4889 if (mid - big > bigend - midend) { /* faster to shorten from end */
4891 Move(little, mid, littlelen,char);
4894 i = bigend - midend;
4896 Move(midend, mid, i,char);
4900 SvCUR_set(bigstr, mid - big);
4902 else if ((i = mid - big)) { /* faster from front */
4903 midend -= littlelen;
4905 sv_chop(bigstr,midend-i);
4910 Move(little, mid, littlelen,char);
4912 else if (littlelen) {
4913 midend -= littlelen;
4914 sv_chop(bigstr,midend);
4915 Move(little,midend,littlelen,char);
4918 sv_chop(bigstr,midend);
4924 =for apidoc sv_replace
4926 Make the first argument a copy of the second, then delete the original.
4927 The target SV physically takes over ownership of the body of the source SV
4928 and inherits its flags; however, the target keeps any magic it owns,
4929 and any magic in the source is discarded.
4930 Note that this is a rather specialist SV copying operation; most of the
4931 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4937 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4940 const U32 refcnt = SvREFCNT(sv);
4941 SV_CHECK_THINKFIRST_COW_DROP(sv);
4942 if (SvREFCNT(nsv) != 1) {
4943 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4944 UVuf " != 1)", (UV) SvREFCNT(nsv));
4946 if (SvMAGICAL(sv)) {
4950 sv_upgrade(nsv, SVt_PVMG);
4951 SvMAGIC_set(nsv, SvMAGIC(sv));
4952 SvFLAGS(nsv) |= SvMAGICAL(sv);
4954 SvMAGIC_set(sv, NULL);
4958 assert(!SvREFCNT(sv));
4959 #ifdef DEBUG_LEAKING_SCALARS
4960 sv->sv_flags = nsv->sv_flags;
4961 sv->sv_any = nsv->sv_any;
4962 sv->sv_refcnt = nsv->sv_refcnt;
4963 sv->sv_u = nsv->sv_u;
4965 StructCopy(nsv,sv,SV);
4967 /* Currently could join these into one piece of pointer arithmetic, but
4968 it would be unclear. */
4969 if(SvTYPE(sv) == SVt_IV)
4971 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4972 else if (SvTYPE(sv) == SVt_RV) {
4973 SvANY(sv) = &sv->sv_u.svu_rv;
4977 #ifdef PERL_OLD_COPY_ON_WRITE
4978 if (SvIsCOW_normal(nsv)) {
4979 /* We need to follow the pointers around the loop to make the
4980 previous SV point to sv, rather than nsv. */
4983 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4986 assert(SvPVX_const(current) == SvPVX_const(nsv));
4988 /* Make the SV before us point to the SV after us. */
4990 PerlIO_printf(Perl_debug_log, "previous is\n");
4992 PerlIO_printf(Perl_debug_log,
4993 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4994 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4996 SV_COW_NEXT_SV_SET(current, sv);
4999 SvREFCNT(sv) = refcnt;
5000 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5006 =for apidoc sv_clear
5008 Clear an SV: call any destructors, free up any memory used by the body,
5009 and free the body itself. The SV's head is I<not> freed, although
5010 its type is set to all 1's so that it won't inadvertently be assumed
5011 to be live during global destruction etc.
5012 This function should only be called when REFCNT is zero. Most of the time
5013 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5020 Perl_sv_clear(pTHX_ register SV *sv)
5023 const U32 type = SvTYPE(sv);
5024 const struct body_details *const sv_type_details
5025 = bodies_by_type + type;
5028 assert(SvREFCNT(sv) == 0);
5030 if (type <= SVt_IV) {
5031 /* See the comment in sv.h about the collusion between this early
5032 return and the overloading of the NULL and IV slots in the size
5038 if (PL_defstash) { /* Still have a symbol table? */
5043 stash = SvSTASH(sv);
5044 destructor = StashHANDLER(stash,DESTROY);
5046 SV* const tmpref = newRV(sv);
5047 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5049 PUSHSTACKi(PERLSI_DESTROY);
5054 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5060 if(SvREFCNT(tmpref) < 2) {
5061 /* tmpref is not kept alive! */
5063 SvRV_set(tmpref, NULL);
5066 SvREFCNT_dec(tmpref);
5068 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5072 if (PL_in_clean_objs)
5073 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5075 /* DESTROY gave object new lease on life */
5081 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5082 SvOBJECT_off(sv); /* Curse the object. */
5083 if (type != SVt_PVIO)
5084 --PL_sv_objcount; /* XXX Might want something more general */
5087 if (type >= SVt_PVMG) {
5088 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5089 SvREFCNT_dec(OURSTASH(sv));
5090 } else if (SvMAGIC(sv))
5092 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5093 SvREFCNT_dec(SvSTASH(sv));
5098 IoIFP(sv) != PerlIO_stdin() &&
5099 IoIFP(sv) != PerlIO_stdout() &&
5100 IoIFP(sv) != PerlIO_stderr())
5102 io_close((IO*)sv, FALSE);
5104 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5105 PerlDir_close(IoDIRP(sv));
5106 IoDIRP(sv) = (DIR*)NULL;
5107 Safefree(IoTOP_NAME(sv));
5108 Safefree(IoFMT_NAME(sv));
5109 Safefree(IoBOTTOM_NAME(sv));
5118 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5125 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5126 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5127 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5128 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5130 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5131 SvREFCNT_dec(LvTARG(sv));
5135 if (GvNAME_HEK(sv)) {
5136 unshare_hek(GvNAME_HEK(sv));
5138 /* If we're in a stash, we don't own a reference to it. However it does
5139 have a back reference to us, which needs to be cleared. */
5141 sv_del_backref((SV*)GvSTASH(sv), sv);
5146 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5148 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5149 /* Don't even bother with turning off the OOK flag. */
5154 SV * const target = SvRV(sv);
5156 sv_del_backref(target, sv);
5158 SvREFCNT_dec(target);
5160 #ifdef PERL_OLD_COPY_ON_WRITE
5161 else if (SvPVX_const(sv)) {
5163 /* I believe I need to grab the global SV mutex here and
5164 then recheck the COW status. */
5166 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5169 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5170 SV_COW_NEXT_SV(sv));
5171 /* And drop it here. */
5173 } else if (SvLEN(sv)) {
5174 Safefree(SvPVX_const(sv));
5178 else if (SvPVX_const(sv) && SvLEN(sv))
5179 Safefree(SvPVX_mutable(sv));
5180 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5181 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5190 SvFLAGS(sv) &= SVf_BREAK;
5191 SvFLAGS(sv) |= SVTYPEMASK;
5193 if (sv_type_details->arena) {
5194 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5195 &PL_body_roots[type]);
5197 else if (sv_type_details->body_size) {
5198 my_safefree(SvANY(sv));
5203 =for apidoc sv_newref
5205 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5212 Perl_sv_newref(pTHX_ SV *sv)
5214 PERL_UNUSED_CONTEXT;
5223 Decrement an SV's reference count, and if it drops to zero, call
5224 C<sv_clear> to invoke destructors and free up any memory used by
5225 the body; finally, deallocate the SV's head itself.
5226 Normally called via a wrapper macro C<SvREFCNT_dec>.
5232 Perl_sv_free(pTHX_ SV *sv)
5237 if (SvREFCNT(sv) == 0) {
5238 if (SvFLAGS(sv) & SVf_BREAK)
5239 /* this SV's refcnt has been artificially decremented to
5240 * trigger cleanup */
5242 if (PL_in_clean_all) /* All is fair */
5244 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5245 /* make sure SvREFCNT(sv)==0 happens very seldom */
5246 SvREFCNT(sv) = (~(U32)0)/2;
5249 if (ckWARN_d(WARN_INTERNAL)) {
5250 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5251 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5252 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5253 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5254 Perl_dump_sv_child(aTHX_ sv);
5259 if (--(SvREFCNT(sv)) > 0)
5261 Perl_sv_free2(aTHX_ sv);
5265 Perl_sv_free2(pTHX_ SV *sv)
5270 if (ckWARN_d(WARN_DEBUGGING))
5271 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5272 "Attempt to free temp prematurely: SV 0x%"UVxf
5273 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5277 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5278 /* make sure SvREFCNT(sv)==0 happens very seldom */
5279 SvREFCNT(sv) = (~(U32)0)/2;
5290 Returns the length of the string in the SV. Handles magic and type
5291 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5297 Perl_sv_len(pTHX_ register SV *sv)
5305 len = mg_length(sv);
5307 (void)SvPV_const(sv, len);
5312 =for apidoc sv_len_utf8
5314 Returns the number of characters in the string in an SV, counting wide
5315 UTF-8 bytes as a single character. Handles magic and type coercion.
5321 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5322 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5323 * (Note that the mg_len is not the length of the mg_ptr field.
5324 * This allows the cache to store the character length of the string without
5325 * needing to malloc() extra storage to attach to the mg_ptr.)
5330 Perl_sv_len_utf8(pTHX_ register SV *sv)
5336 return mg_length(sv);
5340 const U8 *s = (U8*)SvPV_const(sv, len);
5344 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5346 if (mg && mg->mg_len != -1) {
5348 if (PL_utf8cache < 0) {
5349 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5351 /* Need to turn the assertions off otherwise we may
5352 recurse infinitely while printing error messages.
5354 SAVEI8(PL_utf8cache);
5356 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5357 " real %"UVuf" for %"SVf,
5358 (UV) ulen, (UV) real, (void*)sv);
5363 ulen = Perl_utf8_length(aTHX_ s, s + len);
5364 if (!SvREADONLY(sv)) {
5366 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5367 &PL_vtbl_utf8, 0, 0);
5375 return Perl_utf8_length(aTHX_ s, s + len);
5379 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5382 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5385 const U8 *s = start;
5387 while (s < send && uoffset--)
5390 /* This is the existing behaviour. Possibly it should be a croak, as
5391 it's actually a bounds error */
5397 /* Given the length of the string in both bytes and UTF-8 characters, decide
5398 whether to walk forwards or backwards to find the byte corresponding to
5399 the passed in UTF-8 offset. */
5401 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5402 STRLEN uoffset, STRLEN uend)
5404 STRLEN backw = uend - uoffset;
5405 if (uoffset < 2 * backw) {
5406 /* The assumption is that going forwards is twice the speed of going
5407 forward (that's where the 2 * backw comes from).
5408 (The real figure of course depends on the UTF-8 data.) */
5409 return sv_pos_u2b_forwards(start, send, uoffset);
5414 while (UTF8_IS_CONTINUATION(*send))
5417 return send - start;
5420 /* For the string representation of the given scalar, find the byte
5421 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5422 give another position in the string, *before* the sought offset, which
5423 (which is always true, as 0, 0 is a valid pair of positions), which should
5424 help reduce the amount of linear searching.
5425 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5426 will be used to reduce the amount of linear searching. The cache will be
5427 created if necessary, and the found value offered to it for update. */
5429 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5430 const U8 *const send, STRLEN uoffset,
5431 STRLEN uoffset0, STRLEN boffset0) {
5432 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5435 assert (uoffset >= uoffset0);
5437 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5438 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5439 if ((*mgp)->mg_ptr) {
5440 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5441 if (cache[0] == uoffset) {
5442 /* An exact match. */
5445 if (cache[2] == uoffset) {
5446 /* An exact match. */
5450 if (cache[0] < uoffset) {
5451 /* The cache already knows part of the way. */
5452 if (cache[0] > uoffset0) {
5453 /* The cache knows more than the passed in pair */
5454 uoffset0 = cache[0];
5455 boffset0 = cache[1];
5457 if ((*mgp)->mg_len != -1) {
5458 /* And we know the end too. */
5460 + sv_pos_u2b_midway(start + boffset0, send,
5462 (*mgp)->mg_len - uoffset0);
5465 + sv_pos_u2b_forwards(start + boffset0,
5466 send, uoffset - uoffset0);
5469 else if (cache[2] < uoffset) {
5470 /* We're between the two cache entries. */
5471 if (cache[2] > uoffset0) {
5472 /* and the cache knows more than the passed in pair */
5473 uoffset0 = cache[2];
5474 boffset0 = cache[3];
5478 + sv_pos_u2b_midway(start + boffset0,
5481 cache[0] - uoffset0);
5484 + sv_pos_u2b_midway(start + boffset0,
5487 cache[2] - uoffset0);
5491 else if ((*mgp)->mg_len != -1) {
5492 /* If we can take advantage of a passed in offset, do so. */
5493 /* In fact, offset0 is either 0, or less than offset, so don't
5494 need to worry about the other possibility. */
5496 + sv_pos_u2b_midway(start + boffset0, send,
5498 (*mgp)->mg_len - uoffset0);
5503 if (!found || PL_utf8cache < 0) {
5504 const STRLEN real_boffset
5505 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5506 send, uoffset - uoffset0);
5508 if (found && PL_utf8cache < 0) {
5509 if (real_boffset != boffset) {
5510 /* Need to turn the assertions off otherwise we may recurse
5511 infinitely while printing error messages. */
5512 SAVEI8(PL_utf8cache);
5514 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5515 " real %"UVuf" for %"SVf,
5516 (UV) boffset, (UV) real_boffset, (void*)sv);
5519 boffset = real_boffset;
5522 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5528 =for apidoc sv_pos_u2b
5530 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5531 the start of the string, to a count of the equivalent number of bytes; if
5532 lenp is non-zero, it does the same to lenp, but this time starting from
5533 the offset, rather than from the start of the string. Handles magic and
5540 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5541 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5542 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5547 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5555 start = (U8*)SvPV_const(sv, len);
5557 STRLEN uoffset = (STRLEN) *offsetp;
5558 const U8 * const send = start + len;
5560 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5563 *offsetp = (I32) boffset;
5566 /* Convert the relative offset to absolute. */
5567 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5568 const STRLEN boffset2
5569 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5570 uoffset, boffset) - boffset;
5584 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5585 byte length pairing. The (byte) length of the total SV is passed in too,
5586 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5587 may not have updated SvCUR, so we can't rely on reading it directly.
5589 The proffered utf8/byte length pairing isn't used if the cache already has
5590 two pairs, and swapping either for the proffered pair would increase the
5591 RMS of the intervals between known byte offsets.
5593 The cache itself consists of 4 STRLEN values
5594 0: larger UTF-8 offset
5595 1: corresponding byte offset
5596 2: smaller UTF-8 offset
5597 3: corresponding byte offset
5599 Unused cache pairs have the value 0, 0.
5600 Keeping the cache "backwards" means that the invariant of
5601 cache[0] >= cache[2] is maintained even with empty slots, which means that
5602 the code that uses it doesn't need to worry if only 1 entry has actually
5603 been set to non-zero. It also makes the "position beyond the end of the
5604 cache" logic much simpler, as the first slot is always the one to start
5608 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5616 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5618 (*mgp)->mg_len = -1;
5622 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5623 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5624 (*mgp)->mg_ptr = (char *) cache;
5628 if (PL_utf8cache < 0) {
5629 const U8 *start = (const U8 *) SvPVX_const(sv);
5630 const U8 *const end = start + byte;
5631 STRLEN realutf8 = 0;
5633 while (start < end) {
5634 start += UTF8SKIP(start);
5638 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5639 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5640 doesn't? I don't know whether this difference was introduced with
5641 the caching code in 5.8.1. */
5643 if (realutf8 != utf8) {
5644 /* Need to turn the assertions off otherwise we may recurse
5645 infinitely while printing error messages. */
5646 SAVEI8(PL_utf8cache);
5648 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5649 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5653 /* Cache is held with the later position first, to simplify the code
5654 that deals with unbounded ends. */
5656 ASSERT_UTF8_CACHE(cache);
5657 if (cache[1] == 0) {
5658 /* Cache is totally empty */
5661 } else if (cache[3] == 0) {
5662 if (byte > cache[1]) {
5663 /* New one is larger, so goes first. */
5664 cache[2] = cache[0];
5665 cache[3] = cache[1];
5673 #define THREEWAY_SQUARE(a,b,c,d) \
5674 ((float)((d) - (c))) * ((float)((d) - (c))) \
5675 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5676 + ((float)((b) - (a))) * ((float)((b) - (a)))
5678 /* Cache has 2 slots in use, and we know three potential pairs.
5679 Keep the two that give the lowest RMS distance. Do the
5680 calcualation in bytes simply because we always know the byte
5681 length. squareroot has the same ordering as the positive value,
5682 so don't bother with the actual square root. */
5683 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5684 if (byte > cache[1]) {
5685 /* New position is after the existing pair of pairs. */
5686 const float keep_earlier
5687 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5688 const float keep_later
5689 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5691 if (keep_later < keep_earlier) {
5692 if (keep_later < existing) {
5693 cache[2] = cache[0];
5694 cache[3] = cache[1];
5700 if (keep_earlier < existing) {
5706 else if (byte > cache[3]) {
5707 /* New position is between the existing pair of pairs. */
5708 const float keep_earlier
5709 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5710 const float keep_later
5711 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5713 if (keep_later < keep_earlier) {
5714 if (keep_later < existing) {
5720 if (keep_earlier < existing) {
5727 /* New position is before the existing pair of pairs. */
5728 const float keep_earlier
5729 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5730 const float keep_later
5731 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5733 if (keep_later < keep_earlier) {
5734 if (keep_later < existing) {
5740 if (keep_earlier < existing) {
5741 cache[0] = cache[2];
5742 cache[1] = cache[3];
5749 ASSERT_UTF8_CACHE(cache);
5752 /* If we don't know the character offset of the end of a region, our only
5753 option is to walk forwards to the target byte offset. */
5755 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5758 while (s < target) {
5761 /* Call utf8n_to_uvchr() to validate the sequence
5762 * (unless a simple non-UTF character) */
5763 if (!UTF8_IS_INVARIANT(*s))
5764 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5775 /* We already know all of the way, now we may be able to walk back. The same
5776 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5777 backward is half the speed of walking forward. */
5779 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5782 const STRLEN forw = target - s;
5783 STRLEN backw = end - target;
5785 if (forw < 2 * backw) {
5786 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5789 while (end > target) {
5791 while (UTF8_IS_CONTINUATION(*end)) {
5800 =for apidoc sv_pos_b2u
5802 Converts the value pointed to by offsetp from a count of bytes from the
5803 start of the string, to a count of the equivalent number of UTF-8 chars.
5804 Handles magic and type coercion.
5810 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5811 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5816 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5819 const STRLEN byte = *offsetp;
5820 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5829 s = (const U8*)SvPV_const(sv, blen);
5832 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5836 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5837 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5839 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5840 if (cache[1] == byte) {
5841 /* An exact match. */
5842 *offsetp = cache[0];
5845 if (cache[3] == byte) {
5846 /* An exact match. */
5847 *offsetp = cache[2];
5851 if (cache[1] < byte) {
5852 /* We already know part of the way. */
5853 if (mg->mg_len != -1) {
5854 /* Actually, we know the end too. */
5856 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5857 s + blen, mg->mg_len - cache[0]);
5860 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5863 else if (cache[3] < byte) {
5864 /* We're between the two cached pairs, so we do the calculation
5865 offset by the byte/utf-8 positions for the earlier pair,
5866 then add the utf-8 characters from the string start to
5868 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5869 s + cache[1], cache[0] - cache[2])
5873 else { /* cache[3] > byte */
5874 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5878 ASSERT_UTF8_CACHE(cache);
5880 } else if (mg->mg_len != -1) {
5881 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5885 if (!found || PL_utf8cache < 0) {
5886 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5888 if (found && PL_utf8cache < 0) {
5889 if (len != real_len) {
5890 /* Need to turn the assertions off otherwise we may recurse
5891 infinitely while printing error messages. */
5892 SAVEI8(PL_utf8cache);
5894 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5895 " real %"UVuf" for %"SVf,
5896 (UV) len, (UV) real_len, (void*)sv);
5903 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5909 Returns a boolean indicating whether the strings in the two SVs are
5910 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5911 coerce its args to strings if necessary.
5917 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5926 SV* svrecode = NULL;
5933 /* if pv1 and pv2 are the same, second SvPV_const call may
5934 * invalidate pv1, so we may need to make a copy */
5935 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5936 pv1 = SvPV_const(sv1, cur1);
5937 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5938 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5940 pv1 = SvPV_const(sv1, cur1);
5948 pv2 = SvPV_const(sv2, cur2);
5950 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5951 /* Differing utf8ness.
5952 * Do not UTF8size the comparands as a side-effect. */
5955 svrecode = newSVpvn(pv2, cur2);
5956 sv_recode_to_utf8(svrecode, PL_encoding);
5957 pv2 = SvPV_const(svrecode, cur2);
5960 svrecode = newSVpvn(pv1, cur1);
5961 sv_recode_to_utf8(svrecode, PL_encoding);
5962 pv1 = SvPV_const(svrecode, cur1);
5964 /* Now both are in UTF-8. */
5966 SvREFCNT_dec(svrecode);
5971 bool is_utf8 = TRUE;
5974 /* sv1 is the UTF-8 one,
5975 * if is equal it must be downgrade-able */
5976 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5982 /* sv2 is the UTF-8 one,
5983 * if is equal it must be downgrade-able */
5984 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5990 /* Downgrade not possible - cannot be eq */
5998 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6000 SvREFCNT_dec(svrecode);
6010 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6011 string in C<sv1> is less than, equal to, or greater than the string in
6012 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6013 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6019 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6023 const char *pv1, *pv2;
6026 SV *svrecode = NULL;
6033 pv1 = SvPV_const(sv1, cur1);
6040 pv2 = SvPV_const(sv2, cur2);
6042 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6043 /* Differing utf8ness.
6044 * Do not UTF8size the comparands as a side-effect. */
6047 svrecode = newSVpvn(pv2, cur2);
6048 sv_recode_to_utf8(svrecode, PL_encoding);
6049 pv2 = SvPV_const(svrecode, cur2);
6052 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6057 svrecode = newSVpvn(pv1, cur1);
6058 sv_recode_to_utf8(svrecode, PL_encoding);
6059 pv1 = SvPV_const(svrecode, cur1);
6062 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6068 cmp = cur2 ? -1 : 0;
6072 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6075 cmp = retval < 0 ? -1 : 1;
6076 } else if (cur1 == cur2) {
6079 cmp = cur1 < cur2 ? -1 : 1;
6083 SvREFCNT_dec(svrecode);
6091 =for apidoc sv_cmp_locale
6093 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6094 'use bytes' aware, handles get magic, and will coerce its args to strings
6095 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6101 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6104 #ifdef USE_LOCALE_COLLATE
6110 if (PL_collation_standard)
6114 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6116 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6118 if (!pv1 || !len1) {
6129 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6132 return retval < 0 ? -1 : 1;
6135 * When the result of collation is equality, that doesn't mean
6136 * that there are no differences -- some locales exclude some
6137 * characters from consideration. So to avoid false equalities,
6138 * we use the raw string as a tiebreaker.
6144 #endif /* USE_LOCALE_COLLATE */
6146 return sv_cmp(sv1, sv2);
6150 #ifdef USE_LOCALE_COLLATE
6153 =for apidoc sv_collxfrm
6155 Add Collate Transform magic to an SV if it doesn't already have it.
6157 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6158 scalar data of the variable, but transformed to such a format that a normal
6159 memory comparison can be used to compare the data according to the locale
6166 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6171 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6172 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6178 Safefree(mg->mg_ptr);
6179 s = SvPV_const(sv, len);
6180 if ((xf = mem_collxfrm(s, len, &xlen))) {
6181 if (SvREADONLY(sv)) {
6184 return xf + sizeof(PL_collation_ix);
6187 #ifdef PERL_OLD_COPY_ON_WRITE
6189 sv_force_normal_flags(sv, 0);
6191 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6205 if (mg && mg->mg_ptr) {
6207 return mg->mg_ptr + sizeof(PL_collation_ix);
6215 #endif /* USE_LOCALE_COLLATE */
6220 Get a line from the filehandle and store it into the SV, optionally
6221 appending to the currently-stored string.
6227 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6232 register STDCHAR rslast;
6233 register STDCHAR *bp;
6238 if (SvTHINKFIRST(sv))
6239 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6240 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6242 However, perlbench says it's slower, because the existing swipe code
6243 is faster than copy on write.
6244 Swings and roundabouts. */
6245 SvUPGRADE(sv, SVt_PV);
6250 if (PerlIO_isutf8(fp)) {
6252 sv_utf8_upgrade_nomg(sv);
6253 sv_pos_u2b(sv,&append,0);
6255 } else if (SvUTF8(sv)) {
6256 SV * const tsv = newSV(0);
6257 sv_gets(tsv, fp, 0);
6258 sv_utf8_upgrade_nomg(tsv);
6259 SvCUR_set(sv,append);
6262 goto return_string_or_null;
6267 if (PerlIO_isutf8(fp))
6270 if (IN_PERL_COMPILETIME) {
6271 /* we always read code in line mode */
6275 else if (RsSNARF(PL_rs)) {
6276 /* If it is a regular disk file use size from stat() as estimate
6277 of amount we are going to read -- may result in mallocing
6278 more memory than we really need if the layers below reduce
6279 the size we read (e.g. CRLF or a gzip layer).
6282 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6283 const Off_t offset = PerlIO_tell(fp);
6284 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6285 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6291 else if (RsRECORD(PL_rs)) {
6296 /* Grab the size of the record we're getting */
6297 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6298 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6301 /* VMS wants read instead of fread, because fread doesn't respect */
6302 /* RMS record boundaries. This is not necessarily a good thing to be */
6303 /* doing, but we've got no other real choice - except avoid stdio
6304 as implementation - perhaps write a :vms layer ?
6306 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6308 bytesread = PerlIO_read(fp, buffer, recsize);
6312 SvCUR_set(sv, bytesread += append);
6313 buffer[bytesread] = '\0';
6314 goto return_string_or_null;
6316 else if (RsPARA(PL_rs)) {
6322 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6323 if (PerlIO_isutf8(fp)) {
6324 rsptr = SvPVutf8(PL_rs, rslen);
6327 if (SvUTF8(PL_rs)) {
6328 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6329 Perl_croak(aTHX_ "Wide character in $/");
6332 rsptr = SvPV_const(PL_rs, rslen);
6336 rslast = rslen ? rsptr[rslen - 1] : '\0';
6338 if (rspara) { /* have to do this both before and after */
6339 do { /* to make sure file boundaries work right */
6342 i = PerlIO_getc(fp);
6346 PerlIO_ungetc(fp,i);
6352 /* See if we know enough about I/O mechanism to cheat it ! */
6354 /* This used to be #ifdef test - it is made run-time test for ease
6355 of abstracting out stdio interface. One call should be cheap
6356 enough here - and may even be a macro allowing compile
6360 if (PerlIO_fast_gets(fp)) {
6363 * We're going to steal some values from the stdio struct
6364 * and put EVERYTHING in the innermost loop into registers.
6366 register STDCHAR *ptr;
6370 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6371 /* An ungetc()d char is handled separately from the regular
6372 * buffer, so we getc() it back out and stuff it in the buffer.
6374 i = PerlIO_getc(fp);
6375 if (i == EOF) return 0;
6376 *(--((*fp)->_ptr)) = (unsigned char) i;
6380 /* Here is some breathtakingly efficient cheating */
6382 cnt = PerlIO_get_cnt(fp); /* get count into register */
6383 /* make sure we have the room */
6384 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6385 /* Not room for all of it
6386 if we are looking for a separator and room for some
6388 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6389 /* just process what we have room for */
6390 shortbuffered = cnt - SvLEN(sv) + append + 1;
6391 cnt -= shortbuffered;
6395 /* remember that cnt can be negative */
6396 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6401 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6402 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6403 DEBUG_P(PerlIO_printf(Perl_debug_log,
6404 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6405 DEBUG_P(PerlIO_printf(Perl_debug_log,
6406 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6407 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6408 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6413 while (cnt > 0) { /* this | eat */
6415 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6416 goto thats_all_folks; /* screams | sed :-) */
6420 Copy(ptr, bp, cnt, char); /* this | eat */
6421 bp += cnt; /* screams | dust */
6422 ptr += cnt; /* louder | sed :-) */
6427 if (shortbuffered) { /* oh well, must extend */
6428 cnt = shortbuffered;
6430 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6432 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6433 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6437 DEBUG_P(PerlIO_printf(Perl_debug_log,
6438 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6439 PTR2UV(ptr),(long)cnt));
6440 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6442 DEBUG_P(PerlIO_printf(Perl_debug_log,
6443 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6444 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6445 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6447 /* This used to call 'filbuf' in stdio form, but as that behaves like
6448 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6449 another abstraction. */
6450 i = PerlIO_getc(fp); /* get more characters */
6452 DEBUG_P(PerlIO_printf(Perl_debug_log,
6453 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6454 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6455 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6457 cnt = PerlIO_get_cnt(fp);
6458 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6459 DEBUG_P(PerlIO_printf(Perl_debug_log,
6460 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6462 if (i == EOF) /* all done for ever? */
6463 goto thats_really_all_folks;
6465 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6467 SvGROW(sv, bpx + cnt + 2);
6468 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6470 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6472 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6473 goto thats_all_folks;
6477 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6478 memNE((char*)bp - rslen, rsptr, rslen))
6479 goto screamer; /* go back to the fray */
6480 thats_really_all_folks:
6482 cnt += shortbuffered;
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6485 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6486 DEBUG_P(PerlIO_printf(Perl_debug_log,
6487 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6488 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6489 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6491 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6492 DEBUG_P(PerlIO_printf(Perl_debug_log,
6493 "Screamer: done, len=%ld, string=|%.*s|\n",
6494 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6498 /*The big, slow, and stupid way. */
6499 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6500 STDCHAR *buf = NULL;
6501 Newx(buf, 8192, STDCHAR);
6509 register const STDCHAR * const bpe = buf + sizeof(buf);
6511 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6512 ; /* keep reading */
6516 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6517 /* Accomodate broken VAXC compiler, which applies U8 cast to
6518 * both args of ?: operator, causing EOF to change into 255
6521 i = (U8)buf[cnt - 1];
6527 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6529 sv_catpvn(sv, (char *) buf, cnt);
6531 sv_setpvn(sv, (char *) buf, cnt);
6533 if (i != EOF && /* joy */
6535 SvCUR(sv) < rslen ||
6536 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6540 * If we're reading from a TTY and we get a short read,
6541 * indicating that the user hit his EOF character, we need
6542 * to notice it now, because if we try to read from the TTY
6543 * again, the EOF condition will disappear.
6545 * The comparison of cnt to sizeof(buf) is an optimization
6546 * that prevents unnecessary calls to feof().
6550 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6554 #ifdef USE_HEAP_INSTEAD_OF_STACK
6559 if (rspara) { /* have to do this both before and after */
6560 while (i != EOF) { /* to make sure file boundaries work right */
6561 i = PerlIO_getc(fp);
6563 PerlIO_ungetc(fp,i);
6569 return_string_or_null:
6570 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6576 Auto-increment of the value in the SV, doing string to numeric conversion
6577 if necessary. Handles 'get' magic.
6583 Perl_sv_inc(pTHX_ register SV *sv)
6592 if (SvTHINKFIRST(sv)) {
6594 sv_force_normal_flags(sv, 0);
6595 if (SvREADONLY(sv)) {
6596 if (IN_PERL_RUNTIME)
6597 Perl_croak(aTHX_ PL_no_modify);
6601 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6603 i = PTR2IV(SvRV(sv));
6608 flags = SvFLAGS(sv);
6609 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6610 /* It's (privately or publicly) a float, but not tested as an
6611 integer, so test it to see. */
6613 flags = SvFLAGS(sv);
6615 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6616 /* It's publicly an integer, or privately an integer-not-float */
6617 #ifdef PERL_PRESERVE_IVUV
6621 if (SvUVX(sv) == UV_MAX)
6622 sv_setnv(sv, UV_MAX_P1);
6624 (void)SvIOK_only_UV(sv);
6625 SvUV_set(sv, SvUVX(sv) + 1);
6627 if (SvIVX(sv) == IV_MAX)
6628 sv_setuv(sv, (UV)IV_MAX + 1);
6630 (void)SvIOK_only(sv);
6631 SvIV_set(sv, SvIVX(sv) + 1);
6636 if (flags & SVp_NOK) {
6637 (void)SvNOK_only(sv);
6638 SvNV_set(sv, SvNVX(sv) + 1.0);
6642 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6643 if ((flags & SVTYPEMASK) < SVt_PVIV)
6644 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6645 (void)SvIOK_only(sv);
6650 while (isALPHA(*d)) d++;
6651 while (isDIGIT(*d)) d++;
6653 #ifdef PERL_PRESERVE_IVUV
6654 /* Got to punt this as an integer if needs be, but we don't issue
6655 warnings. Probably ought to make the sv_iv_please() that does
6656 the conversion if possible, and silently. */
6657 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6658 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6659 /* Need to try really hard to see if it's an integer.
6660 9.22337203685478e+18 is an integer.
6661 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6662 so $a="9.22337203685478e+18"; $a+0; $a++
6663 needs to be the same as $a="9.22337203685478e+18"; $a++
6670 /* sv_2iv *should* have made this an NV */
6671 if (flags & SVp_NOK) {
6672 (void)SvNOK_only(sv);
6673 SvNV_set(sv, SvNVX(sv) + 1.0);
6676 /* I don't think we can get here. Maybe I should assert this
6677 And if we do get here I suspect that sv_setnv will croak. NWC
6679 #if defined(USE_LONG_DOUBLE)
6680 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",
6681 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6683 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6684 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6687 #endif /* PERL_PRESERVE_IVUV */
6688 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6692 while (d >= SvPVX_const(sv)) {
6700 /* MKS: The original code here died if letters weren't consecutive.
6701 * at least it didn't have to worry about non-C locales. The
6702 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6703 * arranged in order (although not consecutively) and that only
6704 * [A-Za-z] are accepted by isALPHA in the C locale.
6706 if (*d != 'z' && *d != 'Z') {
6707 do { ++*d; } while (!isALPHA(*d));
6710 *(d--) -= 'z' - 'a';
6715 *(d--) -= 'z' - 'a' + 1;
6719 /* oh,oh, the number grew */
6720 SvGROW(sv, SvCUR(sv) + 2);
6721 SvCUR_set(sv, SvCUR(sv) + 1);
6722 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6733 Auto-decrement of the value in the SV, doing string to numeric conversion
6734 if necessary. Handles 'get' magic.
6740 Perl_sv_dec(pTHX_ register SV *sv)
6748 if (SvTHINKFIRST(sv)) {
6750 sv_force_normal_flags(sv, 0);
6751 if (SvREADONLY(sv)) {
6752 if (IN_PERL_RUNTIME)
6753 Perl_croak(aTHX_ PL_no_modify);
6757 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6759 i = PTR2IV(SvRV(sv));
6764 /* Unlike sv_inc we don't have to worry about string-never-numbers
6765 and keeping them magic. But we mustn't warn on punting */
6766 flags = SvFLAGS(sv);
6767 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6768 /* It's publicly an integer, or privately an integer-not-float */
6769 #ifdef PERL_PRESERVE_IVUV
6773 if (SvUVX(sv) == 0) {
6774 (void)SvIOK_only(sv);
6778 (void)SvIOK_only_UV(sv);
6779 SvUV_set(sv, SvUVX(sv) - 1);
6782 if (SvIVX(sv) == IV_MIN)
6783 sv_setnv(sv, (NV)IV_MIN - 1.0);
6785 (void)SvIOK_only(sv);
6786 SvIV_set(sv, SvIVX(sv) - 1);
6791 if (flags & SVp_NOK) {
6792 SvNV_set(sv, SvNVX(sv) - 1.0);
6793 (void)SvNOK_only(sv);
6796 if (!(flags & SVp_POK)) {
6797 if ((flags & SVTYPEMASK) < SVt_PVIV)
6798 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6800 (void)SvIOK_only(sv);
6803 #ifdef PERL_PRESERVE_IVUV
6805 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6806 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6807 /* Need to try really hard to see if it's an integer.
6808 9.22337203685478e+18 is an integer.
6809 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6810 so $a="9.22337203685478e+18"; $a+0; $a--
6811 needs to be the same as $a="9.22337203685478e+18"; $a--
6818 /* sv_2iv *should* have made this an NV */
6819 if (flags & SVp_NOK) {
6820 (void)SvNOK_only(sv);
6821 SvNV_set(sv, SvNVX(sv) - 1.0);
6824 /* I don't think we can get here. Maybe I should assert this
6825 And if we do get here I suspect that sv_setnv will croak. NWC
6827 #if defined(USE_LONG_DOUBLE)
6828 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",
6829 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6831 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6832 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6836 #endif /* PERL_PRESERVE_IVUV */
6837 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6841 =for apidoc sv_mortalcopy
6843 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6844 The new SV is marked as mortal. It will be destroyed "soon", either by an
6845 explicit call to FREETMPS, or by an implicit call at places such as
6846 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6851 /* Make a string that will exist for the duration of the expression
6852 * evaluation. Actually, it may have to last longer than that, but
6853 * hopefully we won't free it until it has been assigned to a
6854 * permanent location. */
6857 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6863 sv_setsv(sv,oldstr);
6865 PL_tmps_stack[++PL_tmps_ix] = sv;
6871 =for apidoc sv_newmortal
6873 Creates a new null SV which is mortal. The reference count of the SV is
6874 set to 1. It will be destroyed "soon", either by an explicit call to
6875 FREETMPS, or by an implicit call at places such as statement boundaries.
6876 See also C<sv_mortalcopy> and C<sv_2mortal>.
6882 Perl_sv_newmortal(pTHX)
6888 SvFLAGS(sv) = SVs_TEMP;
6890 PL_tmps_stack[++PL_tmps_ix] = sv;
6895 =for apidoc sv_2mortal
6897 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6898 by an explicit call to FREETMPS, or by an implicit call at places such as
6899 statement boundaries. SvTEMP() is turned on which means that the SV's
6900 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6901 and C<sv_mortalcopy>.
6907 Perl_sv_2mortal(pTHX_ register SV *sv)
6912 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6915 PL_tmps_stack[++PL_tmps_ix] = sv;
6923 Creates a new SV and copies a string into it. The reference count for the
6924 SV is set to 1. If C<len> is zero, Perl will compute the length using
6925 strlen(). For efficiency, consider using C<newSVpvn> instead.
6931 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6937 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6942 =for apidoc newSVpvn
6944 Creates a new SV and copies a string into it. The reference count for the
6945 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6946 string. You are responsible for ensuring that the source string is at least
6947 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6953 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6959 sv_setpvn(sv,s,len);
6965 =for apidoc newSVhek
6967 Creates a new SV from the hash key structure. It will generate scalars that
6968 point to the shared string table where possible. Returns a new (undefined)
6969 SV if the hek is NULL.
6975 Perl_newSVhek(pTHX_ const HEK *hek)
6985 if (HEK_LEN(hek) == HEf_SVKEY) {
6986 return newSVsv(*(SV**)HEK_KEY(hek));
6988 const int flags = HEK_FLAGS(hek);
6989 if (flags & HVhek_WASUTF8) {
6991 Andreas would like keys he put in as utf8 to come back as utf8
6993 STRLEN utf8_len = HEK_LEN(hek);
6994 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6995 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6998 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7000 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7001 /* We don't have a pointer to the hv, so we have to replicate the
7002 flag into every HEK. This hv is using custom a hasing
7003 algorithm. Hence we can't return a shared string scalar, as
7004 that would contain the (wrong) hash value, and might get passed
7005 into an hv routine with a regular hash.
7006 Similarly, a hash that isn't using shared hash keys has to have
7007 the flag in every key so that we know not to try to call
7008 share_hek_kek on it. */
7010 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7015 /* This will be overwhelminly the most common case. */
7017 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7018 more efficient than sharepvn(). */
7022 sv_upgrade(sv, SVt_PV);
7023 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7024 SvCUR_set(sv, HEK_LEN(hek));
7037 =for apidoc newSVpvn_share
7039 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7040 table. If the string does not already exist in the table, it is created
7041 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7042 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7043 otherwise the hash is computed. The idea here is that as the string table
7044 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7045 hash lookup will avoid string compare.
7051 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7055 bool is_utf8 = FALSE;
7056 const char *const orig_src = src;
7059 STRLEN tmplen = -len;
7061 /* See the note in hv.c:hv_fetch() --jhi */
7062 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7066 PERL_HASH(hash, src, len);
7068 sv_upgrade(sv, SVt_PV);
7069 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7077 if (src != orig_src)
7083 #if defined(PERL_IMPLICIT_CONTEXT)
7085 /* pTHX_ magic can't cope with varargs, so this is a no-context
7086 * version of the main function, (which may itself be aliased to us).
7087 * Don't access this version directly.
7091 Perl_newSVpvf_nocontext(const char* pat, ...)
7096 va_start(args, pat);
7097 sv = vnewSVpvf(pat, &args);
7104 =for apidoc newSVpvf
7106 Creates a new SV and initializes it with the string formatted like
7113 Perl_newSVpvf(pTHX_ const char* pat, ...)
7117 va_start(args, pat);
7118 sv = vnewSVpvf(pat, &args);
7123 /* backend for newSVpvf() and newSVpvf_nocontext() */
7126 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7131 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7138 Creates a new SV and copies a floating point value into it.
7139 The reference count for the SV is set to 1.
7145 Perl_newSVnv(pTHX_ NV n)
7158 Creates a new SV and copies an integer into it. The reference count for the
7165 Perl_newSViv(pTHX_ IV i)
7178 Creates a new SV and copies an unsigned integer into it.
7179 The reference count for the SV is set to 1.
7185 Perl_newSVuv(pTHX_ UV u)
7196 =for apidoc newRV_noinc
7198 Creates an RV wrapper for an SV. The reference count for the original
7199 SV is B<not> incremented.
7205 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7211 sv_upgrade(sv, SVt_RV);
7213 SvRV_set(sv, tmpRef);
7218 /* newRV_inc is the official function name to use now.
7219 * newRV_inc is in fact #defined to newRV in sv.h
7223 Perl_newRV(pTHX_ SV *sv)
7226 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7232 Creates a new SV which is an exact duplicate of the original SV.
7239 Perl_newSVsv(pTHX_ register SV *old)
7246 if (SvTYPE(old) == SVTYPEMASK) {
7247 if (ckWARN_d(WARN_INTERNAL))
7248 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7252 /* SV_GMAGIC is the default for sv_setv()
7253 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7254 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7255 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7260 =for apidoc sv_reset
7262 Underlying implementation for the C<reset> Perl function.
7263 Note that the perl-level function is vaguely deprecated.
7269 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7272 char todo[PERL_UCHAR_MAX+1];
7277 if (!*s) { /* reset ?? searches */
7278 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7280 PMOP *pm = (PMOP *) mg->mg_obj;
7282 pm->op_pmdynflags &= ~PMdf_USED;
7289 /* reset variables */
7291 if (!HvARRAY(stash))
7294 Zero(todo, 256, char);
7297 I32 i = (unsigned char)*s;
7301 max = (unsigned char)*s++;
7302 for ( ; i <= max; i++) {
7305 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7307 for (entry = HvARRAY(stash)[i];
7309 entry = HeNEXT(entry))
7314 if (!todo[(U8)*HeKEY(entry)])
7316 gv = (GV*)HeVAL(entry);
7319 if (SvTHINKFIRST(sv)) {
7320 if (!SvREADONLY(sv) && SvROK(sv))
7322 /* XXX Is this continue a bug? Why should THINKFIRST
7323 exempt us from resetting arrays and hashes? */
7327 if (SvTYPE(sv) >= SVt_PV) {
7329 if (SvPVX_const(sv) != NULL)
7337 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7339 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7342 # if defined(USE_ENVIRON_ARRAY)
7345 # endif /* USE_ENVIRON_ARRAY */
7356 Using various gambits, try to get an IO from an SV: the IO slot if its a
7357 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7358 named after the PV if we're a string.
7364 Perl_sv_2io(pTHX_ SV *sv)
7369 switch (SvTYPE(sv)) {
7377 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7381 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7383 return sv_2io(SvRV(sv));
7384 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7390 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7399 Using various gambits, try to get a CV from an SV; in addition, try if
7400 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7401 The flags in C<lref> are passed to sv_fetchsv.
7407 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7418 switch (SvTYPE(sv)) {
7437 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7438 tryAMAGICunDEREF(to_cv);
7441 if (SvTYPE(sv) == SVt_PVCV) {
7450 Perl_croak(aTHX_ "Not a subroutine reference");
7455 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7461 /* Some flags to gv_fetchsv mean don't really create the GV */
7462 if (SvTYPE(gv) != SVt_PVGV) {
7468 if (lref && !GvCVu(gv)) {
7472 gv_efullname3(tmpsv, gv, NULL);
7473 /* XXX this is probably not what they think they're getting.
7474 * It has the same effect as "sub name;", i.e. just a forward
7476 newSUB(start_subparse(FALSE, 0),
7477 newSVOP(OP_CONST, 0, tmpsv),
7481 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7491 Returns true if the SV has a true value by Perl's rules.
7492 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7493 instead use an in-line version.
7499 Perl_sv_true(pTHX_ register SV *sv)
7504 register const XPV* const tXpv = (XPV*)SvANY(sv);
7506 (tXpv->xpv_cur > 1 ||
7507 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7514 return SvIVX(sv) != 0;
7517 return SvNVX(sv) != 0.0;
7519 return sv_2bool(sv);
7525 =for apidoc sv_pvn_force
7527 Get a sensible string out of the SV somehow.
7528 A private implementation of the C<SvPV_force> macro for compilers which
7529 can't cope with complex macro expressions. Always use the macro instead.
7531 =for apidoc sv_pvn_force_flags
7533 Get a sensible string out of the SV somehow.
7534 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7535 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7536 implemented in terms of this function.
7537 You normally want to use the various wrapper macros instead: see
7538 C<SvPV_force> and C<SvPV_force_nomg>
7544 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7547 if (SvTHINKFIRST(sv) && !SvROK(sv))
7548 sv_force_normal_flags(sv, 0);
7558 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7559 const char * const ref = sv_reftype(sv,0);
7561 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7562 ref, OP_NAME(PL_op));
7564 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7566 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7567 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7569 s = sv_2pv_flags(sv, &len, flags);
7573 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7576 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7577 SvGROW(sv, len + 1);
7578 Move(s,SvPVX(sv),len,char);
7583 SvPOK_on(sv); /* validate pointer */
7585 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7586 PTR2UV(sv),SvPVX_const(sv)));
7589 return SvPVX_mutable(sv);
7593 =for apidoc sv_pvbyten_force
7595 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7601 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7603 sv_pvn_force(sv,lp);
7604 sv_utf8_downgrade(sv,0);
7610 =for apidoc sv_pvutf8n_force
7612 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7618 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7620 sv_pvn_force(sv,lp);
7621 sv_utf8_upgrade(sv);
7627 =for apidoc sv_reftype
7629 Returns a string describing what the SV is a reference to.
7635 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7637 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7638 inside return suggests a const propagation bug in g++. */
7639 if (ob && SvOBJECT(sv)) {
7640 char * const name = HvNAME_get(SvSTASH(sv));
7641 return name ? name : (char *) "__ANON__";
7644 switch (SvTYPE(sv)) {
7661 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7662 /* tied lvalues should appear to be
7663 * scalars for backwards compatitbility */
7664 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7665 ? "SCALAR" : "LVALUE");
7666 case SVt_PVAV: return "ARRAY";
7667 case SVt_PVHV: return "HASH";
7668 case SVt_PVCV: return "CODE";
7669 case SVt_PVGV: return "GLOB";
7670 case SVt_PVFM: return "FORMAT";
7671 case SVt_PVIO: return "IO";
7672 default: return "UNKNOWN";
7678 =for apidoc sv_isobject
7680 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7681 object. If the SV is not an RV, or if the object is not blessed, then this
7688 Perl_sv_isobject(pTHX_ SV *sv)
7704 Returns a boolean indicating whether the SV is blessed into the specified
7705 class. This does not check for subtypes; use C<sv_derived_from> to verify
7706 an inheritance relationship.
7712 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7723 hvname = HvNAME_get(SvSTASH(sv));
7727 return strEQ(hvname, name);
7733 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7734 it will be upgraded to one. If C<classname> is non-null then the new SV will
7735 be blessed in the specified package. The new SV is returned and its
7736 reference count is 1.
7742 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7749 SV_CHECK_THINKFIRST_COW_DROP(rv);
7752 if (SvTYPE(rv) >= SVt_PVMG) {
7753 const U32 refcnt = SvREFCNT(rv);
7757 SvREFCNT(rv) = refcnt;
7759 sv_upgrade(rv, SVt_RV);
7760 } else if (SvROK(rv)) {
7761 SvREFCNT_dec(SvRV(rv));
7762 } else if (SvTYPE(rv) < SVt_RV)
7763 sv_upgrade(rv, SVt_RV);
7764 else if (SvTYPE(rv) > SVt_RV) {
7775 HV* const stash = gv_stashpv(classname, TRUE);
7776 (void)sv_bless(rv, stash);
7782 =for apidoc sv_setref_pv
7784 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7785 argument will be upgraded to an RV. That RV will be modified to point to
7786 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7787 into the SV. The C<classname> argument indicates the package for the
7788 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7789 will have a reference count of 1, and the RV will be returned.
7791 Do not use with other Perl types such as HV, AV, SV, CV, because those
7792 objects will become corrupted by the pointer copy process.
7794 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7800 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7804 sv_setsv(rv, &PL_sv_undef);
7808 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7813 =for apidoc sv_setref_iv
7815 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7816 argument will be upgraded to an RV. That RV will be modified to point to
7817 the new SV. The C<classname> argument indicates the package for the
7818 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7819 will have a reference count of 1, and the RV will be returned.
7825 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7827 sv_setiv(newSVrv(rv,classname), iv);
7832 =for apidoc sv_setref_uv
7834 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7835 argument will be upgraded to an RV. That RV will be modified to point to
7836 the new SV. The C<classname> argument indicates the package for the
7837 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7838 will have a reference count of 1, and the RV will be returned.
7844 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7846 sv_setuv(newSVrv(rv,classname), uv);
7851 =for apidoc sv_setref_nv
7853 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7854 argument will be upgraded to an RV. That RV will be modified to point to
7855 the new SV. The C<classname> argument indicates the package for the
7856 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7857 will have a reference count of 1, and the RV will be returned.
7863 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7865 sv_setnv(newSVrv(rv,classname), nv);
7870 =for apidoc sv_setref_pvn
7872 Copies a string into a new SV, optionally blessing the SV. The length of the
7873 string must be specified with C<n>. The C<rv> argument will be upgraded to
7874 an RV. That RV will be modified to point to the new SV. The C<classname>
7875 argument indicates the package for the blessing. Set C<classname> to
7876 C<NULL> to avoid the blessing. The new SV will have a reference count
7877 of 1, and the RV will be returned.
7879 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7885 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7887 sv_setpvn(newSVrv(rv,classname), pv, n);
7892 =for apidoc sv_bless
7894 Blesses an SV into a specified package. The SV must be an RV. The package
7895 must be designated by its stash (see C<gv_stashpv()>). The reference count
7896 of the SV is unaffected.
7902 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7907 Perl_croak(aTHX_ "Can't bless non-reference value");
7909 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7910 if (SvREADONLY(tmpRef))
7911 Perl_croak(aTHX_ PL_no_modify);
7912 if (SvOBJECT(tmpRef)) {
7913 if (SvTYPE(tmpRef) != SVt_PVIO)
7915 SvREFCNT_dec(SvSTASH(tmpRef));
7918 SvOBJECT_on(tmpRef);
7919 if (SvTYPE(tmpRef) != SVt_PVIO)
7921 SvUPGRADE(tmpRef, SVt_PVMG);
7922 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7929 if(SvSMAGICAL(tmpRef))
7930 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7938 /* Downgrades a PVGV to a PVMG.
7942 S_sv_unglob(pTHX_ SV *sv)
7946 SV * const temp = sv_newmortal();
7948 assert(SvTYPE(sv) == SVt_PVGV);
7950 gv_efullname3(temp, (GV *) sv, "*");
7956 sv_del_backref((SV*)GvSTASH(sv), sv);
7960 if (GvNAME_HEK(sv)) {
7961 unshare_hek(GvNAME_HEK(sv));
7965 /* need to keep SvANY(sv) in the right arena */
7966 xpvmg = new_XPVMG();
7967 StructCopy(SvANY(sv), xpvmg, XPVMG);
7968 del_XPVGV(SvANY(sv));
7971 SvFLAGS(sv) &= ~SVTYPEMASK;
7972 SvFLAGS(sv) |= SVt_PVMG;
7974 /* Intentionally not calling any local SET magic, as this isn't so much a
7975 set operation as merely an internal storage change. */
7976 sv_setsv_flags(sv, temp, 0);
7980 =for apidoc sv_unref_flags
7982 Unsets the RV status of the SV, and decrements the reference count of
7983 whatever was being referenced by the RV. This can almost be thought of
7984 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7985 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7986 (otherwise the decrementing is conditional on the reference count being
7987 different from one or the reference being a readonly SV).
7994 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7996 SV* const target = SvRV(ref);
7998 if (SvWEAKREF(ref)) {
7999 sv_del_backref(target, ref);
8001 SvRV_set(ref, NULL);
8004 SvRV_set(ref, NULL);
8006 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8007 assigned to as BEGIN {$a = \"Foo"} will fail. */
8008 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8009 SvREFCNT_dec(target);
8010 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8011 sv_2mortal(target); /* Schedule for freeing later */
8015 =for apidoc sv_untaint
8017 Untaint an SV. Use C<SvTAINTED_off> instead.
8022 Perl_sv_untaint(pTHX_ SV *sv)
8024 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8025 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8032 =for apidoc sv_tainted
8034 Test an SV for taintedness. Use C<SvTAINTED> instead.
8039 Perl_sv_tainted(pTHX_ SV *sv)
8041 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8042 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8043 if (mg && (mg->mg_len & 1) )
8050 =for apidoc sv_setpviv
8052 Copies an integer into the given SV, also updating its string value.
8053 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8059 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8061 char buf[TYPE_CHARS(UV)];
8063 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8065 sv_setpvn(sv, ptr, ebuf - ptr);
8069 =for apidoc sv_setpviv_mg
8071 Like C<sv_setpviv>, but also handles 'set' magic.
8077 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8083 #if defined(PERL_IMPLICIT_CONTEXT)
8085 /* pTHX_ magic can't cope with varargs, so this is a no-context
8086 * version of the main function, (which may itself be aliased to us).
8087 * Don't access this version directly.
8091 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8095 va_start(args, pat);
8096 sv_vsetpvf(sv, pat, &args);
8100 /* pTHX_ magic can't cope with varargs, so this is a no-context
8101 * version of the main function, (which may itself be aliased to us).
8102 * Don't access this version directly.
8106 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8110 va_start(args, pat);
8111 sv_vsetpvf_mg(sv, pat, &args);
8117 =for apidoc sv_setpvf
8119 Works like C<sv_catpvf> but copies the text into the SV instead of
8120 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8126 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8129 va_start(args, pat);
8130 sv_vsetpvf(sv, pat, &args);
8135 =for apidoc sv_vsetpvf
8137 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8138 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8140 Usually used via its frontend C<sv_setpvf>.
8146 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8148 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8152 =for apidoc sv_setpvf_mg
8154 Like C<sv_setpvf>, but also handles 'set' magic.
8160 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8163 va_start(args, pat);
8164 sv_vsetpvf_mg(sv, pat, &args);
8169 =for apidoc sv_vsetpvf_mg
8171 Like C<sv_vsetpvf>, but also handles 'set' magic.
8173 Usually used via its frontend C<sv_setpvf_mg>.
8179 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8181 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8185 #if defined(PERL_IMPLICIT_CONTEXT)
8187 /* pTHX_ magic can't cope with varargs, so this is a no-context
8188 * version of the main function, (which may itself be aliased to us).
8189 * Don't access this version directly.
8193 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8197 va_start(args, pat);
8198 sv_vcatpvf(sv, pat, &args);
8202 /* pTHX_ magic can't cope with varargs, so this is a no-context
8203 * version of the main function, (which may itself be aliased to us).
8204 * Don't access this version directly.
8208 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8212 va_start(args, pat);
8213 sv_vcatpvf_mg(sv, pat, &args);
8219 =for apidoc sv_catpvf
8221 Processes its arguments like C<sprintf> and appends the formatted
8222 output to an SV. If the appended data contains "wide" characters
8223 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8224 and characters >255 formatted with %c), the original SV might get
8225 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8226 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8227 valid UTF-8; if the original SV was bytes, the pattern should be too.
8232 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8235 va_start(args, pat);
8236 sv_vcatpvf(sv, pat, &args);
8241 =for apidoc sv_vcatpvf
8243 Processes its arguments like C<vsprintf> and appends the formatted output
8244 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8246 Usually used via its frontend C<sv_catpvf>.
8252 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8254 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8258 =for apidoc sv_catpvf_mg
8260 Like C<sv_catpvf>, but also handles 'set' magic.
8266 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8269 va_start(args, pat);
8270 sv_vcatpvf_mg(sv, pat, &args);
8275 =for apidoc sv_vcatpvf_mg
8277 Like C<sv_vcatpvf>, but also handles 'set' magic.
8279 Usually used via its frontend C<sv_catpvf_mg>.
8285 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8287 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8292 =for apidoc sv_vsetpvfn
8294 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8297 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8303 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8305 sv_setpvn(sv, "", 0);
8306 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8310 S_expect_number(pTHX_ char** pattern)
8314 switch (**pattern) {
8315 case '1': case '2': case '3':
8316 case '4': case '5': case '6':
8317 case '7': case '8': case '9':
8318 var = *(*pattern)++ - '0';
8319 while (isDIGIT(**pattern)) {
8320 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8322 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8330 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8332 const int neg = nv < 0;
8341 if (uv & 1 && uv == nv)
8342 uv--; /* Round to even */
8344 const unsigned dig = uv % 10;
8357 =for apidoc sv_vcatpvfn
8359 Processes its arguments like C<vsprintf> and appends the formatted output
8360 to an SV. Uses an array of SVs if the C style variable argument list is
8361 missing (NULL). When running with taint checks enabled, indicates via
8362 C<maybe_tainted> if results are untrustworthy (often due to the use of
8365 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8371 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8372 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8373 vec_utf8 = DO_UTF8(vecsv);
8375 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8378 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8386 static const char nullstr[] = "(null)";
8388 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8389 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8391 /* Times 4: a decimal digit takes more than 3 binary digits.
8392 * NV_DIG: mantissa takes than many decimal digits.
8393 * Plus 32: Playing safe. */
8394 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8395 /* large enough for "%#.#f" --chip */
8396 /* what about long double NVs? --jhi */
8398 PERL_UNUSED_ARG(maybe_tainted);
8400 /* no matter what, this is a string now */
8401 (void)SvPV_force(sv, origlen);
8403 /* special-case "", "%s", and "%-p" (SVf - see below) */
8406 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8408 const char * const s = va_arg(*args, char*);
8409 sv_catpv(sv, s ? s : nullstr);
8411 else if (svix < svmax) {
8412 sv_catsv(sv, *svargs);
8416 if (args && patlen == 3 && pat[0] == '%' &&
8417 pat[1] == '-' && pat[2] == 'p') {
8418 argsv = va_arg(*args, SV*);
8419 sv_catsv(sv, argsv);
8423 #ifndef USE_LONG_DOUBLE
8424 /* special-case "%.<number>[gf]" */
8425 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8426 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8427 unsigned digits = 0;
8431 while (*pp >= '0' && *pp <= '9')
8432 digits = 10 * digits + (*pp++ - '0');
8433 if (pp - pat == (int)patlen - 1) {
8441 /* Add check for digits != 0 because it seems that some
8442 gconverts are buggy in this case, and we don't yet have
8443 a Configure test for this. */
8444 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8445 /* 0, point, slack */
8446 Gconvert(nv, (int)digits, 0, ebuf);
8448 if (*ebuf) /* May return an empty string for digits==0 */
8451 } else if (!digits) {
8454 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8455 sv_catpvn(sv, p, l);
8461 #endif /* !USE_LONG_DOUBLE */
8463 if (!args && svix < svmax && DO_UTF8(*svargs))
8466 patend = (char*)pat + patlen;
8467 for (p = (char*)pat; p < patend; p = q) {
8470 bool vectorize = FALSE;
8471 bool vectorarg = FALSE;
8472 bool vec_utf8 = FALSE;
8478 bool has_precis = FALSE;
8480 const I32 osvix = svix;
8481 bool is_utf8 = FALSE; /* is this item utf8? */
8482 #ifdef HAS_LDBL_SPRINTF_BUG
8483 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8484 with sfio - Allen <allens@cpan.org> */
8485 bool fix_ldbl_sprintf_bug = FALSE;
8489 U8 utf8buf[UTF8_MAXBYTES+1];
8490 STRLEN esignlen = 0;
8492 const char *eptr = NULL;
8495 const U8 *vecstr = NULL;
8502 /* we need a long double target in case HAS_LONG_DOUBLE but
8505 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8513 const char *dotstr = ".";
8514 STRLEN dotstrlen = 1;
8515 I32 efix = 0; /* explicit format parameter index */
8516 I32 ewix = 0; /* explicit width index */
8517 I32 epix = 0; /* explicit precision index */
8518 I32 evix = 0; /* explicit vector index */
8519 bool asterisk = FALSE;
8521 /* echo everything up to the next format specification */
8522 for (q = p; q < patend && *q != '%'; ++q) ;
8524 if (has_utf8 && !pat_utf8)
8525 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8527 sv_catpvn(sv, p, q - p);
8534 We allow format specification elements in this order:
8535 \d+\$ explicit format parameter index
8537 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8538 0 flag (as above): repeated to allow "v02"
8539 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8540 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8542 [%bcdefginopsuxDFOUX] format (mandatory)
8547 As of perl5.9.3, printf format checking is on by default.
8548 Internally, perl uses %p formats to provide an escape to
8549 some extended formatting. This block deals with those
8550 extensions: if it does not match, (char*)q is reset and
8551 the normal format processing code is used.
8553 Currently defined extensions are:
8554 %p include pointer address (standard)
8555 %-p (SVf) include an SV (previously %_)
8556 %-<num>p include an SV with precision <num>
8557 %1p (VDf) include a v-string (as %vd)
8558 %<num>p reserved for future extensions
8560 Robin Barker 2005-07-14
8567 n = expect_number(&q);
8574 argsv = va_arg(*args, SV*);
8575 eptr = SvPVx_const(argsv, elen);
8581 else if (n == vdNUMBER) { /* VDf */
8588 if (ckWARN_d(WARN_INTERNAL))
8589 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8590 "internal %%<num>p might conflict with future printf extensions");
8596 if ( (width = expect_number(&q)) ) {
8637 if ( (ewix = expect_number(&q)) )
8646 if ((vectorarg = asterisk)) {
8659 width = expect_number(&q);
8665 vecsv = va_arg(*args, SV*);
8667 vecsv = (evix > 0 && evix <= svmax)
8668 ? svargs[evix-1] : &PL_sv_undef;
8670 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8672 dotstr = SvPV_const(vecsv, dotstrlen);
8673 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8674 bad with tied or overloaded values that return UTF8. */
8677 else if (has_utf8) {
8678 vecsv = sv_mortalcopy(vecsv);
8679 sv_utf8_upgrade(vecsv);
8680 dotstr = SvPV_const(vecsv, dotstrlen);
8687 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8688 vecsv = svargs[efix ? efix-1 : svix++];
8689 vecstr = (U8*)SvPV_const(vecsv,veclen);
8690 vec_utf8 = DO_UTF8(vecsv);
8692 /* if this is a version object, we need to convert
8693 * back into v-string notation and then let the
8694 * vectorize happen normally
8696 if (sv_derived_from(vecsv, "version")) {
8697 char *version = savesvpv(vecsv);
8698 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8699 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8700 "vector argument not supported with alpha versions");
8703 vecsv = sv_newmortal();
8704 /* scan_vstring is expected to be called during
8705 * tokenization, so we need to fake up the end
8706 * of the buffer for it
8708 PL_bufend = version + veclen;
8709 scan_vstring(version, vecsv);
8710 vecstr = (U8*)SvPV_const(vecsv, veclen);
8711 vec_utf8 = DO_UTF8(vecsv);
8723 i = va_arg(*args, int);
8725 i = (ewix ? ewix <= svmax : svix < svmax) ?
8726 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8728 width = (i < 0) ? -i : i;
8738 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8740 /* XXX: todo, support specified precision parameter */
8744 i = va_arg(*args, int);
8746 i = (ewix ? ewix <= svmax : svix < svmax)
8747 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8748 precis = (i < 0) ? 0 : i;
8753 precis = precis * 10 + (*q++ - '0');
8762 case 'I': /* Ix, I32x, and I64x */
8764 if (q[1] == '6' && q[2] == '4') {
8770 if (q[1] == '3' && q[2] == '2') {
8780 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8791 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8792 if (*(q + 1) == 'l') { /* lld, llf */
8818 if (!vectorize && !args) {
8820 const I32 i = efix-1;
8821 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8823 argsv = (svix >= 0 && svix < svmax)
8824 ? svargs[svix++] : &PL_sv_undef;
8835 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8837 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8839 eptr = (char*)utf8buf;
8840 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8854 eptr = va_arg(*args, char*);
8856 #ifdef MACOS_TRADITIONAL
8857 /* On MacOS, %#s format is used for Pascal strings */
8862 elen = strlen(eptr);
8864 eptr = (char *)nullstr;
8865 elen = sizeof nullstr - 1;
8869 eptr = SvPVx_const(argsv, elen);
8870 if (DO_UTF8(argsv)) {
8871 if (has_precis && precis < elen) {
8873 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8876 if (width) { /* fudge width (can't fudge elen) */
8877 width += elen - sv_len_utf8(argsv);
8884 if (has_precis && elen > precis)
8891 if (alt || vectorize)
8893 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8914 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8923 esignbuf[esignlen++] = plus;
8927 case 'h': iv = (short)va_arg(*args, int); break;
8928 case 'l': iv = va_arg(*args, long); break;
8929 case 'V': iv = va_arg(*args, IV); break;
8930 default: iv = va_arg(*args, int); break;
8932 case 'q': iv = va_arg(*args, Quad_t); break;
8937 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8939 case 'h': iv = (short)tiv; break;
8940 case 'l': iv = (long)tiv; break;
8942 default: iv = tiv; break;
8944 case 'q': iv = (Quad_t)tiv; break;
8948 if ( !vectorize ) /* we already set uv above */
8953 esignbuf[esignlen++] = plus;
8957 esignbuf[esignlen++] = '-';
9000 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9011 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9012 case 'l': uv = va_arg(*args, unsigned long); break;
9013 case 'V': uv = va_arg(*args, UV); break;
9014 default: uv = va_arg(*args, unsigned); break;
9016 case 'q': uv = va_arg(*args, Uquad_t); break;
9021 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9023 case 'h': uv = (unsigned short)tuv; break;
9024 case 'l': uv = (unsigned long)tuv; break;
9026 default: uv = tuv; break;
9028 case 'q': uv = (Uquad_t)tuv; break;
9035 char *ptr = ebuf + sizeof ebuf;
9036 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9042 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9048 esignbuf[esignlen++] = '0';
9049 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9057 if (alt && *ptr != '0')
9066 esignbuf[esignlen++] = '0';
9067 esignbuf[esignlen++] = 'b';
9070 default: /* it had better be ten or less */
9074 } while (uv /= base);
9077 elen = (ebuf + sizeof ebuf) - ptr;
9081 zeros = precis - elen;
9082 else if (precis == 0 && elen == 1 && *eptr == '0')
9088 /* FLOATING POINT */
9091 c = 'f'; /* maybe %F isn't supported here */
9099 /* This is evil, but floating point is even more evil */
9101 /* for SV-style calling, we can only get NV
9102 for C-style calling, we assume %f is double;
9103 for simplicity we allow any of %Lf, %llf, %qf for long double
9107 #if defined(USE_LONG_DOUBLE)
9111 /* [perl #20339] - we should accept and ignore %lf rather than die */
9115 #if defined(USE_LONG_DOUBLE)
9116 intsize = args ? 0 : 'q';
9120 #if defined(HAS_LONG_DOUBLE)
9129 /* now we need (long double) if intsize == 'q', else (double) */
9131 #if LONG_DOUBLESIZE > DOUBLESIZE
9133 va_arg(*args, long double) :
9134 va_arg(*args, double)
9136 va_arg(*args, double)
9141 if (c != 'e' && c != 'E') {
9143 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9144 will cast our (long double) to (double) */
9145 (void)Perl_frexp(nv, &i);
9146 if (i == PERL_INT_MIN)
9147 Perl_die(aTHX_ "panic: frexp");
9149 need = BIT_DIGITS(i);
9151 need += has_precis ? precis : 6; /* known default */
9156 #ifdef HAS_LDBL_SPRINTF_BUG
9157 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9158 with sfio - Allen <allens@cpan.org> */
9161 # define MY_DBL_MAX DBL_MAX
9162 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9163 # if DOUBLESIZE >= 8
9164 # define MY_DBL_MAX 1.7976931348623157E+308L
9166 # define MY_DBL_MAX 3.40282347E+38L
9170 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9171 # define MY_DBL_MAX_BUG 1L
9173 # define MY_DBL_MAX_BUG MY_DBL_MAX
9177 # define MY_DBL_MIN DBL_MIN
9178 # else /* XXX guessing! -Allen */
9179 # if DOUBLESIZE >= 8
9180 # define MY_DBL_MIN 2.2250738585072014E-308L
9182 # define MY_DBL_MIN 1.17549435E-38L
9186 if ((intsize == 'q') && (c == 'f') &&
9187 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9189 /* it's going to be short enough that
9190 * long double precision is not needed */
9192 if ((nv <= 0L) && (nv >= -0L))
9193 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9195 /* would use Perl_fp_class as a double-check but not
9196 * functional on IRIX - see perl.h comments */
9198 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9199 /* It's within the range that a double can represent */
9200 #if defined(DBL_MAX) && !defined(DBL_MIN)
9201 if ((nv >= ((long double)1/DBL_MAX)) ||
9202 (nv <= (-(long double)1/DBL_MAX)))
9204 fix_ldbl_sprintf_bug = TRUE;
9207 if (fix_ldbl_sprintf_bug == TRUE) {
9217 # undef MY_DBL_MAX_BUG
9220 #endif /* HAS_LDBL_SPRINTF_BUG */
9222 need += 20; /* fudge factor */
9223 if (PL_efloatsize < need) {
9224 Safefree(PL_efloatbuf);
9225 PL_efloatsize = need + 20; /* more fudge */
9226 Newx(PL_efloatbuf, PL_efloatsize, char);
9227 PL_efloatbuf[0] = '\0';
9230 if ( !(width || left || plus || alt) && fill != '0'
9231 && has_precis && intsize != 'q' ) { /* Shortcuts */
9232 /* See earlier comment about buggy Gconvert when digits,
9234 if ( c == 'g' && precis) {
9235 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9236 /* May return an empty string for digits==0 */
9237 if (*PL_efloatbuf) {
9238 elen = strlen(PL_efloatbuf);
9239 goto float_converted;
9241 } else if ( c == 'f' && !precis) {
9242 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9247 char *ptr = ebuf + sizeof ebuf;
9250 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9251 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9252 if (intsize == 'q') {
9253 /* Copy the one or more characters in a long double
9254 * format before the 'base' ([efgEFG]) character to
9255 * the format string. */
9256 static char const prifldbl[] = PERL_PRIfldbl;
9257 char const *p = prifldbl + sizeof(prifldbl) - 3;
9258 while (p >= prifldbl) { *--ptr = *p--; }
9263 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9268 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9280 /* No taint. Otherwise we are in the strange situation
9281 * where printf() taints but print($float) doesn't.
9283 #if defined(HAS_LONG_DOUBLE)
9284 elen = ((intsize == 'q')
9285 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9286 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9288 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9292 eptr = PL_efloatbuf;
9300 i = SvCUR(sv) - origlen;
9303 case 'h': *(va_arg(*args, short*)) = i; break;
9304 default: *(va_arg(*args, int*)) = i; break;
9305 case 'l': *(va_arg(*args, long*)) = i; break;
9306 case 'V': *(va_arg(*args, IV*)) = i; break;
9308 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9313 sv_setuv_mg(argsv, (UV)i);
9314 continue; /* not "break" */
9321 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9322 && ckWARN(WARN_PRINTF))
9324 SV * const msg = sv_newmortal();
9325 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9326 (PL_op->op_type == OP_PRTF) ? "" : "s");
9329 Perl_sv_catpvf(aTHX_ msg,
9330 "\"%%%c\"", c & 0xFF);
9332 Perl_sv_catpvf(aTHX_ msg,
9333 "\"%%\\%03"UVof"\"",
9336 sv_catpvs(msg, "end of string");
9337 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9340 /* output mangled stuff ... */
9346 /* ... right here, because formatting flags should not apply */
9347 SvGROW(sv, SvCUR(sv) + elen + 1);
9349 Copy(eptr, p, elen, char);
9352 SvCUR_set(sv, p - SvPVX_const(sv));
9354 continue; /* not "break" */
9357 if (is_utf8 != has_utf8) {
9360 sv_utf8_upgrade(sv);
9363 const STRLEN old_elen = elen;
9364 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9365 sv_utf8_upgrade(nsv);
9366 eptr = SvPVX_const(nsv);
9369 if (width) { /* fudge width (can't fudge elen) */
9370 width += elen - old_elen;
9376 have = esignlen + zeros + elen;
9378 Perl_croak_nocontext(PL_memory_wrap);
9380 need = (have > width ? have : width);
9383 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9384 Perl_croak_nocontext(PL_memory_wrap);
9385 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9387 if (esignlen && fill == '0') {
9389 for (i = 0; i < (int)esignlen; i++)
9393 memset(p, fill, gap);
9396 if (esignlen && fill != '0') {
9398 for (i = 0; i < (int)esignlen; i++)
9403 for (i = zeros; i; i--)
9407 Copy(eptr, p, elen, char);
9411 memset(p, ' ', gap);
9416 Copy(dotstr, p, dotstrlen, char);
9420 vectorize = FALSE; /* done iterating over vecstr */
9427 SvCUR_set(sv, p - SvPVX_const(sv));
9435 /* =========================================================================
9437 =head1 Cloning an interpreter
9439 All the macros and functions in this section are for the private use of
9440 the main function, perl_clone().
9442 The foo_dup() functions make an exact copy of an existing foo thinngy.
9443 During the course of a cloning, a hash table is used to map old addresses
9444 to new addresses. The table is created and manipulated with the
9445 ptr_table_* functions.
9449 ============================================================================*/
9452 #if defined(USE_ITHREADS)
9454 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9455 #ifndef GpREFCNT_inc
9456 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9460 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9461 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9462 please unmerge ss_dup. */
9463 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9464 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9465 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9466 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9467 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9468 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9469 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9470 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9471 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9472 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9473 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9474 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9475 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9476 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9479 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9480 regcomp.c. AMS 20010712 */
9483 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9485 return CALLREGDUPE(r,param);
9488 /* duplicate a file handle */
9491 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9495 PERL_UNUSED_ARG(type);
9498 return (PerlIO*)NULL;
9500 /* look for it in the table first */
9501 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9505 /* create anew and remember what it is */
9506 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9507 ptr_table_store(PL_ptr_table, fp, ret);
9511 /* duplicate a directory handle */
9514 Perl_dirp_dup(pTHX_ DIR *dp)
9516 PERL_UNUSED_CONTEXT;
9523 /* duplicate a typeglob */
9526 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9532 /* look for it in the table first */
9533 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9537 /* create anew and remember what it is */
9539 ptr_table_store(PL_ptr_table, gp, ret);
9542 ret->gp_refcnt = 0; /* must be before any other dups! */
9543 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9544 ret->gp_io = io_dup_inc(gp->gp_io, param);
9545 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9546 ret->gp_av = av_dup_inc(gp->gp_av, param);
9547 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9548 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9549 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9550 ret->gp_cvgen = gp->gp_cvgen;
9551 ret->gp_line = gp->gp_line;
9552 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9556 /* duplicate a chain of magic */
9559 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9561 MAGIC *mgprev = (MAGIC*)NULL;
9564 return (MAGIC*)NULL;
9565 /* look for it in the table first */
9566 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9570 for (; mg; mg = mg->mg_moremagic) {
9572 Newxz(nmg, 1, MAGIC);
9574 mgprev->mg_moremagic = nmg;
9577 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9578 nmg->mg_private = mg->mg_private;
9579 nmg->mg_type = mg->mg_type;
9580 nmg->mg_flags = mg->mg_flags;
9581 if (mg->mg_type == PERL_MAGIC_qr) {
9582 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9584 else if(mg->mg_type == PERL_MAGIC_backref) {
9585 /* The backref AV has its reference count deliberately bumped by
9587 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9589 else if (mg->mg_type == PERL_MAGIC_symtab) {
9590 nmg->mg_obj = mg->mg_obj;
9593 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9594 ? sv_dup_inc(mg->mg_obj, param)
9595 : sv_dup(mg->mg_obj, param);
9597 nmg->mg_len = mg->mg_len;
9598 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9599 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9600 if (mg->mg_len > 0) {
9601 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9602 if (mg->mg_type == PERL_MAGIC_overload_table &&
9603 AMT_AMAGIC((AMT*)mg->mg_ptr))
9605 const AMT * const amtp = (AMT*)mg->mg_ptr;
9606 AMT * const namtp = (AMT*)nmg->mg_ptr;
9608 for (i = 1; i < NofAMmeth; i++) {
9609 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9613 else if (mg->mg_len == HEf_SVKEY)
9614 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9616 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9617 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9624 /* create a new pointer-mapping table */
9627 Perl_ptr_table_new(pTHX)
9630 PERL_UNUSED_CONTEXT;
9632 Newxz(tbl, 1, PTR_TBL_t);
9635 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9639 #define PTR_TABLE_HASH(ptr) \
9640 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9643 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9644 following define) and at call to new_body_inline made below in
9645 Perl_ptr_table_store()
9648 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9650 /* map an existing pointer using a table */
9652 STATIC PTR_TBL_ENT_t *
9653 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9654 PTR_TBL_ENT_t *tblent;
9655 const UV hash = PTR_TABLE_HASH(sv);
9657 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9658 for (; tblent; tblent = tblent->next) {
9659 if (tblent->oldval == sv)
9666 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9668 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9669 PERL_UNUSED_CONTEXT;
9670 return tblent ? tblent->newval : NULL;
9673 /* add a new entry to a pointer-mapping table */
9676 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9678 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9679 PERL_UNUSED_CONTEXT;
9682 tblent->newval = newsv;
9684 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9686 new_body_inline(tblent, PTE_SVSLOT);
9688 tblent->oldval = oldsv;
9689 tblent->newval = newsv;
9690 tblent->next = tbl->tbl_ary[entry];
9691 tbl->tbl_ary[entry] = tblent;
9693 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9694 ptr_table_split(tbl);
9698 /* double the hash bucket size of an existing ptr table */
9701 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9703 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9704 const UV oldsize = tbl->tbl_max + 1;
9705 UV newsize = oldsize * 2;
9707 PERL_UNUSED_CONTEXT;
9709 Renew(ary, newsize, PTR_TBL_ENT_t*);
9710 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9711 tbl->tbl_max = --newsize;
9713 for (i=0; i < oldsize; i++, ary++) {
9714 PTR_TBL_ENT_t **curentp, **entp, *ent;
9717 curentp = ary + oldsize;
9718 for (entp = ary, ent = *ary; ent; ent = *entp) {
9719 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9721 ent->next = *curentp;
9731 /* remove all the entries from a ptr table */
9734 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9736 if (tbl && tbl->tbl_items) {
9737 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9738 UV riter = tbl->tbl_max;
9741 PTR_TBL_ENT_t *entry = array[riter];
9744 PTR_TBL_ENT_t * const oentry = entry;
9745 entry = entry->next;
9754 /* clear and free a ptr table */
9757 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9762 ptr_table_clear(tbl);
9763 Safefree(tbl->tbl_ary);
9769 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9772 SvRV_set(dstr, SvWEAKREF(sstr)
9773 ? sv_dup(SvRV(sstr), param)
9774 : sv_dup_inc(SvRV(sstr), param));
9777 else if (SvPVX_const(sstr)) {
9778 /* Has something there */
9780 /* Normal PV - clone whole allocated space */
9781 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9782 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9783 /* Not that normal - actually sstr is copy on write.
9784 But we are a true, independant SV, so: */
9785 SvREADONLY_off(dstr);
9790 /* Special case - not normally malloced for some reason */
9791 if (isGV_with_GP(sstr)) {
9792 /* Don't need to do anything here. */
9794 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9795 /* A "shared" PV - clone it as "shared" PV */
9797 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9801 /* Some other special case - random pointer */
9802 SvPV_set(dstr, SvPVX(sstr));
9808 if (SvTYPE(dstr) == SVt_RV)
9809 SvRV_set(dstr, NULL);
9811 SvPV_set(dstr, NULL);
9815 /* duplicate an SV of any type (including AV, HV etc) */
9818 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9823 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9825 /* look for it in the table first */
9826 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9830 if(param->flags & CLONEf_JOIN_IN) {
9831 /** We are joining here so we don't want do clone
9832 something that is bad **/
9833 if (SvTYPE(sstr) == SVt_PVHV) {
9834 const char * const hvname = HvNAME_get(sstr);
9836 /** don't clone stashes if they already exist **/
9837 return (SV*)gv_stashpv(hvname,0);
9841 /* create anew and remember what it is */
9844 #ifdef DEBUG_LEAKING_SCALARS
9845 dstr->sv_debug_optype = sstr->sv_debug_optype;
9846 dstr->sv_debug_line = sstr->sv_debug_line;
9847 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9848 dstr->sv_debug_cloned = 1;
9849 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9852 ptr_table_store(PL_ptr_table, sstr, dstr);
9855 SvFLAGS(dstr) = SvFLAGS(sstr);
9856 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9857 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9860 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9861 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9862 PL_watch_pvx, SvPVX_const(sstr));
9865 /* don't clone objects whose class has asked us not to */
9866 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9867 SvFLAGS(dstr) &= ~SVTYPEMASK;
9872 switch (SvTYPE(sstr)) {
9877 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9878 SvIV_set(dstr, SvIVX(sstr));
9881 SvANY(dstr) = new_XNV();
9882 SvNV_set(dstr, SvNVX(sstr));
9885 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9886 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9890 /* These are all the types that need complex bodies allocating. */
9892 const svtype sv_type = SvTYPE(sstr);
9893 const struct body_details *const sv_type_details
9894 = bodies_by_type + sv_type;
9898 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9902 if (GvUNIQUE((GV*)sstr)) {
9903 NOOP; /* Do sharing here, and fall through */
9916 assert(sv_type_details->body_size);
9917 if (sv_type_details->arena) {
9918 new_body_inline(new_body, sv_type);
9920 = (void*)((char*)new_body - sv_type_details->offset);
9922 new_body = new_NOARENA(sv_type_details);
9926 SvANY(dstr) = new_body;
9929 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9930 ((char*)SvANY(dstr)) + sv_type_details->offset,
9931 sv_type_details->copy, char);
9933 Copy(((char*)SvANY(sstr)),
9934 ((char*)SvANY(dstr)),
9935 sv_type_details->body_size + sv_type_details->offset, char);
9938 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9939 && !isGV_with_GP(dstr))
9940 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9942 /* The Copy above means that all the source (unduplicated) pointers
9943 are now in the destination. We can check the flags and the
9944 pointers in either, but it's possible that there's less cache
9945 missing by always going for the destination.
9946 FIXME - instrument and check that assumption */
9947 if (sv_type >= SVt_PVMG) {
9948 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9949 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9950 } else if (SvMAGIC(dstr))
9951 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9953 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9956 /* The cast silences a GCC warning about unhandled types. */
9957 switch ((int)sv_type) {
9969 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9970 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9971 LvTARG(dstr) = dstr;
9972 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9973 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9975 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9978 if (GvNAME_HEK(dstr))
9979 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9981 /* Don't call sv_add_backref here as it's going to be created
9982 as part of the magic cloning of the symbol table. */
9983 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9984 if(isGV_with_GP(sstr)) {
9985 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9986 at the point of this comment. */
9987 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9988 (void)GpREFCNT_inc(GvGP(dstr));
9990 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9993 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9994 if (IoOFP(dstr) == IoIFP(sstr))
9995 IoOFP(dstr) = IoIFP(dstr);
9997 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9998 /* PL_rsfp_filters entries have fake IoDIRP() */
9999 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10000 /* I have no idea why fake dirp (rsfps)
10001 should be treated differently but otherwise
10002 we end up with leaks -- sky*/
10003 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10004 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10005 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10007 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10008 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10009 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10010 if (IoDIRP(dstr)) {
10011 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10014 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10017 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10018 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10019 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10022 if (AvARRAY((AV*)sstr)) {
10023 SV **dst_ary, **src_ary;
10024 SSize_t items = AvFILLp((AV*)sstr) + 1;
10026 src_ary = AvARRAY((AV*)sstr);
10027 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10028 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10029 SvPV_set(dstr, (char*)dst_ary);
10030 AvALLOC((AV*)dstr) = dst_ary;
10031 if (AvREAL((AV*)sstr)) {
10032 while (items-- > 0)
10033 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10036 while (items-- > 0)
10037 *dst_ary++ = sv_dup(*src_ary++, param);
10039 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10040 while (items-- > 0) {
10041 *dst_ary++ = &PL_sv_undef;
10045 SvPV_set(dstr, NULL);
10046 AvALLOC((AV*)dstr) = (SV**)NULL;
10050 if (HvARRAY((HV*)sstr)) {
10052 const bool sharekeys = !!HvSHAREKEYS(sstr);
10053 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10054 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10056 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10057 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10059 HvARRAY(dstr) = (HE**)darray;
10060 while (i <= sxhv->xhv_max) {
10061 const HE * const source = HvARRAY(sstr)[i];
10062 HvARRAY(dstr)[i] = source
10063 ? he_dup(source, sharekeys, param) : 0;
10068 const struct xpvhv_aux * const saux = HvAUX(sstr);
10069 struct xpvhv_aux * const daux = HvAUX(dstr);
10070 /* This flag isn't copied. */
10071 /* SvOOK_on(hv) attacks the IV flags. */
10072 SvFLAGS(dstr) |= SVf_OOK;
10074 hvname = saux->xhv_name;
10075 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10077 daux->xhv_riter = saux->xhv_riter;
10078 daux->xhv_eiter = saux->xhv_eiter
10079 ? he_dup(saux->xhv_eiter,
10080 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10081 daux->xhv_backreferences =
10082 saux->xhv_backreferences
10083 ? (AV*) SvREFCNT_inc(
10084 sv_dup((SV*)saux->xhv_backreferences, param))
10086 /* Record stashes for possible cloning in Perl_clone(). */
10088 av_push(param->stashes, dstr);
10092 SvPV_set(dstr, NULL);
10095 if (!(param->flags & CLONEf_COPY_STACKS)) {
10099 /* NOTE: not refcounted */
10100 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10102 if (!CvISXSUB(dstr))
10103 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10105 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10106 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10107 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10108 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10110 /* don't dup if copying back - CvGV isn't refcounted, so the
10111 * duped GV may never be freed. A bit of a hack! DAPM */
10112 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10113 NULL : gv_dup(CvGV(dstr), param) ;
10114 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10116 CvWEAKOUTSIDE(sstr)
10117 ? cv_dup( CvOUTSIDE(dstr), param)
10118 : cv_dup_inc(CvOUTSIDE(dstr), param);
10119 if (!CvISXSUB(dstr))
10120 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10126 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10132 /* duplicate a context */
10135 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10137 PERL_CONTEXT *ncxs;
10140 return (PERL_CONTEXT*)NULL;
10142 /* look for it in the table first */
10143 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10147 /* create anew and remember what it is */
10148 Newxz(ncxs, max + 1, PERL_CONTEXT);
10149 ptr_table_store(PL_ptr_table, cxs, ncxs);
10152 PERL_CONTEXT * const cx = &cxs[ix];
10153 PERL_CONTEXT * const ncx = &ncxs[ix];
10154 ncx->cx_type = cx->cx_type;
10155 if (CxTYPE(cx) == CXt_SUBST) {
10156 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10159 ncx->blk_oldsp = cx->blk_oldsp;
10160 ncx->blk_oldcop = cx->blk_oldcop;
10161 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10162 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10163 ncx->blk_oldpm = cx->blk_oldpm;
10164 ncx->blk_gimme = cx->blk_gimme;
10165 switch (CxTYPE(cx)) {
10167 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10168 ? cv_dup_inc(cx->blk_sub.cv, param)
10169 : cv_dup(cx->blk_sub.cv,param));
10170 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10171 ? av_dup_inc(cx->blk_sub.argarray, param)
10173 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10174 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10175 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10176 ncx->blk_sub.lval = cx->blk_sub.lval;
10177 ncx->blk_sub.retop = cx->blk_sub.retop;
10178 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10179 cx->blk_sub.oldcomppad);
10182 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10183 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10184 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10185 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10186 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10187 ncx->blk_eval.retop = cx->blk_eval.retop;
10190 ncx->blk_loop.label = cx->blk_loop.label;
10191 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10192 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10193 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10194 ? cx->blk_loop.iterdata
10195 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10196 ncx->blk_loop.oldcomppad
10197 = (PAD*)ptr_table_fetch(PL_ptr_table,
10198 cx->blk_loop.oldcomppad);
10199 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10200 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10201 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10202 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10203 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10206 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10207 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10208 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10209 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10210 ncx->blk_sub.retop = cx->blk_sub.retop;
10222 /* duplicate a stack info structure */
10225 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10230 return (PERL_SI*)NULL;
10232 /* look for it in the table first */
10233 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10237 /* create anew and remember what it is */
10238 Newxz(nsi, 1, PERL_SI);
10239 ptr_table_store(PL_ptr_table, si, nsi);
10241 nsi->si_stack = av_dup_inc(si->si_stack, param);
10242 nsi->si_cxix = si->si_cxix;
10243 nsi->si_cxmax = si->si_cxmax;
10244 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10245 nsi->si_type = si->si_type;
10246 nsi->si_prev = si_dup(si->si_prev, param);
10247 nsi->si_next = si_dup(si->si_next, param);
10248 nsi->si_markoff = si->si_markoff;
10253 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10254 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10255 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10256 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10257 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10258 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10259 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10260 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10261 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10262 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10263 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10264 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10265 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10266 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10269 #define pv_dup_inc(p) SAVEPV(p)
10270 #define pv_dup(p) SAVEPV(p)
10271 #define svp_dup_inc(p,pp) any_dup(p,pp)
10273 /* map any object to the new equivent - either something in the
10274 * ptr table, or something in the interpreter structure
10278 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10283 return (void*)NULL;
10285 /* look for it in the table first */
10286 ret = ptr_table_fetch(PL_ptr_table, v);
10290 /* see if it is part of the interpreter structure */
10291 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10292 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10300 /* duplicate the save stack */
10303 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10305 ANY * const ss = proto_perl->Tsavestack;
10306 const I32 max = proto_perl->Tsavestack_max;
10307 I32 ix = proto_perl->Tsavestack_ix;
10319 void (*dptr) (void*);
10320 void (*dxptr) (pTHX_ void*);
10322 Newxz(nss, max, ANY);
10325 I32 i = POPINT(ss,ix);
10326 TOPINT(nss,ix) = i;
10328 case SAVEt_ITEM: /* normal string */
10329 case SAVEt_SV: /* scalar reference */
10330 sv = (SV*)POPPTR(ss,ix);
10331 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10332 sv = (SV*)POPPTR(ss,ix);
10333 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10335 case SAVEt_SHARED_PVREF: /* char* in shared space */
10336 c = (char*)POPPTR(ss,ix);
10337 TOPPTR(nss,ix) = savesharedpv(c);
10338 ptr = POPPTR(ss,ix);
10339 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10341 case SAVEt_GENERIC_SVREF: /* generic sv */
10342 case SAVEt_SVREF: /* scalar reference */
10343 sv = (SV*)POPPTR(ss,ix);
10344 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10345 ptr = POPPTR(ss,ix);
10346 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10348 case SAVEt_HV: /* hash reference */
10349 case SAVEt_AV: /* array reference */
10350 sv = (SV*) POPPTR(ss,ix);
10351 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10352 gv = (GV*)POPPTR(ss,ix);
10353 TOPPTR(nss,ix) = gv_dup(gv, param);
10355 case SAVEt_INT: /* int reference */
10356 ptr = POPPTR(ss,ix);
10357 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10358 intval = (int)POPINT(ss,ix);
10359 TOPINT(nss,ix) = intval;
10361 case SAVEt_LONG: /* long reference */
10362 ptr = POPPTR(ss,ix);
10363 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10364 longval = (long)POPLONG(ss,ix);
10365 TOPLONG(nss,ix) = longval;
10367 case SAVEt_I32: /* I32 reference */
10368 case SAVEt_I16: /* I16 reference */
10369 case SAVEt_I8: /* I8 reference */
10370 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10371 ptr = POPPTR(ss,ix);
10372 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10374 TOPINT(nss,ix) = i;
10376 case SAVEt_IV: /* IV reference */
10377 ptr = POPPTR(ss,ix);
10378 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10380 TOPIV(nss,ix) = iv;
10382 case SAVEt_HPTR: /* HV* reference */
10383 case SAVEt_APTR: /* AV* reference */
10384 case SAVEt_SPTR: /* SV* reference */
10385 ptr = POPPTR(ss,ix);
10386 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10387 sv = (SV*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = sv_dup(sv, param);
10390 case SAVEt_VPTR: /* random* reference */
10391 ptr = POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10393 ptr = POPPTR(ss,ix);
10394 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10396 case SAVEt_GENERIC_PVREF: /* generic char* */
10397 case SAVEt_PPTR: /* char* reference */
10398 ptr = POPPTR(ss,ix);
10399 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10400 c = (char*)POPPTR(ss,ix);
10401 TOPPTR(nss,ix) = pv_dup(c);
10404 gv = (GV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = gv_dup(gv, param);
10407 case SAVEt_GP: /* scalar reference */
10408 gp = (GP*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10410 (void)GpREFCNT_inc(gp);
10411 gv = (GV*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10413 c = (char*)POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = pv_dup(c);
10416 TOPIV(nss,ix) = iv;
10418 TOPIV(nss,ix) = iv;
10421 case SAVEt_MORTALIZESV:
10422 sv = (SV*)POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10426 ptr = POPPTR(ss,ix);
10427 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10428 /* these are assumed to be refcounted properly */
10430 switch (((OP*)ptr)->op_type) {
10432 case OP_LEAVESUBLV:
10436 case OP_LEAVEWRITE:
10437 TOPPTR(nss,ix) = ptr;
10442 TOPPTR(nss,ix) = NULL;
10447 TOPPTR(nss,ix) = NULL;
10450 c = (char*)POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = pv_dup_inc(c);
10453 case SAVEt_CLEARSV:
10454 longval = POPLONG(ss,ix);
10455 TOPLONG(nss,ix) = longval;
10458 hv = (HV*)POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10460 c = (char*)POPPTR(ss,ix);
10461 TOPPTR(nss,ix) = pv_dup_inc(c);
10463 TOPINT(nss,ix) = i;
10465 case SAVEt_DESTRUCTOR:
10466 ptr = POPPTR(ss,ix);
10467 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10468 dptr = POPDPTR(ss,ix);
10469 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10470 any_dup(FPTR2DPTR(void *, dptr),
10473 case SAVEt_DESTRUCTOR_X:
10474 ptr = POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10476 dxptr = POPDXPTR(ss,ix);
10477 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10478 any_dup(FPTR2DPTR(void *, dxptr),
10481 case SAVEt_REGCONTEXT:
10484 TOPINT(nss,ix) = i;
10487 case SAVEt_STACK_POS: /* Position on Perl stack */
10489 TOPINT(nss,ix) = i;
10491 case SAVEt_AELEM: /* array element */
10492 sv = (SV*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10495 TOPINT(nss,ix) = i;
10496 av = (AV*)POPPTR(ss,ix);
10497 TOPPTR(nss,ix) = av_dup_inc(av, param);
10499 case SAVEt_HELEM: /* hash element */
10500 sv = (SV*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10502 sv = (SV*)POPPTR(ss,ix);
10503 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10504 hv = (HV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10508 ptr = POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = ptr;
10513 TOPINT(nss,ix) = i;
10514 ptr = POPPTR(ss,ix);
10517 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10518 HINTS_REFCNT_UNLOCK;
10520 TOPPTR(nss,ix) = ptr;
10521 if (i & HINT_LOCALIZE_HH) {
10522 hv = (HV*)POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10526 case SAVEt_COMPPAD:
10527 av = (AV*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = av_dup(av, param);
10531 longval = (long)POPLONG(ss,ix);
10532 TOPLONG(nss,ix) = longval;
10533 ptr = POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10535 sv = (SV*)POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = sv_dup(sv, param);
10539 ptr = POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10541 longval = (long)POPBOOL(ss,ix);
10542 TOPBOOL(nss,ix) = (bool)longval;
10544 case SAVEt_SET_SVFLAGS:
10546 TOPINT(nss,ix) = i;
10548 TOPINT(nss,ix) = i;
10549 sv = (SV*)POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup(sv, param);
10552 case SAVEt_RE_STATE:
10554 const struct re_save_state *const old_state
10555 = (struct re_save_state *)
10556 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10557 struct re_save_state *const new_state
10558 = (struct re_save_state *)
10559 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10561 Copy(old_state, new_state, 1, struct re_save_state);
10562 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10564 new_state->re_state_bostr
10565 = pv_dup(old_state->re_state_bostr);
10566 new_state->re_state_reginput
10567 = pv_dup(old_state->re_state_reginput);
10568 new_state->re_state_regeol
10569 = pv_dup(old_state->re_state_regeol);
10570 new_state->re_state_regstartp
10571 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10572 new_state->re_state_regendp
10573 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10574 new_state->re_state_reglastparen
10575 = (U32*) any_dup(old_state->re_state_reglastparen,
10577 new_state->re_state_reglastcloseparen
10578 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10580 /* XXX This just has to be broken. The old save_re_context
10581 code did SAVEGENERICPV(PL_reg_start_tmp);
10582 PL_reg_start_tmp is char **.
10583 Look above to what the dup code does for
10584 SAVEt_GENERIC_PVREF
10585 It can never have worked.
10586 So this is merely a faithful copy of the exiting bug: */
10587 new_state->re_state_reg_start_tmp
10588 = (char **) pv_dup((char *)
10589 old_state->re_state_reg_start_tmp);
10590 /* I assume that it only ever "worked" because no-one called
10591 (pseudo)fork while the regexp engine had re-entered itself.
10593 #ifdef PERL_OLD_COPY_ON_WRITE
10594 new_state->re_state_nrs
10595 = sv_dup(old_state->re_state_nrs, param);
10597 new_state->re_state_reg_magic
10598 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10600 new_state->re_state_reg_oldcurpm
10601 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10603 new_state->re_state_reg_curpm
10604 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10606 new_state->re_state_reg_oldsaved
10607 = pv_dup(old_state->re_state_reg_oldsaved);
10608 new_state->re_state_reg_poscache
10609 = pv_dup(old_state->re_state_reg_poscache);
10610 new_state->re_state_reg_starttry
10611 = pv_dup(old_state->re_state_reg_starttry);
10614 case SAVEt_COMPILE_WARNINGS:
10615 ptr = POPPTR(ss,ix);
10616 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10619 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10627 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10628 * flag to the result. This is done for each stash before cloning starts,
10629 * so we know which stashes want their objects cloned */
10632 do_mark_cloneable_stash(pTHX_ SV *sv)
10634 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10636 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10637 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10638 if (cloner && GvCV(cloner)) {
10645 XPUSHs(sv_2mortal(newSVhek(hvname)));
10647 call_sv((SV*)GvCV(cloner), G_SCALAR);
10654 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10662 =for apidoc perl_clone
10664 Create and return a new interpreter by cloning the current one.
10666 perl_clone takes these flags as parameters:
10668 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10669 without it we only clone the data and zero the stacks,
10670 with it we copy the stacks and the new perl interpreter is
10671 ready to run at the exact same point as the previous one.
10672 The pseudo-fork code uses COPY_STACKS while the
10673 threads->new doesn't.
10675 CLONEf_KEEP_PTR_TABLE
10676 perl_clone keeps a ptr_table with the pointer of the old
10677 variable as a key and the new variable as a value,
10678 this allows it to check if something has been cloned and not
10679 clone it again but rather just use the value and increase the
10680 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10681 the ptr_table using the function
10682 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10683 reason to keep it around is if you want to dup some of your own
10684 variable who are outside the graph perl scans, example of this
10685 code is in threads.xs create
10688 This is a win32 thing, it is ignored on unix, it tells perls
10689 win32host code (which is c++) to clone itself, this is needed on
10690 win32 if you want to run two threads at the same time,
10691 if you just want to do some stuff in a separate perl interpreter
10692 and then throw it away and return to the original one,
10693 you don't need to do anything.
10698 /* XXX the above needs expanding by someone who actually understands it ! */
10699 EXTERN_C PerlInterpreter *
10700 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10703 perl_clone(PerlInterpreter *proto_perl, UV flags)
10706 #ifdef PERL_IMPLICIT_SYS
10708 /* perlhost.h so we need to call into it
10709 to clone the host, CPerlHost should have a c interface, sky */
10711 if (flags & CLONEf_CLONE_HOST) {
10712 return perl_clone_host(proto_perl,flags);
10714 return perl_clone_using(proto_perl, flags,
10716 proto_perl->IMemShared,
10717 proto_perl->IMemParse,
10719 proto_perl->IStdIO,
10723 proto_perl->IProc);
10727 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10728 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10729 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10730 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10731 struct IPerlDir* ipD, struct IPerlSock* ipS,
10732 struct IPerlProc* ipP)
10734 /* XXX many of the string copies here can be optimized if they're
10735 * constants; they need to be allocated as common memory and just
10736 * their pointers copied. */
10739 CLONE_PARAMS clone_params;
10740 CLONE_PARAMS* const param = &clone_params;
10742 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10743 /* for each stash, determine whether its objects should be cloned */
10744 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10745 PERL_SET_THX(my_perl);
10748 PoisonNew(my_perl, 1, PerlInterpreter);
10754 PL_savestack_ix = 0;
10755 PL_savestack_max = -1;
10756 PL_sig_pending = 0;
10757 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10758 # else /* !DEBUGGING */
10759 Zero(my_perl, 1, PerlInterpreter);
10760 # endif /* DEBUGGING */
10762 /* host pointers */
10764 PL_MemShared = ipMS;
10765 PL_MemParse = ipMP;
10772 #else /* !PERL_IMPLICIT_SYS */
10774 CLONE_PARAMS clone_params;
10775 CLONE_PARAMS* param = &clone_params;
10776 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10777 /* for each stash, determine whether its objects should be cloned */
10778 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10779 PERL_SET_THX(my_perl);
10782 PoisonNew(my_perl, 1, PerlInterpreter);
10788 PL_savestack_ix = 0;
10789 PL_savestack_max = -1;
10790 PL_sig_pending = 0;
10791 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10792 # else /* !DEBUGGING */
10793 Zero(my_perl, 1, PerlInterpreter);
10794 # endif /* DEBUGGING */
10795 #endif /* PERL_IMPLICIT_SYS */
10796 param->flags = flags;
10797 param->proto_perl = proto_perl;
10799 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10801 PL_body_arenas = NULL;
10802 Zero(&PL_body_roots, 1, PL_body_roots);
10804 PL_nice_chunk = NULL;
10805 PL_nice_chunk_size = 0;
10807 PL_sv_objcount = 0;
10809 PL_sv_arenaroot = NULL;
10811 PL_debug = proto_perl->Idebug;
10813 PL_hash_seed = proto_perl->Ihash_seed;
10814 PL_rehash_seed = proto_perl->Irehash_seed;
10816 #ifdef USE_REENTRANT_API
10817 /* XXX: things like -Dm will segfault here in perlio, but doing
10818 * PERL_SET_CONTEXT(proto_perl);
10819 * breaks too many other things
10821 Perl_reentrant_init(aTHX);
10824 /* create SV map for pointer relocation */
10825 PL_ptr_table = ptr_table_new();
10827 /* initialize these special pointers as early as possible */
10828 SvANY(&PL_sv_undef) = NULL;
10829 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10830 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10831 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10833 SvANY(&PL_sv_no) = new_XPVNV();
10834 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10835 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10836 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10837 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10838 SvCUR_set(&PL_sv_no, 0);
10839 SvLEN_set(&PL_sv_no, 1);
10840 SvIV_set(&PL_sv_no, 0);
10841 SvNV_set(&PL_sv_no, 0);
10842 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10844 SvANY(&PL_sv_yes) = new_XPVNV();
10845 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10846 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10847 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10848 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10849 SvCUR_set(&PL_sv_yes, 1);
10850 SvLEN_set(&PL_sv_yes, 2);
10851 SvIV_set(&PL_sv_yes, 1);
10852 SvNV_set(&PL_sv_yes, 1);
10853 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10855 /* create (a non-shared!) shared string table */
10856 PL_strtab = newHV();
10857 HvSHAREKEYS_off(PL_strtab);
10858 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10859 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10861 PL_compiling = proto_perl->Icompiling;
10863 /* These two PVs will be free'd special way so must set them same way op.c does */
10864 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10865 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10867 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10868 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10870 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10871 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10872 if (PL_compiling.cop_hints_hash) {
10874 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10875 HINTS_REFCNT_UNLOCK;
10877 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10879 /* pseudo environmental stuff */
10880 PL_origargc = proto_perl->Iorigargc;
10881 PL_origargv = proto_perl->Iorigargv;
10883 param->stashes = newAV(); /* Setup array of objects to call clone on */
10885 /* Set tainting stuff before PerlIO_debug can possibly get called */
10886 PL_tainting = proto_perl->Itainting;
10887 PL_taint_warn = proto_perl->Itaint_warn;
10889 #ifdef PERLIO_LAYERS
10890 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10891 PerlIO_clone(aTHX_ proto_perl, param);
10894 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10895 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10896 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10897 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10898 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10899 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10902 PL_minus_c = proto_perl->Iminus_c;
10903 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10904 PL_localpatches = proto_perl->Ilocalpatches;
10905 PL_splitstr = proto_perl->Isplitstr;
10906 PL_preprocess = proto_perl->Ipreprocess;
10907 PL_minus_n = proto_perl->Iminus_n;
10908 PL_minus_p = proto_perl->Iminus_p;
10909 PL_minus_l = proto_perl->Iminus_l;
10910 PL_minus_a = proto_perl->Iminus_a;
10911 PL_minus_E = proto_perl->Iminus_E;
10912 PL_minus_F = proto_perl->Iminus_F;
10913 PL_doswitches = proto_perl->Idoswitches;
10914 PL_dowarn = proto_perl->Idowarn;
10915 PL_doextract = proto_perl->Idoextract;
10916 PL_sawampersand = proto_perl->Isawampersand;
10917 PL_unsafe = proto_perl->Iunsafe;
10918 PL_inplace = SAVEPV(proto_perl->Iinplace);
10919 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10920 PL_perldb = proto_perl->Iperldb;
10921 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10922 PL_exit_flags = proto_perl->Iexit_flags;
10924 /* magical thingies */
10925 /* XXX time(&PL_basetime) when asked for? */
10926 PL_basetime = proto_perl->Ibasetime;
10927 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10929 PL_maxsysfd = proto_perl->Imaxsysfd;
10930 PL_statusvalue = proto_perl->Istatusvalue;
10932 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10934 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10936 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10938 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10939 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10940 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10943 /* RE engine related */
10944 Zero(&PL_reg_state, 1, struct re_save_state);
10945 PL_reginterp_cnt = 0;
10946 PL_regmatch_slab = NULL;
10948 /* Clone the regex array */
10949 PL_regex_padav = newAV();
10951 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10952 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10954 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10955 for(i = 1; i <= len; i++) {
10956 const SV * const regex = regexen[i];
10959 ? sv_dup_inc(regex, param)
10961 newSViv(PTR2IV(re_dup(
10962 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10964 av_push(PL_regex_padav, sv);
10967 PL_regex_pad = AvARRAY(PL_regex_padav);
10969 /* shortcuts to various I/O objects */
10970 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10971 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10972 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10973 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10974 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10975 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10977 /* shortcuts to regexp stuff */
10978 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10980 /* shortcuts to misc objects */
10981 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10983 /* shortcuts to debugging objects */
10984 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10985 PL_DBline = gv_dup(proto_perl->IDBline, param);
10986 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10987 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10988 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10989 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10990 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10991 PL_lineary = av_dup(proto_perl->Ilineary, param);
10992 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10994 /* symbol tables */
10995 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10996 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10997 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10998 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10999 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11001 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11002 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11003 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11004 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11005 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11006 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11008 PL_sub_generation = proto_perl->Isub_generation;
11010 /* funky return mechanisms */
11011 PL_forkprocess = proto_perl->Iforkprocess;
11013 /* subprocess state */
11014 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11016 /* internal state */
11017 PL_maxo = proto_perl->Imaxo;
11018 if (proto_perl->Iop_mask)
11019 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11022 /* PL_asserting = proto_perl->Iasserting; */
11024 /* current interpreter roots */
11025 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11026 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11027 PL_main_start = proto_perl->Imain_start;
11028 PL_eval_root = proto_perl->Ieval_root;
11029 PL_eval_start = proto_perl->Ieval_start;
11031 /* runtime control stuff */
11032 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11033 PL_copline = proto_perl->Icopline;
11035 PL_filemode = proto_perl->Ifilemode;
11036 PL_lastfd = proto_perl->Ilastfd;
11037 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11040 PL_gensym = proto_perl->Igensym;
11041 PL_preambled = proto_perl->Ipreambled;
11042 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11043 PL_laststatval = proto_perl->Ilaststatval;
11044 PL_laststype = proto_perl->Ilaststype;
11047 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11049 /* interpreter atexit processing */
11050 PL_exitlistlen = proto_perl->Iexitlistlen;
11051 if (PL_exitlistlen) {
11052 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11053 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11056 PL_exitlist = (PerlExitListEntry*)NULL;
11058 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11059 if (PL_my_cxt_size) {
11060 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11061 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11064 PL_my_cxt_list = (void**)NULL;
11065 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11066 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11067 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11069 PL_profiledata = NULL;
11070 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11071 /* PL_rsfp_filters entries have fake IoDIRP() */
11072 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11074 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11076 PAD_CLONE_VARS(proto_perl, param);
11078 #ifdef HAVE_INTERP_INTERN
11079 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11082 /* more statics moved here */
11083 PL_generation = proto_perl->Igeneration;
11084 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11086 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11087 PL_in_clean_all = proto_perl->Iin_clean_all;
11089 PL_uid = proto_perl->Iuid;
11090 PL_euid = proto_perl->Ieuid;
11091 PL_gid = proto_perl->Igid;
11092 PL_egid = proto_perl->Iegid;
11093 PL_nomemok = proto_perl->Inomemok;
11094 PL_an = proto_perl->Ian;
11095 PL_evalseq = proto_perl->Ievalseq;
11096 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11097 PL_origalen = proto_perl->Iorigalen;
11098 #ifdef PERL_USES_PL_PIDSTATUS
11099 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11101 PL_osname = SAVEPV(proto_perl->Iosname);
11102 PL_sighandlerp = proto_perl->Isighandlerp;
11104 PL_runops = proto_perl->Irunops;
11106 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11109 PL_cshlen = proto_perl->Icshlen;
11110 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11113 PL_lex_state = proto_perl->Ilex_state;
11114 PL_lex_defer = proto_perl->Ilex_defer;
11115 PL_lex_expect = proto_perl->Ilex_expect;
11116 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11117 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11118 PL_lex_starts = proto_perl->Ilex_starts;
11119 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11120 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11121 PL_lex_op = proto_perl->Ilex_op;
11122 PL_lex_inpat = proto_perl->Ilex_inpat;
11123 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11124 PL_lex_brackets = proto_perl->Ilex_brackets;
11125 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11126 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11127 PL_lex_casemods = proto_perl->Ilex_casemods;
11128 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11129 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11132 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11133 PL_lasttoke = proto_perl->Ilasttoke;
11134 PL_realtokenstart = proto_perl->Irealtokenstart;
11135 PL_faketokens = proto_perl->Ifaketokens;
11136 PL_thismad = proto_perl->Ithismad;
11137 PL_thistoken = proto_perl->Ithistoken;
11138 PL_thisopen = proto_perl->Ithisopen;
11139 PL_thisstuff = proto_perl->Ithisstuff;
11140 PL_thisclose = proto_perl->Ithisclose;
11141 PL_thiswhite = proto_perl->Ithiswhite;
11142 PL_nextwhite = proto_perl->Inextwhite;
11143 PL_skipwhite = proto_perl->Iskipwhite;
11144 PL_endwhite = proto_perl->Iendwhite;
11145 PL_curforce = proto_perl->Icurforce;
11147 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11148 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11149 PL_nexttoke = proto_perl->Inexttoke;
11152 /* XXX This is probably masking the deeper issue of why
11153 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11154 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11155 * (A little debugging with a watchpoint on it may help.)
11157 if (SvANY(proto_perl->Ilinestr)) {
11158 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11159 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11160 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11161 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11162 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11163 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11164 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11165 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11166 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11169 PL_linestr = newSV(79);
11170 sv_upgrade(PL_linestr,SVt_PVIV);
11171 sv_setpvn(PL_linestr,"",0);
11172 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11174 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11175 PL_pending_ident = proto_perl->Ipending_ident;
11176 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11178 PL_expect = proto_perl->Iexpect;
11180 PL_multi_start = proto_perl->Imulti_start;
11181 PL_multi_end = proto_perl->Imulti_end;
11182 PL_multi_open = proto_perl->Imulti_open;
11183 PL_multi_close = proto_perl->Imulti_close;
11185 PL_error_count = proto_perl->Ierror_count;
11186 PL_subline = proto_perl->Isubline;
11187 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11189 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11190 if (SvANY(proto_perl->Ilinestr)) {
11191 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11192 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11193 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11194 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11195 PL_last_lop_op = proto_perl->Ilast_lop_op;
11198 PL_last_uni = SvPVX(PL_linestr);
11199 PL_last_lop = SvPVX(PL_linestr);
11200 PL_last_lop_op = 0;
11202 PL_in_my = proto_perl->Iin_my;
11203 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11205 PL_cryptseen = proto_perl->Icryptseen;
11208 PL_hints = proto_perl->Ihints;
11210 PL_amagic_generation = proto_perl->Iamagic_generation;
11212 #ifdef USE_LOCALE_COLLATE
11213 PL_collation_ix = proto_perl->Icollation_ix;
11214 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11215 PL_collation_standard = proto_perl->Icollation_standard;
11216 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11217 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11218 #endif /* USE_LOCALE_COLLATE */
11220 #ifdef USE_LOCALE_NUMERIC
11221 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11222 PL_numeric_standard = proto_perl->Inumeric_standard;
11223 PL_numeric_local = proto_perl->Inumeric_local;
11224 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11225 #endif /* !USE_LOCALE_NUMERIC */
11227 /* utf8 character classes */
11228 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11229 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11230 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11231 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11232 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11233 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11234 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11235 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11236 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11237 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11238 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11239 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11240 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11241 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11242 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11243 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11244 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11245 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11246 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11247 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11249 /* Did the locale setup indicate UTF-8? */
11250 PL_utf8locale = proto_perl->Iutf8locale;
11251 /* Unicode features (see perlrun/-C) */
11252 PL_unicode = proto_perl->Iunicode;
11254 /* Pre-5.8 signals control */
11255 PL_signals = proto_perl->Isignals;
11257 /* times() ticks per second */
11258 PL_clocktick = proto_perl->Iclocktick;
11260 /* Recursion stopper for PerlIO_find_layer */
11261 PL_in_load_module = proto_perl->Iin_load_module;
11263 /* sort() routine */
11264 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11266 /* Not really needed/useful since the reenrant_retint is "volatile",
11267 * but do it for consistency's sake. */
11268 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11270 /* Hooks to shared SVs and locks. */
11271 PL_sharehook = proto_perl->Isharehook;
11272 PL_lockhook = proto_perl->Ilockhook;
11273 PL_unlockhook = proto_perl->Iunlockhook;
11274 PL_threadhook = proto_perl->Ithreadhook;
11276 PL_runops_std = proto_perl->Irunops_std;
11277 PL_runops_dbg = proto_perl->Irunops_dbg;
11279 #ifdef THREADS_HAVE_PIDS
11280 PL_ppid = proto_perl->Ippid;
11284 PL_last_swash_hv = NULL; /* reinits on demand */
11285 PL_last_swash_klen = 0;
11286 PL_last_swash_key[0]= '\0';
11287 PL_last_swash_tmps = (U8*)NULL;
11288 PL_last_swash_slen = 0;
11290 PL_glob_index = proto_perl->Iglob_index;
11291 PL_srand_called = proto_perl->Isrand_called;
11292 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11293 PL_bitcount = NULL; /* reinits on demand */
11295 if (proto_perl->Ipsig_pend) {
11296 Newxz(PL_psig_pend, SIG_SIZE, int);
11299 PL_psig_pend = (int*)NULL;
11302 if (proto_perl->Ipsig_ptr) {
11303 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11304 Newxz(PL_psig_name, SIG_SIZE, SV*);
11305 for (i = 1; i < SIG_SIZE; i++) {
11306 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11307 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11311 PL_psig_ptr = (SV**)NULL;
11312 PL_psig_name = (SV**)NULL;
11315 /* thrdvar.h stuff */
11317 if (flags & CLONEf_COPY_STACKS) {
11318 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11319 PL_tmps_ix = proto_perl->Ttmps_ix;
11320 PL_tmps_max = proto_perl->Ttmps_max;
11321 PL_tmps_floor = proto_perl->Ttmps_floor;
11322 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11324 while (i <= PL_tmps_ix) {
11325 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11329 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11330 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11331 Newxz(PL_markstack, i, I32);
11332 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11333 - proto_perl->Tmarkstack);
11334 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11335 - proto_perl->Tmarkstack);
11336 Copy(proto_perl->Tmarkstack, PL_markstack,
11337 PL_markstack_ptr - PL_markstack + 1, I32);
11339 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11340 * NOTE: unlike the others! */
11341 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11342 PL_scopestack_max = proto_perl->Tscopestack_max;
11343 Newxz(PL_scopestack, PL_scopestack_max, I32);
11344 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11346 /* NOTE: si_dup() looks at PL_markstack */
11347 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11349 /* PL_curstack = PL_curstackinfo->si_stack; */
11350 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11351 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11353 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11354 PL_stack_base = AvARRAY(PL_curstack);
11355 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11356 - proto_perl->Tstack_base);
11357 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11359 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11360 * NOTE: unlike the others! */
11361 PL_savestack_ix = proto_perl->Tsavestack_ix;
11362 PL_savestack_max = proto_perl->Tsavestack_max;
11363 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11364 PL_savestack = ss_dup(proto_perl, param);
11368 ENTER; /* perl_destruct() wants to LEAVE; */
11370 /* although we're not duplicating the tmps stack, we should still
11371 * add entries for any SVs on the tmps stack that got cloned by a
11372 * non-refcount means (eg a temp in @_); otherwise they will be
11375 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11376 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11377 proto_perl->Ttmps_stack[i]);
11378 if (nsv && !SvREFCNT(nsv)) {
11380 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11385 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11386 PL_top_env = &PL_start_env;
11388 PL_op = proto_perl->Top;
11391 PL_Xpv = (XPV*)NULL;
11392 PL_na = proto_perl->Tna;
11394 PL_statbuf = proto_perl->Tstatbuf;
11395 PL_statcache = proto_perl->Tstatcache;
11396 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11397 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11399 PL_timesbuf = proto_perl->Ttimesbuf;
11402 PL_tainted = proto_perl->Ttainted;
11403 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11404 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11405 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11406 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11407 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11408 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11409 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11410 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11411 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11413 PL_restartop = proto_perl->Trestartop;
11414 PL_in_eval = proto_perl->Tin_eval;
11415 PL_delaymagic = proto_perl->Tdelaymagic;
11416 PL_dirty = proto_perl->Tdirty;
11417 PL_localizing = proto_perl->Tlocalizing;
11419 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11420 PL_hv_fetch_ent_mh = NULL;
11421 PL_modcount = proto_perl->Tmodcount;
11422 PL_lastgotoprobe = NULL;
11423 PL_dumpindent = proto_perl->Tdumpindent;
11425 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11426 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11427 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11428 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11429 PL_efloatbuf = NULL; /* reinits on demand */
11430 PL_efloatsize = 0; /* reinits on demand */
11434 PL_screamfirst = NULL;
11435 PL_screamnext = NULL;
11436 PL_maxscream = -1; /* reinits on demand */
11437 PL_lastscream = NULL;
11439 PL_watchaddr = NULL;
11442 PL_regdummy = proto_perl->Tregdummy;
11443 PL_colorset = 0; /* reinits PL_colors[] */
11444 /*PL_colors[6] = {0,0,0,0,0,0};*/
11448 /* Pluggable optimizer */
11449 PL_peepp = proto_perl->Tpeepp;
11451 PL_stashcache = newHV();
11453 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11454 ptr_table_free(PL_ptr_table);
11455 PL_ptr_table = NULL;
11458 /* Call the ->CLONE method, if it exists, for each of the stashes
11459 identified by sv_dup() above.
11461 while(av_len(param->stashes) != -1) {
11462 HV* const stash = (HV*) av_shift(param->stashes);
11463 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11464 if (cloner && GvCV(cloner)) {
11469 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11471 call_sv((SV*)GvCV(cloner), G_DISCARD);
11477 SvREFCNT_dec(param->stashes);
11479 /* orphaned? eg threads->new inside BEGIN or use */
11480 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11481 SvREFCNT_inc_simple_void(PL_compcv);
11482 SAVEFREESV(PL_compcv);
11488 #endif /* USE_ITHREADS */
11491 =head1 Unicode Support
11493 =for apidoc sv_recode_to_utf8
11495 The encoding is assumed to be an Encode object, on entry the PV
11496 of the sv is assumed to be octets in that encoding, and the sv
11497 will be converted into Unicode (and UTF-8).
11499 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11500 is not a reference, nothing is done to the sv. If the encoding is not
11501 an C<Encode::XS> Encoding object, bad things will happen.
11502 (See F<lib/encoding.pm> and L<Encode>).
11504 The PV of the sv is returned.
11509 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11512 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11526 Passing sv_yes is wrong - it needs to be or'ed set of constants
11527 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11528 remove converted chars from source.
11530 Both will default the value - let them.
11532 XPUSHs(&PL_sv_yes);
11535 call_method("decode", G_SCALAR);
11539 s = SvPV_const(uni, len);
11540 if (s != SvPVX_const(sv)) {
11541 SvGROW(sv, len + 1);
11542 Move(s, SvPVX(sv), len + 1, char);
11543 SvCUR_set(sv, len);
11550 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11554 =for apidoc sv_cat_decode
11556 The encoding is assumed to be an Encode object, the PV of the ssv is
11557 assumed to be octets in that encoding and decoding the input starts
11558 from the position which (PV + *offset) pointed to. The dsv will be
11559 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11560 when the string tstr appears in decoding output or the input ends on
11561 the PV of the ssv. The value which the offset points will be modified
11562 to the last input position on the ssv.
11564 Returns TRUE if the terminator was found, else returns FALSE.
11569 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11570 SV *ssv, int *offset, char *tstr, int tlen)
11574 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11585 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11586 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11588 call_method("cat_decode", G_SCALAR);
11590 ret = SvTRUE(TOPs);
11591 *offset = SvIV(offsv);
11597 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11602 /* ---------------------------------------------------------------------
11604 * support functions for report_uninit()
11607 /* the maxiumum size of array or hash where we will scan looking
11608 * for the undefined element that triggered the warning */
11610 #define FUV_MAX_SEARCH_SIZE 1000
11612 /* Look for an entry in the hash whose value has the same SV as val;
11613 * If so, return a mortal copy of the key. */
11616 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11619 register HE **array;
11622 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11623 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11626 array = HvARRAY(hv);
11628 for (i=HvMAX(hv); i>0; i--) {
11629 register HE *entry;
11630 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11631 if (HeVAL(entry) != val)
11633 if ( HeVAL(entry) == &PL_sv_undef ||
11634 HeVAL(entry) == &PL_sv_placeholder)
11638 if (HeKLEN(entry) == HEf_SVKEY)
11639 return sv_mortalcopy(HeKEY_sv(entry));
11640 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11646 /* Look for an entry in the array whose value has the same SV as val;
11647 * If so, return the index, otherwise return -1. */
11650 S_find_array_subscript(pTHX_ AV *av, SV* val)
11653 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11654 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11657 if (val != &PL_sv_undef) {
11658 SV ** const svp = AvARRAY(av);
11661 for (i=AvFILLp(av); i>=0; i--)
11668 /* S_varname(): return the name of a variable, optionally with a subscript.
11669 * If gv is non-zero, use the name of that global, along with gvtype (one
11670 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11671 * targ. Depending on the value of the subscript_type flag, return:
11674 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11675 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11676 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11677 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11680 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11681 SV* keyname, I32 aindex, int subscript_type)
11684 SV * const name = sv_newmortal();
11687 buffer[0] = gvtype;
11690 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11692 gv_fullname4(name, gv, buffer, 0);
11694 if ((unsigned int)SvPVX(name)[1] <= 26) {
11696 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11698 /* Swap the 1 unprintable control character for the 2 byte pretty
11699 version - ie substr($name, 1, 1) = $buffer; */
11700 sv_insert(name, 1, 1, buffer, 2);
11705 CV * const cv = find_runcv(&unused);
11709 if (!cv || !CvPADLIST(cv))
11711 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11712 sv = *av_fetch(av, targ, FALSE);
11713 /* SvLEN in a pad name is not to be trusted */
11714 sv_setpv(name, SvPV_nolen_const(sv));
11717 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11718 SV * const sv = newSV(0);
11719 *SvPVX(name) = '$';
11720 Perl_sv_catpvf(aTHX_ name, "{%s}",
11721 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11724 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11725 *SvPVX(name) = '$';
11726 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11728 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11729 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11736 =for apidoc find_uninit_var
11738 Find the name of the undefined variable (if any) that caused the operator o
11739 to issue a "Use of uninitialized value" warning.
11740 If match is true, only return a name if it's value matches uninit_sv.
11741 So roughly speaking, if a unary operator (such as OP_COS) generates a
11742 warning, then following the direct child of the op may yield an
11743 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11744 other hand, with OP_ADD there are two branches to follow, so we only print
11745 the variable name if we get an exact match.
11747 The name is returned as a mortal SV.
11749 Assumes that PL_op is the op that originally triggered the error, and that
11750 PL_comppad/PL_curpad points to the currently executing pad.
11756 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11764 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11765 uninit_sv == &PL_sv_placeholder)))
11768 switch (obase->op_type) {
11775 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11776 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11779 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11781 if (pad) { /* @lex, %lex */
11782 sv = PAD_SVl(obase->op_targ);
11786 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11787 /* @global, %global */
11788 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11791 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11793 else /* @{expr}, %{expr} */
11794 return find_uninit_var(cUNOPx(obase)->op_first,
11798 /* attempt to find a match within the aggregate */
11800 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11802 subscript_type = FUV_SUBSCRIPT_HASH;
11805 index = find_array_subscript((AV*)sv, uninit_sv);
11807 subscript_type = FUV_SUBSCRIPT_ARRAY;
11810 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11813 return varname(gv, hash ? '%' : '@', obase->op_targ,
11814 keysv, index, subscript_type);
11818 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11820 return varname(NULL, '$', obase->op_targ,
11821 NULL, 0, FUV_SUBSCRIPT_NONE);
11824 gv = cGVOPx_gv(obase);
11825 if (!gv || (match && GvSV(gv) != uninit_sv))
11827 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11830 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11833 av = (AV*)PAD_SV(obase->op_targ);
11834 if (!av || SvRMAGICAL(av))
11836 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11837 if (!svp || *svp != uninit_sv)
11840 return varname(NULL, '$', obase->op_targ,
11841 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11844 gv = cGVOPx_gv(obase);
11850 if (!av || SvRMAGICAL(av))
11852 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11853 if (!svp || *svp != uninit_sv)
11856 return varname(gv, '$', 0,
11857 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11862 o = cUNOPx(obase)->op_first;
11863 if (!o || o->op_type != OP_NULL ||
11864 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11866 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11870 if (PL_op == obase)
11871 /* $a[uninit_expr] or $h{uninit_expr} */
11872 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11875 o = cBINOPx(obase)->op_first;
11876 kid = cBINOPx(obase)->op_last;
11878 /* get the av or hv, and optionally the gv */
11880 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11881 sv = PAD_SV(o->op_targ);
11883 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11884 && cUNOPo->op_first->op_type == OP_GV)
11886 gv = cGVOPx_gv(cUNOPo->op_first);
11889 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11894 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11895 /* index is constant */
11899 if (obase->op_type == OP_HELEM) {
11900 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11901 if (!he || HeVAL(he) != uninit_sv)
11905 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11906 if (!svp || *svp != uninit_sv)
11910 if (obase->op_type == OP_HELEM)
11911 return varname(gv, '%', o->op_targ,
11912 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11914 return varname(gv, '@', o->op_targ, NULL,
11915 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11918 /* index is an expression;
11919 * attempt to find a match within the aggregate */
11920 if (obase->op_type == OP_HELEM) {
11921 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11923 return varname(gv, '%', o->op_targ,
11924 keysv, 0, FUV_SUBSCRIPT_HASH);
11927 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11929 return varname(gv, '@', o->op_targ,
11930 NULL, index, FUV_SUBSCRIPT_ARRAY);
11935 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11937 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11942 /* only examine RHS */
11943 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11946 o = cUNOPx(obase)->op_first;
11947 if (o->op_type == OP_PUSHMARK)
11950 if (!o->op_sibling) {
11951 /* one-arg version of open is highly magical */
11953 if (o->op_type == OP_GV) { /* open FOO; */
11955 if (match && GvSV(gv) != uninit_sv)
11957 return varname(gv, '$', 0,
11958 NULL, 0, FUV_SUBSCRIPT_NONE);
11960 /* other possibilities not handled are:
11961 * open $x; or open my $x; should return '${*$x}'
11962 * open expr; should return '$'.expr ideally
11968 /* ops where $_ may be an implicit arg */
11972 if ( !(obase->op_flags & OPf_STACKED)) {
11973 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11974 ? PAD_SVl(obase->op_targ)
11977 sv = sv_newmortal();
11978 sv_setpvn(sv, "$_", 2);
11986 /* skip filehandle as it can't produce 'undef' warning */
11987 o = cUNOPx(obase)->op_first;
11988 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11989 o = o->op_sibling->op_sibling;
11996 match = 1; /* XS or custom code could trigger random warnings */
12001 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12002 return sv_2mortal(newSVpvs("${$/}"));
12007 if (!(obase->op_flags & OPf_KIDS))
12009 o = cUNOPx(obase)->op_first;
12015 /* if all except one arg are constant, or have no side-effects,
12016 * or are optimized away, then it's unambiguous */
12018 for (kid=o; kid; kid = kid->op_sibling) {
12020 const OPCODE type = kid->op_type;
12021 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12022 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12023 || (type == OP_PUSHMARK)
12027 if (o2) { /* more than one found */
12034 return find_uninit_var(o2, uninit_sv, match);
12036 /* scan all args */
12038 sv = find_uninit_var(o, uninit_sv, 1);
12050 =for apidoc report_uninit
12052 Print appropriate "Use of uninitialized variable" warning
12058 Perl_report_uninit(pTHX_ SV* uninit_sv)
12062 SV* varname = NULL;
12064 varname = find_uninit_var(PL_op, uninit_sv,0);
12066 sv_insert(varname, 0, 0, " ", 1);
12068 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12069 varname ? SvPV_nolen_const(varname) : "",
12070 " in ", OP_DESC(PL_op));
12073 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12079 * c-indentation-style: bsd
12080 * c-basic-offset: 4
12081 * indent-tabs-mode: t
12084 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob