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 = *((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 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));
1855 if (SvNVX(sv) < (NV)IV_MIN) {
1856 (void)SvIOKp_on(sv);
1858 SvIV_set(sv, IV_MIN);
1859 return IS_NUMBER_UNDERFLOW_IV;
1861 if (SvNVX(sv) > (NV)UV_MAX) {
1862 (void)SvIOKp_on(sv);
1865 SvUV_set(sv, UV_MAX);
1866 return IS_NUMBER_OVERFLOW_UV;
1868 (void)SvIOKp_on(sv);
1870 /* Can't use strtol etc to convert this string. (See truth table in
1872 if (SvNVX(sv) <= (UV)IV_MAX) {
1873 SvIV_set(sv, I_V(SvNVX(sv)));
1874 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1875 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1877 /* Integer is imprecise. NOK, IOKp */
1879 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1882 SvUV_set(sv, U_V(SvNVX(sv)));
1883 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1884 if (SvUVX(sv) == UV_MAX) {
1885 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1886 possibly be preserved by NV. Hence, it must be overflow.
1888 return IS_NUMBER_OVERFLOW_UV;
1890 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1892 /* Integer is imprecise. NOK, IOKp */
1894 return IS_NUMBER_OVERFLOW_IV;
1896 #endif /* !NV_PRESERVES_UV*/
1899 S_sv_2iuv_common(pTHX_ SV *sv) {
1902 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1903 * without also getting a cached IV/UV from it at the same time
1904 * (ie PV->NV conversion should detect loss of accuracy and cache
1905 * IV or UV at same time to avoid this. */
1906 /* IV-over-UV optimisation - choose to cache IV if possible */
1908 if (SvTYPE(sv) == SVt_NV)
1909 sv_upgrade(sv, SVt_PVNV);
1911 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1912 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1913 certainly cast into the IV range at IV_MAX, whereas the correct
1914 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1916 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1917 if (Perl_isnan(SvNVX(sv))) {
1923 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1924 SvIV_set(sv, I_V(SvNVX(sv)));
1925 if (SvNVX(sv) == (NV) SvIVX(sv)
1926 #ifndef NV_PRESERVES_UV
1927 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1928 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1929 /* Don't flag it as "accurately an integer" if the number
1930 came from a (by definition imprecise) NV operation, and
1931 we're outside the range of NV integer precision */
1934 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1935 DEBUG_c(PerlIO_printf(Perl_debug_log,
1936 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1942 /* IV not precise. No need to convert from PV, as NV
1943 conversion would already have cached IV if it detected
1944 that PV->IV would be better than PV->NV->IV
1945 flags already correct - don't set public IOK. */
1946 DEBUG_c(PerlIO_printf(Perl_debug_log,
1947 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1952 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1953 but the cast (NV)IV_MIN rounds to a the value less (more
1954 negative) than IV_MIN which happens to be equal to SvNVX ??
1955 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1956 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1957 (NV)UVX == NVX are both true, but the values differ. :-(
1958 Hopefully for 2s complement IV_MIN is something like
1959 0x8000000000000000 which will be exact. NWC */
1962 SvUV_set(sv, U_V(SvNVX(sv)));
1964 (SvNVX(sv) == (NV) SvUVX(sv))
1965 #ifndef NV_PRESERVES_UV
1966 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1967 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1968 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1969 /* Don't flag it as "accurately an integer" if the number
1970 came from a (by definition imprecise) NV operation, and
1971 we're outside the range of NV integer precision */
1976 DEBUG_c(PerlIO_printf(Perl_debug_log,
1977 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1983 else if (SvPOKp(sv) && SvLEN(sv)) {
1985 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1986 /* We want to avoid a possible problem when we cache an IV/ a UV which
1987 may be later translated to an NV, and the resulting NV is not
1988 the same as the direct translation of the initial string
1989 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1990 be careful to ensure that the value with the .456 is around if the
1991 NV value is requested in the future).
1993 This means that if we cache such an IV/a UV, we need to cache the
1994 NV as well. Moreover, we trade speed for space, and do not
1995 cache the NV if we are sure it's not needed.
1998 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer, only upgrade to PVIV */
2002 if (SvTYPE(sv) < SVt_PVIV)
2003 sv_upgrade(sv, SVt_PVIV);
2005 } else if (SvTYPE(sv) < SVt_PVNV)
2006 sv_upgrade(sv, SVt_PVNV);
2008 /* If NVs preserve UVs then we only use the UV value if we know that
2009 we aren't going to call atof() below. If NVs don't preserve UVs
2010 then the value returned may have more precision than atof() will
2011 return, even though value isn't perfectly accurate. */
2012 if ((numtype & (IS_NUMBER_IN_UV
2013 #ifdef NV_PRESERVES_UV
2016 )) == IS_NUMBER_IN_UV) {
2017 /* This won't turn off the public IOK flag if it was set above */
2018 (void)SvIOKp_on(sv);
2020 if (!(numtype & IS_NUMBER_NEG)) {
2022 if (value <= (UV)IV_MAX) {
2023 SvIV_set(sv, (IV)value);
2025 /* it didn't overflow, and it was positive. */
2026 SvUV_set(sv, value);
2030 /* 2s complement assumption */
2031 if (value <= (UV)IV_MIN) {
2032 SvIV_set(sv, -(IV)value);
2034 /* Too negative for an IV. This is a double upgrade, but
2035 I'm assuming it will be rare. */
2036 if (SvTYPE(sv) < SVt_PVNV)
2037 sv_upgrade(sv, SVt_PVNV);
2041 SvNV_set(sv, -(NV)value);
2042 SvIV_set(sv, IV_MIN);
2046 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2047 will be in the previous block to set the IV slot, and the next
2048 block to set the NV slot. So no else here. */
2050 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2051 != IS_NUMBER_IN_UV) {
2052 /* It wasn't an (integer that doesn't overflow the UV). */
2053 SvNV_set(sv, Atof(SvPVX_const(sv)));
2055 if (! numtype && ckWARN(WARN_NUMERIC))
2058 #if defined(USE_LONG_DOUBLE)
2059 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2060 PTR2UV(sv), SvNVX(sv)));
2062 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2063 PTR2UV(sv), SvNVX(sv)));
2066 #ifdef NV_PRESERVES_UV
2067 (void)SvIOKp_on(sv);
2069 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2070 SvIV_set(sv, I_V(SvNVX(sv)));
2071 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2074 NOOP; /* Integer is imprecise. NOK, IOKp */
2076 /* UV will not work better than IV */
2078 if (SvNVX(sv) > (NV)UV_MAX) {
2080 /* Integer is inaccurate. NOK, IOKp, is UV */
2081 SvUV_set(sv, UV_MAX);
2083 SvUV_set(sv, U_V(SvNVX(sv)));
2084 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2085 NV preservse UV so can do correct comparison. */
2086 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2089 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2094 #else /* NV_PRESERVES_UV */
2095 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2096 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2097 /* The IV/UV slot will have been set from value returned by
2098 grok_number above. The NV slot has just been set using
2101 assert (SvIOKp(sv));
2103 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2104 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2105 /* Small enough to preserve all bits. */
2106 (void)SvIOKp_on(sv);
2108 SvIV_set(sv, I_V(SvNVX(sv)));
2109 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2111 /* Assumption: first non-preserved integer is < IV_MAX,
2112 this NV is in the preserved range, therefore: */
2113 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2115 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);
2119 0 0 already failed to read UV.
2120 0 1 already failed to read UV.
2121 1 0 you won't get here in this case. IV/UV
2122 slot set, public IOK, Atof() unneeded.
2123 1 1 already read UV.
2124 so there's no point in sv_2iuv_non_preserve() attempting
2125 to use atol, strtol, strtoul etc. */
2126 sv_2iuv_non_preserve (sv, numtype);
2129 #endif /* NV_PRESERVES_UV */
2133 if (isGV_with_GP(sv))
2134 return glob_2number((GV *)sv);
2136 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2137 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2140 if (SvTYPE(sv) < SVt_IV)
2141 /* Typically the caller expects that sv_any is not NULL now. */
2142 sv_upgrade(sv, SVt_IV);
2143 /* Return 0 from the caller. */
2150 =for apidoc sv_2iv_flags
2152 Return the integer value of an SV, doing any necessary string
2153 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2154 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2160 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2165 if (SvGMAGICAL(sv)) {
2166 if (flags & SV_GMAGIC)
2171 return I_V(SvNVX(sv));
2173 if (SvPOKp(sv) && SvLEN(sv)) {
2176 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2178 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2179 == IS_NUMBER_IN_UV) {
2180 /* It's definitely an integer */
2181 if (numtype & IS_NUMBER_NEG) {
2182 if (value < (UV)IV_MIN)
2185 if (value < (UV)IV_MAX)
2190 if (ckWARN(WARN_NUMERIC))
2193 return I_V(Atof(SvPVX_const(sv)));
2198 assert(SvTYPE(sv) >= SVt_PVMG);
2199 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2200 } else if (SvTHINKFIRST(sv)) {
2204 SV * const tmpstr=AMG_CALLun(sv,numer);
2205 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2206 return SvIV(tmpstr);
2209 return PTR2IV(SvRV(sv));
2212 sv_force_normal_flags(sv, 0);
2214 if (SvREADONLY(sv) && !SvOK(sv)) {
2215 if (ckWARN(WARN_UNINITIALIZED))
2221 if (S_sv_2iuv_common(aTHX_ sv))
2224 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2225 PTR2UV(sv),SvIVX(sv)));
2226 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2230 =for apidoc sv_2uv_flags
2232 Return the unsigned integer value of an SV, doing any necessary string
2233 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2234 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2240 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2245 if (SvGMAGICAL(sv)) {
2246 if (flags & SV_GMAGIC)
2251 return U_V(SvNVX(sv));
2252 if (SvPOKp(sv) && SvLEN(sv)) {
2255 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2257 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2258 == IS_NUMBER_IN_UV) {
2259 /* It's definitely an integer */
2260 if (!(numtype & IS_NUMBER_NEG))
2264 if (ckWARN(WARN_NUMERIC))
2267 return U_V(Atof(SvPVX_const(sv)));
2272 assert(SvTYPE(sv) >= SVt_PVMG);
2273 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2274 } else if (SvTHINKFIRST(sv)) {
2278 SV *const tmpstr = AMG_CALLun(sv,numer);
2279 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2280 return SvUV(tmpstr);
2283 return PTR2UV(SvRV(sv));
2286 sv_force_normal_flags(sv, 0);
2288 if (SvREADONLY(sv) && !SvOK(sv)) {
2289 if (ckWARN(WARN_UNINITIALIZED))
2295 if (S_sv_2iuv_common(aTHX_ sv))
2299 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2300 PTR2UV(sv),SvUVX(sv)));
2301 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2307 Return the num value of an SV, doing any necessary string or integer
2308 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2315 Perl_sv_2nv(pTHX_ register SV *sv)
2320 if (SvGMAGICAL(sv)) {
2324 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2325 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2326 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2328 return Atof(SvPVX_const(sv));
2332 return (NV)SvUVX(sv);
2334 return (NV)SvIVX(sv);
2339 assert(SvTYPE(sv) >= SVt_PVMG);
2340 /* This falls through to the report_uninit near the end of the
2342 } else if (SvTHINKFIRST(sv)) {
2346 SV *const tmpstr = AMG_CALLun(sv,numer);
2347 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2348 return SvNV(tmpstr);
2351 return PTR2NV(SvRV(sv));
2354 sv_force_normal_flags(sv, 0);
2356 if (SvREADONLY(sv) && !SvOK(sv)) {
2357 if (ckWARN(WARN_UNINITIALIZED))
2362 if (SvTYPE(sv) < SVt_NV) {
2363 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2364 sv_upgrade(sv, SVt_NV);
2365 #ifdef USE_LONG_DOUBLE
2367 STORE_NUMERIC_LOCAL_SET_STANDARD();
2368 PerlIO_printf(Perl_debug_log,
2369 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2370 PTR2UV(sv), SvNVX(sv));
2371 RESTORE_NUMERIC_LOCAL();
2375 STORE_NUMERIC_LOCAL_SET_STANDARD();
2376 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2377 PTR2UV(sv), SvNVX(sv));
2378 RESTORE_NUMERIC_LOCAL();
2382 else if (SvTYPE(sv) < SVt_PVNV)
2383 sv_upgrade(sv, SVt_PVNV);
2388 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2389 #ifdef NV_PRESERVES_UV
2392 /* Only set the public NV OK flag if this NV preserves the IV */
2393 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2394 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2395 : (SvIVX(sv) == I_V(SvNVX(sv))))
2401 else if (SvPOKp(sv) && SvLEN(sv)) {
2403 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2404 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2406 #ifdef NV_PRESERVES_UV
2407 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2408 == IS_NUMBER_IN_UV) {
2409 /* It's definitely an integer */
2410 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2412 SvNV_set(sv, Atof(SvPVX_const(sv)));
2415 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 /* Only set the public NV OK flag if this NV preserves the value in
2417 the PV at least as well as an IV/UV would.
2418 Not sure how to do this 100% reliably. */
2419 /* if that shift count is out of range then Configure's test is
2420 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2422 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2423 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2424 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2425 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2426 /* Can't use strtol etc to convert this string, so don't try.
2427 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2430 /* value has been set. It may not be precise. */
2431 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2432 /* 2s complement assumption for (UV)IV_MIN */
2433 SvNOK_on(sv); /* Integer is too negative. */
2438 if (numtype & IS_NUMBER_NEG) {
2439 SvIV_set(sv, -(IV)value);
2440 } else if (value <= (UV)IV_MAX) {
2441 SvIV_set(sv, (IV)value);
2443 SvUV_set(sv, value);
2447 if (numtype & IS_NUMBER_NOT_INT) {
2448 /* I believe that even if the original PV had decimals,
2449 they are lost beyond the limit of the FP precision.
2450 However, neither is canonical, so both only get p
2451 flags. NWC, 2000/11/25 */
2452 /* Both already have p flags, so do nothing */
2454 const NV nv = SvNVX(sv);
2455 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2456 if (SvIVX(sv) == I_V(nv)) {
2459 /* It had no "." so it must be integer. */
2463 /* between IV_MAX and NV(UV_MAX).
2464 Could be slightly > UV_MAX */
2466 if (numtype & IS_NUMBER_NOT_INT) {
2467 /* UV and NV both imprecise. */
2469 const UV nv_as_uv = U_V(nv);
2471 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2480 #endif /* NV_PRESERVES_UV */
2483 if (isGV_with_GP(sv)) {
2484 glob_2number((GV *)sv);
2488 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2490 assert (SvTYPE(sv) >= SVt_NV);
2491 /* Typically the caller expects that sv_any is not NULL now. */
2492 /* XXX Ilya implies that this is a bug in callers that assume this
2493 and ideally should be fixed. */
2496 #if defined(USE_LONG_DOUBLE)
2498 STORE_NUMERIC_LOCAL_SET_STANDARD();
2499 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2500 PTR2UV(sv), SvNVX(sv));
2501 RESTORE_NUMERIC_LOCAL();
2505 STORE_NUMERIC_LOCAL_SET_STANDARD();
2506 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2507 PTR2UV(sv), SvNVX(sv));
2508 RESTORE_NUMERIC_LOCAL();
2514 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2515 * UV as a string towards the end of buf, and return pointers to start and
2518 * We assume that buf is at least TYPE_CHARS(UV) long.
2522 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2524 char *ptr = buf + TYPE_CHARS(UV);
2525 char * const ebuf = ptr;
2538 *--ptr = '0' + (char)(uv % 10);
2546 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2547 * a regexp to its stringified form.
2551 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2553 const regexp * const re = (regexp *)mg->mg_obj;
2556 const char *fptr = "msix";
2561 bool need_newline = 0;
2562 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2564 while((ch = *fptr++)) {
2566 reflags[left++] = ch;
2569 reflags[right--] = ch;
2574 reflags[left] = '-';
2578 mg->mg_len = re->prelen + 4 + left;
2580 * If /x was used, we have to worry about a regex ending with a
2581 * comment later being embedded within another regex. If so, we don't
2582 * want this regex's "commentization" to leak out to the right part of
2583 * the enclosing regex, we must cap it with a newline.
2585 * So, if /x was used, we scan backwards from the end of the regex. If
2586 * we find a '#' before we find a newline, we need to add a newline
2587 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2588 * we don't need to add anything. -jfriedl
2590 if (PMf_EXTENDED & re->reganch) {
2591 const char *endptr = re->precomp + re->prelen;
2592 while (endptr >= re->precomp) {
2593 const char c = *(endptr--);
2595 break; /* don't need another */
2597 /* we end while in a comment, so we need a newline */
2598 mg->mg_len++; /* save space for it */
2599 need_newline = 1; /* note to add it */
2605 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2606 mg->mg_ptr[0] = '(';
2607 mg->mg_ptr[1] = '?';
2608 Copy(reflags, mg->mg_ptr+2, left, char);
2609 *(mg->mg_ptr+left+2) = ':';
2610 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2612 mg->mg_ptr[mg->mg_len - 2] = '\n';
2613 mg->mg_ptr[mg->mg_len - 1] = ')';
2614 mg->mg_ptr[mg->mg_len] = 0;
2616 PL_reginterp_cnt += re->program[0].next_off;
2618 if (re->reganch & ROPT_UTF8)
2628 =for apidoc sv_2pv_flags
2630 Returns a pointer to the string value of an SV, and sets *lp to its length.
2631 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2633 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2634 usually end up here too.
2640 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2650 if (SvGMAGICAL(sv)) {
2651 if (flags & SV_GMAGIC)
2656 if (flags & SV_MUTABLE_RETURN)
2657 return SvPVX_mutable(sv);
2658 if (flags & SV_CONST_RETURN)
2659 return (char *)SvPVX_const(sv);
2662 if (SvIOKp(sv) || SvNOKp(sv)) {
2663 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2668 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2669 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2671 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2678 #ifdef FIXNEGATIVEZERO
2679 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2685 SvUPGRADE(sv, SVt_PV);
2688 s = SvGROW_mutable(sv, len + 1);
2691 return (char*)memcpy(s, tbuf, len + 1);
2697 assert(SvTYPE(sv) >= SVt_PVMG);
2698 /* This falls through to the report_uninit near the end of the
2700 } else if (SvTHINKFIRST(sv)) {
2704 SV *const tmpstr = AMG_CALLun(sv,string);
2705 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2707 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2711 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2712 if (flags & SV_CONST_RETURN) {
2713 pv = (char *) SvPVX_const(tmpstr);
2715 pv = (flags & SV_MUTABLE_RETURN)
2716 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2719 *lp = SvCUR(tmpstr);
2721 pv = sv_2pv_flags(tmpstr, lp, flags);
2733 const SV *const referent = (SV*)SvRV(sv);
2736 tsv = sv_2mortal(newSVpvs("NULLREF"));
2737 } else if (SvTYPE(referent) == SVt_PVMG
2738 && ((SvFLAGS(referent) &
2739 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2740 == (SVs_OBJECT|SVs_SMG))
2741 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2742 return stringify_regexp(sv, mg, lp);
2744 const char *const typestr = sv_reftype(referent, 0);
2746 tsv = sv_newmortal();
2747 if (SvOBJECT(referent)) {
2748 const char *const name = HvNAME_get(SvSTASH(referent));
2749 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2750 name ? name : "__ANON__" , typestr,
2754 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2762 if (SvREADONLY(sv) && !SvOK(sv)) {
2763 if (ckWARN(WARN_UNINITIALIZED))
2770 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2771 /* I'm assuming that if both IV and NV are equally valid then
2772 converting the IV is going to be more efficient */
2773 const U32 isIOK = SvIOK(sv);
2774 const U32 isUIOK = SvIsUV(sv);
2775 char buf[TYPE_CHARS(UV)];
2778 if (SvTYPE(sv) < SVt_PVIV)
2779 sv_upgrade(sv, SVt_PVIV);
2780 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2781 /* inlined from sv_setpvn */
2782 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2783 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2784 SvCUR_set(sv, ebuf - ptr);
2794 else if (SvNOKp(sv)) {
2795 const int olderrno = errno;
2796 if (SvTYPE(sv) < SVt_PVNV)
2797 sv_upgrade(sv, SVt_PVNV);
2798 /* The +20 is pure guesswork. Configure test needed. --jhi */
2799 s = SvGROW_mutable(sv, NV_DIG + 20);
2800 /* some Xenix systems wipe out errno here */
2802 if (SvNVX(sv) == 0.0)
2803 my_strlcpy(s, "0", SvLEN(sv));
2807 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2810 #ifdef FIXNEGATIVEZERO
2811 if (*s == '-' && s[1] == '0' && !s[2])
2812 my_strlcpy(s, "0", SvLEN(s));
2821 if (isGV_with_GP(sv))
2822 return glob_2pv((GV *)sv, lp);
2824 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2828 if (SvTYPE(sv) < SVt_PV)
2829 /* Typically the caller expects that sv_any is not NULL now. */
2830 sv_upgrade(sv, SVt_PV);
2834 const STRLEN len = s - SvPVX_const(sv);
2840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2841 PTR2UV(sv),SvPVX_const(sv)));
2842 if (flags & SV_CONST_RETURN)
2843 return (char *)SvPVX_const(sv);
2844 if (flags & SV_MUTABLE_RETURN)
2845 return SvPVX_mutable(sv);
2850 =for apidoc sv_copypv
2852 Copies a stringified representation of the source SV into the
2853 destination SV. Automatically performs any necessary mg_get and
2854 coercion of numeric values into strings. Guaranteed to preserve
2855 UTF-8 flag even from overloaded objects. Similar in nature to
2856 sv_2pv[_flags] but operates directly on an SV instead of just the
2857 string. Mostly uses sv_2pv_flags to do its work, except when that
2858 would lose the UTF-8'ness of the PV.
2864 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2867 const char * const s = SvPV_const(ssv,len);
2868 sv_setpvn(dsv,s,len);
2876 =for apidoc sv_2pvbyte
2878 Return a pointer to the byte-encoded representation of the SV, and set *lp
2879 to its length. May cause the SV to be downgraded from UTF-8 as a
2882 Usually accessed via the C<SvPVbyte> macro.
2888 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2890 sv_utf8_downgrade(sv,0);
2891 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2895 =for apidoc sv_2pvutf8
2897 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2898 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2900 Usually accessed via the C<SvPVutf8> macro.
2906 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2908 sv_utf8_upgrade(sv);
2909 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2914 =for apidoc sv_2bool
2916 This function is only called on magical items, and is only used by
2917 sv_true() or its macro equivalent.
2923 Perl_sv_2bool(pTHX_ register SV *sv)
2932 SV * const tmpsv = AMG_CALLun(sv,bool_);
2933 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2934 return (bool)SvTRUE(tmpsv);
2936 return SvRV(sv) != 0;
2939 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2941 (*sv->sv_u.svu_pv > '0' ||
2942 Xpvtmp->xpv_cur > 1 ||
2943 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2950 return SvIVX(sv) != 0;
2953 return SvNVX(sv) != 0.0;
2955 if (isGV_with_GP(sv))
2965 =for apidoc sv_utf8_upgrade
2967 Converts the PV of an SV to its UTF-8-encoded form.
2968 Forces the SV to string form if it is not already.
2969 Always sets the SvUTF8 flag to avoid future validity checks even
2970 if all the bytes have hibit clear.
2972 This is not as a general purpose byte encoding to Unicode interface:
2973 use the Encode extension for that.
2975 =for apidoc sv_utf8_upgrade_flags
2977 Converts the PV of an SV to its UTF-8-encoded form.
2978 Forces the SV to string form if it is not already.
2979 Always sets the SvUTF8 flag to avoid future validity checks even
2980 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2981 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2982 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2984 This is not as a general purpose byte encoding to Unicode interface:
2985 use the Encode extension for that.
2991 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2994 if (sv == &PL_sv_undef)
2998 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2999 (void) sv_2pv_flags(sv,&len, flags);
3003 (void) SvPV_force(sv,len);
3012 sv_force_normal_flags(sv, 0);
3015 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3016 sv_recode_to_utf8(sv, PL_encoding);
3017 else { /* Assume Latin-1/EBCDIC */
3018 /* This function could be much more efficient if we
3019 * had a FLAG in SVs to signal if there are any hibit
3020 * chars in the PV. Given that there isn't such a flag
3021 * make the loop as fast as possible. */
3022 const U8 * const s = (U8 *) SvPVX_const(sv);
3023 const U8 * const e = (U8 *) SvEND(sv);
3028 /* Check for hi bit */
3029 if (!NATIVE_IS_INVARIANT(ch)) {
3030 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3031 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3033 SvPV_free(sv); /* No longer using what was there before. */
3034 SvPV_set(sv, (char*)recoded);
3035 SvCUR_set(sv, len - 1);
3036 SvLEN_set(sv, len); /* No longer know the real size. */
3040 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3047 =for apidoc sv_utf8_downgrade
3049 Attempts to convert the PV of an SV from characters to bytes.
3050 If the PV contains a character beyond byte, this conversion will fail;
3051 in this case, either returns false or, if C<fail_ok> is not
3054 This is not as a general purpose Unicode to byte encoding interface:
3055 use the Encode extension for that.
3061 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3064 if (SvPOKp(sv) && SvUTF8(sv)) {
3070 sv_force_normal_flags(sv, 0);
3072 s = (U8 *) SvPV(sv, len);
3073 if (!utf8_to_bytes(s, &len)) {
3078 Perl_croak(aTHX_ "Wide character in %s",
3081 Perl_croak(aTHX_ "Wide character");
3092 =for apidoc sv_utf8_encode
3094 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3095 flag off so that it looks like octets again.
3101 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3104 sv_force_normal_flags(sv, 0);
3106 if (SvREADONLY(sv)) {
3107 Perl_croak(aTHX_ PL_no_modify);
3109 (void) sv_utf8_upgrade(sv);
3114 =for apidoc sv_utf8_decode
3116 If the PV of the SV is an octet sequence in UTF-8
3117 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3118 so that it looks like a character. If the PV contains only single-byte
3119 characters, the C<SvUTF8> flag stays being off.
3120 Scans PV for validity and returns false if the PV is invalid UTF-8.
3126 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3132 /* The octets may have got themselves encoded - get them back as
3135 if (!sv_utf8_downgrade(sv, TRUE))
3138 /* it is actually just a matter of turning the utf8 flag on, but
3139 * we want to make sure everything inside is valid utf8 first.
3141 c = (const U8 *) SvPVX_const(sv);
3142 if (!is_utf8_string(c, SvCUR(sv)+1))
3144 e = (const U8 *) SvEND(sv);
3147 if (!UTF8_IS_INVARIANT(ch)) {
3157 =for apidoc sv_setsv
3159 Copies the contents of the source SV C<ssv> into the destination SV
3160 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3161 function if the source SV needs to be reused. Does not handle 'set' magic.
3162 Loosely speaking, it performs a copy-by-value, obliterating any previous
3163 content of the destination.
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3169 =for apidoc sv_setsv_flags
3171 Copies the contents of the source SV C<ssv> into the destination SV
3172 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3173 function if the source SV needs to be reused. Does not handle 'set' magic.
3174 Loosely speaking, it performs a copy-by-value, obliterating any previous
3175 content of the destination.
3176 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3177 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3178 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3179 and C<sv_setsv_nomg> are implemented in terms of this function.
3181 You probably want to use one of the assortment of wrappers, such as
3182 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3183 C<SvSetMagicSV_nosteal>.
3185 This is the primary function for copying scalars, and most other
3186 copy-ish functions and macros use this underneath.
3192 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3194 if (dtype != SVt_PVGV) {
3195 const char * const name = GvNAME(sstr);
3196 const STRLEN len = GvNAMELEN(sstr);
3197 /* don't upgrade SVt_PVLV: it can hold a glob */
3198 if (dtype != SVt_PVLV) {
3199 if (dtype >= SVt_PV) {
3205 sv_upgrade(dstr, SVt_PVGV);
3206 (void)SvOK_off(dstr);
3209 GvSTASH(dstr) = GvSTASH(sstr);
3211 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3212 gv_name_set((GV *)dstr, name, len, GV_ADD);
3213 SvFAKE_on(dstr); /* can coerce to non-glob */
3216 #ifdef GV_UNIQUE_CHECK
3217 if (GvUNIQUE((GV*)dstr)) {
3218 Perl_croak(aTHX_ PL_no_modify);
3224 (void)SvOK_off(dstr);
3226 GvINTRO_off(dstr); /* one-shot flag */
3227 GvGP(dstr) = gp_ref(GvGP(sstr));
3228 if (SvTAINTED(sstr))
3230 if (GvIMPORTED(dstr) != GVf_IMPORTED
3231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3233 GvIMPORTED_on(dstr);
3240 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3241 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3243 const int intro = GvINTRO(dstr);
3246 const U32 stype = SvTYPE(sref);
3249 #ifdef GV_UNIQUE_CHECK
3250 if (GvUNIQUE((GV*)dstr)) {
3251 Perl_croak(aTHX_ PL_no_modify);
3256 GvINTRO_off(dstr); /* one-shot flag */
3257 GvLINE(dstr) = CopLINE(PL_curcop);
3258 GvEGV(dstr) = (GV*)dstr;
3263 location = (SV **) &GvCV(dstr);
3264 import_flag = GVf_IMPORTED_CV;
3267 location = (SV **) &GvHV(dstr);
3268 import_flag = GVf_IMPORTED_HV;
3271 location = (SV **) &GvAV(dstr);
3272 import_flag = GVf_IMPORTED_AV;
3275 location = (SV **) &GvIOp(dstr);
3278 location = (SV **) &GvFORM(dstr);
3280 location = &GvSV(dstr);
3281 import_flag = GVf_IMPORTED_SV;
3284 if (stype == SVt_PVCV) {
3285 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3286 SvREFCNT_dec(GvCV(dstr));
3288 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3289 PL_sub_generation++;
3292 SAVEGENERICSV(*location);
3296 if (stype == SVt_PVCV && *location != sref) {
3297 CV* const cv = (CV*)*location;
3299 if (!GvCVGEN((GV*)dstr) &&
3300 (CvROOT(cv) || CvXSUB(cv)))
3302 /* Redefining a sub - warning is mandatory if
3303 it was a const and its value changed. */
3304 if (CvCONST(cv) && CvCONST((CV*)sref)
3305 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3307 /* They are 2 constant subroutines generated from
3308 the same constant. This probably means that
3309 they are really the "same" proxy subroutine
3310 instantiated in 2 places. Most likely this is
3311 when a constant is exported twice. Don't warn.
3314 else if (ckWARN(WARN_REDEFINE)
3316 && (!CvCONST((CV*)sref)
3317 || sv_cmp(cv_const_sv(cv),
3318 cv_const_sv((CV*)sref))))) {
3319 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3322 ? "Constant subroutine %s::%s redefined"
3323 : "Subroutine %s::%s redefined"),
3324 HvNAME_get(GvSTASH((GV*)dstr)),
3325 GvENAME((GV*)dstr));
3329 cv_ckproto_len(cv, (GV*)dstr,
3330 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3331 SvPOK(sref) ? SvCUR(sref) : 0);
3333 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3334 GvASSUMECV_on(dstr);
3335 PL_sub_generation++;
3338 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3339 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3340 GvFLAGS(dstr) |= import_flag;
3345 if (SvTAINTED(sstr))
3351 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3354 register U32 sflags;
3356 register svtype stype;
3360 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3362 sstr = &PL_sv_undef;
3363 stype = SvTYPE(sstr);
3364 dtype = SvTYPE(dstr);
3369 /* need to nuke the magic */
3371 SvRMAGICAL_off(dstr);
3374 /* There's a lot of redundancy below but we're going for speed here */
3379 if (dtype != SVt_PVGV) {
3380 (void)SvOK_off(dstr);
3388 sv_upgrade(dstr, SVt_IV);
3393 sv_upgrade(dstr, SVt_PVIV);
3396 (void)SvIOK_only(dstr);
3397 SvIV_set(dstr, SvIVX(sstr));
3400 /* SvTAINTED can only be true if the SV has taint magic, which in
3401 turn means that the SV type is PVMG (or greater). This is the
3402 case statement for SVt_IV, so this cannot be true (whatever gcov
3404 assert(!SvTAINTED(sstr));
3414 sv_upgrade(dstr, SVt_NV);
3419 sv_upgrade(dstr, SVt_PVNV);
3422 SvNV_set(dstr, SvNVX(sstr));
3423 (void)SvNOK_only(dstr);
3424 /* SvTAINTED can only be true if the SV has taint magic, which in
3425 turn means that the SV type is PVMG (or greater). This is the
3426 case statement for SVt_NV, so this cannot be true (whatever gcov
3428 assert(!SvTAINTED(sstr));
3435 sv_upgrade(dstr, SVt_RV);
3438 #ifdef PERL_OLD_COPY_ON_WRITE
3439 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3440 if (dtype < SVt_PVIV)
3441 sv_upgrade(dstr, SVt_PVIV);
3448 sv_upgrade(dstr, SVt_PV);
3451 if (dtype < SVt_PVIV)
3452 sv_upgrade(dstr, SVt_PVIV);
3455 if (dtype < SVt_PVNV)
3456 sv_upgrade(dstr, SVt_PVNV);
3460 const char * const type = sv_reftype(sstr,0);
3462 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3464 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3469 if (dtype <= SVt_PVGV) {
3470 glob_assign_glob(dstr, sstr, dtype);
3478 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3480 if ((int)SvTYPE(sstr) != stype) {
3481 stype = SvTYPE(sstr);
3482 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3483 glob_assign_glob(dstr, sstr, dtype);
3488 if (stype == SVt_PVLV)
3489 SvUPGRADE(dstr, SVt_PVNV);
3491 SvUPGRADE(dstr, (svtype)stype);
3494 /* dstr may have been upgraded. */
3495 dtype = SvTYPE(dstr);
3496 sflags = SvFLAGS(sstr);
3498 if (sflags & SVf_ROK) {
3499 if (dtype == SVt_PVGV &&
3500 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3503 if (GvIMPORTED(dstr) != GVf_IMPORTED
3504 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3506 GvIMPORTED_on(dstr);
3511 glob_assign_glob(dstr, sstr, dtype);
3515 if (dtype >= SVt_PV) {
3516 if (dtype == SVt_PVGV) {
3517 glob_assign_ref(dstr, sstr);
3520 if (SvPVX_const(dstr)) {
3526 (void)SvOK_off(dstr);
3527 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3528 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3529 assert(!(sflags & SVp_NOK));
3530 assert(!(sflags & SVp_IOK));
3531 assert(!(sflags & SVf_NOK));
3532 assert(!(sflags & SVf_IOK));
3534 else if (dtype == SVt_PVGV) {
3535 if (!(sflags & SVf_OK)) {
3536 if (ckWARN(WARN_MISC))
3537 Perl_warner(aTHX_ packWARN(WARN_MISC),
3538 "Undefined value assigned to typeglob");
3541 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3542 if (dstr != (SV*)gv) {
3545 GvGP(dstr) = gp_ref(GvGP(gv));
3549 else if (sflags & SVp_POK) {
3553 * Check to see if we can just swipe the string. If so, it's a
3554 * possible small lose on short strings, but a big win on long ones.
3555 * It might even be a win on short strings if SvPVX_const(dstr)
3556 * has to be allocated and SvPVX_const(sstr) has to be freed.
3559 /* Whichever path we take through the next code, we want this true,
3560 and doing it now facilitates the COW check. */
3561 (void)SvPOK_only(dstr);
3564 /* We're not already COW */
3565 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3566 #ifndef PERL_OLD_COPY_ON_WRITE
3567 /* or we are, but dstr isn't a suitable target. */
3568 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3573 (sflags & SVs_TEMP) && /* slated for free anyway? */
3574 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3575 (!(flags & SV_NOSTEAL)) &&
3576 /* and we're allowed to steal temps */
3577 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3578 SvLEN(sstr) && /* and really is a string */
3579 /* and won't be needed again, potentially */
3580 !(PL_op && PL_op->op_type == OP_AASSIGN))
3581 #ifdef PERL_OLD_COPY_ON_WRITE
3582 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3583 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3584 && SvTYPE(sstr) >= SVt_PVIV)
3587 /* Failed the swipe test, and it's not a shared hash key either.
3588 Have to copy the string. */
3589 STRLEN len = SvCUR(sstr);
3590 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3591 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3592 SvCUR_set(dstr, len);
3593 *SvEND(dstr) = '\0';
3595 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3597 /* Either it's a shared hash key, or it's suitable for
3598 copy-on-write or we can swipe the string. */
3600 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3604 #ifdef PERL_OLD_COPY_ON_WRITE
3606 /* I believe I should acquire a global SV mutex if
3607 it's a COW sv (not a shared hash key) to stop
3608 it going un copy-on-write.
3609 If the source SV has gone un copy on write between up there
3610 and down here, then (assert() that) it is of the correct
3611 form to make it copy on write again */
3612 if ((sflags & (SVf_FAKE | SVf_READONLY))
3613 != (SVf_FAKE | SVf_READONLY)) {
3614 SvREADONLY_on(sstr);
3616 /* Make the source SV into a loop of 1.
3617 (about to become 2) */
3618 SV_COW_NEXT_SV_SET(sstr, sstr);
3622 /* Initial code is common. */
3623 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3628 /* making another shared SV. */
3629 STRLEN cur = SvCUR(sstr);
3630 STRLEN len = SvLEN(sstr);
3631 #ifdef PERL_OLD_COPY_ON_WRITE
3633 assert (SvTYPE(dstr) >= SVt_PVIV);
3634 /* SvIsCOW_normal */
3635 /* splice us in between source and next-after-source. */
3636 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3637 SV_COW_NEXT_SV_SET(sstr, dstr);
3638 SvPV_set(dstr, SvPVX_mutable(sstr));
3642 /* SvIsCOW_shared_hash */
3643 DEBUG_C(PerlIO_printf(Perl_debug_log,
3644 "Copy on write: Sharing hash\n"));
3646 assert (SvTYPE(dstr) >= SVt_PV);
3648 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3650 SvLEN_set(dstr, len);
3651 SvCUR_set(dstr, cur);
3652 SvREADONLY_on(dstr);
3654 /* Relesase a global SV mutex. */
3657 { /* Passes the swipe test. */
3658 SvPV_set(dstr, SvPVX_mutable(sstr));
3659 SvLEN_set(dstr, SvLEN(sstr));
3660 SvCUR_set(dstr, SvCUR(sstr));
3663 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3664 SvPV_set(sstr, NULL);
3670 if (sflags & SVp_NOK) {
3671 SvNV_set(dstr, SvNVX(sstr));
3673 if (sflags & SVp_IOK) {
3674 SvRELEASE_IVX(dstr);
3675 SvIV_set(dstr, SvIVX(sstr));
3676 /* Must do this otherwise some other overloaded use of 0x80000000
3677 gets confused. I guess SVpbm_VALID */
3678 if (sflags & SVf_IVisUV)
3681 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3684 const MAGIC * const smg = SvVSTRING_mg(sstr);
3686 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3687 smg->mg_ptr, smg->mg_len);
3688 SvRMAGICAL_on(dstr);
3692 else if (sflags & (SVp_IOK|SVp_NOK)) {
3693 (void)SvOK_off(dstr);
3694 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3696 if (sflags & SVp_IOK) {
3697 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3698 SvIV_set(dstr, SvIVX(sstr));
3700 if (sflags & SVp_NOK) {
3701 SvNV_set(dstr, SvNVX(sstr));
3705 if (isGV_with_GP(sstr)) {
3706 /* This stringification rule for globs is spread in 3 places.
3707 This feels bad. FIXME. */
3708 const U32 wasfake = sflags & SVf_FAKE;
3710 /* FAKE globs can get coerced, so need to turn this off
3711 temporarily if it is on. */
3713 gv_efullname3(dstr, (GV *)sstr, "*");
3714 SvFLAGS(sstr) |= wasfake;
3715 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3718 (void)SvOK_off(dstr);
3720 if (SvTAINTED(sstr))
3725 =for apidoc sv_setsv_mg
3727 Like C<sv_setsv>, but also handles 'set' magic.
3733 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3735 sv_setsv(dstr,sstr);
3739 #ifdef PERL_OLD_COPY_ON_WRITE
3741 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3743 STRLEN cur = SvCUR(sstr);
3744 STRLEN len = SvLEN(sstr);
3745 register char *new_pv;
3748 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3756 if (SvTHINKFIRST(dstr))
3757 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3758 else if (SvPVX_const(dstr))
3759 Safefree(SvPVX_const(dstr));
3763 SvUPGRADE(dstr, SVt_PVIV);
3765 assert (SvPOK(sstr));
3766 assert (SvPOKp(sstr));
3767 assert (!SvIOK(sstr));
3768 assert (!SvIOKp(sstr));
3769 assert (!SvNOK(sstr));
3770 assert (!SvNOKp(sstr));
3772 if (SvIsCOW(sstr)) {
3774 if (SvLEN(sstr) == 0) {
3775 /* source is a COW shared hash key. */
3776 DEBUG_C(PerlIO_printf(Perl_debug_log,
3777 "Fast copy on write: Sharing hash\n"));
3778 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3781 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3783 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3784 SvUPGRADE(sstr, SVt_PVIV);
3785 SvREADONLY_on(sstr);
3787 DEBUG_C(PerlIO_printf(Perl_debug_log,
3788 "Fast copy on write: Converting sstr to COW\n"));
3789 SV_COW_NEXT_SV_SET(dstr, sstr);
3791 SV_COW_NEXT_SV_SET(sstr, dstr);
3792 new_pv = SvPVX_mutable(sstr);
3795 SvPV_set(dstr, new_pv);
3796 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3799 SvLEN_set(dstr, len);
3800 SvCUR_set(dstr, cur);
3809 =for apidoc sv_setpvn
3811 Copies a string into an SV. The C<len> parameter indicates the number of
3812 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3813 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3819 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3822 register char *dptr;
3824 SV_CHECK_THINKFIRST_COW_DROP(sv);
3830 /* len is STRLEN which is unsigned, need to copy to signed */
3833 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3835 SvUPGRADE(sv, SVt_PV);
3837 dptr = SvGROW(sv, len + 1);
3838 Move(ptr,dptr,len,char);
3841 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3846 =for apidoc sv_setpvn_mg
3848 Like C<sv_setpvn>, but also handles 'set' magic.
3854 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3856 sv_setpvn(sv,ptr,len);
3861 =for apidoc sv_setpv
3863 Copies a string into an SV. The string must be null-terminated. Does not
3864 handle 'set' magic. See C<sv_setpv_mg>.
3870 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3873 register STRLEN len;
3875 SV_CHECK_THINKFIRST_COW_DROP(sv);
3881 SvUPGRADE(sv, SVt_PV);
3883 SvGROW(sv, len + 1);
3884 Move(ptr,SvPVX(sv),len+1,char);
3886 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3891 =for apidoc sv_setpv_mg
3893 Like C<sv_setpv>, but also handles 'set' magic.
3899 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3906 =for apidoc sv_usepvn_flags
3908 Tells an SV to use C<ptr> to find its string value. Normally the
3909 string is stored inside the SV but sv_usepvn allows the SV to use an
3910 outside string. The C<ptr> should point to memory that was allocated
3911 by C<malloc>. The string length, C<len>, must be supplied. By default
3912 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3913 so that pointer should not be freed or used by the programmer after
3914 giving it to sv_usepvn, and neither should any pointers from "behind"
3915 that pointer (e.g. ptr + 1) be used.
3917 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3918 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3919 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3920 C<len>, and already meets the requirements for storing in C<SvPVX>)
3926 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3930 SV_CHECK_THINKFIRST_COW_DROP(sv);
3931 SvUPGRADE(sv, SVt_PV);
3934 if (flags & SV_SMAGIC)
3938 if (SvPVX_const(sv))
3942 if (flags & SV_HAS_TRAILING_NUL)
3943 assert(ptr[len] == '\0');
3946 allocate = (flags & SV_HAS_TRAILING_NUL)
3947 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3948 if (flags & SV_HAS_TRAILING_NUL) {
3949 /* It's long enough - do nothing.
3950 Specfically Perl_newCONSTSUB is relying on this. */
3953 /* Force a move to shake out bugs in callers. */
3954 char *new_ptr = (char*)safemalloc(allocate);
3955 Copy(ptr, new_ptr, len, char);
3956 PoisonFree(ptr,len,char);
3960 ptr = (char*) saferealloc (ptr, allocate);
3965 SvLEN_set(sv, allocate);
3966 if (!(flags & SV_HAS_TRAILING_NUL)) {
3969 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3971 if (flags & SV_SMAGIC)
3975 #ifdef PERL_OLD_COPY_ON_WRITE
3976 /* Need to do this *after* making the SV normal, as we need the buffer
3977 pointer to remain valid until after we've copied it. If we let go too early,
3978 another thread could invalidate it by unsharing last of the same hash key
3979 (which it can do by means other than releasing copy-on-write Svs)
3980 or by changing the other copy-on-write SVs in the loop. */
3982 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3984 if (len) { /* this SV was SvIsCOW_normal(sv) */
3985 /* we need to find the SV pointing to us. */
3986 SV *current = SV_COW_NEXT_SV(after);
3988 if (current == sv) {
3989 /* The SV we point to points back to us (there were only two of us
3991 Hence other SV is no longer copy on write either. */
3993 SvREADONLY_off(after);
3995 /* We need to follow the pointers around the loop. */
3997 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4000 /* don't loop forever if the structure is bust, and we have
4001 a pointer into a closed loop. */
4002 assert (current != after);
4003 assert (SvPVX_const(current) == pvx);
4005 /* Make the SV before us point to the SV after us. */
4006 SV_COW_NEXT_SV_SET(current, after);
4009 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4014 Perl_sv_release_IVX(pTHX_ register SV *sv)
4017 sv_force_normal_flags(sv, 0);
4023 =for apidoc sv_force_normal_flags
4025 Undo various types of fakery on an SV: if the PV is a shared string, make
4026 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4027 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4028 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4029 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4030 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4031 set to some other value.) In addition, the C<flags> parameter gets passed to
4032 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4033 with flags set to 0.
4039 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4042 #ifdef PERL_OLD_COPY_ON_WRITE
4043 if (SvREADONLY(sv)) {
4044 /* At this point I believe I should acquire a global SV mutex. */
4046 const char * const pvx = SvPVX_const(sv);
4047 const STRLEN len = SvLEN(sv);
4048 const STRLEN cur = SvCUR(sv);
4049 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4051 PerlIO_printf(Perl_debug_log,
4052 "Copy on write: Force normal %ld\n",
4058 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4061 if (flags & SV_COW_DROP_PV) {
4062 /* OK, so we don't need to copy our buffer. */
4065 SvGROW(sv, cur + 1);
4066 Move(pvx,SvPVX(sv),cur,char);
4070 sv_release_COW(sv, pvx, len, next);
4075 else if (IN_PERL_RUNTIME)
4076 Perl_croak(aTHX_ PL_no_modify);
4077 /* At this point I believe that I can drop the global SV mutex. */
4080 if (SvREADONLY(sv)) {
4082 const char * const pvx = SvPVX_const(sv);
4083 const STRLEN len = SvCUR(sv);
4088 SvGROW(sv, len + 1);
4089 Move(pvx,SvPVX(sv),len,char);
4091 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4093 else if (IN_PERL_RUNTIME)
4094 Perl_croak(aTHX_ PL_no_modify);
4098 sv_unref_flags(sv, flags);
4099 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4106 Efficient removal of characters from the beginning of the string buffer.
4107 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4108 the string buffer. The C<ptr> becomes the first character of the adjusted
4109 string. Uses the "OOK hack".
4110 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4111 refer to the same chunk of data.
4117 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4119 register STRLEN delta;
4120 if (!ptr || !SvPOKp(sv))
4122 delta = ptr - SvPVX_const(sv);
4123 SV_CHECK_THINKFIRST(sv);
4124 if (SvTYPE(sv) < SVt_PVIV)
4125 sv_upgrade(sv,SVt_PVIV);
4128 if (!SvLEN(sv)) { /* make copy of shared string */
4129 const char *pvx = SvPVX_const(sv);
4130 const STRLEN len = SvCUR(sv);
4131 SvGROW(sv, len + 1);
4132 Move(pvx,SvPVX(sv),len,char);
4136 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4137 and we do that anyway inside the SvNIOK_off
4139 SvFLAGS(sv) |= SVf_OOK;
4142 SvLEN_set(sv, SvLEN(sv) - delta);
4143 SvCUR_set(sv, SvCUR(sv) - delta);
4144 SvPV_set(sv, SvPVX(sv) + delta);
4145 SvIV_set(sv, SvIVX(sv) + delta);
4149 =for apidoc sv_catpvn
4151 Concatenates the string onto the end of the string which is in the SV. The
4152 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4153 status set, then the bytes appended should be valid UTF-8.
4154 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4156 =for apidoc sv_catpvn_flags
4158 Concatenates the string onto the end of the string which is in the SV. The
4159 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4160 status set, then the bytes appended should be valid UTF-8.
4161 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4162 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4163 in terms of this function.
4169 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4173 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4175 SvGROW(dsv, dlen + slen + 1);
4177 sstr = SvPVX_const(dsv);
4178 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4179 SvCUR_set(dsv, SvCUR(dsv) + slen);
4181 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4183 if (flags & SV_SMAGIC)
4188 =for apidoc sv_catsv
4190 Concatenates the string from SV C<ssv> onto the end of the string in
4191 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4192 not 'set' magic. See C<sv_catsv_mg>.
4194 =for apidoc sv_catsv_flags
4196 Concatenates the string from SV C<ssv> onto the end of the string in
4197 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4198 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4199 and C<sv_catsv_nomg> are implemented in terms of this function.
4204 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4209 const char *spv = SvPV_const(ssv, slen);
4211 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4212 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4213 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4214 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4215 dsv->sv_flags doesn't have that bit set.
4216 Andy Dougherty 12 Oct 2001
4218 const I32 sutf8 = DO_UTF8(ssv);
4221 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4223 dutf8 = DO_UTF8(dsv);
4225 if (dutf8 != sutf8) {
4227 /* Not modifying source SV, so taking a temporary copy. */
4228 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4230 sv_utf8_upgrade(csv);
4231 spv = SvPV_const(csv, slen);
4234 sv_utf8_upgrade_nomg(dsv);
4236 sv_catpvn_nomg(dsv, spv, slen);
4239 if (flags & SV_SMAGIC)
4244 =for apidoc sv_catpv
4246 Concatenates the string onto the end of the string which is in the SV.
4247 If the SV has the UTF-8 status set, then the bytes appended should be
4248 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4253 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4256 register STRLEN len;
4262 junk = SvPV_force(sv, tlen);
4264 SvGROW(sv, tlen + len + 1);
4266 ptr = SvPVX_const(sv);
4267 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4268 SvCUR_set(sv, SvCUR(sv) + len);
4269 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4274 =for apidoc sv_catpv_mg
4276 Like C<sv_catpv>, but also handles 'set' magic.
4282 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4291 Creates a new SV. A non-zero C<len> parameter indicates the number of
4292 bytes of preallocated string space the SV should have. An extra byte for a
4293 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4294 space is allocated.) The reference count for the new SV is set to 1.
4296 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4297 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4298 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4299 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4300 modules supporting older perls.
4306 Perl_newSV(pTHX_ STRLEN len)
4313 sv_upgrade(sv, SVt_PV);
4314 SvGROW(sv, len + 1);
4319 =for apidoc sv_magicext
4321 Adds magic to an SV, upgrading it if necessary. Applies the
4322 supplied vtable and returns a pointer to the magic added.
4324 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4325 In particular, you can add magic to SvREADONLY SVs, and add more than
4326 one instance of the same 'how'.
4328 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4329 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4330 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4331 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4333 (This is now used as a subroutine by C<sv_magic>.)
4338 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4339 const char* name, I32 namlen)
4344 if (SvTYPE(sv) < SVt_PVMG) {
4345 SvUPGRADE(sv, SVt_PVMG);
4347 Newxz(mg, 1, MAGIC);
4348 mg->mg_moremagic = SvMAGIC(sv);
4349 SvMAGIC_set(sv, mg);
4351 /* Sometimes a magic contains a reference loop, where the sv and
4352 object refer to each other. To prevent a reference loop that
4353 would prevent such objects being freed, we look for such loops
4354 and if we find one we avoid incrementing the object refcount.
4356 Note we cannot do this to avoid self-tie loops as intervening RV must
4357 have its REFCNT incremented to keep it in existence.
4360 if (!obj || obj == sv ||
4361 how == PERL_MAGIC_arylen ||
4362 how == PERL_MAGIC_qr ||
4363 how == PERL_MAGIC_symtab ||
4364 (SvTYPE(obj) == SVt_PVGV &&
4365 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4366 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4367 GvFORM(obj) == (CV*)sv)))
4372 mg->mg_obj = SvREFCNT_inc_simple(obj);
4373 mg->mg_flags |= MGf_REFCOUNTED;
4376 /* Normal self-ties simply pass a null object, and instead of
4377 using mg_obj directly, use the SvTIED_obj macro to produce a
4378 new RV as needed. For glob "self-ties", we are tieing the PVIO
4379 with an RV obj pointing to the glob containing the PVIO. In
4380 this case, to avoid a reference loop, we need to weaken the
4384 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4385 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4391 mg->mg_len = namlen;
4394 mg->mg_ptr = savepvn(name, namlen);
4395 else if (namlen == HEf_SVKEY)
4396 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4398 mg->mg_ptr = (char *) name;
4400 mg->mg_virtual = vtable;
4404 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4409 =for apidoc sv_magic
4411 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4412 then adds a new magic item of type C<how> to the head of the magic list.
4414 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4415 handling of the C<name> and C<namlen> arguments.
4417 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4418 to add more than one instance of the same 'how'.
4424 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4430 #ifdef PERL_OLD_COPY_ON_WRITE
4432 sv_force_normal_flags(sv, 0);
4434 if (SvREADONLY(sv)) {
4436 /* its okay to attach magic to shared strings; the subsequent
4437 * upgrade to PVMG will unshare the string */
4438 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4441 && how != PERL_MAGIC_regex_global
4442 && how != PERL_MAGIC_bm
4443 && how != PERL_MAGIC_fm
4444 && how != PERL_MAGIC_sv
4445 && how != PERL_MAGIC_backref
4448 Perl_croak(aTHX_ PL_no_modify);
4451 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4452 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4453 /* sv_magic() refuses to add a magic of the same 'how' as an
4456 if (how == PERL_MAGIC_taint) {
4458 /* Any scalar which already had taint magic on which someone
4459 (erroneously?) did SvIOK_on() or similar will now be
4460 incorrectly sporting public "OK" flags. */
4461 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4469 vtable = &PL_vtbl_sv;
4471 case PERL_MAGIC_overload:
4472 vtable = &PL_vtbl_amagic;
4474 case PERL_MAGIC_overload_elem:
4475 vtable = &PL_vtbl_amagicelem;
4477 case PERL_MAGIC_overload_table:
4478 vtable = &PL_vtbl_ovrld;
4481 vtable = &PL_vtbl_bm;
4483 case PERL_MAGIC_regdata:
4484 vtable = &PL_vtbl_regdata;
4486 case PERL_MAGIC_regdatum:
4487 vtable = &PL_vtbl_regdatum;
4489 case PERL_MAGIC_env:
4490 vtable = &PL_vtbl_env;
4493 vtable = &PL_vtbl_fm;
4495 case PERL_MAGIC_envelem:
4496 vtable = &PL_vtbl_envelem;
4498 case PERL_MAGIC_regex_global:
4499 vtable = &PL_vtbl_mglob;
4501 case PERL_MAGIC_isa:
4502 vtable = &PL_vtbl_isa;
4504 case PERL_MAGIC_isaelem:
4505 vtable = &PL_vtbl_isaelem;
4507 case PERL_MAGIC_nkeys:
4508 vtable = &PL_vtbl_nkeys;
4510 case PERL_MAGIC_dbfile:
4513 case PERL_MAGIC_dbline:
4514 vtable = &PL_vtbl_dbline;
4516 #ifdef USE_LOCALE_COLLATE
4517 case PERL_MAGIC_collxfrm:
4518 vtable = &PL_vtbl_collxfrm;
4520 #endif /* USE_LOCALE_COLLATE */
4521 case PERL_MAGIC_tied:
4522 vtable = &PL_vtbl_pack;
4524 case PERL_MAGIC_tiedelem:
4525 case PERL_MAGIC_tiedscalar:
4526 vtable = &PL_vtbl_packelem;
4529 vtable = &PL_vtbl_regexp;
4531 case PERL_MAGIC_hints:
4532 /* As this vtable is all NULL, we can reuse it. */
4533 case PERL_MAGIC_sig:
4534 vtable = &PL_vtbl_sig;
4536 case PERL_MAGIC_sigelem:
4537 vtable = &PL_vtbl_sigelem;
4539 case PERL_MAGIC_taint:
4540 vtable = &PL_vtbl_taint;
4542 case PERL_MAGIC_uvar:
4543 vtable = &PL_vtbl_uvar;
4545 case PERL_MAGIC_vec:
4546 vtable = &PL_vtbl_vec;
4548 case PERL_MAGIC_arylen_p:
4549 case PERL_MAGIC_rhash:
4550 case PERL_MAGIC_symtab:
4551 case PERL_MAGIC_vstring:
4554 case PERL_MAGIC_utf8:
4555 vtable = &PL_vtbl_utf8;
4557 case PERL_MAGIC_substr:
4558 vtable = &PL_vtbl_substr;
4560 case PERL_MAGIC_defelem:
4561 vtable = &PL_vtbl_defelem;
4563 case PERL_MAGIC_arylen:
4564 vtable = &PL_vtbl_arylen;
4566 case PERL_MAGIC_pos:
4567 vtable = &PL_vtbl_pos;
4569 case PERL_MAGIC_backref:
4570 vtable = &PL_vtbl_backref;
4572 case PERL_MAGIC_hintselem:
4573 vtable = &PL_vtbl_hintselem;
4575 case PERL_MAGIC_ext:
4576 /* Reserved for use by extensions not perl internals. */
4577 /* Useful for attaching extension internal data to perl vars. */
4578 /* Note that multiple extensions may clash if magical scalars */
4579 /* etc holding private data from one are passed to another. */
4583 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4586 /* Rest of work is done else where */
4587 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4590 case PERL_MAGIC_taint:
4593 case PERL_MAGIC_ext:
4594 case PERL_MAGIC_dbfile:
4601 =for apidoc sv_unmagic
4603 Removes all magic of type C<type> from an SV.
4609 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4613 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4615 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4616 for (mg = *mgp; mg; mg = *mgp) {
4617 if (mg->mg_type == type) {
4618 const MGVTBL* const vtbl = mg->mg_virtual;
4619 *mgp = mg->mg_moremagic;
4620 if (vtbl && vtbl->svt_free)
4621 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4622 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4624 Safefree(mg->mg_ptr);
4625 else if (mg->mg_len == HEf_SVKEY)
4626 SvREFCNT_dec((SV*)mg->mg_ptr);
4627 else if (mg->mg_type == PERL_MAGIC_utf8)
4628 Safefree(mg->mg_ptr);
4630 if (mg->mg_flags & MGf_REFCOUNTED)
4631 SvREFCNT_dec(mg->mg_obj);
4635 mgp = &mg->mg_moremagic;
4639 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4640 SvMAGIC_set(sv, NULL);
4647 =for apidoc sv_rvweaken
4649 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4650 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4651 push a back-reference to this RV onto the array of backreferences
4652 associated with that magic. If the RV is magical, set magic will be
4653 called after the RV is cleared.
4659 Perl_sv_rvweaken(pTHX_ SV *sv)
4662 if (!SvOK(sv)) /* let undefs pass */
4665 Perl_croak(aTHX_ "Can't weaken a nonreference");
4666 else if (SvWEAKREF(sv)) {
4667 if (ckWARN(WARN_MISC))
4668 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4672 Perl_sv_add_backref(aTHX_ tsv, sv);
4678 /* Give tsv backref magic if it hasn't already got it, then push a
4679 * back-reference to sv onto the array associated with the backref magic.
4683 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4688 if (SvTYPE(tsv) == SVt_PVHV) {
4689 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4693 /* There is no AV in the offical place - try a fixup. */
4694 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4697 /* Aha. They've got it stowed in magic. Bring it back. */
4698 av = (AV*)mg->mg_obj;
4699 /* Stop mg_free decreasing the refernce count. */
4701 /* Stop mg_free even calling the destructor, given that
4702 there's no AV to free up. */
4704 sv_unmagic(tsv, PERL_MAGIC_backref);
4708 SvREFCNT_inc_simple_void(av);
4713 const MAGIC *const mg
4714 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4716 av = (AV*)mg->mg_obj;
4720 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4721 /* av now has a refcnt of 2, which avoids it getting freed
4722 * before us during global cleanup. The extra ref is removed
4723 * by magic_killbackrefs() when tsv is being freed */
4726 if (AvFILLp(av) >= AvMAX(av)) {
4727 av_extend(av, AvFILLp(av)+1);
4729 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4732 /* delete a back-reference to ourselves from the backref magic associated
4733 * with the SV we point to.
4737 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4744 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4745 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4746 /* We mustn't attempt to "fix up" the hash here by moving the
4747 backreference array back to the hv_aux structure, as that is stored
4748 in the main HvARRAY(), and hfreentries assumes that no-one
4749 reallocates HvARRAY() while it is running. */
4752 const MAGIC *const mg
4753 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4755 av = (AV *)mg->mg_obj;
4758 if (PL_in_clean_all)
4760 Perl_croak(aTHX_ "panic: del_backref");
4767 /* We shouldn't be in here more than once, but for paranoia reasons lets
4769 for (i = AvFILLp(av); i >= 0; i--) {
4771 const SSize_t fill = AvFILLp(av);
4773 /* We weren't the last entry.
4774 An unordered list has this property that you can take the
4775 last element off the end to fill the hole, and it's still
4776 an unordered list :-)
4781 AvFILLp(av) = fill - 1;
4787 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4789 SV **svp = AvARRAY(av);
4791 PERL_UNUSED_ARG(sv);
4793 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4794 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4795 if (svp && !SvIS_FREED(av)) {
4796 SV *const *const last = svp + AvFILLp(av);
4798 while (svp <= last) {
4800 SV *const referrer = *svp;
4801 if (SvWEAKREF(referrer)) {
4802 /* XXX Should we check that it hasn't changed? */
4803 SvRV_set(referrer, 0);
4805 SvWEAKREF_off(referrer);
4806 SvSETMAGIC(referrer);
4807 } else if (SvTYPE(referrer) == SVt_PVGV ||
4808 SvTYPE(referrer) == SVt_PVLV) {
4809 /* You lookin' at me? */
4810 assert(GvSTASH(referrer));
4811 assert(GvSTASH(referrer) == (HV*)sv);
4812 GvSTASH(referrer) = 0;
4815 "panic: magic_killbackrefs (flags=%"UVxf")",
4816 (UV)SvFLAGS(referrer));
4824 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4829 =for apidoc sv_insert
4831 Inserts a string at the specified offset/length within the SV. Similar to
4832 the Perl substr() function.
4838 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4843 register char *midend;
4844 register char *bigend;
4850 Perl_croak(aTHX_ "Can't modify non-existent substring");
4851 SvPV_force(bigstr, curlen);
4852 (void)SvPOK_only_UTF8(bigstr);
4853 if (offset + len > curlen) {
4854 SvGROW(bigstr, offset+len+1);
4855 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4856 SvCUR_set(bigstr, offset+len);
4860 i = littlelen - len;
4861 if (i > 0) { /* string might grow */
4862 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4863 mid = big + offset + len;
4864 midend = bigend = big + SvCUR(bigstr);
4867 while (midend > mid) /* shove everything down */
4868 *--bigend = *--midend;
4869 Move(little,big+offset,littlelen,char);
4870 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4875 Move(little,SvPVX(bigstr)+offset,len,char);
4880 big = SvPVX(bigstr);
4883 bigend = big + SvCUR(bigstr);
4885 if (midend > bigend)
4886 Perl_croak(aTHX_ "panic: sv_insert");
4888 if (mid - big > bigend - midend) { /* faster to shorten from end */
4890 Move(little, mid, littlelen,char);
4893 i = bigend - midend;
4895 Move(midend, mid, i,char);
4899 SvCUR_set(bigstr, mid - big);
4901 else if ((i = mid - big)) { /* faster from front */
4902 midend -= littlelen;
4904 sv_chop(bigstr,midend-i);
4909 Move(little, mid, littlelen,char);
4911 else if (littlelen) {
4912 midend -= littlelen;
4913 sv_chop(bigstr,midend);
4914 Move(little,midend,littlelen,char);
4917 sv_chop(bigstr,midend);
4923 =for apidoc sv_replace
4925 Make the first argument a copy of the second, then delete the original.
4926 The target SV physically takes over ownership of the body of the source SV
4927 and inherits its flags; however, the target keeps any magic it owns,
4928 and any magic in the source is discarded.
4929 Note that this is a rather specialist SV copying operation; most of the
4930 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4936 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4939 const U32 refcnt = SvREFCNT(sv);
4940 SV_CHECK_THINKFIRST_COW_DROP(sv);
4941 if (SvREFCNT(nsv) != 1) {
4942 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4943 UVuf " != 1)", (UV) SvREFCNT(nsv));
4945 if (SvMAGICAL(sv)) {
4949 sv_upgrade(nsv, SVt_PVMG);
4950 SvMAGIC_set(nsv, SvMAGIC(sv));
4951 SvFLAGS(nsv) |= SvMAGICAL(sv);
4953 SvMAGIC_set(sv, NULL);
4957 assert(!SvREFCNT(sv));
4958 #ifdef DEBUG_LEAKING_SCALARS
4959 sv->sv_flags = nsv->sv_flags;
4960 sv->sv_any = nsv->sv_any;
4961 sv->sv_refcnt = nsv->sv_refcnt;
4962 sv->sv_u = nsv->sv_u;
4964 StructCopy(nsv,sv,SV);
4966 /* Currently could join these into one piece of pointer arithmetic, but
4967 it would be unclear. */
4968 if(SvTYPE(sv) == SVt_IV)
4970 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4971 else if (SvTYPE(sv) == SVt_RV) {
4972 SvANY(sv) = &sv->sv_u.svu_rv;
4976 #ifdef PERL_OLD_COPY_ON_WRITE
4977 if (SvIsCOW_normal(nsv)) {
4978 /* We need to follow the pointers around the loop to make the
4979 previous SV point to sv, rather than nsv. */
4982 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4985 assert(SvPVX_const(current) == SvPVX_const(nsv));
4987 /* Make the SV before us point to the SV after us. */
4989 PerlIO_printf(Perl_debug_log, "previous is\n");
4991 PerlIO_printf(Perl_debug_log,
4992 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4993 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4995 SV_COW_NEXT_SV_SET(current, sv);
4998 SvREFCNT(sv) = refcnt;
4999 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5005 =for apidoc sv_clear
5007 Clear an SV: call any destructors, free up any memory used by the body,
5008 and free the body itself. The SV's head is I<not> freed, although
5009 its type is set to all 1's so that it won't inadvertently be assumed
5010 to be live during global destruction etc.
5011 This function should only be called when REFCNT is zero. Most of the time
5012 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5019 Perl_sv_clear(pTHX_ register SV *sv)
5022 const U32 type = SvTYPE(sv);
5023 const struct body_details *const sv_type_details
5024 = bodies_by_type + type;
5027 assert(SvREFCNT(sv) == 0);
5029 if (type <= SVt_IV) {
5030 /* See the comment in sv.h about the collusion between this early
5031 return and the overloading of the NULL and IV slots in the size
5037 if (PL_defstash) { /* Still have a symbol table? */
5042 stash = SvSTASH(sv);
5043 destructor = StashHANDLER(stash,DESTROY);
5045 SV* const tmpref = newRV(sv);
5046 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5048 PUSHSTACKi(PERLSI_DESTROY);
5053 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5059 if(SvREFCNT(tmpref) < 2) {
5060 /* tmpref is not kept alive! */
5062 SvRV_set(tmpref, NULL);
5065 SvREFCNT_dec(tmpref);
5067 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5071 if (PL_in_clean_objs)
5072 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5074 /* DESTROY gave object new lease on life */
5080 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5081 SvOBJECT_off(sv); /* Curse the object. */
5082 if (type != SVt_PVIO)
5083 --PL_sv_objcount; /* XXX Might want something more general */
5086 if (type >= SVt_PVMG) {
5087 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5088 SvREFCNT_dec(OURSTASH(sv));
5089 } else if (SvMAGIC(sv))
5091 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5092 SvREFCNT_dec(SvSTASH(sv));
5097 IoIFP(sv) != PerlIO_stdin() &&
5098 IoIFP(sv) != PerlIO_stdout() &&
5099 IoIFP(sv) != PerlIO_stderr())
5101 io_close((IO*)sv, FALSE);
5103 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5104 PerlDir_close(IoDIRP(sv));
5105 IoDIRP(sv) = (DIR*)NULL;
5106 Safefree(IoTOP_NAME(sv));
5107 Safefree(IoFMT_NAME(sv));
5108 Safefree(IoBOTTOM_NAME(sv));
5117 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5124 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5125 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5126 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5127 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5129 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5130 SvREFCNT_dec(LvTARG(sv));
5134 if (GvNAME_HEK(sv)) {
5135 unshare_hek(GvNAME_HEK(sv));
5137 /* If we're in a stash, we don't own a reference to it. However it does
5138 have a back reference to us, which needs to be cleared. */
5140 sv_del_backref((SV*)GvSTASH(sv), sv);
5145 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5147 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5148 /* Don't even bother with turning off the OOK flag. */
5153 SV * const target = SvRV(sv);
5155 sv_del_backref(target, sv);
5157 SvREFCNT_dec(target);
5159 #ifdef PERL_OLD_COPY_ON_WRITE
5160 else if (SvPVX_const(sv)) {
5162 /* I believe I need to grab the global SV mutex here and
5163 then recheck the COW status. */
5165 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5168 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5169 SV_COW_NEXT_SV(sv));
5170 /* And drop it here. */
5172 } else if (SvLEN(sv)) {
5173 Safefree(SvPVX_const(sv));
5177 else if (SvPVX_const(sv) && SvLEN(sv))
5178 Safefree(SvPVX_mutable(sv));
5179 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5180 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5189 SvFLAGS(sv) &= SVf_BREAK;
5190 SvFLAGS(sv) |= SVTYPEMASK;
5192 if (sv_type_details->arena) {
5193 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5194 &PL_body_roots[type]);
5196 else if (sv_type_details->body_size) {
5197 my_safefree(SvANY(sv));
5202 =for apidoc sv_newref
5204 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5211 Perl_sv_newref(pTHX_ SV *sv)
5213 PERL_UNUSED_CONTEXT;
5222 Decrement an SV's reference count, and if it drops to zero, call
5223 C<sv_clear> to invoke destructors and free up any memory used by
5224 the body; finally, deallocate the SV's head itself.
5225 Normally called via a wrapper macro C<SvREFCNT_dec>.
5231 Perl_sv_free(pTHX_ SV *sv)
5236 if (SvREFCNT(sv) == 0) {
5237 if (SvFLAGS(sv) & SVf_BREAK)
5238 /* this SV's refcnt has been artificially decremented to
5239 * trigger cleanup */
5241 if (PL_in_clean_all) /* All is fair */
5243 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5244 /* make sure SvREFCNT(sv)==0 happens very seldom */
5245 SvREFCNT(sv) = (~(U32)0)/2;
5248 if (ckWARN_d(WARN_INTERNAL)) {
5249 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5250 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5251 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5252 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5253 Perl_dump_sv_child(aTHX_ sv);
5258 if (--(SvREFCNT(sv)) > 0)
5260 Perl_sv_free2(aTHX_ sv);
5264 Perl_sv_free2(pTHX_ SV *sv)
5269 if (ckWARN_d(WARN_DEBUGGING))
5270 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5271 "Attempt to free temp prematurely: SV 0x%"UVxf
5272 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5276 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5277 /* make sure SvREFCNT(sv)==0 happens very seldom */
5278 SvREFCNT(sv) = (~(U32)0)/2;
5289 Returns the length of the string in the SV. Handles magic and type
5290 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5296 Perl_sv_len(pTHX_ register SV *sv)
5304 len = mg_length(sv);
5306 (void)SvPV_const(sv, len);
5311 =for apidoc sv_len_utf8
5313 Returns the number of characters in the string in an SV, counting wide
5314 UTF-8 bytes as a single character. Handles magic and type coercion.
5320 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5321 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5322 * (Note that the mg_len is not the length of the mg_ptr field.
5323 * This allows the cache to store the character length of the string without
5324 * needing to malloc() extra storage to attach to the mg_ptr.)
5329 Perl_sv_len_utf8(pTHX_ register SV *sv)
5335 return mg_length(sv);
5339 const U8 *s = (U8*)SvPV_const(sv, len);
5343 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5345 if (mg && mg->mg_len != -1) {
5347 if (PL_utf8cache < 0) {
5348 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5350 /* Need to turn the assertions off otherwise we may
5351 recurse infinitely while printing error messages.
5353 SAVEI8(PL_utf8cache);
5355 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5356 " real %"UVf" for %"SVf,
5357 (UV) ulen, (UV) real, (void*)sv);
5362 ulen = Perl_utf8_length(aTHX_ s, s + len);
5363 if (!SvREADONLY(sv)) {
5365 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5366 &PL_vtbl_utf8, 0, 0);
5374 return Perl_utf8_length(aTHX_ s, s + len);
5378 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5381 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5384 const U8 *s = start;
5386 while (s < send && uoffset--)
5389 /* This is the existing behaviour. Possibly it should be a croak, as
5390 it's actually a bounds error */
5396 /* Given the length of the string in both bytes and UTF-8 characters, decide
5397 whether to walk forwards or backwards to find the byte corresponding to
5398 the passed in UTF-8 offset. */
5400 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5401 STRLEN uoffset, STRLEN uend)
5403 STRLEN backw = uend - uoffset;
5404 if (uoffset < 2 * backw) {
5405 /* The assumption is that going forwards is twice the speed of going
5406 forward (that's where the 2 * backw comes from).
5407 (The real figure of course depends on the UTF-8 data.) */
5408 return sv_pos_u2b_forwards(start, send, uoffset);
5413 while (UTF8_IS_CONTINUATION(*send))
5416 return send - start;
5419 /* For the string representation of the given scalar, find the byte
5420 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5421 give another position in the string, *before* the sought offset, which
5422 (which is always true, as 0, 0 is a valid pair of positions), which should
5423 help reduce the amount of linear searching.
5424 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5425 will be used to reduce the amount of linear searching. The cache will be
5426 created if necessary, and the found value offered to it for update. */
5428 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5429 const U8 *const send, STRLEN uoffset,
5430 STRLEN uoffset0, STRLEN boffset0) {
5431 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5434 assert (uoffset >= uoffset0);
5436 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5437 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5438 if ((*mgp)->mg_ptr) {
5439 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5440 if (cache[0] == uoffset) {
5441 /* An exact match. */
5444 if (cache[2] == uoffset) {
5445 /* An exact match. */
5449 if (cache[0] < uoffset) {
5450 /* The cache already knows part of the way. */
5451 if (cache[0] > uoffset0) {
5452 /* The cache knows more than the passed in pair */
5453 uoffset0 = cache[0];
5454 boffset0 = cache[1];
5456 if ((*mgp)->mg_len != -1) {
5457 /* And we know the end too. */
5459 + sv_pos_u2b_midway(start + boffset0, send,
5461 (*mgp)->mg_len - uoffset0);
5464 + sv_pos_u2b_forwards(start + boffset0,
5465 send, uoffset - uoffset0);
5468 else if (cache[2] < uoffset) {
5469 /* We're between the two cache entries. */
5470 if (cache[2] > uoffset0) {
5471 /* and the cache knows more than the passed in pair */
5472 uoffset0 = cache[2];
5473 boffset0 = cache[3];
5477 + sv_pos_u2b_midway(start + boffset0,
5480 cache[0] - uoffset0);
5483 + sv_pos_u2b_midway(start + boffset0,
5486 cache[2] - uoffset0);
5490 else if ((*mgp)->mg_len != -1) {
5491 /* If we can take advantage of a passed in offset, do so. */
5492 /* In fact, offset0 is either 0, or less than offset, so don't
5493 need to worry about the other possibility. */
5495 + sv_pos_u2b_midway(start + boffset0, send,
5497 (*mgp)->mg_len - uoffset0);
5502 if (!found || PL_utf8cache < 0) {
5503 const STRLEN real_boffset
5504 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5505 send, uoffset - uoffset0);
5507 if (found && PL_utf8cache < 0) {
5508 if (real_boffset != boffset) {
5509 /* Need to turn the assertions off otherwise we may recurse
5510 infinitely while printing error messages. */
5511 SAVEI8(PL_utf8cache);
5513 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5514 " real %"UVf" for %"SVf,
5515 (UV) boffset, (UV) real_boffset, (void*)sv);
5518 boffset = real_boffset;
5521 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5527 =for apidoc sv_pos_u2b
5529 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5530 the start of the string, to a count of the equivalent number of bytes; if
5531 lenp is non-zero, it does the same to lenp, but this time starting from
5532 the offset, rather than from the start of the string. Handles magic and
5539 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5540 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5541 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5546 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5554 start = (U8*)SvPV_const(sv, len);
5556 STRLEN uoffset = (STRLEN) *offsetp;
5557 const U8 * const send = start + len;
5559 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5562 *offsetp = (I32) boffset;
5565 /* Convert the relative offset to absolute. */
5566 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5567 const STRLEN boffset2
5568 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5569 uoffset, boffset) - boffset;
5583 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5584 byte length pairing. The (byte) length of the total SV is passed in too,
5585 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5586 may not have updated SvCUR, so we can't rely on reading it directly.
5588 The proffered utf8/byte length pairing isn't used if the cache already has
5589 two pairs, and swapping either for the proffered pair would increase the
5590 RMS of the intervals between known byte offsets.
5592 The cache itself consists of 4 STRLEN values
5593 0: larger UTF-8 offset
5594 1: corresponding byte offset
5595 2: smaller UTF-8 offset
5596 3: corresponding byte offset
5598 Unused cache pairs have the value 0, 0.
5599 Keeping the cache "backwards" means that the invariant of
5600 cache[0] >= cache[2] is maintained even with empty slots, which means that
5601 the code that uses it doesn't need to worry if only 1 entry has actually
5602 been set to non-zero. It also makes the "position beyond the end of the
5603 cache" logic much simpler, as the first slot is always the one to start
5607 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5615 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5617 (*mgp)->mg_len = -1;
5621 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5622 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5623 (*mgp)->mg_ptr = (char *) cache;
5627 if (PL_utf8cache < 0) {
5628 const U8 *start = (const U8 *) SvPVX_const(sv);
5629 const U8 *const end = start + byte;
5630 STRLEN realutf8 = 0;
5632 while (start < end) {
5633 start += UTF8SKIP(start);
5637 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5638 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5639 doesn't? I don't know whether this difference was introduced with
5640 the caching code in 5.8.1. */
5642 if (realutf8 != utf8) {
5643 /* Need to turn the assertions off otherwise we may recurse
5644 infinitely while printing error messages. */
5645 SAVEI8(PL_utf8cache);
5647 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5648 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5652 /* Cache is held with the later position first, to simplify the code
5653 that deals with unbounded ends. */
5655 ASSERT_UTF8_CACHE(cache);
5656 if (cache[1] == 0) {
5657 /* Cache is totally empty */
5660 } else if (cache[3] == 0) {
5661 if (byte > cache[1]) {
5662 /* New one is larger, so goes first. */
5663 cache[2] = cache[0];
5664 cache[3] = cache[1];
5672 #define THREEWAY_SQUARE(a,b,c,d) \
5673 ((float)((d) - (c))) * ((float)((d) - (c))) \
5674 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5675 + ((float)((b) - (a))) * ((float)((b) - (a)))
5677 /* Cache has 2 slots in use, and we know three potential pairs.
5678 Keep the two that give the lowest RMS distance. Do the
5679 calcualation in bytes simply because we always know the byte
5680 length. squareroot has the same ordering as the positive value,
5681 so don't bother with the actual square root. */
5682 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5683 if (byte > cache[1]) {
5684 /* New position is after the existing pair of pairs. */
5685 const float keep_earlier
5686 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5687 const float keep_later
5688 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5690 if (keep_later < keep_earlier) {
5691 if (keep_later < existing) {
5692 cache[2] = cache[0];
5693 cache[3] = cache[1];
5699 if (keep_earlier < existing) {
5705 else if (byte > cache[3]) {
5706 /* New position is between the existing pair of pairs. */
5707 const float keep_earlier
5708 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5709 const float keep_later
5710 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5712 if (keep_later < keep_earlier) {
5713 if (keep_later < existing) {
5719 if (keep_earlier < existing) {
5726 /* New position is before the existing pair of pairs. */
5727 const float keep_earlier
5728 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5729 const float keep_later
5730 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5732 if (keep_later < keep_earlier) {
5733 if (keep_later < existing) {
5739 if (keep_earlier < existing) {
5740 cache[0] = cache[2];
5741 cache[1] = cache[3];
5748 ASSERT_UTF8_CACHE(cache);
5751 /* If we don't know the character offset of the end of a region, our only
5752 option is to walk forwards to the target byte offset. */
5754 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5757 while (s < target) {
5760 /* Call utf8n_to_uvchr() to validate the sequence
5761 * (unless a simple non-UTF character) */
5762 if (!UTF8_IS_INVARIANT(*s))
5763 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5774 /* We already know all of the way, now we may be able to walk back. The same
5775 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5776 backward is half the speed of walking forward. */
5778 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5781 const STRLEN forw = target - s;
5782 STRLEN backw = end - target;
5784 if (forw < 2 * backw) {
5785 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5788 while (end > target) {
5790 while (UTF8_IS_CONTINUATION(*end)) {
5799 =for apidoc sv_pos_b2u
5801 Converts the value pointed to by offsetp from a count of bytes from the
5802 start of the string, to a count of the equivalent number of UTF-8 chars.
5803 Handles magic and type coercion.
5809 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5810 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5815 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5818 const STRLEN byte = *offsetp;
5819 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5828 s = (const U8*)SvPV_const(sv, blen);
5831 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5835 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5836 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5838 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5839 if (cache[1] == byte) {
5840 /* An exact match. */
5841 *offsetp = cache[0];
5844 if (cache[3] == byte) {
5845 /* An exact match. */
5846 *offsetp = cache[2];
5850 if (cache[1] < byte) {
5851 /* We already know part of the way. */
5852 if (mg->mg_len != -1) {
5853 /* Actually, we know the end too. */
5855 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5856 s + blen, mg->mg_len - cache[0]);
5859 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5862 else if (cache[3] < byte) {
5863 /* We're between the two cached pairs, so we do the calculation
5864 offset by the byte/utf-8 positions for the earlier pair,
5865 then add the utf-8 characters from the string start to
5867 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5868 s + cache[1], cache[0] - cache[2])
5872 else { /* cache[3] > byte */
5873 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5877 ASSERT_UTF8_CACHE(cache);
5879 } else if (mg->mg_len != -1) {
5880 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5884 if (!found || PL_utf8cache < 0) {
5885 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5887 if (found && PL_utf8cache < 0) {
5888 if (len != real_len) {
5889 /* Need to turn the assertions off otherwise we may recurse
5890 infinitely while printing error messages. */
5891 SAVEI8(PL_utf8cache);
5893 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5894 " real %"UVf" for %"SVf,
5895 (UV) len, (UV) real_len, (void*)sv);
5902 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5908 Returns a boolean indicating whether the strings in the two SVs are
5909 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5910 coerce its args to strings if necessary.
5916 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5925 SV* svrecode = NULL;
5932 pv1 = SvPV_const(sv1, cur1);
5939 pv2 = SvPV_const(sv2, cur2);
5941 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5942 /* Differing utf8ness.
5943 * Do not UTF8size the comparands as a side-effect. */
5946 svrecode = newSVpvn(pv2, cur2);
5947 sv_recode_to_utf8(svrecode, PL_encoding);
5948 pv2 = SvPV_const(svrecode, cur2);
5951 svrecode = newSVpvn(pv1, cur1);
5952 sv_recode_to_utf8(svrecode, PL_encoding);
5953 pv1 = SvPV_const(svrecode, cur1);
5955 /* Now both are in UTF-8. */
5957 SvREFCNT_dec(svrecode);
5962 bool is_utf8 = TRUE;
5965 /* sv1 is the UTF-8 one,
5966 * if is equal it must be downgrade-able */
5967 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5973 /* sv2 is the UTF-8 one,
5974 * if is equal it must be downgrade-able */
5975 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5981 /* Downgrade not possible - cannot be eq */
5989 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5991 SvREFCNT_dec(svrecode);
6001 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6002 string in C<sv1> is less than, equal to, or greater than the string in
6003 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6004 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6010 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6014 const char *pv1, *pv2;
6017 SV *svrecode = NULL;
6024 pv1 = SvPV_const(sv1, cur1);
6031 pv2 = SvPV_const(sv2, cur2);
6033 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6034 /* Differing utf8ness.
6035 * Do not UTF8size the comparands as a side-effect. */
6038 svrecode = newSVpvn(pv2, cur2);
6039 sv_recode_to_utf8(svrecode, PL_encoding);
6040 pv2 = SvPV_const(svrecode, cur2);
6043 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6048 svrecode = newSVpvn(pv1, cur1);
6049 sv_recode_to_utf8(svrecode, PL_encoding);
6050 pv1 = SvPV_const(svrecode, cur1);
6053 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6059 cmp = cur2 ? -1 : 0;
6063 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6066 cmp = retval < 0 ? -1 : 1;
6067 } else if (cur1 == cur2) {
6070 cmp = cur1 < cur2 ? -1 : 1;
6074 SvREFCNT_dec(svrecode);
6082 =for apidoc sv_cmp_locale
6084 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6085 'use bytes' aware, handles get magic, and will coerce its args to strings
6086 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6092 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6095 #ifdef USE_LOCALE_COLLATE
6101 if (PL_collation_standard)
6105 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6107 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6109 if (!pv1 || !len1) {
6120 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6123 return retval < 0 ? -1 : 1;
6126 * When the result of collation is equality, that doesn't mean
6127 * that there are no differences -- some locales exclude some
6128 * characters from consideration. So to avoid false equalities,
6129 * we use the raw string as a tiebreaker.
6135 #endif /* USE_LOCALE_COLLATE */
6137 return sv_cmp(sv1, sv2);
6141 #ifdef USE_LOCALE_COLLATE
6144 =for apidoc sv_collxfrm
6146 Add Collate Transform magic to an SV if it doesn't already have it.
6148 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6149 scalar data of the variable, but transformed to such a format that a normal
6150 memory comparison can be used to compare the data according to the locale
6157 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6162 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6163 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6169 Safefree(mg->mg_ptr);
6170 s = SvPV_const(sv, len);
6171 if ((xf = mem_collxfrm(s, len, &xlen))) {
6172 if (SvREADONLY(sv)) {
6175 return xf + sizeof(PL_collation_ix);
6178 #ifdef PERL_OLD_COPY_ON_WRITE
6180 sv_force_normal_flags(sv, 0);
6182 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6196 if (mg && mg->mg_ptr) {
6198 return mg->mg_ptr + sizeof(PL_collation_ix);
6206 #endif /* USE_LOCALE_COLLATE */
6211 Get a line from the filehandle and store it into the SV, optionally
6212 appending to the currently-stored string.
6218 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6223 register STDCHAR rslast;
6224 register STDCHAR *bp;
6229 if (SvTHINKFIRST(sv))
6230 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6231 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6233 However, perlbench says it's slower, because the existing swipe code
6234 is faster than copy on write.
6235 Swings and roundabouts. */
6236 SvUPGRADE(sv, SVt_PV);
6241 if (PerlIO_isutf8(fp)) {
6243 sv_utf8_upgrade_nomg(sv);
6244 sv_pos_u2b(sv,&append,0);
6246 } else if (SvUTF8(sv)) {
6247 SV * const tsv = newSV(0);
6248 sv_gets(tsv, fp, 0);
6249 sv_utf8_upgrade_nomg(tsv);
6250 SvCUR_set(sv,append);
6253 goto return_string_or_null;
6258 if (PerlIO_isutf8(fp))
6261 if (IN_PERL_COMPILETIME) {
6262 /* we always read code in line mode */
6266 else if (RsSNARF(PL_rs)) {
6267 /* If it is a regular disk file use size from stat() as estimate
6268 of amount we are going to read -- may result in mallocing
6269 more memory than we really need if the layers below reduce
6270 the size we read (e.g. CRLF or a gzip layer).
6273 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6274 const Off_t offset = PerlIO_tell(fp);
6275 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6276 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6282 else if (RsRECORD(PL_rs)) {
6287 /* Grab the size of the record we're getting */
6288 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6289 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6292 /* VMS wants read instead of fread, because fread doesn't respect */
6293 /* RMS record boundaries. This is not necessarily a good thing to be */
6294 /* doing, but we've got no other real choice - except avoid stdio
6295 as implementation - perhaps write a :vms layer ?
6297 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6299 bytesread = PerlIO_read(fp, buffer, recsize);
6303 SvCUR_set(sv, bytesread += append);
6304 buffer[bytesread] = '\0';
6305 goto return_string_or_null;
6307 else if (RsPARA(PL_rs)) {
6313 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6314 if (PerlIO_isutf8(fp)) {
6315 rsptr = SvPVutf8(PL_rs, rslen);
6318 if (SvUTF8(PL_rs)) {
6319 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6320 Perl_croak(aTHX_ "Wide character in $/");
6323 rsptr = SvPV_const(PL_rs, rslen);
6327 rslast = rslen ? rsptr[rslen - 1] : '\0';
6329 if (rspara) { /* have to do this both before and after */
6330 do { /* to make sure file boundaries work right */
6333 i = PerlIO_getc(fp);
6337 PerlIO_ungetc(fp,i);
6343 /* See if we know enough about I/O mechanism to cheat it ! */
6345 /* This used to be #ifdef test - it is made run-time test for ease
6346 of abstracting out stdio interface. One call should be cheap
6347 enough here - and may even be a macro allowing compile
6351 if (PerlIO_fast_gets(fp)) {
6354 * We're going to steal some values from the stdio struct
6355 * and put EVERYTHING in the innermost loop into registers.
6357 register STDCHAR *ptr;
6361 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6362 /* An ungetc()d char is handled separately from the regular
6363 * buffer, so we getc() it back out and stuff it in the buffer.
6365 i = PerlIO_getc(fp);
6366 if (i == EOF) return 0;
6367 *(--((*fp)->_ptr)) = (unsigned char) i;
6371 /* Here is some breathtakingly efficient cheating */
6373 cnt = PerlIO_get_cnt(fp); /* get count into register */
6374 /* make sure we have the room */
6375 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6376 /* Not room for all of it
6377 if we are looking for a separator and room for some
6379 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6380 /* just process what we have room for */
6381 shortbuffered = cnt - SvLEN(sv) + append + 1;
6382 cnt -= shortbuffered;
6386 /* remember that cnt can be negative */
6387 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6392 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6393 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6394 DEBUG_P(PerlIO_printf(Perl_debug_log,
6395 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6396 DEBUG_P(PerlIO_printf(Perl_debug_log,
6397 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6398 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6399 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6404 while (cnt > 0) { /* this | eat */
6406 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6407 goto thats_all_folks; /* screams | sed :-) */
6411 Copy(ptr, bp, cnt, char); /* this | eat */
6412 bp += cnt; /* screams | dust */
6413 ptr += cnt; /* louder | sed :-) */
6418 if (shortbuffered) { /* oh well, must extend */
6419 cnt = shortbuffered;
6421 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6423 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6424 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6428 DEBUG_P(PerlIO_printf(Perl_debug_log,
6429 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6430 PTR2UV(ptr),(long)cnt));
6431 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6433 DEBUG_P(PerlIO_printf(Perl_debug_log,
6434 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6435 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6436 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6438 /* This used to call 'filbuf' in stdio form, but as that behaves like
6439 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6440 another abstraction. */
6441 i = PerlIO_getc(fp); /* get more characters */
6443 DEBUG_P(PerlIO_printf(Perl_debug_log,
6444 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6445 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6446 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6448 cnt = PerlIO_get_cnt(fp);
6449 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6450 DEBUG_P(PerlIO_printf(Perl_debug_log,
6451 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6453 if (i == EOF) /* all done for ever? */
6454 goto thats_really_all_folks;
6456 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6458 SvGROW(sv, bpx + cnt + 2);
6459 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6461 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6463 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6464 goto thats_all_folks;
6468 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6469 memNE((char*)bp - rslen, rsptr, rslen))
6470 goto screamer; /* go back to the fray */
6471 thats_really_all_folks:
6473 cnt += shortbuffered;
6474 DEBUG_P(PerlIO_printf(Perl_debug_log,
6475 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6476 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6477 DEBUG_P(PerlIO_printf(Perl_debug_log,
6478 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6479 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6480 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6482 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: done, len=%ld, string=|%.*s|\n",
6485 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6489 /*The big, slow, and stupid way. */
6490 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6491 STDCHAR *buf = NULL;
6492 Newx(buf, 8192, STDCHAR);
6500 register const STDCHAR * const bpe = buf + sizeof(buf);
6502 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6503 ; /* keep reading */
6507 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6508 /* Accomodate broken VAXC compiler, which applies U8 cast to
6509 * both args of ?: operator, causing EOF to change into 255
6512 i = (U8)buf[cnt - 1];
6518 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6520 sv_catpvn(sv, (char *) buf, cnt);
6522 sv_setpvn(sv, (char *) buf, cnt);
6524 if (i != EOF && /* joy */
6526 SvCUR(sv) < rslen ||
6527 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6531 * If we're reading from a TTY and we get a short read,
6532 * indicating that the user hit his EOF character, we need
6533 * to notice it now, because if we try to read from the TTY
6534 * again, the EOF condition will disappear.
6536 * The comparison of cnt to sizeof(buf) is an optimization
6537 * that prevents unnecessary calls to feof().
6541 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6545 #ifdef USE_HEAP_INSTEAD_OF_STACK
6550 if (rspara) { /* have to do this both before and after */
6551 while (i != EOF) { /* to make sure file boundaries work right */
6552 i = PerlIO_getc(fp);
6554 PerlIO_ungetc(fp,i);
6560 return_string_or_null:
6561 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6567 Auto-increment of the value in the SV, doing string to numeric conversion
6568 if necessary. Handles 'get' magic.
6574 Perl_sv_inc(pTHX_ register SV *sv)
6583 if (SvTHINKFIRST(sv)) {
6585 sv_force_normal_flags(sv, 0);
6586 if (SvREADONLY(sv)) {
6587 if (IN_PERL_RUNTIME)
6588 Perl_croak(aTHX_ PL_no_modify);
6592 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6594 i = PTR2IV(SvRV(sv));
6599 flags = SvFLAGS(sv);
6600 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6601 /* It's (privately or publicly) a float, but not tested as an
6602 integer, so test it to see. */
6604 flags = SvFLAGS(sv);
6606 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6607 /* It's publicly an integer, or privately an integer-not-float */
6608 #ifdef PERL_PRESERVE_IVUV
6612 if (SvUVX(sv) == UV_MAX)
6613 sv_setnv(sv, UV_MAX_P1);
6615 (void)SvIOK_only_UV(sv);
6616 SvUV_set(sv, SvUVX(sv) + 1);
6618 if (SvIVX(sv) == IV_MAX)
6619 sv_setuv(sv, (UV)IV_MAX + 1);
6621 (void)SvIOK_only(sv);
6622 SvIV_set(sv, SvIVX(sv) + 1);
6627 if (flags & SVp_NOK) {
6628 (void)SvNOK_only(sv);
6629 SvNV_set(sv, SvNVX(sv) + 1.0);
6633 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6634 if ((flags & SVTYPEMASK) < SVt_PVIV)
6635 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6636 (void)SvIOK_only(sv);
6641 while (isALPHA(*d)) d++;
6642 while (isDIGIT(*d)) d++;
6644 #ifdef PERL_PRESERVE_IVUV
6645 /* Got to punt this as an integer if needs be, but we don't issue
6646 warnings. Probably ought to make the sv_iv_please() that does
6647 the conversion if possible, and silently. */
6648 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6649 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6650 /* Need to try really hard to see if it's an integer.
6651 9.22337203685478e+18 is an integer.
6652 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6653 so $a="9.22337203685478e+18"; $a+0; $a++
6654 needs to be the same as $a="9.22337203685478e+18"; $a++
6661 /* sv_2iv *should* have made this an NV */
6662 if (flags & SVp_NOK) {
6663 (void)SvNOK_only(sv);
6664 SvNV_set(sv, SvNVX(sv) + 1.0);
6667 /* I don't think we can get here. Maybe I should assert this
6668 And if we do get here I suspect that sv_setnv will croak. NWC
6670 #if defined(USE_LONG_DOUBLE)
6671 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",
6672 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6674 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6675 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6678 #endif /* PERL_PRESERVE_IVUV */
6679 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6683 while (d >= SvPVX_const(sv)) {
6691 /* MKS: The original code here died if letters weren't consecutive.
6692 * at least it didn't have to worry about non-C locales. The
6693 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6694 * arranged in order (although not consecutively) and that only
6695 * [A-Za-z] are accepted by isALPHA in the C locale.
6697 if (*d != 'z' && *d != 'Z') {
6698 do { ++*d; } while (!isALPHA(*d));
6701 *(d--) -= 'z' - 'a';
6706 *(d--) -= 'z' - 'a' + 1;
6710 /* oh,oh, the number grew */
6711 SvGROW(sv, SvCUR(sv) + 2);
6712 SvCUR_set(sv, SvCUR(sv) + 1);
6713 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6724 Auto-decrement of the value in the SV, doing string to numeric conversion
6725 if necessary. Handles 'get' magic.
6731 Perl_sv_dec(pTHX_ register SV *sv)
6739 if (SvTHINKFIRST(sv)) {
6741 sv_force_normal_flags(sv, 0);
6742 if (SvREADONLY(sv)) {
6743 if (IN_PERL_RUNTIME)
6744 Perl_croak(aTHX_ PL_no_modify);
6748 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6750 i = PTR2IV(SvRV(sv));
6755 /* Unlike sv_inc we don't have to worry about string-never-numbers
6756 and keeping them magic. But we mustn't warn on punting */
6757 flags = SvFLAGS(sv);
6758 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6759 /* It's publicly an integer, or privately an integer-not-float */
6760 #ifdef PERL_PRESERVE_IVUV
6764 if (SvUVX(sv) == 0) {
6765 (void)SvIOK_only(sv);
6769 (void)SvIOK_only_UV(sv);
6770 SvUV_set(sv, SvUVX(sv) - 1);
6773 if (SvIVX(sv) == IV_MIN)
6774 sv_setnv(sv, (NV)IV_MIN - 1.0);
6776 (void)SvIOK_only(sv);
6777 SvIV_set(sv, SvIVX(sv) - 1);
6782 if (flags & SVp_NOK) {
6783 SvNV_set(sv, SvNVX(sv) - 1.0);
6784 (void)SvNOK_only(sv);
6787 if (!(flags & SVp_POK)) {
6788 if ((flags & SVTYPEMASK) < SVt_PVIV)
6789 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6791 (void)SvIOK_only(sv);
6794 #ifdef PERL_PRESERVE_IVUV
6796 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6797 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6798 /* Need to try really hard to see if it's an integer.
6799 9.22337203685478e+18 is an integer.
6800 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6801 so $a="9.22337203685478e+18"; $a+0; $a--
6802 needs to be the same as $a="9.22337203685478e+18"; $a--
6809 /* sv_2iv *should* have made this an NV */
6810 if (flags & SVp_NOK) {
6811 (void)SvNOK_only(sv);
6812 SvNV_set(sv, SvNVX(sv) - 1.0);
6815 /* I don't think we can get here. Maybe I should assert this
6816 And if we do get here I suspect that sv_setnv will croak. NWC
6818 #if defined(USE_LONG_DOUBLE)
6819 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",
6820 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6822 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6823 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6827 #endif /* PERL_PRESERVE_IVUV */
6828 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6832 =for apidoc sv_mortalcopy
6834 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6835 The new SV is marked as mortal. It will be destroyed "soon", either by an
6836 explicit call to FREETMPS, or by an implicit call at places such as
6837 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6842 /* Make a string that will exist for the duration of the expression
6843 * evaluation. Actually, it may have to last longer than that, but
6844 * hopefully we won't free it until it has been assigned to a
6845 * permanent location. */
6848 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6854 sv_setsv(sv,oldstr);
6856 PL_tmps_stack[++PL_tmps_ix] = sv;
6862 =for apidoc sv_newmortal
6864 Creates a new null SV which is mortal. The reference count of the SV is
6865 set to 1. It will be destroyed "soon", either by an explicit call to
6866 FREETMPS, or by an implicit call at places such as statement boundaries.
6867 See also C<sv_mortalcopy> and C<sv_2mortal>.
6873 Perl_sv_newmortal(pTHX)
6879 SvFLAGS(sv) = SVs_TEMP;
6881 PL_tmps_stack[++PL_tmps_ix] = sv;
6886 =for apidoc sv_2mortal
6888 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6889 by an explicit call to FREETMPS, or by an implicit call at places such as
6890 statement boundaries. SvTEMP() is turned on which means that the SV's
6891 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6892 and C<sv_mortalcopy>.
6898 Perl_sv_2mortal(pTHX_ register SV *sv)
6903 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6906 PL_tmps_stack[++PL_tmps_ix] = sv;
6914 Creates a new SV and copies a string into it. The reference count for the
6915 SV is set to 1. If C<len> is zero, Perl will compute the length using
6916 strlen(). For efficiency, consider using C<newSVpvn> instead.
6922 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6928 sv_setpvn(sv,s,len ? len : strlen(s));
6933 =for apidoc newSVpvn
6935 Creates a new SV and copies a string into it. The reference count for the
6936 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6937 string. You are responsible for ensuring that the source string is at least
6938 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6944 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6950 sv_setpvn(sv,s,len);
6956 =for apidoc newSVhek
6958 Creates a new SV from the hash key structure. It will generate scalars that
6959 point to the shared string table where possible. Returns a new (undefined)
6960 SV if the hek is NULL.
6966 Perl_newSVhek(pTHX_ const HEK *hek)
6976 if (HEK_LEN(hek) == HEf_SVKEY) {
6977 return newSVsv(*(SV**)HEK_KEY(hek));
6979 const int flags = HEK_FLAGS(hek);
6980 if (flags & HVhek_WASUTF8) {
6982 Andreas would like keys he put in as utf8 to come back as utf8
6984 STRLEN utf8_len = HEK_LEN(hek);
6985 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6986 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6989 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6991 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6992 /* We don't have a pointer to the hv, so we have to replicate the
6993 flag into every HEK. This hv is using custom a hasing
6994 algorithm. Hence we can't return a shared string scalar, as
6995 that would contain the (wrong) hash value, and might get passed
6996 into an hv routine with a regular hash.
6997 Similarly, a hash that isn't using shared hash keys has to have
6998 the flag in every key so that we know not to try to call
6999 share_hek_kek on it. */
7001 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7006 /* This will be overwhelminly the most common case. */
7008 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7009 more efficient than sharepvn(). */
7013 sv_upgrade(sv, SVt_PV);
7014 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7015 SvCUR_set(sv, HEK_LEN(hek));
7028 =for apidoc newSVpvn_share
7030 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7031 table. If the string does not already exist in the table, it is created
7032 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7033 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7034 otherwise the hash is computed. The idea here is that as the string table
7035 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7036 hash lookup will avoid string compare.
7042 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7046 bool is_utf8 = FALSE;
7047 const char *const orig_src = src;
7050 STRLEN tmplen = -len;
7052 /* See the note in hv.c:hv_fetch() --jhi */
7053 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7057 PERL_HASH(hash, src, len);
7059 sv_upgrade(sv, SVt_PV);
7060 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7068 if (src != orig_src)
7074 #if defined(PERL_IMPLICIT_CONTEXT)
7076 /* pTHX_ magic can't cope with varargs, so this is a no-context
7077 * version of the main function, (which may itself be aliased to us).
7078 * Don't access this version directly.
7082 Perl_newSVpvf_nocontext(const char* pat, ...)
7087 va_start(args, pat);
7088 sv = vnewSVpvf(pat, &args);
7095 =for apidoc newSVpvf
7097 Creates a new SV and initializes it with the string formatted like
7104 Perl_newSVpvf(pTHX_ const char* pat, ...)
7108 va_start(args, pat);
7109 sv = vnewSVpvf(pat, &args);
7114 /* backend for newSVpvf() and newSVpvf_nocontext() */
7117 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7122 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7129 Creates a new SV and copies a floating point value into it.
7130 The reference count for the SV is set to 1.
7136 Perl_newSVnv(pTHX_ NV n)
7149 Creates a new SV and copies an integer into it. The reference count for the
7156 Perl_newSViv(pTHX_ IV i)
7169 Creates a new SV and copies an unsigned integer into it.
7170 The reference count for the SV is set to 1.
7176 Perl_newSVuv(pTHX_ UV u)
7187 =for apidoc newRV_noinc
7189 Creates an RV wrapper for an SV. The reference count for the original
7190 SV is B<not> incremented.
7196 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7202 sv_upgrade(sv, SVt_RV);
7204 SvRV_set(sv, tmpRef);
7209 /* newRV_inc is the official function name to use now.
7210 * newRV_inc is in fact #defined to newRV in sv.h
7214 Perl_newRV(pTHX_ SV *sv)
7217 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7223 Creates a new SV which is an exact duplicate of the original SV.
7230 Perl_newSVsv(pTHX_ register SV *old)
7237 if (SvTYPE(old) == SVTYPEMASK) {
7238 if (ckWARN_d(WARN_INTERNAL))
7239 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7243 /* SV_GMAGIC is the default for sv_setv()
7244 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7245 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7246 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7251 =for apidoc sv_reset
7253 Underlying implementation for the C<reset> Perl function.
7254 Note that the perl-level function is vaguely deprecated.
7260 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7263 char todo[PERL_UCHAR_MAX+1];
7268 if (!*s) { /* reset ?? searches */
7269 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7271 PMOP *pm = (PMOP *) mg->mg_obj;
7273 pm->op_pmdynflags &= ~PMdf_USED;
7280 /* reset variables */
7282 if (!HvARRAY(stash))
7285 Zero(todo, 256, char);
7288 I32 i = (unsigned char)*s;
7292 max = (unsigned char)*s++;
7293 for ( ; i <= max; i++) {
7296 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7298 for (entry = HvARRAY(stash)[i];
7300 entry = HeNEXT(entry))
7305 if (!todo[(U8)*HeKEY(entry)])
7307 gv = (GV*)HeVAL(entry);
7310 if (SvTHINKFIRST(sv)) {
7311 if (!SvREADONLY(sv) && SvROK(sv))
7313 /* XXX Is this continue a bug? Why should THINKFIRST
7314 exempt us from resetting arrays and hashes? */
7318 if (SvTYPE(sv) >= SVt_PV) {
7320 if (SvPVX_const(sv) != NULL)
7328 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7330 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7333 # if defined(USE_ENVIRON_ARRAY)
7336 # endif /* USE_ENVIRON_ARRAY */
7347 Using various gambits, try to get an IO from an SV: the IO slot if its a
7348 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7349 named after the PV if we're a string.
7355 Perl_sv_2io(pTHX_ SV *sv)
7360 switch (SvTYPE(sv)) {
7368 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7372 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7374 return sv_2io(SvRV(sv));
7375 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7381 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7390 Using various gambits, try to get a CV from an SV; in addition, try if
7391 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7392 The flags in C<lref> are passed to sv_fetchsv.
7398 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7409 switch (SvTYPE(sv)) {
7428 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7429 tryAMAGICunDEREF(to_cv);
7432 if (SvTYPE(sv) == SVt_PVCV) {
7441 Perl_croak(aTHX_ "Not a subroutine reference");
7446 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7452 /* Some flags to gv_fetchsv mean don't really create the GV */
7453 if (SvTYPE(gv) != SVt_PVGV) {
7459 if (lref && !GvCVu(gv)) {
7463 gv_efullname3(tmpsv, gv, NULL);
7464 /* XXX this is probably not what they think they're getting.
7465 * It has the same effect as "sub name;", i.e. just a forward
7467 newSUB(start_subparse(FALSE, 0),
7468 newSVOP(OP_CONST, 0, tmpsv),
7472 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7482 Returns true if the SV has a true value by Perl's rules.
7483 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7484 instead use an in-line version.
7490 Perl_sv_true(pTHX_ register SV *sv)
7495 register const XPV* const tXpv = (XPV*)SvANY(sv);
7497 (tXpv->xpv_cur > 1 ||
7498 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7505 return SvIVX(sv) != 0;
7508 return SvNVX(sv) != 0.0;
7510 return sv_2bool(sv);
7516 =for apidoc sv_pvn_force
7518 Get a sensible string out of the SV somehow.
7519 A private implementation of the C<SvPV_force> macro for compilers which
7520 can't cope with complex macro expressions. Always use the macro instead.
7522 =for apidoc sv_pvn_force_flags
7524 Get a sensible string out of the SV somehow.
7525 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7526 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7527 implemented in terms of this function.
7528 You normally want to use the various wrapper macros instead: see
7529 C<SvPV_force> and C<SvPV_force_nomg>
7535 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7538 if (SvTHINKFIRST(sv) && !SvROK(sv))
7539 sv_force_normal_flags(sv, 0);
7549 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7550 const char * const ref = sv_reftype(sv,0);
7552 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7553 ref, OP_NAME(PL_op));
7555 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7557 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7558 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7560 s = sv_2pv_flags(sv, &len, flags);
7564 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7567 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7568 SvGROW(sv, len + 1);
7569 Move(s,SvPVX(sv),len,char);
7574 SvPOK_on(sv); /* validate pointer */
7576 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7577 PTR2UV(sv),SvPVX_const(sv)));
7580 return SvPVX_mutable(sv);
7584 =for apidoc sv_pvbyten_force
7586 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7592 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7594 sv_pvn_force(sv,lp);
7595 sv_utf8_downgrade(sv,0);
7601 =for apidoc sv_pvutf8n_force
7603 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7609 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7611 sv_pvn_force(sv,lp);
7612 sv_utf8_upgrade(sv);
7618 =for apidoc sv_reftype
7620 Returns a string describing what the SV is a reference to.
7626 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7628 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7629 inside return suggests a const propagation bug in g++. */
7630 if (ob && SvOBJECT(sv)) {
7631 char * const name = HvNAME_get(SvSTASH(sv));
7632 return name ? name : (char *) "__ANON__";
7635 switch (SvTYPE(sv)) {
7652 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7653 /* tied lvalues should appear to be
7654 * scalars for backwards compatitbility */
7655 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7656 ? "SCALAR" : "LVALUE");
7657 case SVt_PVAV: return "ARRAY";
7658 case SVt_PVHV: return "HASH";
7659 case SVt_PVCV: return "CODE";
7660 case SVt_PVGV: return "GLOB";
7661 case SVt_PVFM: return "FORMAT";
7662 case SVt_PVIO: return "IO";
7663 default: return "UNKNOWN";
7669 =for apidoc sv_isobject
7671 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7672 object. If the SV is not an RV, or if the object is not blessed, then this
7679 Perl_sv_isobject(pTHX_ SV *sv)
7695 Returns a boolean indicating whether the SV is blessed into the specified
7696 class. This does not check for subtypes; use C<sv_derived_from> to verify
7697 an inheritance relationship.
7703 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7714 hvname = HvNAME_get(SvSTASH(sv));
7718 return strEQ(hvname, name);
7724 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7725 it will be upgraded to one. If C<classname> is non-null then the new SV will
7726 be blessed in the specified package. The new SV is returned and its
7727 reference count is 1.
7733 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7740 SV_CHECK_THINKFIRST_COW_DROP(rv);
7743 if (SvTYPE(rv) >= SVt_PVMG) {
7744 const U32 refcnt = SvREFCNT(rv);
7748 SvREFCNT(rv) = refcnt;
7750 sv_upgrade(rv, SVt_RV);
7751 } else if (SvROK(rv)) {
7752 SvREFCNT_dec(SvRV(rv));
7753 } else if (SvTYPE(rv) < SVt_RV)
7754 sv_upgrade(rv, SVt_RV);
7755 else if (SvTYPE(rv) > SVt_RV) {
7766 HV* const stash = gv_stashpv(classname, TRUE);
7767 (void)sv_bless(rv, stash);
7773 =for apidoc sv_setref_pv
7775 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7776 argument will be upgraded to an RV. That RV will be modified to point to
7777 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7778 into the SV. The C<classname> argument indicates the package for the
7779 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7780 will have a reference count of 1, and the RV will be returned.
7782 Do not use with other Perl types such as HV, AV, SV, CV, because those
7783 objects will become corrupted by the pointer copy process.
7785 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7791 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7795 sv_setsv(rv, &PL_sv_undef);
7799 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7804 =for apidoc sv_setref_iv
7806 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7807 argument will be upgraded to an RV. That RV will be modified to point to
7808 the new SV. The C<classname> argument indicates the package for the
7809 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7810 will have a reference count of 1, and the RV will be returned.
7816 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7818 sv_setiv(newSVrv(rv,classname), iv);
7823 =for apidoc sv_setref_uv
7825 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7826 argument will be upgraded to an RV. That RV will be modified to point to
7827 the new SV. The C<classname> argument indicates the package for the
7828 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7829 will have a reference count of 1, and the RV will be returned.
7835 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7837 sv_setuv(newSVrv(rv,classname), uv);
7842 =for apidoc sv_setref_nv
7844 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7845 argument will be upgraded to an RV. That RV will be modified to point to
7846 the new SV. The C<classname> argument indicates the package for the
7847 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7848 will have a reference count of 1, and the RV will be returned.
7854 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7856 sv_setnv(newSVrv(rv,classname), nv);
7861 =for apidoc sv_setref_pvn
7863 Copies a string into a new SV, optionally blessing the SV. The length of the
7864 string must be specified with C<n>. The C<rv> argument will be upgraded to
7865 an RV. That RV will be modified to point to the new SV. The C<classname>
7866 argument indicates the package for the blessing. Set C<classname> to
7867 C<NULL> to avoid the blessing. The new SV will have a reference count
7868 of 1, and the RV will be returned.
7870 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7876 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7878 sv_setpvn(newSVrv(rv,classname), pv, n);
7883 =for apidoc sv_bless
7885 Blesses an SV into a specified package. The SV must be an RV. The package
7886 must be designated by its stash (see C<gv_stashpv()>). The reference count
7887 of the SV is unaffected.
7893 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7898 Perl_croak(aTHX_ "Can't bless non-reference value");
7900 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7901 if (SvREADONLY(tmpRef))
7902 Perl_croak(aTHX_ PL_no_modify);
7903 if (SvOBJECT(tmpRef)) {
7904 if (SvTYPE(tmpRef) != SVt_PVIO)
7906 SvREFCNT_dec(SvSTASH(tmpRef));
7909 SvOBJECT_on(tmpRef);
7910 if (SvTYPE(tmpRef) != SVt_PVIO)
7912 SvUPGRADE(tmpRef, SVt_PVMG);
7913 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7920 if(SvSMAGICAL(tmpRef))
7921 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7929 /* Downgrades a PVGV to a PVMG.
7933 S_sv_unglob(pTHX_ SV *sv)
7937 SV * const temp = sv_newmortal();
7939 assert(SvTYPE(sv) == SVt_PVGV);
7941 gv_efullname3(temp, (GV *) sv, "*");
7947 sv_del_backref((SV*)GvSTASH(sv), sv);
7951 if (GvNAME_HEK(sv)) {
7952 unshare_hek(GvNAME_HEK(sv));
7956 /* need to keep SvANY(sv) in the right arena */
7957 xpvmg = new_XPVMG();
7958 StructCopy(SvANY(sv), xpvmg, XPVMG);
7959 del_XPVGV(SvANY(sv));
7962 SvFLAGS(sv) &= ~SVTYPEMASK;
7963 SvFLAGS(sv) |= SVt_PVMG;
7965 /* Intentionally not calling any local SET magic, as this isn't so much a
7966 set operation as merely an internal storage change. */
7967 sv_setsv_flags(sv, temp, 0);
7971 =for apidoc sv_unref_flags
7973 Unsets the RV status of the SV, and decrements the reference count of
7974 whatever was being referenced by the RV. This can almost be thought of
7975 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7976 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7977 (otherwise the decrementing is conditional on the reference count being
7978 different from one or the reference being a readonly SV).
7985 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7987 SV* const target = SvRV(ref);
7989 if (SvWEAKREF(ref)) {
7990 sv_del_backref(target, ref);
7992 SvRV_set(ref, NULL);
7995 SvRV_set(ref, NULL);
7997 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7998 assigned to as BEGIN {$a = \"Foo"} will fail. */
7999 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8000 SvREFCNT_dec(target);
8001 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8002 sv_2mortal(target); /* Schedule for freeing later */
8006 =for apidoc sv_untaint
8008 Untaint an SV. Use C<SvTAINTED_off> instead.
8013 Perl_sv_untaint(pTHX_ SV *sv)
8015 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8016 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8023 =for apidoc sv_tainted
8025 Test an SV for taintedness. Use C<SvTAINTED> instead.
8030 Perl_sv_tainted(pTHX_ SV *sv)
8032 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8033 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8034 if (mg && (mg->mg_len & 1) )
8041 =for apidoc sv_setpviv
8043 Copies an integer into the given SV, also updating its string value.
8044 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8050 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8052 char buf[TYPE_CHARS(UV)];
8054 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8056 sv_setpvn(sv, ptr, ebuf - ptr);
8060 =for apidoc sv_setpviv_mg
8062 Like C<sv_setpviv>, but also handles 'set' magic.
8068 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8074 #if defined(PERL_IMPLICIT_CONTEXT)
8076 /* pTHX_ magic can't cope with varargs, so this is a no-context
8077 * version of the main function, (which may itself be aliased to us).
8078 * Don't access this version directly.
8082 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8086 va_start(args, pat);
8087 sv_vsetpvf(sv, pat, &args);
8091 /* pTHX_ magic can't cope with varargs, so this is a no-context
8092 * version of the main function, (which may itself be aliased to us).
8093 * Don't access this version directly.
8097 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8101 va_start(args, pat);
8102 sv_vsetpvf_mg(sv, pat, &args);
8108 =for apidoc sv_setpvf
8110 Works like C<sv_catpvf> but copies the text into the SV instead of
8111 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8117 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8120 va_start(args, pat);
8121 sv_vsetpvf(sv, pat, &args);
8126 =for apidoc sv_vsetpvf
8128 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8129 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8131 Usually used via its frontend C<sv_setpvf>.
8137 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8139 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8143 =for apidoc sv_setpvf_mg
8145 Like C<sv_setpvf>, but also handles 'set' magic.
8151 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8154 va_start(args, pat);
8155 sv_vsetpvf_mg(sv, pat, &args);
8160 =for apidoc sv_vsetpvf_mg
8162 Like C<sv_vsetpvf>, but also handles 'set' magic.
8164 Usually used via its frontend C<sv_setpvf_mg>.
8170 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8172 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8176 #if defined(PERL_IMPLICIT_CONTEXT)
8178 /* pTHX_ magic can't cope with varargs, so this is a no-context
8179 * version of the main function, (which may itself be aliased to us).
8180 * Don't access this version directly.
8184 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8188 va_start(args, pat);
8189 sv_vcatpvf(sv, pat, &args);
8193 /* pTHX_ magic can't cope with varargs, so this is a no-context
8194 * version of the main function, (which may itself be aliased to us).
8195 * Don't access this version directly.
8199 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8203 va_start(args, pat);
8204 sv_vcatpvf_mg(sv, pat, &args);
8210 =for apidoc sv_catpvf
8212 Processes its arguments like C<sprintf> and appends the formatted
8213 output to an SV. If the appended data contains "wide" characters
8214 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8215 and characters >255 formatted with %c), the original SV might get
8216 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8217 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8218 valid UTF-8; if the original SV was bytes, the pattern should be too.
8223 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8226 va_start(args, pat);
8227 sv_vcatpvf(sv, pat, &args);
8232 =for apidoc sv_vcatpvf
8234 Processes its arguments like C<vsprintf> and appends the formatted output
8235 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8237 Usually used via its frontend C<sv_catpvf>.
8243 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8245 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8249 =for apidoc sv_catpvf_mg
8251 Like C<sv_catpvf>, but also handles 'set' magic.
8257 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8260 va_start(args, pat);
8261 sv_vcatpvf_mg(sv, pat, &args);
8266 =for apidoc sv_vcatpvf_mg
8268 Like C<sv_vcatpvf>, but also handles 'set' magic.
8270 Usually used via its frontend C<sv_catpvf_mg>.
8276 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8278 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8283 =for apidoc sv_vsetpvfn
8285 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8288 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8294 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8296 sv_setpvn(sv, "", 0);
8297 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8301 S_expect_number(pTHX_ char** pattern)
8305 switch (**pattern) {
8306 case '1': case '2': case '3':
8307 case '4': case '5': case '6':
8308 case '7': case '8': case '9':
8309 var = *(*pattern)++ - '0';
8310 while (isDIGIT(**pattern)) {
8311 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8313 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8321 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8323 const int neg = nv < 0;
8332 if (uv & 1 && uv == nv)
8333 uv--; /* Round to even */
8335 const unsigned dig = uv % 10;
8348 =for apidoc sv_vcatpvfn
8350 Processes its arguments like C<vsprintf> and appends the formatted output
8351 to an SV. Uses an array of SVs if the C style variable argument list is
8352 missing (NULL). When running with taint checks enabled, indicates via
8353 C<maybe_tainted> if results are untrustworthy (often due to the use of
8356 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8362 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8363 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8364 vec_utf8 = DO_UTF8(vecsv);
8366 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8369 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8377 static const char nullstr[] = "(null)";
8379 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8380 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8382 /* Times 4: a decimal digit takes more than 3 binary digits.
8383 * NV_DIG: mantissa takes than many decimal digits.
8384 * Plus 32: Playing safe. */
8385 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8386 /* large enough for "%#.#f" --chip */
8387 /* what about long double NVs? --jhi */
8389 PERL_UNUSED_ARG(maybe_tainted);
8391 /* no matter what, this is a string now */
8392 (void)SvPV_force(sv, origlen);
8394 /* special-case "", "%s", and "%-p" (SVf - see below) */
8397 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8399 const char * const s = va_arg(*args, char*);
8400 sv_catpv(sv, s ? s : nullstr);
8402 else if (svix < svmax) {
8403 sv_catsv(sv, *svargs);
8407 if (args && patlen == 3 && pat[0] == '%' &&
8408 pat[1] == '-' && pat[2] == 'p') {
8409 argsv = va_arg(*args, SV*);
8410 sv_catsv(sv, argsv);
8414 #ifndef USE_LONG_DOUBLE
8415 /* special-case "%.<number>[gf]" */
8416 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8417 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8418 unsigned digits = 0;
8422 while (*pp >= '0' && *pp <= '9')
8423 digits = 10 * digits + (*pp++ - '0');
8424 if (pp - pat == (int)patlen - 1) {
8432 /* Add check for digits != 0 because it seems that some
8433 gconverts are buggy in this case, and we don't yet have
8434 a Configure test for this. */
8435 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8436 /* 0, point, slack */
8437 Gconvert(nv, (int)digits, 0, ebuf);
8439 if (*ebuf) /* May return an empty string for digits==0 */
8442 } else if (!digits) {
8445 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8446 sv_catpvn(sv, p, l);
8452 #endif /* !USE_LONG_DOUBLE */
8454 if (!args && svix < svmax && DO_UTF8(*svargs))
8457 patend = (char*)pat + patlen;
8458 for (p = (char*)pat; p < patend; p = q) {
8461 bool vectorize = FALSE;
8462 bool vectorarg = FALSE;
8463 bool vec_utf8 = FALSE;
8469 bool has_precis = FALSE;
8471 const I32 osvix = svix;
8472 bool is_utf8 = FALSE; /* is this item utf8? */
8473 #ifdef HAS_LDBL_SPRINTF_BUG
8474 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8475 with sfio - Allen <allens@cpan.org> */
8476 bool fix_ldbl_sprintf_bug = FALSE;
8480 U8 utf8buf[UTF8_MAXBYTES+1];
8481 STRLEN esignlen = 0;
8483 const char *eptr = NULL;
8486 const U8 *vecstr = NULL;
8493 /* we need a long double target in case HAS_LONG_DOUBLE but
8496 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8504 const char *dotstr = ".";
8505 STRLEN dotstrlen = 1;
8506 I32 efix = 0; /* explicit format parameter index */
8507 I32 ewix = 0; /* explicit width index */
8508 I32 epix = 0; /* explicit precision index */
8509 I32 evix = 0; /* explicit vector index */
8510 bool asterisk = FALSE;
8512 /* echo everything up to the next format specification */
8513 for (q = p; q < patend && *q != '%'; ++q) ;
8515 if (has_utf8 && !pat_utf8)
8516 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8518 sv_catpvn(sv, p, q - p);
8525 We allow format specification elements in this order:
8526 \d+\$ explicit format parameter index
8528 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8529 0 flag (as above): repeated to allow "v02"
8530 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8531 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8533 [%bcdefginopsuxDFOUX] format (mandatory)
8538 As of perl5.9.3, printf format checking is on by default.
8539 Internally, perl uses %p formats to provide an escape to
8540 some extended formatting. This block deals with those
8541 extensions: if it does not match, (char*)q is reset and
8542 the normal format processing code is used.
8544 Currently defined extensions are:
8545 %p include pointer address (standard)
8546 %-p (SVf) include an SV (previously %_)
8547 %-<num>p include an SV with precision <num>
8548 %1p (VDf) include a v-string (as %vd)
8549 %<num>p reserved for future extensions
8551 Robin Barker 2005-07-14
8558 n = expect_number(&q);
8565 argsv = va_arg(*args, SV*);
8566 eptr = SvPVx_const(argsv, elen);
8572 else if (n == vdNUMBER) { /* VDf */
8579 if (ckWARN_d(WARN_INTERNAL))
8580 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8581 "internal %%<num>p might conflict with future printf extensions");
8587 if ( (width = expect_number(&q)) ) {
8628 if ( (ewix = expect_number(&q)) )
8637 if ((vectorarg = asterisk)) {
8650 width = expect_number(&q);
8656 vecsv = va_arg(*args, SV*);
8658 vecsv = (evix > 0 && evix <= svmax)
8659 ? svargs[evix-1] : &PL_sv_undef;
8661 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8663 dotstr = SvPV_const(vecsv, dotstrlen);
8664 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8665 bad with tied or overloaded values that return UTF8. */
8668 else if (has_utf8) {
8669 vecsv = sv_mortalcopy(vecsv);
8670 sv_utf8_upgrade(vecsv);
8671 dotstr = SvPV_const(vecsv, dotstrlen);
8678 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8679 vecsv = svargs[efix ? efix-1 : svix++];
8680 vecstr = (U8*)SvPV_const(vecsv,veclen);
8681 vec_utf8 = DO_UTF8(vecsv);
8683 /* if this is a version object, we need to convert
8684 * back into v-string notation and then let the
8685 * vectorize happen normally
8687 if (sv_derived_from(vecsv, "version")) {
8688 char *version = savesvpv(vecsv);
8689 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8690 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8691 "vector argument not supported with alpha versions");
8694 vecsv = sv_newmortal();
8695 /* scan_vstring is expected to be called during
8696 * tokenization, so we need to fake up the end
8697 * of the buffer for it
8699 PL_bufend = version + veclen;
8700 scan_vstring(version, vecsv);
8701 vecstr = (U8*)SvPV_const(vecsv, veclen);
8702 vec_utf8 = DO_UTF8(vecsv);
8714 i = va_arg(*args, int);
8716 i = (ewix ? ewix <= svmax : svix < svmax) ?
8717 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8719 width = (i < 0) ? -i : i;
8729 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8731 /* XXX: todo, support specified precision parameter */
8735 i = va_arg(*args, int);
8737 i = (ewix ? ewix <= svmax : svix < svmax)
8738 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8739 precis = (i < 0) ? 0 : i;
8744 precis = precis * 10 + (*q++ - '0');
8753 case 'I': /* Ix, I32x, and I64x */
8755 if (q[1] == '6' && q[2] == '4') {
8761 if (q[1] == '3' && q[2] == '2') {
8771 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8782 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8783 if (*(q + 1) == 'l') { /* lld, llf */
8809 if (!vectorize && !args) {
8811 const I32 i = efix-1;
8812 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8814 argsv = (svix >= 0 && svix < svmax)
8815 ? svargs[svix++] : &PL_sv_undef;
8826 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8828 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8830 eptr = (char*)utf8buf;
8831 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8845 eptr = va_arg(*args, char*);
8847 #ifdef MACOS_TRADITIONAL
8848 /* On MacOS, %#s format is used for Pascal strings */
8853 elen = strlen(eptr);
8855 eptr = (char *)nullstr;
8856 elen = sizeof nullstr - 1;
8860 eptr = SvPVx_const(argsv, elen);
8861 if (DO_UTF8(argsv)) {
8862 if (has_precis && precis < elen) {
8864 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8867 if (width) { /* fudge width (can't fudge elen) */
8868 width += elen - sv_len_utf8(argsv);
8875 if (has_precis && elen > precis)
8882 if (alt || vectorize)
8884 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8905 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8914 esignbuf[esignlen++] = plus;
8918 case 'h': iv = (short)va_arg(*args, int); break;
8919 case 'l': iv = va_arg(*args, long); break;
8920 case 'V': iv = va_arg(*args, IV); break;
8921 default: iv = va_arg(*args, int); break;
8923 case 'q': iv = va_arg(*args, Quad_t); break;
8928 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8930 case 'h': iv = (short)tiv; break;
8931 case 'l': iv = (long)tiv; break;
8933 default: iv = tiv; break;
8935 case 'q': iv = (Quad_t)tiv; break;
8939 if ( !vectorize ) /* we already set uv above */
8944 esignbuf[esignlen++] = plus;
8948 esignbuf[esignlen++] = '-';
8991 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9002 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9003 case 'l': uv = va_arg(*args, unsigned long); break;
9004 case 'V': uv = va_arg(*args, UV); break;
9005 default: uv = va_arg(*args, unsigned); break;
9007 case 'q': uv = va_arg(*args, Uquad_t); break;
9012 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9014 case 'h': uv = (unsigned short)tuv; break;
9015 case 'l': uv = (unsigned long)tuv; break;
9017 default: uv = tuv; break;
9019 case 'q': uv = (Uquad_t)tuv; break;
9026 char *ptr = ebuf + sizeof ebuf;
9027 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9033 p = (char*)((c == 'X')
9034 ? "0123456789ABCDEF" : "0123456789abcdef");
9040 esignbuf[esignlen++] = '0';
9041 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9049 if (alt && *ptr != '0')
9058 esignbuf[esignlen++] = '0';
9059 esignbuf[esignlen++] = 'b';
9062 default: /* it had better be ten or less */
9066 } while (uv /= base);
9069 elen = (ebuf + sizeof ebuf) - ptr;
9073 zeros = precis - elen;
9074 else if (precis == 0 && elen == 1 && *eptr == '0')
9080 /* FLOATING POINT */
9083 c = 'f'; /* maybe %F isn't supported here */
9091 /* This is evil, but floating point is even more evil */
9093 /* for SV-style calling, we can only get NV
9094 for C-style calling, we assume %f is double;
9095 for simplicity we allow any of %Lf, %llf, %qf for long double
9099 #if defined(USE_LONG_DOUBLE)
9103 /* [perl #20339] - we should accept and ignore %lf rather than die */
9107 #if defined(USE_LONG_DOUBLE)
9108 intsize = args ? 0 : 'q';
9112 #if defined(HAS_LONG_DOUBLE)
9121 /* now we need (long double) if intsize == 'q', else (double) */
9123 #if LONG_DOUBLESIZE > DOUBLESIZE
9125 va_arg(*args, long double) :
9126 va_arg(*args, double)
9128 va_arg(*args, double)
9133 if (c != 'e' && c != 'E') {
9135 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9136 will cast our (long double) to (double) */
9137 (void)Perl_frexp(nv, &i);
9138 if (i == PERL_INT_MIN)
9139 Perl_die(aTHX_ "panic: frexp");
9141 need = BIT_DIGITS(i);
9143 need += has_precis ? precis : 6; /* known default */
9148 #ifdef HAS_LDBL_SPRINTF_BUG
9149 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9150 with sfio - Allen <allens@cpan.org> */
9153 # define MY_DBL_MAX DBL_MAX
9154 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9155 # if DOUBLESIZE >= 8
9156 # define MY_DBL_MAX 1.7976931348623157E+308L
9158 # define MY_DBL_MAX 3.40282347E+38L
9162 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9163 # define MY_DBL_MAX_BUG 1L
9165 # define MY_DBL_MAX_BUG MY_DBL_MAX
9169 # define MY_DBL_MIN DBL_MIN
9170 # else /* XXX guessing! -Allen */
9171 # if DOUBLESIZE >= 8
9172 # define MY_DBL_MIN 2.2250738585072014E-308L
9174 # define MY_DBL_MIN 1.17549435E-38L
9178 if ((intsize == 'q') && (c == 'f') &&
9179 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9181 /* it's going to be short enough that
9182 * long double precision is not needed */
9184 if ((nv <= 0L) && (nv >= -0L))
9185 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9187 /* would use Perl_fp_class as a double-check but not
9188 * functional on IRIX - see perl.h comments */
9190 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9191 /* It's within the range that a double can represent */
9192 #if defined(DBL_MAX) && !defined(DBL_MIN)
9193 if ((nv >= ((long double)1/DBL_MAX)) ||
9194 (nv <= (-(long double)1/DBL_MAX)))
9196 fix_ldbl_sprintf_bug = TRUE;
9199 if (fix_ldbl_sprintf_bug == TRUE) {
9209 # undef MY_DBL_MAX_BUG
9212 #endif /* HAS_LDBL_SPRINTF_BUG */
9214 need += 20; /* fudge factor */
9215 if (PL_efloatsize < need) {
9216 Safefree(PL_efloatbuf);
9217 PL_efloatsize = need + 20; /* more fudge */
9218 Newx(PL_efloatbuf, PL_efloatsize, char);
9219 PL_efloatbuf[0] = '\0';
9222 if ( !(width || left || plus || alt) && fill != '0'
9223 && has_precis && intsize != 'q' ) { /* Shortcuts */
9224 /* See earlier comment about buggy Gconvert when digits,
9226 if ( c == 'g' && precis) {
9227 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9228 /* May return an empty string for digits==0 */
9229 if (*PL_efloatbuf) {
9230 elen = strlen(PL_efloatbuf);
9231 goto float_converted;
9233 } else if ( c == 'f' && !precis) {
9234 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9239 char *ptr = ebuf + sizeof ebuf;
9242 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9243 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9244 if (intsize == 'q') {
9245 /* Copy the one or more characters in a long double
9246 * format before the 'base' ([efgEFG]) character to
9247 * the format string. */
9248 static char const prifldbl[] = PERL_PRIfldbl;
9249 char const *p = prifldbl + sizeof(prifldbl) - 3;
9250 while (p >= prifldbl) { *--ptr = *p--; }
9255 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9260 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9272 /* No taint. Otherwise we are in the strange situation
9273 * where printf() taints but print($float) doesn't.
9275 #if defined(HAS_LONG_DOUBLE)
9276 elen = ((intsize == 'q')
9277 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9278 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9280 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9284 eptr = PL_efloatbuf;
9292 i = SvCUR(sv) - origlen;
9295 case 'h': *(va_arg(*args, short*)) = i; break;
9296 default: *(va_arg(*args, int*)) = i; break;
9297 case 'l': *(va_arg(*args, long*)) = i; break;
9298 case 'V': *(va_arg(*args, IV*)) = i; break;
9300 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9305 sv_setuv_mg(argsv, (UV)i);
9306 continue; /* not "break" */
9313 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9314 && ckWARN(WARN_PRINTF))
9316 SV * const msg = sv_newmortal();
9317 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9318 (PL_op->op_type == OP_PRTF) ? "" : "s");
9321 Perl_sv_catpvf(aTHX_ msg,
9322 "\"%%%c\"", c & 0xFF);
9324 Perl_sv_catpvf(aTHX_ msg,
9325 "\"%%\\%03"UVof"\"",
9328 sv_catpvs(msg, "end of string");
9329 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9332 /* output mangled stuff ... */
9338 /* ... right here, because formatting flags should not apply */
9339 SvGROW(sv, SvCUR(sv) + elen + 1);
9341 Copy(eptr, p, elen, char);
9344 SvCUR_set(sv, p - SvPVX_const(sv));
9346 continue; /* not "break" */
9349 if (is_utf8 != has_utf8) {
9352 sv_utf8_upgrade(sv);
9355 const STRLEN old_elen = elen;
9356 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9357 sv_utf8_upgrade(nsv);
9358 eptr = SvPVX_const(nsv);
9361 if (width) { /* fudge width (can't fudge elen) */
9362 width += elen - old_elen;
9368 have = esignlen + zeros + elen;
9370 Perl_croak_nocontext(PL_memory_wrap);
9372 need = (have > width ? have : width);
9375 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9376 Perl_croak_nocontext(PL_memory_wrap);
9377 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9379 if (esignlen && fill == '0') {
9381 for (i = 0; i < (int)esignlen; i++)
9385 memset(p, fill, gap);
9388 if (esignlen && fill != '0') {
9390 for (i = 0; i < (int)esignlen; i++)
9395 for (i = zeros; i; i--)
9399 Copy(eptr, p, elen, char);
9403 memset(p, ' ', gap);
9408 Copy(dotstr, p, dotstrlen, char);
9412 vectorize = FALSE; /* done iterating over vecstr */
9419 SvCUR_set(sv, p - SvPVX_const(sv));
9427 /* =========================================================================
9429 =head1 Cloning an interpreter
9431 All the macros and functions in this section are for the private use of
9432 the main function, perl_clone().
9434 The foo_dup() functions make an exact copy of an existing foo thinngy.
9435 During the course of a cloning, a hash table is used to map old addresses
9436 to new addresses. The table is created and manipulated with the
9437 ptr_table_* functions.
9441 ============================================================================*/
9444 #if defined(USE_ITHREADS)
9446 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9447 #ifndef GpREFCNT_inc
9448 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9452 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9453 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9454 please unmerge ss_dup. */
9455 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9456 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9457 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9458 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9459 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9460 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9461 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9462 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9463 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9464 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9465 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9466 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9467 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9468 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9471 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9472 regcomp.c. AMS 20010712 */
9475 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9480 struct reg_substr_datum *s;
9483 return (REGEXP *)NULL;
9485 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9488 len = r->offsets[0];
9489 npar = r->nparens+1;
9491 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9492 Copy(r->program, ret->program, len+1, regnode);
9494 Newx(ret->startp, npar, I32);
9495 Copy(r->startp, ret->startp, npar, I32);
9496 Newx(ret->endp, npar, I32);
9497 Copy(r->startp, ret->startp, npar, I32);
9499 Newx(ret->substrs, 1, struct reg_substr_data);
9500 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9501 s->min_offset = r->substrs->data[i].min_offset;
9502 s->max_offset = r->substrs->data[i].max_offset;
9503 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9504 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9507 ret->regstclass = NULL;
9510 const int count = r->data->count;
9513 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9514 char, struct reg_data);
9515 Newx(d->what, count, U8);
9518 for (i = 0; i < count; i++) {
9519 d->what[i] = r->data->what[i];
9520 switch (d->what[i]) {
9521 /* legal options are one of: sfpont
9522 see also regcomp.h and pregfree() */
9524 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9527 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9530 /* This is cheating. */
9531 Newx(d->data[i], 1, struct regnode_charclass_class);
9532 StructCopy(r->data->data[i], d->data[i],
9533 struct regnode_charclass_class);
9534 ret->regstclass = (regnode*)d->data[i];
9537 /* Compiled op trees are readonly, and can thus be
9538 shared without duplication. */
9540 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9544 d->data[i] = r->data->data[i];
9547 d->data[i] = r->data->data[i];
9549 ((reg_trie_data*)d->data[i])->refcount++;
9553 d->data[i] = r->data->data[i];
9555 ((reg_ac_data*)d->data[i])->refcount++;
9557 /* Trie stclasses are readonly and can thus be shared
9558 * without duplication. We free the stclass in pregfree
9559 * when the corresponding reg_ac_data struct is freed.
9561 ret->regstclass= r->regstclass;
9564 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9573 Newx(ret->offsets, 2*len+1, U32);
9574 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9576 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9577 ret->refcnt = r->refcnt;
9578 ret->minlen = r->minlen;
9579 ret->prelen = r->prelen;
9580 ret->nparens = r->nparens;
9581 ret->lastparen = r->lastparen;
9582 ret->lastcloseparen = r->lastcloseparen;
9583 ret->reganch = r->reganch;
9585 ret->sublen = r->sublen;
9587 if (RX_MATCH_COPIED(ret))
9588 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9591 #ifdef PERL_OLD_COPY_ON_WRITE
9592 ret->saved_copy = NULL;
9595 ptr_table_store(PL_ptr_table, r, ret);
9599 /* duplicate a file handle */
9602 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9606 PERL_UNUSED_ARG(type);
9609 return (PerlIO*)NULL;
9611 /* look for it in the table first */
9612 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9616 /* create anew and remember what it is */
9617 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9618 ptr_table_store(PL_ptr_table, fp, ret);
9622 /* duplicate a directory handle */
9625 Perl_dirp_dup(pTHX_ DIR *dp)
9627 PERL_UNUSED_CONTEXT;
9634 /* duplicate a typeglob */
9637 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9643 /* look for it in the table first */
9644 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9648 /* create anew and remember what it is */
9650 ptr_table_store(PL_ptr_table, gp, ret);
9653 ret->gp_refcnt = 0; /* must be before any other dups! */
9654 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9655 ret->gp_io = io_dup_inc(gp->gp_io, param);
9656 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9657 ret->gp_av = av_dup_inc(gp->gp_av, param);
9658 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9659 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9660 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9661 ret->gp_cvgen = gp->gp_cvgen;
9662 ret->gp_line = gp->gp_line;
9663 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9667 /* duplicate a chain of magic */
9670 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9672 MAGIC *mgprev = (MAGIC*)NULL;
9675 return (MAGIC*)NULL;
9676 /* look for it in the table first */
9677 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9681 for (; mg; mg = mg->mg_moremagic) {
9683 Newxz(nmg, 1, MAGIC);
9685 mgprev->mg_moremagic = nmg;
9688 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9689 nmg->mg_private = mg->mg_private;
9690 nmg->mg_type = mg->mg_type;
9691 nmg->mg_flags = mg->mg_flags;
9692 if (mg->mg_type == PERL_MAGIC_qr) {
9693 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9695 else if(mg->mg_type == PERL_MAGIC_backref) {
9696 /* The backref AV has its reference count deliberately bumped by
9698 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9700 else if (mg->mg_type == PERL_MAGIC_symtab) {
9701 nmg->mg_obj = mg->mg_obj;
9704 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9705 ? sv_dup_inc(mg->mg_obj, param)
9706 : sv_dup(mg->mg_obj, param);
9708 nmg->mg_len = mg->mg_len;
9709 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9710 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9711 if (mg->mg_len > 0) {
9712 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9713 if (mg->mg_type == PERL_MAGIC_overload_table &&
9714 AMT_AMAGIC((AMT*)mg->mg_ptr))
9716 const AMT * const amtp = (AMT*)mg->mg_ptr;
9717 AMT * const namtp = (AMT*)nmg->mg_ptr;
9719 for (i = 1; i < NofAMmeth; i++) {
9720 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9724 else if (mg->mg_len == HEf_SVKEY)
9725 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9727 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9728 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9735 /* create a new pointer-mapping table */
9738 Perl_ptr_table_new(pTHX)
9741 PERL_UNUSED_CONTEXT;
9743 Newxz(tbl, 1, PTR_TBL_t);
9746 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9750 #define PTR_TABLE_HASH(ptr) \
9751 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9754 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9755 following define) and at call to new_body_inline made below in
9756 Perl_ptr_table_store()
9759 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9761 /* map an existing pointer using a table */
9763 STATIC PTR_TBL_ENT_t *
9764 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9765 PTR_TBL_ENT_t *tblent;
9766 const UV hash = PTR_TABLE_HASH(sv);
9768 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9769 for (; tblent; tblent = tblent->next) {
9770 if (tblent->oldval == sv)
9777 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9779 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9780 PERL_UNUSED_CONTEXT;
9781 return tblent ? tblent->newval : NULL;
9784 /* add a new entry to a pointer-mapping table */
9787 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9789 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9790 PERL_UNUSED_CONTEXT;
9793 tblent->newval = newsv;
9795 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9797 new_body_inline(tblent, PTE_SVSLOT);
9799 tblent->oldval = oldsv;
9800 tblent->newval = newsv;
9801 tblent->next = tbl->tbl_ary[entry];
9802 tbl->tbl_ary[entry] = tblent;
9804 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9805 ptr_table_split(tbl);
9809 /* double the hash bucket size of an existing ptr table */
9812 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9814 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9815 const UV oldsize = tbl->tbl_max + 1;
9816 UV newsize = oldsize * 2;
9818 PERL_UNUSED_CONTEXT;
9820 Renew(ary, newsize, PTR_TBL_ENT_t*);
9821 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9822 tbl->tbl_max = --newsize;
9824 for (i=0; i < oldsize; i++, ary++) {
9825 PTR_TBL_ENT_t **curentp, **entp, *ent;
9828 curentp = ary + oldsize;
9829 for (entp = ary, ent = *ary; ent; ent = *entp) {
9830 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9832 ent->next = *curentp;
9842 /* remove all the entries from a ptr table */
9845 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9847 if (tbl && tbl->tbl_items) {
9848 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9849 UV riter = tbl->tbl_max;
9852 PTR_TBL_ENT_t *entry = array[riter];
9855 PTR_TBL_ENT_t * const oentry = entry;
9856 entry = entry->next;
9865 /* clear and free a ptr table */
9868 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9873 ptr_table_clear(tbl);
9874 Safefree(tbl->tbl_ary);
9880 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9883 SvRV_set(dstr, SvWEAKREF(sstr)
9884 ? sv_dup(SvRV(sstr), param)
9885 : sv_dup_inc(SvRV(sstr), param));
9888 else if (SvPVX_const(sstr)) {
9889 /* Has something there */
9891 /* Normal PV - clone whole allocated space */
9892 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9893 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9894 /* Not that normal - actually sstr is copy on write.
9895 But we are a true, independant SV, so: */
9896 SvREADONLY_off(dstr);
9901 /* Special case - not normally malloced for some reason */
9902 if (isGV_with_GP(sstr)) {
9903 /* Don't need to do anything here. */
9905 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9906 /* A "shared" PV - clone it as "shared" PV */
9908 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9912 /* Some other special case - random pointer */
9913 SvPV_set(dstr, SvPVX(sstr));
9919 if (SvTYPE(dstr) == SVt_RV)
9920 SvRV_set(dstr, NULL);
9922 SvPV_set(dstr, NULL);
9926 /* duplicate an SV of any type (including AV, HV etc) */
9929 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9934 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9936 /* look for it in the table first */
9937 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9941 if(param->flags & CLONEf_JOIN_IN) {
9942 /** We are joining here so we don't want do clone
9943 something that is bad **/
9944 if (SvTYPE(sstr) == SVt_PVHV) {
9945 const char * const hvname = HvNAME_get(sstr);
9947 /** don't clone stashes if they already exist **/
9948 return (SV*)gv_stashpv(hvname,0);
9952 /* create anew and remember what it is */
9955 #ifdef DEBUG_LEAKING_SCALARS
9956 dstr->sv_debug_optype = sstr->sv_debug_optype;
9957 dstr->sv_debug_line = sstr->sv_debug_line;
9958 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9959 dstr->sv_debug_cloned = 1;
9960 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9963 ptr_table_store(PL_ptr_table, sstr, dstr);
9966 SvFLAGS(dstr) = SvFLAGS(sstr);
9967 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9968 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9971 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9972 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9973 PL_watch_pvx, SvPVX_const(sstr));
9976 /* don't clone objects whose class has asked us not to */
9977 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9978 SvFLAGS(dstr) &= ~SVTYPEMASK;
9983 switch (SvTYPE(sstr)) {
9988 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9989 SvIV_set(dstr, SvIVX(sstr));
9992 SvANY(dstr) = new_XNV();
9993 SvNV_set(dstr, SvNVX(sstr));
9996 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9997 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10001 /* These are all the types that need complex bodies allocating. */
10003 const svtype sv_type = SvTYPE(sstr);
10004 const struct body_details *const sv_type_details
10005 = bodies_by_type + sv_type;
10009 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10013 if (GvUNIQUE((GV*)sstr)) {
10014 NOOP; /* Do sharing here, and fall through */
10027 assert(sv_type_details->body_size);
10028 if (sv_type_details->arena) {
10029 new_body_inline(new_body, sv_type);
10031 = (void*)((char*)new_body - sv_type_details->offset);
10033 new_body = new_NOARENA(sv_type_details);
10037 SvANY(dstr) = new_body;
10040 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10041 ((char*)SvANY(dstr)) + sv_type_details->offset,
10042 sv_type_details->copy, char);
10044 Copy(((char*)SvANY(sstr)),
10045 ((char*)SvANY(dstr)),
10046 sv_type_details->body_size + sv_type_details->offset, char);
10049 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10050 && !isGV_with_GP(dstr))
10051 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10053 /* The Copy above means that all the source (unduplicated) pointers
10054 are now in the destination. We can check the flags and the
10055 pointers in either, but it's possible that there's less cache
10056 missing by always going for the destination.
10057 FIXME - instrument and check that assumption */
10058 if (sv_type >= SVt_PVMG) {
10059 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10060 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10061 } else if (SvMAGIC(dstr))
10062 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10064 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10067 /* The cast silences a GCC warning about unhandled types. */
10068 switch ((int)sv_type) {
10080 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10081 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10082 LvTARG(dstr) = dstr;
10083 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10084 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10086 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10089 if (GvNAME_HEK(dstr))
10090 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10092 /* Don't call sv_add_backref here as it's going to be created
10093 as part of the magic cloning of the symbol table. */
10094 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10095 if(isGV_with_GP(sstr)) {
10096 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10097 at the point of this comment. */
10098 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10099 (void)GpREFCNT_inc(GvGP(dstr));
10101 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10104 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10105 if (IoOFP(dstr) == IoIFP(sstr))
10106 IoOFP(dstr) = IoIFP(dstr);
10108 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10109 /* PL_rsfp_filters entries have fake IoDIRP() */
10110 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10111 /* I have no idea why fake dirp (rsfps)
10112 should be treated differently but otherwise
10113 we end up with leaks -- sky*/
10114 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10115 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10116 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10118 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10119 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10120 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10121 if (IoDIRP(dstr)) {
10122 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10125 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10128 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10129 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10130 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10133 if (AvARRAY((AV*)sstr)) {
10134 SV **dst_ary, **src_ary;
10135 SSize_t items = AvFILLp((AV*)sstr) + 1;
10137 src_ary = AvARRAY((AV*)sstr);
10138 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10139 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10140 SvPV_set(dstr, (char*)dst_ary);
10141 AvALLOC((AV*)dstr) = dst_ary;
10142 if (AvREAL((AV*)sstr)) {
10143 while (items-- > 0)
10144 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10147 while (items-- > 0)
10148 *dst_ary++ = sv_dup(*src_ary++, param);
10150 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10151 while (items-- > 0) {
10152 *dst_ary++ = &PL_sv_undef;
10156 SvPV_set(dstr, NULL);
10157 AvALLOC((AV*)dstr) = (SV**)NULL;
10161 if (HvARRAY((HV*)sstr)) {
10163 const bool sharekeys = !!HvSHAREKEYS(sstr);
10164 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10165 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10167 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10168 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10170 HvARRAY(dstr) = (HE**)darray;
10171 while (i <= sxhv->xhv_max) {
10172 const HE * const source = HvARRAY(sstr)[i];
10173 HvARRAY(dstr)[i] = source
10174 ? he_dup(source, sharekeys, param) : 0;
10179 const struct xpvhv_aux * const saux = HvAUX(sstr);
10180 struct xpvhv_aux * const daux = HvAUX(dstr);
10181 /* This flag isn't copied. */
10182 /* SvOOK_on(hv) attacks the IV flags. */
10183 SvFLAGS(dstr) |= SVf_OOK;
10185 hvname = saux->xhv_name;
10186 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10188 daux->xhv_riter = saux->xhv_riter;
10189 daux->xhv_eiter = saux->xhv_eiter
10190 ? he_dup(saux->xhv_eiter,
10191 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10192 daux->xhv_backreferences =
10193 saux->xhv_backreferences
10194 ? (AV*) SvREFCNT_inc(
10195 sv_dup((SV*)saux->xhv_backreferences, param))
10197 /* Record stashes for possible cloning in Perl_clone(). */
10199 av_push(param->stashes, dstr);
10203 SvPV_set(dstr, NULL);
10206 if (!(param->flags & CLONEf_COPY_STACKS)) {
10210 /* NOTE: not refcounted */
10211 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10213 if (!CvISXSUB(dstr))
10214 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10216 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10217 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10218 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10219 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10221 /* don't dup if copying back - CvGV isn't refcounted, so the
10222 * duped GV may never be freed. A bit of a hack! DAPM */
10223 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10224 NULL : gv_dup(CvGV(dstr), param) ;
10225 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10227 CvWEAKOUTSIDE(sstr)
10228 ? cv_dup( CvOUTSIDE(dstr), param)
10229 : cv_dup_inc(CvOUTSIDE(dstr), param);
10230 if (!CvISXSUB(dstr))
10231 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10237 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10243 /* duplicate a context */
10246 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10248 PERL_CONTEXT *ncxs;
10251 return (PERL_CONTEXT*)NULL;
10253 /* look for it in the table first */
10254 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10258 /* create anew and remember what it is */
10259 Newxz(ncxs, max + 1, PERL_CONTEXT);
10260 ptr_table_store(PL_ptr_table, cxs, ncxs);
10263 PERL_CONTEXT * const cx = &cxs[ix];
10264 PERL_CONTEXT * const ncx = &ncxs[ix];
10265 ncx->cx_type = cx->cx_type;
10266 if (CxTYPE(cx) == CXt_SUBST) {
10267 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10270 ncx->blk_oldsp = cx->blk_oldsp;
10271 ncx->blk_oldcop = cx->blk_oldcop;
10272 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10273 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10274 ncx->blk_oldpm = cx->blk_oldpm;
10275 ncx->blk_gimme = cx->blk_gimme;
10276 switch (CxTYPE(cx)) {
10278 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10279 ? cv_dup_inc(cx->blk_sub.cv, param)
10280 : cv_dup(cx->blk_sub.cv,param));
10281 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10282 ? av_dup_inc(cx->blk_sub.argarray, param)
10284 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10285 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10286 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10287 ncx->blk_sub.lval = cx->blk_sub.lval;
10288 ncx->blk_sub.retop = cx->blk_sub.retop;
10289 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10290 cx->blk_sub.oldcomppad);
10293 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10294 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10295 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10296 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10297 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10298 ncx->blk_eval.retop = cx->blk_eval.retop;
10301 ncx->blk_loop.label = cx->blk_loop.label;
10302 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10303 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10304 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10305 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10306 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10307 ? cx->blk_loop.iterdata
10308 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10309 ncx->blk_loop.oldcomppad
10310 = (PAD*)ptr_table_fetch(PL_ptr_table,
10311 cx->blk_loop.oldcomppad);
10312 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10313 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10314 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10315 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10316 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10319 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10320 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10321 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10322 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10323 ncx->blk_sub.retop = cx->blk_sub.retop;
10335 /* duplicate a stack info structure */
10338 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10343 return (PERL_SI*)NULL;
10345 /* look for it in the table first */
10346 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10350 /* create anew and remember what it is */
10351 Newxz(nsi, 1, PERL_SI);
10352 ptr_table_store(PL_ptr_table, si, nsi);
10354 nsi->si_stack = av_dup_inc(si->si_stack, param);
10355 nsi->si_cxix = si->si_cxix;
10356 nsi->si_cxmax = si->si_cxmax;
10357 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10358 nsi->si_type = si->si_type;
10359 nsi->si_prev = si_dup(si->si_prev, param);
10360 nsi->si_next = si_dup(si->si_next, param);
10361 nsi->si_markoff = si->si_markoff;
10366 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10367 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10368 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10369 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10370 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10371 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10372 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10373 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10374 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10375 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10376 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10377 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10378 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10379 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10382 #define pv_dup_inc(p) SAVEPV(p)
10383 #define pv_dup(p) SAVEPV(p)
10384 #define svp_dup_inc(p,pp) any_dup(p,pp)
10386 /* map any object to the new equivent - either something in the
10387 * ptr table, or something in the interpreter structure
10391 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10396 return (void*)NULL;
10398 /* look for it in the table first */
10399 ret = ptr_table_fetch(PL_ptr_table, v);
10403 /* see if it is part of the interpreter structure */
10404 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10405 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10413 /* duplicate the save stack */
10416 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10418 ANY * const ss = proto_perl->Tsavestack;
10419 const I32 max = proto_perl->Tsavestack_max;
10420 I32 ix = proto_perl->Tsavestack_ix;
10432 void (*dptr) (void*);
10433 void (*dxptr) (pTHX_ void*);
10435 Newxz(nss, max, ANY);
10438 I32 i = POPINT(ss,ix);
10439 TOPINT(nss,ix) = i;
10441 case SAVEt_ITEM: /* normal string */
10442 case SAVEt_SV: /* scalar reference */
10443 sv = (SV*)POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10445 sv = (SV*)POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10448 case SAVEt_SHARED_PVREF: /* char* in shared space */
10449 c = (char*)POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = savesharedpv(c);
10451 ptr = POPPTR(ss,ix);
10452 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10454 case SAVEt_GENERIC_SVREF: /* generic sv */
10455 case SAVEt_SVREF: /* scalar reference */
10456 sv = (SV*)POPPTR(ss,ix);
10457 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10461 case SAVEt_HV: /* hash reference */
10462 case SAVEt_AV: /* array reference */
10463 sv = POPPTR(ss,ix);
10464 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10465 gv = (GV*)POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = gv_dup(gv, param);
10468 case SAVEt_INT: /* int reference */
10469 ptr = POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10471 intval = (int)POPINT(ss,ix);
10472 TOPINT(nss,ix) = intval;
10474 case SAVEt_LONG: /* long reference */
10475 ptr = POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 longval = (long)POPLONG(ss,ix);
10478 TOPLONG(nss,ix) = longval;
10480 case SAVEt_I32: /* I32 reference */
10481 case SAVEt_I16: /* I16 reference */
10482 case SAVEt_I8: /* I8 reference */
10483 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10484 ptr = POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10487 TOPINT(nss,ix) = i;
10489 case SAVEt_IV: /* IV reference */
10490 ptr = POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10493 TOPIV(nss,ix) = iv;
10495 case SAVEt_HPTR: /* HV* reference */
10496 case SAVEt_APTR: /* AV* reference */
10497 case SAVEt_SPTR: /* SV* reference */
10498 ptr = POPPTR(ss,ix);
10499 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10500 sv = (SV*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = sv_dup(sv, param);
10503 case SAVEt_VPTR: /* random* reference */
10504 ptr = POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10506 ptr = POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10509 case SAVEt_GENERIC_PVREF: /* generic char* */
10510 case SAVEt_PPTR: /* char* reference */
10511 ptr = POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10513 c = (char*)POPPTR(ss,ix);
10514 TOPPTR(nss,ix) = pv_dup(c);
10517 gv = (GV*)POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = gv_dup(gv, param);
10520 case SAVEt_GP: /* scalar reference */
10521 gp = (GP*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10523 (void)GpREFCNT_inc(gp);
10524 gv = (GV*)POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10526 c = (char*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = pv_dup(c);
10529 TOPIV(nss,ix) = iv;
10531 TOPIV(nss,ix) = iv;
10534 case SAVEt_MORTALIZESV:
10535 sv = (SV*)POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10539 ptr = POPPTR(ss,ix);
10540 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10541 /* these are assumed to be refcounted properly */
10543 switch (((OP*)ptr)->op_type) {
10545 case OP_LEAVESUBLV:
10549 case OP_LEAVEWRITE:
10550 TOPPTR(nss,ix) = ptr;
10555 TOPPTR(nss,ix) = NULL;
10560 TOPPTR(nss,ix) = NULL;
10563 c = (char*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = pv_dup_inc(c);
10566 case SAVEt_CLEARSV:
10567 longval = POPLONG(ss,ix);
10568 TOPLONG(nss,ix) = longval;
10571 hv = (HV*)POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10573 c = (char*)POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = pv_dup_inc(c);
10576 TOPINT(nss,ix) = i;
10578 case SAVEt_DESTRUCTOR:
10579 ptr = POPPTR(ss,ix);
10580 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10581 dptr = POPDPTR(ss,ix);
10582 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10583 any_dup(FPTR2DPTR(void *, dptr),
10586 case SAVEt_DESTRUCTOR_X:
10587 ptr = POPPTR(ss,ix);
10588 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10589 dxptr = POPDXPTR(ss,ix);
10590 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10591 any_dup(FPTR2DPTR(void *, dxptr),
10594 case SAVEt_REGCONTEXT:
10597 TOPINT(nss,ix) = i;
10600 case SAVEt_STACK_POS: /* Position on Perl stack */
10602 TOPINT(nss,ix) = i;
10604 case SAVEt_AELEM: /* array element */
10605 sv = (SV*)POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10608 TOPINT(nss,ix) = i;
10609 av = (AV*)POPPTR(ss,ix);
10610 TOPPTR(nss,ix) = av_dup_inc(av, param);
10612 case SAVEt_HELEM: /* hash element */
10613 sv = (SV*)POPPTR(ss,ix);
10614 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10615 sv = (SV*)POPPTR(ss,ix);
10616 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10617 hv = (HV*)POPPTR(ss,ix);
10618 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10621 ptr = POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = ptr;
10626 TOPINT(nss,ix) = i;
10627 ptr = POPPTR(ss,ix);
10630 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10631 HINTS_REFCNT_UNLOCK;
10633 TOPPTR(nss,ix) = ptr;
10634 if (i & HINT_LOCALIZE_HH) {
10635 hv = (HV*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10639 case SAVEt_COMPPAD:
10640 av = (AV*)POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = av_dup(av, param);
10644 longval = (long)POPLONG(ss,ix);
10645 TOPLONG(nss,ix) = longval;
10646 ptr = POPPTR(ss,ix);
10647 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10648 sv = (SV*)POPPTR(ss,ix);
10649 TOPPTR(nss,ix) = sv_dup(sv, param);
10652 ptr = POPPTR(ss,ix);
10653 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10654 longval = (long)POPBOOL(ss,ix);
10655 TOPBOOL(nss,ix) = (bool)longval;
10657 case SAVEt_SET_SVFLAGS:
10659 TOPINT(nss,ix) = i;
10661 TOPINT(nss,ix) = i;
10662 sv = (SV*)POPPTR(ss,ix);
10663 TOPPTR(nss,ix) = sv_dup(sv, param);
10665 case SAVEt_RE_STATE:
10667 const struct re_save_state *const old_state
10668 = (struct re_save_state *)
10669 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10670 struct re_save_state *const new_state
10671 = (struct re_save_state *)
10672 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10674 Copy(old_state, new_state, 1, struct re_save_state);
10675 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10677 new_state->re_state_bostr
10678 = pv_dup(old_state->re_state_bostr);
10679 new_state->re_state_reginput
10680 = pv_dup(old_state->re_state_reginput);
10681 new_state->re_state_regeol
10682 = pv_dup(old_state->re_state_regeol);
10683 new_state->re_state_regstartp
10684 = any_dup(old_state->re_state_regstartp, proto_perl);
10685 new_state->re_state_regendp
10686 = any_dup(old_state->re_state_regendp, proto_perl);
10687 new_state->re_state_reglastparen
10688 = any_dup(old_state->re_state_reglastparen, proto_perl);
10689 new_state->re_state_reglastcloseparen
10690 = any_dup(old_state->re_state_reglastcloseparen,
10692 /* XXX This just has to be broken. The old save_re_context
10693 code did SAVEGENERICPV(PL_reg_start_tmp);
10694 PL_reg_start_tmp is char **.
10695 Look above to what the dup code does for
10696 SAVEt_GENERIC_PVREF
10697 It can never have worked.
10698 So this is merely a faithful copy of the exiting bug: */
10699 new_state->re_state_reg_start_tmp
10700 = (char **) pv_dup((char *)
10701 old_state->re_state_reg_start_tmp);
10702 /* I assume that it only ever "worked" because no-one called
10703 (pseudo)fork while the regexp engine had re-entered itself.
10705 #ifdef PERL_OLD_COPY_ON_WRITE
10706 new_state->re_state_nrs
10707 = sv_dup(old_state->re_state_nrs, param);
10709 new_state->re_state_reg_magic
10710 = any_dup(old_state->re_state_reg_magic, proto_perl);
10711 new_state->re_state_reg_oldcurpm
10712 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10713 new_state->re_state_reg_curpm
10714 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10715 new_state->re_state_reg_oldsaved
10716 = pv_dup(old_state->re_state_reg_oldsaved);
10717 new_state->re_state_reg_poscache
10718 = pv_dup(old_state->re_state_reg_poscache);
10719 new_state->re_state_reg_starttry
10720 = pv_dup(old_state->re_state_reg_starttry);
10723 case SAVEt_COMPILE_WARNINGS:
10724 ptr = POPPTR(ss,ix);
10725 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10728 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10736 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10737 * flag to the result. This is done for each stash before cloning starts,
10738 * so we know which stashes want their objects cloned */
10741 do_mark_cloneable_stash(pTHX_ SV *sv)
10743 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10745 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10746 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10747 if (cloner && GvCV(cloner)) {
10754 XPUSHs(sv_2mortal(newSVhek(hvname)));
10756 call_sv((SV*)GvCV(cloner), G_SCALAR);
10763 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10771 =for apidoc perl_clone
10773 Create and return a new interpreter by cloning the current one.
10775 perl_clone takes these flags as parameters:
10777 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10778 without it we only clone the data and zero the stacks,
10779 with it we copy the stacks and the new perl interpreter is
10780 ready to run at the exact same point as the previous one.
10781 The pseudo-fork code uses COPY_STACKS while the
10782 threads->new doesn't.
10784 CLONEf_KEEP_PTR_TABLE
10785 perl_clone keeps a ptr_table with the pointer of the old
10786 variable as a key and the new variable as a value,
10787 this allows it to check if something has been cloned and not
10788 clone it again but rather just use the value and increase the
10789 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10790 the ptr_table using the function
10791 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10792 reason to keep it around is if you want to dup some of your own
10793 variable who are outside the graph perl scans, example of this
10794 code is in threads.xs create
10797 This is a win32 thing, it is ignored on unix, it tells perls
10798 win32host code (which is c++) to clone itself, this is needed on
10799 win32 if you want to run two threads at the same time,
10800 if you just want to do some stuff in a separate perl interpreter
10801 and then throw it away and return to the original one,
10802 you don't need to do anything.
10807 /* XXX the above needs expanding by someone who actually understands it ! */
10808 EXTERN_C PerlInterpreter *
10809 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10812 perl_clone(PerlInterpreter *proto_perl, UV flags)
10815 #ifdef PERL_IMPLICIT_SYS
10817 /* perlhost.h so we need to call into it
10818 to clone the host, CPerlHost should have a c interface, sky */
10820 if (flags & CLONEf_CLONE_HOST) {
10821 return perl_clone_host(proto_perl,flags);
10823 return perl_clone_using(proto_perl, flags,
10825 proto_perl->IMemShared,
10826 proto_perl->IMemParse,
10828 proto_perl->IStdIO,
10832 proto_perl->IProc);
10836 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10837 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10838 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10839 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10840 struct IPerlDir* ipD, struct IPerlSock* ipS,
10841 struct IPerlProc* ipP)
10843 /* XXX many of the string copies here can be optimized if they're
10844 * constants; they need to be allocated as common memory and just
10845 * their pointers copied. */
10848 CLONE_PARAMS clone_params;
10849 CLONE_PARAMS* const param = &clone_params;
10851 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10852 /* for each stash, determine whether its objects should be cloned */
10853 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10854 PERL_SET_THX(my_perl);
10857 PoisonNew(my_perl, 1, PerlInterpreter);
10863 PL_savestack_ix = 0;
10864 PL_savestack_max = -1;
10865 PL_sig_pending = 0;
10866 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10867 # else /* !DEBUGGING */
10868 Zero(my_perl, 1, PerlInterpreter);
10869 # endif /* DEBUGGING */
10871 /* host pointers */
10873 PL_MemShared = ipMS;
10874 PL_MemParse = ipMP;
10881 #else /* !PERL_IMPLICIT_SYS */
10883 CLONE_PARAMS clone_params;
10884 CLONE_PARAMS* param = &clone_params;
10885 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10886 /* for each stash, determine whether its objects should be cloned */
10887 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10888 PERL_SET_THX(my_perl);
10891 PoisonNew(my_perl, 1, PerlInterpreter);
10897 PL_savestack_ix = 0;
10898 PL_savestack_max = -1;
10899 PL_sig_pending = 0;
10900 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10901 # else /* !DEBUGGING */
10902 Zero(my_perl, 1, PerlInterpreter);
10903 # endif /* DEBUGGING */
10904 #endif /* PERL_IMPLICIT_SYS */
10905 param->flags = flags;
10906 param->proto_perl = proto_perl;
10908 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10910 PL_body_arenas = NULL;
10911 Zero(&PL_body_roots, 1, PL_body_roots);
10913 PL_nice_chunk = NULL;
10914 PL_nice_chunk_size = 0;
10916 PL_sv_objcount = 0;
10918 PL_sv_arenaroot = NULL;
10920 PL_debug = proto_perl->Idebug;
10922 PL_hash_seed = proto_perl->Ihash_seed;
10923 PL_rehash_seed = proto_perl->Irehash_seed;
10925 #ifdef USE_REENTRANT_API
10926 /* XXX: things like -Dm will segfault here in perlio, but doing
10927 * PERL_SET_CONTEXT(proto_perl);
10928 * breaks too many other things
10930 Perl_reentrant_init(aTHX);
10933 /* create SV map for pointer relocation */
10934 PL_ptr_table = ptr_table_new();
10936 /* initialize these special pointers as early as possible */
10937 SvANY(&PL_sv_undef) = NULL;
10938 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10939 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10940 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10942 SvANY(&PL_sv_no) = new_XPVNV();
10943 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10944 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10945 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10946 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10947 SvCUR_set(&PL_sv_no, 0);
10948 SvLEN_set(&PL_sv_no, 1);
10949 SvIV_set(&PL_sv_no, 0);
10950 SvNV_set(&PL_sv_no, 0);
10951 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10953 SvANY(&PL_sv_yes) = new_XPVNV();
10954 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10955 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10956 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10957 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10958 SvCUR_set(&PL_sv_yes, 1);
10959 SvLEN_set(&PL_sv_yes, 2);
10960 SvIV_set(&PL_sv_yes, 1);
10961 SvNV_set(&PL_sv_yes, 1);
10962 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10964 /* create (a non-shared!) shared string table */
10965 PL_strtab = newHV();
10966 HvSHAREKEYS_off(PL_strtab);
10967 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10968 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10970 PL_compiling = proto_perl->Icompiling;
10972 /* These two PVs will be free'd special way so must set them same way op.c does */
10973 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10974 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10976 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10977 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10979 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10980 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10981 if (PL_compiling.cop_hints_hash) {
10983 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10984 HINTS_REFCNT_UNLOCK;
10986 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10988 /* pseudo environmental stuff */
10989 PL_origargc = proto_perl->Iorigargc;
10990 PL_origargv = proto_perl->Iorigargv;
10992 param->stashes = newAV(); /* Setup array of objects to call clone on */
10994 /* Set tainting stuff before PerlIO_debug can possibly get called */
10995 PL_tainting = proto_perl->Itainting;
10996 PL_taint_warn = proto_perl->Itaint_warn;
10998 #ifdef PERLIO_LAYERS
10999 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11000 PerlIO_clone(aTHX_ proto_perl, param);
11003 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11004 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11005 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11006 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11007 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11008 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11011 PL_minus_c = proto_perl->Iminus_c;
11012 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11013 PL_localpatches = proto_perl->Ilocalpatches;
11014 PL_splitstr = proto_perl->Isplitstr;
11015 PL_preprocess = proto_perl->Ipreprocess;
11016 PL_minus_n = proto_perl->Iminus_n;
11017 PL_minus_p = proto_perl->Iminus_p;
11018 PL_minus_l = proto_perl->Iminus_l;
11019 PL_minus_a = proto_perl->Iminus_a;
11020 PL_minus_E = proto_perl->Iminus_E;
11021 PL_minus_F = proto_perl->Iminus_F;
11022 PL_doswitches = proto_perl->Idoswitches;
11023 PL_dowarn = proto_perl->Idowarn;
11024 PL_doextract = proto_perl->Idoextract;
11025 PL_sawampersand = proto_perl->Isawampersand;
11026 PL_unsafe = proto_perl->Iunsafe;
11027 PL_inplace = SAVEPV(proto_perl->Iinplace);
11028 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11029 PL_perldb = proto_perl->Iperldb;
11030 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11031 PL_exit_flags = proto_perl->Iexit_flags;
11033 /* magical thingies */
11034 /* XXX time(&PL_basetime) when asked for? */
11035 PL_basetime = proto_perl->Ibasetime;
11036 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11038 PL_maxsysfd = proto_perl->Imaxsysfd;
11039 PL_statusvalue = proto_perl->Istatusvalue;
11041 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11043 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11045 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11047 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11048 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11049 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11051 /* Clone the regex array */
11052 PL_regex_padav = newAV();
11054 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11055 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11057 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11058 for(i = 1; i <= len; i++) {
11059 const SV * const regex = regexen[i];
11062 ? sv_dup_inc(regex, param)
11064 newSViv(PTR2IV(re_dup(
11065 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11067 av_push(PL_regex_padav, sv);
11070 PL_regex_pad = AvARRAY(PL_regex_padav);
11072 /* shortcuts to various I/O objects */
11073 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11074 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11075 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11076 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11077 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11078 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11080 /* shortcuts to regexp stuff */
11081 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11083 /* shortcuts to misc objects */
11084 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11086 /* shortcuts to debugging objects */
11087 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11088 PL_DBline = gv_dup(proto_perl->IDBline, param);
11089 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11090 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11091 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11092 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11093 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11094 PL_lineary = av_dup(proto_perl->Ilineary, param);
11095 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11097 /* symbol tables */
11098 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11099 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11100 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11101 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11102 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11104 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11105 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11106 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11107 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11108 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11109 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11111 PL_sub_generation = proto_perl->Isub_generation;
11113 /* funky return mechanisms */
11114 PL_forkprocess = proto_perl->Iforkprocess;
11116 /* subprocess state */
11117 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11119 /* internal state */
11120 PL_maxo = proto_perl->Imaxo;
11121 if (proto_perl->Iop_mask)
11122 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11125 /* PL_asserting = proto_perl->Iasserting; */
11127 /* current interpreter roots */
11128 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11129 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11130 PL_main_start = proto_perl->Imain_start;
11131 PL_eval_root = proto_perl->Ieval_root;
11132 PL_eval_start = proto_perl->Ieval_start;
11134 /* runtime control stuff */
11135 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11136 PL_copline = proto_perl->Icopline;
11138 PL_filemode = proto_perl->Ifilemode;
11139 PL_lastfd = proto_perl->Ilastfd;
11140 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11143 PL_gensym = proto_perl->Igensym;
11144 PL_preambled = proto_perl->Ipreambled;
11145 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11146 PL_laststatval = proto_perl->Ilaststatval;
11147 PL_laststype = proto_perl->Ilaststype;
11150 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11152 /* interpreter atexit processing */
11153 PL_exitlistlen = proto_perl->Iexitlistlen;
11154 if (PL_exitlistlen) {
11155 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11156 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11159 PL_exitlist = (PerlExitListEntry*)NULL;
11161 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11162 if (PL_my_cxt_size) {
11163 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11164 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11167 PL_my_cxt_list = (void**)NULL;
11168 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11169 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11170 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11172 PL_profiledata = NULL;
11173 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11174 /* PL_rsfp_filters entries have fake IoDIRP() */
11175 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11177 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11179 PAD_CLONE_VARS(proto_perl, param);
11181 #ifdef HAVE_INTERP_INTERN
11182 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11185 /* more statics moved here */
11186 PL_generation = proto_perl->Igeneration;
11187 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11189 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11190 PL_in_clean_all = proto_perl->Iin_clean_all;
11192 PL_uid = proto_perl->Iuid;
11193 PL_euid = proto_perl->Ieuid;
11194 PL_gid = proto_perl->Igid;
11195 PL_egid = proto_perl->Iegid;
11196 PL_nomemok = proto_perl->Inomemok;
11197 PL_an = proto_perl->Ian;
11198 PL_evalseq = proto_perl->Ievalseq;
11199 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11200 PL_origalen = proto_perl->Iorigalen;
11201 #ifdef PERL_USES_PL_PIDSTATUS
11202 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11204 PL_osname = SAVEPV(proto_perl->Iosname);
11205 PL_sighandlerp = proto_perl->Isighandlerp;
11207 PL_runops = proto_perl->Irunops;
11209 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11212 PL_cshlen = proto_perl->Icshlen;
11213 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11216 PL_lex_state = proto_perl->Ilex_state;
11217 PL_lex_defer = proto_perl->Ilex_defer;
11218 PL_lex_expect = proto_perl->Ilex_expect;
11219 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11220 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11221 PL_lex_starts = proto_perl->Ilex_starts;
11222 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11223 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11224 PL_lex_op = proto_perl->Ilex_op;
11225 PL_lex_inpat = proto_perl->Ilex_inpat;
11226 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11227 PL_lex_brackets = proto_perl->Ilex_brackets;
11228 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11229 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11230 PL_lex_casemods = proto_perl->Ilex_casemods;
11231 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11232 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11235 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11236 PL_lasttoke = proto_perl->Ilasttoke;
11237 PL_realtokenstart = proto_perl->Irealtokenstart;
11238 PL_faketokens = proto_perl->Ifaketokens;
11239 PL_thismad = proto_perl->Ithismad;
11240 PL_thistoken = proto_perl->Ithistoken;
11241 PL_thisopen = proto_perl->Ithisopen;
11242 PL_thisstuff = proto_perl->Ithisstuff;
11243 PL_thisclose = proto_perl->Ithisclose;
11244 PL_thiswhite = proto_perl->Ithiswhite;
11245 PL_nextwhite = proto_perl->Inextwhite;
11246 PL_skipwhite = proto_perl->Iskipwhite;
11247 PL_endwhite = proto_perl->Iendwhite;
11248 PL_curforce = proto_perl->Icurforce;
11250 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11251 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11252 PL_nexttoke = proto_perl->Inexttoke;
11255 /* XXX This is probably masking the deeper issue of why
11256 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11257 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11258 * (A little debugging with a watchpoint on it may help.)
11260 if (SvANY(proto_perl->Ilinestr)) {
11261 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11262 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11263 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11264 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11265 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11266 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11267 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11268 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11269 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11272 PL_linestr = newSV(79);
11273 sv_upgrade(PL_linestr,SVt_PVIV);
11274 sv_setpvn(PL_linestr,"",0);
11275 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11277 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11278 PL_pending_ident = proto_perl->Ipending_ident;
11279 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11281 PL_expect = proto_perl->Iexpect;
11283 PL_multi_start = proto_perl->Imulti_start;
11284 PL_multi_end = proto_perl->Imulti_end;
11285 PL_multi_open = proto_perl->Imulti_open;
11286 PL_multi_close = proto_perl->Imulti_close;
11288 PL_error_count = proto_perl->Ierror_count;
11289 PL_subline = proto_perl->Isubline;
11290 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11292 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11293 if (SvANY(proto_perl->Ilinestr)) {
11294 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11295 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11296 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11297 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11298 PL_last_lop_op = proto_perl->Ilast_lop_op;
11301 PL_last_uni = SvPVX(PL_linestr);
11302 PL_last_lop = SvPVX(PL_linestr);
11303 PL_last_lop_op = 0;
11305 PL_in_my = proto_perl->Iin_my;
11306 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11308 PL_cryptseen = proto_perl->Icryptseen;
11311 PL_hints = proto_perl->Ihints;
11313 PL_amagic_generation = proto_perl->Iamagic_generation;
11315 #ifdef USE_LOCALE_COLLATE
11316 PL_collation_ix = proto_perl->Icollation_ix;
11317 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11318 PL_collation_standard = proto_perl->Icollation_standard;
11319 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11320 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11321 #endif /* USE_LOCALE_COLLATE */
11323 #ifdef USE_LOCALE_NUMERIC
11324 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11325 PL_numeric_standard = proto_perl->Inumeric_standard;
11326 PL_numeric_local = proto_perl->Inumeric_local;
11327 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11328 #endif /* !USE_LOCALE_NUMERIC */
11330 /* utf8 character classes */
11331 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11332 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11333 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11334 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11335 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11336 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11337 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11338 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11339 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11340 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11341 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11342 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11343 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11344 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11345 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11346 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11347 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11348 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11349 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11350 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11352 /* Did the locale setup indicate UTF-8? */
11353 PL_utf8locale = proto_perl->Iutf8locale;
11354 /* Unicode features (see perlrun/-C) */
11355 PL_unicode = proto_perl->Iunicode;
11357 /* Pre-5.8 signals control */
11358 PL_signals = proto_perl->Isignals;
11360 /* times() ticks per second */
11361 PL_clocktick = proto_perl->Iclocktick;
11363 /* Recursion stopper for PerlIO_find_layer */
11364 PL_in_load_module = proto_perl->Iin_load_module;
11366 /* sort() routine */
11367 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11369 /* Not really needed/useful since the reenrant_retint is "volatile",
11370 * but do it for consistency's sake. */
11371 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11373 /* Hooks to shared SVs and locks. */
11374 PL_sharehook = proto_perl->Isharehook;
11375 PL_lockhook = proto_perl->Ilockhook;
11376 PL_unlockhook = proto_perl->Iunlockhook;
11377 PL_threadhook = proto_perl->Ithreadhook;
11379 PL_runops_std = proto_perl->Irunops_std;
11380 PL_runops_dbg = proto_perl->Irunops_dbg;
11382 #ifdef THREADS_HAVE_PIDS
11383 PL_ppid = proto_perl->Ippid;
11387 PL_last_swash_hv = NULL; /* reinits on demand */
11388 PL_last_swash_klen = 0;
11389 PL_last_swash_key[0]= '\0';
11390 PL_last_swash_tmps = (U8*)NULL;
11391 PL_last_swash_slen = 0;
11393 PL_glob_index = proto_perl->Iglob_index;
11394 PL_srand_called = proto_perl->Isrand_called;
11395 PL_uudmap['M'] = 0; /* reinits on demand */
11396 PL_bitcount = NULL; /* reinits on demand */
11398 if (proto_perl->Ipsig_pend) {
11399 Newxz(PL_psig_pend, SIG_SIZE, int);
11402 PL_psig_pend = (int*)NULL;
11405 if (proto_perl->Ipsig_ptr) {
11406 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11407 Newxz(PL_psig_name, SIG_SIZE, SV*);
11408 for (i = 1; i < SIG_SIZE; i++) {
11409 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11410 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11414 PL_psig_ptr = (SV**)NULL;
11415 PL_psig_name = (SV**)NULL;
11418 /* thrdvar.h stuff */
11420 if (flags & CLONEf_COPY_STACKS) {
11421 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11422 PL_tmps_ix = proto_perl->Ttmps_ix;
11423 PL_tmps_max = proto_perl->Ttmps_max;
11424 PL_tmps_floor = proto_perl->Ttmps_floor;
11425 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11427 while (i <= PL_tmps_ix) {
11428 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11432 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11433 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11434 Newxz(PL_markstack, i, I32);
11435 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11436 - proto_perl->Tmarkstack);
11437 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11438 - proto_perl->Tmarkstack);
11439 Copy(proto_perl->Tmarkstack, PL_markstack,
11440 PL_markstack_ptr - PL_markstack + 1, I32);
11442 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11443 * NOTE: unlike the others! */
11444 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11445 PL_scopestack_max = proto_perl->Tscopestack_max;
11446 Newxz(PL_scopestack, PL_scopestack_max, I32);
11447 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11449 /* NOTE: si_dup() looks at PL_markstack */
11450 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11452 /* PL_curstack = PL_curstackinfo->si_stack; */
11453 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11454 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11456 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11457 PL_stack_base = AvARRAY(PL_curstack);
11458 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11459 - proto_perl->Tstack_base);
11460 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11462 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11463 * NOTE: unlike the others! */
11464 PL_savestack_ix = proto_perl->Tsavestack_ix;
11465 PL_savestack_max = proto_perl->Tsavestack_max;
11466 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11467 PL_savestack = ss_dup(proto_perl, param);
11471 ENTER; /* perl_destruct() wants to LEAVE; */
11473 /* although we're not duplicating the tmps stack, we should still
11474 * add entries for any SVs on the tmps stack that got cloned by a
11475 * non-refcount means (eg a temp in @_); otherwise they will be
11478 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11479 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11480 proto_perl->Ttmps_stack[i]);
11481 if (nsv && !SvREFCNT(nsv)) {
11483 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11488 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11489 PL_top_env = &PL_start_env;
11491 PL_op = proto_perl->Top;
11494 PL_Xpv = (XPV*)NULL;
11495 PL_na = proto_perl->Tna;
11497 PL_statbuf = proto_perl->Tstatbuf;
11498 PL_statcache = proto_perl->Tstatcache;
11499 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11500 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11502 PL_timesbuf = proto_perl->Ttimesbuf;
11505 PL_tainted = proto_perl->Ttainted;
11506 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11507 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11508 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11509 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11510 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11511 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11512 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11513 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11514 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11516 PL_restartop = proto_perl->Trestartop;
11517 PL_in_eval = proto_perl->Tin_eval;
11518 PL_delaymagic = proto_perl->Tdelaymagic;
11519 PL_dirty = proto_perl->Tdirty;
11520 PL_localizing = proto_perl->Tlocalizing;
11522 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11523 PL_hv_fetch_ent_mh = NULL;
11524 PL_modcount = proto_perl->Tmodcount;
11525 PL_lastgotoprobe = NULL;
11526 PL_dumpindent = proto_perl->Tdumpindent;
11528 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11529 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11530 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11531 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11532 PL_efloatbuf = NULL; /* reinits on demand */
11533 PL_efloatsize = 0; /* reinits on demand */
11537 PL_screamfirst = NULL;
11538 PL_screamnext = NULL;
11539 PL_maxscream = -1; /* reinits on demand */
11540 PL_lastscream = NULL;
11542 PL_watchaddr = NULL;
11545 PL_regdummy = proto_perl->Tregdummy;
11546 PL_colorset = 0; /* reinits PL_colors[] */
11547 /*PL_colors[6] = {0,0,0,0,0,0};*/
11549 /* RE engine - function pointers */
11550 PL_regcompp = proto_perl->Tregcompp;
11551 PL_regexecp = proto_perl->Tregexecp;
11552 PL_regint_start = proto_perl->Tregint_start;
11553 PL_regint_string = proto_perl->Tregint_string;
11554 PL_regfree = proto_perl->Tregfree;
11555 Zero(&PL_reg_state, 1, struct re_save_state);
11556 PL_reginterp_cnt = 0;
11557 PL_regmatch_slab = NULL;
11559 /* Pluggable optimizer */
11560 PL_peepp = proto_perl->Tpeepp;
11562 PL_stashcache = newHV();
11564 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11565 ptr_table_free(PL_ptr_table);
11566 PL_ptr_table = NULL;
11569 /* Call the ->CLONE method, if it exists, for each of the stashes
11570 identified by sv_dup() above.
11572 while(av_len(param->stashes) != -1) {
11573 HV* const stash = (HV*) av_shift(param->stashes);
11574 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11575 if (cloner && GvCV(cloner)) {
11580 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11582 call_sv((SV*)GvCV(cloner), G_DISCARD);
11588 SvREFCNT_dec(param->stashes);
11590 /* orphaned? eg threads->new inside BEGIN or use */
11591 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11592 SvREFCNT_inc_simple_void(PL_compcv);
11593 SAVEFREESV(PL_compcv);
11599 #endif /* USE_ITHREADS */
11602 =head1 Unicode Support
11604 =for apidoc sv_recode_to_utf8
11606 The encoding is assumed to be an Encode object, on entry the PV
11607 of the sv is assumed to be octets in that encoding, and the sv
11608 will be converted into Unicode (and UTF-8).
11610 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11611 is not a reference, nothing is done to the sv. If the encoding is not
11612 an C<Encode::XS> Encoding object, bad things will happen.
11613 (See F<lib/encoding.pm> and L<Encode>).
11615 The PV of the sv is returned.
11620 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11623 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11637 Passing sv_yes is wrong - it needs to be or'ed set of constants
11638 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11639 remove converted chars from source.
11641 Both will default the value - let them.
11643 XPUSHs(&PL_sv_yes);
11646 call_method("decode", G_SCALAR);
11650 s = SvPV_const(uni, len);
11651 if (s != SvPVX_const(sv)) {
11652 SvGROW(sv, len + 1);
11653 Move(s, SvPVX(sv), len + 1, char);
11654 SvCUR_set(sv, len);
11661 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11665 =for apidoc sv_cat_decode
11667 The encoding is assumed to be an Encode object, the PV of the ssv is
11668 assumed to be octets in that encoding and decoding the input starts
11669 from the position which (PV + *offset) pointed to. The dsv will be
11670 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11671 when the string tstr appears in decoding output or the input ends on
11672 the PV of the ssv. The value which the offset points will be modified
11673 to the last input position on the ssv.
11675 Returns TRUE if the terminator was found, else returns FALSE.
11680 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11681 SV *ssv, int *offset, char *tstr, int tlen)
11685 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11696 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11697 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11699 call_method("cat_decode", G_SCALAR);
11701 ret = SvTRUE(TOPs);
11702 *offset = SvIV(offsv);
11708 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11713 /* ---------------------------------------------------------------------
11715 * support functions for report_uninit()
11718 /* the maxiumum size of array or hash where we will scan looking
11719 * for the undefined element that triggered the warning */
11721 #define FUV_MAX_SEARCH_SIZE 1000
11723 /* Look for an entry in the hash whose value has the same SV as val;
11724 * If so, return a mortal copy of the key. */
11727 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11730 register HE **array;
11733 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11734 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11737 array = HvARRAY(hv);
11739 for (i=HvMAX(hv); i>0; i--) {
11740 register HE *entry;
11741 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11742 if (HeVAL(entry) != val)
11744 if ( HeVAL(entry) == &PL_sv_undef ||
11745 HeVAL(entry) == &PL_sv_placeholder)
11749 if (HeKLEN(entry) == HEf_SVKEY)
11750 return sv_mortalcopy(HeKEY_sv(entry));
11751 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11757 /* Look for an entry in the array whose value has the same SV as val;
11758 * If so, return the index, otherwise return -1. */
11761 S_find_array_subscript(pTHX_ AV *av, SV* val)
11764 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11765 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11768 if (val != &PL_sv_undef) {
11769 SV ** const svp = AvARRAY(av);
11772 for (i=AvFILLp(av); i>=0; i--)
11779 /* S_varname(): return the name of a variable, optionally with a subscript.
11780 * If gv is non-zero, use the name of that global, along with gvtype (one
11781 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11782 * targ. Depending on the value of the subscript_type flag, return:
11785 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11786 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11787 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11788 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11791 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11792 SV* keyname, I32 aindex, int subscript_type)
11795 SV * const name = sv_newmortal();
11798 buffer[0] = gvtype;
11801 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11803 gv_fullname4(name, gv, buffer, 0);
11805 if ((unsigned int)SvPVX(name)[1] <= 26) {
11807 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11809 /* Swap the 1 unprintable control character for the 2 byte pretty
11810 version - ie substr($name, 1, 1) = $buffer; */
11811 sv_insert(name, 1, 1, buffer, 2);
11816 CV * const cv = find_runcv(&unused);
11820 if (!cv || !CvPADLIST(cv))
11822 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11823 sv = *av_fetch(av, targ, FALSE);
11824 /* SvLEN in a pad name is not to be trusted */
11825 sv_setpv(name, SvPV_nolen_const(sv));
11828 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11829 SV * const sv = newSV(0);
11830 *SvPVX(name) = '$';
11831 Perl_sv_catpvf(aTHX_ name, "{%s}",
11832 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11835 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11836 *SvPVX(name) = '$';
11837 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11839 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11840 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11847 =for apidoc find_uninit_var
11849 Find the name of the undefined variable (if any) that caused the operator o
11850 to issue a "Use of uninitialized value" warning.
11851 If match is true, only return a name if it's value matches uninit_sv.
11852 So roughly speaking, if a unary operator (such as OP_COS) generates a
11853 warning, then following the direct child of the op may yield an
11854 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11855 other hand, with OP_ADD there are two branches to follow, so we only print
11856 the variable name if we get an exact match.
11858 The name is returned as a mortal SV.
11860 Assumes that PL_op is the op that originally triggered the error, and that
11861 PL_comppad/PL_curpad points to the currently executing pad.
11867 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11875 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11876 uninit_sv == &PL_sv_placeholder)))
11879 switch (obase->op_type) {
11886 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11887 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11890 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11892 if (pad) { /* @lex, %lex */
11893 sv = PAD_SVl(obase->op_targ);
11897 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11898 /* @global, %global */
11899 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11902 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11904 else /* @{expr}, %{expr} */
11905 return find_uninit_var(cUNOPx(obase)->op_first,
11909 /* attempt to find a match within the aggregate */
11911 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11913 subscript_type = FUV_SUBSCRIPT_HASH;
11916 index = find_array_subscript((AV*)sv, uninit_sv);
11918 subscript_type = FUV_SUBSCRIPT_ARRAY;
11921 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11924 return varname(gv, hash ? '%' : '@', obase->op_targ,
11925 keysv, index, subscript_type);
11929 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11931 return varname(NULL, '$', obase->op_targ,
11932 NULL, 0, FUV_SUBSCRIPT_NONE);
11935 gv = cGVOPx_gv(obase);
11936 if (!gv || (match && GvSV(gv) != uninit_sv))
11938 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11941 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11944 av = (AV*)PAD_SV(obase->op_targ);
11945 if (!av || SvRMAGICAL(av))
11947 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11948 if (!svp || *svp != uninit_sv)
11951 return varname(NULL, '$', obase->op_targ,
11952 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11955 gv = cGVOPx_gv(obase);
11961 if (!av || SvRMAGICAL(av))
11963 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11964 if (!svp || *svp != uninit_sv)
11967 return varname(gv, '$', 0,
11968 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11973 o = cUNOPx(obase)->op_first;
11974 if (!o || o->op_type != OP_NULL ||
11975 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11977 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11981 if (PL_op == obase)
11982 /* $a[uninit_expr] or $h{uninit_expr} */
11983 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11986 o = cBINOPx(obase)->op_first;
11987 kid = cBINOPx(obase)->op_last;
11989 /* get the av or hv, and optionally the gv */
11991 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11992 sv = PAD_SV(o->op_targ);
11994 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11995 && cUNOPo->op_first->op_type == OP_GV)
11997 gv = cGVOPx_gv(cUNOPo->op_first);
12000 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12005 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12006 /* index is constant */
12010 if (obase->op_type == OP_HELEM) {
12011 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12012 if (!he || HeVAL(he) != uninit_sv)
12016 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12017 if (!svp || *svp != uninit_sv)
12021 if (obase->op_type == OP_HELEM)
12022 return varname(gv, '%', o->op_targ,
12023 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12025 return varname(gv, '@', o->op_targ, NULL,
12026 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12029 /* index is an expression;
12030 * attempt to find a match within the aggregate */
12031 if (obase->op_type == OP_HELEM) {
12032 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12034 return varname(gv, '%', o->op_targ,
12035 keysv, 0, FUV_SUBSCRIPT_HASH);
12038 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12040 return varname(gv, '@', o->op_targ,
12041 NULL, index, FUV_SUBSCRIPT_ARRAY);
12046 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12048 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12053 /* only examine RHS */
12054 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12057 o = cUNOPx(obase)->op_first;
12058 if (o->op_type == OP_PUSHMARK)
12061 if (!o->op_sibling) {
12062 /* one-arg version of open is highly magical */
12064 if (o->op_type == OP_GV) { /* open FOO; */
12066 if (match && GvSV(gv) != uninit_sv)
12068 return varname(gv, '$', 0,
12069 NULL, 0, FUV_SUBSCRIPT_NONE);
12071 /* other possibilities not handled are:
12072 * open $x; or open my $x; should return '${*$x}'
12073 * open expr; should return '$'.expr ideally
12079 /* ops where $_ may be an implicit arg */
12083 if ( !(obase->op_flags & OPf_STACKED)) {
12084 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12085 ? PAD_SVl(obase->op_targ)
12088 sv = sv_newmortal();
12089 sv_setpvn(sv, "$_", 2);
12097 /* skip filehandle as it can't produce 'undef' warning */
12098 o = cUNOPx(obase)->op_first;
12099 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12100 o = o->op_sibling->op_sibling;
12107 match = 1; /* XS or custom code could trigger random warnings */
12112 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12113 return sv_2mortal(newSVpvs("${$/}"));
12118 if (!(obase->op_flags & OPf_KIDS))
12120 o = cUNOPx(obase)->op_first;
12126 /* if all except one arg are constant, or have no side-effects,
12127 * or are optimized away, then it's unambiguous */
12129 for (kid=o; kid; kid = kid->op_sibling) {
12131 const OPCODE type = kid->op_type;
12132 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12133 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12134 || (type == OP_PUSHMARK)
12138 if (o2) { /* more than one found */
12145 return find_uninit_var(o2, uninit_sv, match);
12147 /* scan all args */
12149 sv = find_uninit_var(o, uninit_sv, 1);
12161 =for apidoc report_uninit
12163 Print appropriate "Use of uninitialized variable" warning
12169 Perl_report_uninit(pTHX_ SV* uninit_sv)
12173 SV* varname = NULL;
12175 varname = find_uninit_var(PL_op, uninit_sv,0);
12177 sv_insert(varname, 0, 0, " ", 1);
12179 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12180 varname ? SvPV_nolen_const(varname) : "",
12181 " in ", OP_DESC(PL_op));
12184 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12190 * c-indentation-style: bsd
12191 * c-basic-offset: 4
12192 * indent-tabs-mode: t
12195 * ex: set ts=8 sts=4 sw=4 noet: