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)
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);
1052 if (!done_sanity_check) {
1053 unsigned int i = SVt_LAST;
1055 done_sanity_check = TRUE;
1058 assert (bodies_by_type[i].type == i);
1062 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1064 end = start + bdp->arena_size - body_size;
1066 /* computed count doesnt reflect the 1st slot reservation */
1067 DEBUG_m(PerlIO_printf(Perl_debug_log,
1068 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1070 (int)bdp->arena_size, sv_type, (int)body_size,
1071 (int)bdp->arena_size / (int)body_size));
1073 *root = (void *)start;
1075 while (start < end) {
1076 char * const next = start + body_size;
1077 *(void**) start = (void *)next;
1080 *(void **)start = 0;
1085 /* grab a new thing from the free list, allocating more if necessary.
1086 The inline version is used for speed in hot routines, and the
1087 function using it serves the rest (unless PURIFY).
1089 #define new_body_inline(xpv, sv_type) \
1091 void ** const r3wt = &PL_body_roots[sv_type]; \
1093 xpv = *((void **)(r3wt)) \
1094 ? *((void **)(r3wt)) : more_bodies(sv_type); \
1095 *(r3wt) = *(void**)(xpv); \
1102 S_new_body(pTHX_ svtype sv_type)
1106 new_body_inline(xpv, sv_type);
1113 =for apidoc sv_upgrade
1115 Upgrade an SV to a more complex form. Generally adds a new body type to the
1116 SV, then copies across as much information as possible from the old body.
1117 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1123 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1128 const U32 old_type = SvTYPE(sv);
1129 const struct body_details *new_type_details;
1130 const struct body_details *const old_type_details
1131 = bodies_by_type + old_type;
1133 if (new_type != SVt_PV && SvIsCOW(sv)) {
1134 sv_force_normal_flags(sv, 0);
1137 if (old_type == new_type)
1140 if (old_type > new_type)
1141 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1142 (int)old_type, (int)new_type);
1145 old_body = SvANY(sv);
1147 /* Copying structures onto other structures that have been neatly zeroed
1148 has a subtle gotcha. Consider XPVMG
1150 +------+------+------+------+------+-------+-------+
1151 | NV | CUR | LEN | IV | MAGIC | STASH |
1152 +------+------+------+------+------+-------+-------+
1153 0 4 8 12 16 20 24 28
1155 where NVs are aligned to 8 bytes, so that sizeof that structure is
1156 actually 32 bytes long, with 4 bytes of padding at the end:
1158 +------+------+------+------+------+-------+-------+------+
1159 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1160 +------+------+------+------+------+-------+-------+------+
1161 0 4 8 12 16 20 24 28 32
1163 so what happens if you allocate memory for this structure:
1165 +------+------+------+------+------+-------+-------+------+------+...
1166 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 0 4 8 12 16 20 24 28 32 36
1170 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1171 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1172 started out as zero once, but it's quite possible that it isn't. So now,
1173 rather than a nicely zeroed GP, you have it pointing somewhere random.
1176 (In fact, GP ends up pointing at a previous GP structure, because the
1177 principle cause of the padding in XPVMG getting garbage is a copy of
1178 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1180 So we are careful and work out the size of used parts of all the
1187 if (new_type < SVt_PVIV) {
1188 new_type = (new_type == SVt_NV)
1189 ? SVt_PVNV : SVt_PVIV;
1193 if (new_type < SVt_PVNV) {
1194 new_type = SVt_PVNV;
1200 assert(new_type > SVt_PV);
1201 assert(SVt_IV < SVt_PV);
1202 assert(SVt_NV < SVt_PV);
1209 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1210 there's no way that it can be safely upgraded, because perl.c
1211 expects to Safefree(SvANY(PL_mess_sv)) */
1212 assert(sv != PL_mess_sv);
1213 /* This flag bit is used to mean other things in other scalar types.
1214 Given that it only has meaning inside the pad, it shouldn't be set
1215 on anything that can get upgraded. */
1216 assert(!SvPAD_TYPED(sv));
1219 if (old_type_details->cant_upgrade)
1220 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1221 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1223 new_type_details = bodies_by_type + new_type;
1225 SvFLAGS(sv) &= ~SVTYPEMASK;
1226 SvFLAGS(sv) |= new_type;
1228 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1229 the return statements above will have triggered. */
1230 assert (new_type != SVt_NULL);
1233 assert(old_type == SVt_NULL);
1234 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1238 assert(old_type == SVt_NULL);
1239 SvANY(sv) = new_XNV();
1243 assert(old_type == SVt_NULL);
1244 SvANY(sv) = &sv->sv_u.svu_rv;
1249 assert(new_type_details->body_size);
1252 assert(new_type_details->arena);
1253 assert(new_type_details->arena_size);
1254 /* This points to the start of the allocated area. */
1255 new_body_inline(new_body, new_type);
1256 Zero(new_body, new_type_details->body_size, char);
1257 new_body = ((char *)new_body) - new_type_details->offset;
1259 /* We always allocated the full length item with PURIFY. To do this
1260 we fake things so that arena is false for all 16 types.. */
1261 new_body = new_NOARENAZ(new_type_details);
1263 SvANY(sv) = new_body;
1264 if (new_type == SVt_PVAV) {
1270 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1271 The target created by newSVrv also is, and it can have magic.
1272 However, it never has SvPVX set.
1274 if (old_type >= SVt_RV) {
1275 assert(SvPVX_const(sv) == 0);
1278 /* Could put this in the else clause below, as PVMG must have SvPVX
1279 0 already (the assertion above) */
1282 if (old_type >= SVt_PVMG) {
1283 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1284 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1290 /* XXX Is this still needed? Was it ever needed? Surely as there is
1291 no route from NV to PVIV, NOK can never be true */
1292 assert(!SvNOKp(sv));
1304 assert(new_type_details->body_size);
1305 /* We always allocated the full length item with PURIFY. To do this
1306 we fake things so that arena is false for all 16 types.. */
1307 if(new_type_details->arena) {
1308 /* This points to the start of the allocated area. */
1309 new_body_inline(new_body, new_type);
1310 Zero(new_body, new_type_details->body_size, char);
1311 new_body = ((char *)new_body) - new_type_details->offset;
1313 new_body = new_NOARENAZ(new_type_details);
1315 SvANY(sv) = new_body;
1317 if (old_type_details->copy) {
1318 /* There is now the potential for an upgrade from something without
1319 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1320 int offset = old_type_details->offset;
1321 int length = old_type_details->copy;
1323 if (new_type_details->offset > old_type_details->offset) {
1324 const int difference
1325 = new_type_details->offset - old_type_details->offset;
1326 offset += difference;
1327 length -= difference;
1329 assert (length >= 0);
1331 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1335 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1336 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1337 * correct 0.0 for us. Otherwise, if the old body didn't have an
1338 * NV slot, but the new one does, then we need to initialise the
1339 * freshly created NV slot with whatever the correct bit pattern is
1341 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1345 if (new_type == SVt_PVIO)
1346 IoPAGE_LEN(sv) = 60;
1347 if (old_type < SVt_RV)
1351 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1352 (unsigned long)new_type);
1355 if (old_type_details->arena) {
1356 /* If there was an old body, then we need to free it.
1357 Note that there is an assumption that all bodies of types that
1358 can be upgraded came from arenas. Only the more complex non-
1359 upgradable types are allowed to be directly malloc()ed. */
1361 my_safefree(old_body);
1363 del_body((void*)((char*)old_body + old_type_details->offset),
1364 &PL_body_roots[old_type]);
1370 =for apidoc sv_backoff
1372 Remove any string offset. You should normally use the C<SvOOK_off> macro
1379 Perl_sv_backoff(pTHX_ register SV *sv)
1381 PERL_UNUSED_CONTEXT;
1383 assert(SvTYPE(sv) != SVt_PVHV);
1384 assert(SvTYPE(sv) != SVt_PVAV);
1386 const char * const s = SvPVX_const(sv);
1387 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1388 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1390 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1392 SvFLAGS(sv) &= ~SVf_OOK;
1399 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1400 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1401 Use the C<SvGROW> wrapper instead.
1407 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1411 if (PL_madskills && newlen >= 0x100000) {
1412 PerlIO_printf(Perl_debug_log,
1413 "Allocation too large: %"UVxf"\n", (UV)newlen);
1415 #ifdef HAS_64K_LIMIT
1416 if (newlen >= 0x10000) {
1417 PerlIO_printf(Perl_debug_log,
1418 "Allocation too large: %"UVxf"\n", (UV)newlen);
1421 #endif /* HAS_64K_LIMIT */
1424 if (SvTYPE(sv) < SVt_PV) {
1425 sv_upgrade(sv, SVt_PV);
1426 s = SvPVX_mutable(sv);
1428 else if (SvOOK(sv)) { /* pv is offset? */
1430 s = SvPVX_mutable(sv);
1431 if (newlen > SvLEN(sv))
1432 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1433 #ifdef HAS_64K_LIMIT
1434 if (newlen >= 0x10000)
1439 s = SvPVX_mutable(sv);
1441 if (newlen > SvLEN(sv)) { /* need more room? */
1442 newlen = PERL_STRLEN_ROUNDUP(newlen);
1443 if (SvLEN(sv) && s) {
1445 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1451 s = saferealloc(s, newlen);
1454 s = safemalloc(newlen);
1455 if (SvPVX_const(sv) && SvCUR(sv)) {
1456 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1460 SvLEN_set(sv, newlen);
1466 =for apidoc sv_setiv
1468 Copies an integer into the given SV, upgrading first if necessary.
1469 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1475 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1478 SV_CHECK_THINKFIRST_COW_DROP(sv);
1479 switch (SvTYPE(sv)) {
1481 sv_upgrade(sv, SVt_IV);
1484 sv_upgrade(sv, SVt_PVNV);
1488 sv_upgrade(sv, SVt_PVIV);
1497 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1500 (void)SvIOK_only(sv); /* validate number */
1506 =for apidoc sv_setiv_mg
1508 Like C<sv_setiv>, but also handles 'set' magic.
1514 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1521 =for apidoc sv_setuv
1523 Copies an unsigned integer into the given SV, upgrading first if necessary.
1524 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1530 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1532 /* With these two if statements:
1533 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1536 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1538 If you wish to remove them, please benchmark to see what the effect is
1540 if (u <= (UV)IV_MAX) {
1541 sv_setiv(sv, (IV)u);
1550 =for apidoc sv_setuv_mg
1552 Like C<sv_setuv>, but also handles 'set' magic.
1558 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1567 =for apidoc sv_setnv
1569 Copies a double into the given SV, upgrading first if necessary.
1570 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1576 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1579 SV_CHECK_THINKFIRST_COW_DROP(sv);
1580 switch (SvTYPE(sv)) {
1583 sv_upgrade(sv, SVt_NV);
1588 sv_upgrade(sv, SVt_PVNV);
1597 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1601 (void)SvNOK_only(sv); /* validate number */
1606 =for apidoc sv_setnv_mg
1608 Like C<sv_setnv>, but also handles 'set' magic.
1614 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1620 /* Print an "isn't numeric" warning, using a cleaned-up,
1621 * printable version of the offending string
1625 S_not_a_number(pTHX_ SV *sv)
1633 dsv = sv_2mortal(newSVpvs(""));
1634 pv = sv_uni_display(dsv, sv, 10, 0);
1637 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1638 /* each *s can expand to 4 chars + "...\0",
1639 i.e. need room for 8 chars */
1641 const char *s = SvPVX_const(sv);
1642 const char * const end = s + SvCUR(sv);
1643 for ( ; s < end && d < limit; s++ ) {
1645 if (ch & 128 && !isPRINT_LC(ch)) {
1654 else if (ch == '\r') {
1658 else if (ch == '\f') {
1662 else if (ch == '\\') {
1666 else if (ch == '\0') {
1670 else if (isPRINT_LC(ch))
1687 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1688 "Argument \"%s\" isn't numeric in %s", pv,
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric", pv);
1696 =for apidoc looks_like_number
1698 Test if the content of an SV looks like a number (or is a number).
1699 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1700 non-numeric warning), even if your atof() doesn't grok them.
1706 Perl_looks_like_number(pTHX_ SV *sv)
1708 register const char *sbegin;
1712 sbegin = SvPVX_const(sv);
1715 else if (SvPOKp(sv))
1716 sbegin = SvPV_const(sv, len);
1718 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1719 return grok_number(sbegin, len, NULL);
1723 S_glob_2number(pTHX_ GV * const gv)
1725 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1726 SV *const buffer = sv_newmortal();
1728 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1731 gv_efullname3(buffer, gv, "*");
1732 SvFLAGS(gv) |= wasfake;
1734 /* We know that all GVs stringify to something that is not-a-number,
1735 so no need to test that. */
1736 if (ckWARN(WARN_NUMERIC))
1737 not_a_number(buffer);
1738 /* We just want something true to return, so that S_sv_2iuv_common
1739 can tail call us and return true. */
1744 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1746 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1747 SV *const buffer = sv_newmortal();
1749 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1752 gv_efullname3(buffer, gv, "*");
1753 SvFLAGS(gv) |= wasfake;
1755 assert(SvPOK(buffer));
1757 *len = SvCUR(buffer);
1759 return SvPVX(buffer);
1762 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1763 until proven guilty, assume that things are not that bad... */
1768 As 64 bit platforms often have an NV that doesn't preserve all bits of
1769 an IV (an assumption perl has been based on to date) it becomes necessary
1770 to remove the assumption that the NV always carries enough precision to
1771 recreate the IV whenever needed, and that the NV is the canonical form.
1772 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1773 precision as a side effect of conversion (which would lead to insanity
1774 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1775 1) to distinguish between IV/UV/NV slots that have cached a valid
1776 conversion where precision was lost and IV/UV/NV slots that have a
1777 valid conversion which has lost no precision
1778 2) to ensure that if a numeric conversion to one form is requested that
1779 would lose precision, the precise conversion (or differently
1780 imprecise conversion) is also performed and cached, to prevent
1781 requests for different numeric formats on the same SV causing
1782 lossy conversion chains. (lossless conversion chains are perfectly
1787 SvIOKp is true if the IV slot contains a valid value
1788 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1789 SvNOKp is true if the NV slot contains a valid value
1790 SvNOK is true only if the NV value is accurate
1793 while converting from PV to NV, check to see if converting that NV to an
1794 IV(or UV) would lose accuracy over a direct conversion from PV to
1795 IV(or UV). If it would, cache both conversions, return NV, but mark
1796 SV as IOK NOKp (ie not NOK).
1798 While converting from PV to IV, check to see if converting that IV to an
1799 NV would lose accuracy over a direct conversion from PV to NV. If it
1800 would, cache both conversions, flag similarly.
1802 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1803 correctly because if IV & NV were set NV *always* overruled.
1804 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1805 changes - now IV and NV together means that the two are interchangeable:
1806 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1808 The benefit of this is that operations such as pp_add know that if
1809 SvIOK is true for both left and right operands, then integer addition
1810 can be used instead of floating point (for cases where the result won't
1811 overflow). Before, floating point was always used, which could lead to
1812 loss of precision compared with integer addition.
1814 * making IV and NV equal status should make maths accurate on 64 bit
1816 * may speed up maths somewhat if pp_add and friends start to use
1817 integers when possible instead of fp. (Hopefully the overhead in
1818 looking for SvIOK and checking for overflow will not outweigh the
1819 fp to integer speedup)
1820 * will slow down integer operations (callers of SvIV) on "inaccurate"
1821 values, as the change from SvIOK to SvIOKp will cause a call into
1822 sv_2iv each time rather than a macro access direct to the IV slot
1823 * should speed up number->string conversion on integers as IV is
1824 favoured when IV and NV are equally accurate
1826 ####################################################################
1827 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1828 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1829 On the other hand, SvUOK is true iff UV.
1830 ####################################################################
1832 Your mileage will vary depending your CPU's relative fp to integer
1836 #ifndef NV_PRESERVES_UV
1837 # define IS_NUMBER_UNDERFLOW_IV 1
1838 # define IS_NUMBER_UNDERFLOW_UV 2
1839 # define IS_NUMBER_IV_AND_UV 2
1840 # define IS_NUMBER_OVERFLOW_IV 4
1841 # define IS_NUMBER_OVERFLOW_UV 5
1843 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1845 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1847 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1850 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));
1851 if (SvNVX(sv) < (NV)IV_MIN) {
1852 (void)SvIOKp_on(sv);
1854 SvIV_set(sv, IV_MIN);
1855 return IS_NUMBER_UNDERFLOW_IV;
1857 if (SvNVX(sv) > (NV)UV_MAX) {
1858 (void)SvIOKp_on(sv);
1861 SvUV_set(sv, UV_MAX);
1862 return IS_NUMBER_OVERFLOW_UV;
1864 (void)SvIOKp_on(sv);
1866 /* Can't use strtol etc to convert this string. (See truth table in
1868 if (SvNVX(sv) <= (UV)IV_MAX) {
1869 SvIV_set(sv, I_V(SvNVX(sv)));
1870 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1871 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1873 /* Integer is imprecise. NOK, IOKp */
1875 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1878 SvUV_set(sv, U_V(SvNVX(sv)));
1879 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1880 if (SvUVX(sv) == UV_MAX) {
1881 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1882 possibly be preserved by NV. Hence, it must be overflow.
1884 return IS_NUMBER_OVERFLOW_UV;
1886 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1888 /* Integer is imprecise. NOK, IOKp */
1890 return IS_NUMBER_OVERFLOW_IV;
1892 #endif /* !NV_PRESERVES_UV*/
1895 S_sv_2iuv_common(pTHX_ SV *sv) {
1898 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1899 * without also getting a cached IV/UV from it at the same time
1900 * (ie PV->NV conversion should detect loss of accuracy and cache
1901 * IV or UV at same time to avoid this. */
1902 /* IV-over-UV optimisation - choose to cache IV if possible */
1904 if (SvTYPE(sv) == SVt_NV)
1905 sv_upgrade(sv, SVt_PVNV);
1907 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1908 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1909 certainly cast into the IV range at IV_MAX, whereas the correct
1910 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1912 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1913 if (Perl_isnan(SvNVX(sv))) {
1919 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1920 SvIV_set(sv, I_V(SvNVX(sv)));
1921 if (SvNVX(sv) == (NV) SvIVX(sv)
1922 #ifndef NV_PRESERVES_UV
1923 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1924 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1925 /* Don't flag it as "accurately an integer" if the number
1926 came from a (by definition imprecise) NV operation, and
1927 we're outside the range of NV integer precision */
1930 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1931 DEBUG_c(PerlIO_printf(Perl_debug_log,
1932 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1938 /* IV not precise. No need to convert from PV, as NV
1939 conversion would already have cached IV if it detected
1940 that PV->IV would be better than PV->NV->IV
1941 flags already correct - don't set public IOK. */
1942 DEBUG_c(PerlIO_printf(Perl_debug_log,
1943 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1948 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1949 but the cast (NV)IV_MIN rounds to a the value less (more
1950 negative) than IV_MIN which happens to be equal to SvNVX ??
1951 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1952 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1953 (NV)UVX == NVX are both true, but the values differ. :-(
1954 Hopefully for 2s complement IV_MIN is something like
1955 0x8000000000000000 which will be exact. NWC */
1958 SvUV_set(sv, U_V(SvNVX(sv)));
1960 (SvNVX(sv) == (NV) SvUVX(sv))
1961 #ifndef NV_PRESERVES_UV
1962 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1963 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1964 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1965 /* Don't flag it as "accurately an integer" if the number
1966 came from a (by definition imprecise) NV operation, and
1967 we're outside the range of NV integer precision */
1972 DEBUG_c(PerlIO_printf(Perl_debug_log,
1973 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1979 else if (SvPOKp(sv) && SvLEN(sv)) {
1981 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1982 /* We want to avoid a possible problem when we cache an IV/ a UV which
1983 may be later translated to an NV, and the resulting NV is not
1984 the same as the direct translation of the initial string
1985 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1986 be careful to ensure that the value with the .456 is around if the
1987 NV value is requested in the future).
1989 This means that if we cache such an IV/a UV, we need to cache the
1990 NV as well. Moreover, we trade speed for space, and do not
1991 cache the NV if we are sure it's not needed.
1994 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1995 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1996 == IS_NUMBER_IN_UV) {
1997 /* It's definitely an integer, only upgrade to PVIV */
1998 if (SvTYPE(sv) < SVt_PVIV)
1999 sv_upgrade(sv, SVt_PVIV);
2001 } else if (SvTYPE(sv) < SVt_PVNV)
2002 sv_upgrade(sv, SVt_PVNV);
2004 /* If NVs preserve UVs then we only use the UV value if we know that
2005 we aren't going to call atof() below. If NVs don't preserve UVs
2006 then the value returned may have more precision than atof() will
2007 return, even though value isn't perfectly accurate. */
2008 if ((numtype & (IS_NUMBER_IN_UV
2009 #ifdef NV_PRESERVES_UV
2012 )) == IS_NUMBER_IN_UV) {
2013 /* This won't turn off the public IOK flag if it was set above */
2014 (void)SvIOKp_on(sv);
2016 if (!(numtype & IS_NUMBER_NEG)) {
2018 if (value <= (UV)IV_MAX) {
2019 SvIV_set(sv, (IV)value);
2021 /* it didn't overflow, and it was positive. */
2022 SvUV_set(sv, value);
2026 /* 2s complement assumption */
2027 if (value <= (UV)IV_MIN) {
2028 SvIV_set(sv, -(IV)value);
2030 /* Too negative for an IV. This is a double upgrade, but
2031 I'm assuming it will be rare. */
2032 if (SvTYPE(sv) < SVt_PVNV)
2033 sv_upgrade(sv, SVt_PVNV);
2037 SvNV_set(sv, -(NV)value);
2038 SvIV_set(sv, IV_MIN);
2042 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2043 will be in the previous block to set the IV slot, and the next
2044 block to set the NV slot. So no else here. */
2046 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2047 != IS_NUMBER_IN_UV) {
2048 /* It wasn't an (integer that doesn't overflow the UV). */
2049 SvNV_set(sv, Atof(SvPVX_const(sv)));
2051 if (! numtype && ckWARN(WARN_NUMERIC))
2054 #if defined(USE_LONG_DOUBLE)
2055 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2056 PTR2UV(sv), SvNVX(sv)));
2058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2059 PTR2UV(sv), SvNVX(sv)));
2062 #ifdef NV_PRESERVES_UV
2063 (void)SvIOKp_on(sv);
2065 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2066 SvIV_set(sv, I_V(SvNVX(sv)));
2067 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2070 NOOP; /* Integer is imprecise. NOK, IOKp */
2072 /* UV will not work better than IV */
2074 if (SvNVX(sv) > (NV)UV_MAX) {
2076 /* Integer is inaccurate. NOK, IOKp, is UV */
2077 SvUV_set(sv, UV_MAX);
2079 SvUV_set(sv, U_V(SvNVX(sv)));
2080 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2081 NV preservse UV so can do correct comparison. */
2082 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2085 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2090 #else /* NV_PRESERVES_UV */
2091 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2092 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2093 /* The IV/UV slot will have been set from value returned by
2094 grok_number above. The NV slot has just been set using
2097 assert (SvIOKp(sv));
2099 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2100 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2101 /* Small enough to preserve all bits. */
2102 (void)SvIOKp_on(sv);
2104 SvIV_set(sv, I_V(SvNVX(sv)));
2105 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2107 /* Assumption: first non-preserved integer is < IV_MAX,
2108 this NV is in the preserved range, therefore: */
2109 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2111 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);
2115 0 0 already failed to read UV.
2116 0 1 already failed to read UV.
2117 1 0 you won't get here in this case. IV/UV
2118 slot set, public IOK, Atof() unneeded.
2119 1 1 already read UV.
2120 so there's no point in sv_2iuv_non_preserve() attempting
2121 to use atol, strtol, strtoul etc. */
2122 sv_2iuv_non_preserve (sv, numtype);
2125 #endif /* NV_PRESERVES_UV */
2129 if (isGV_with_GP(sv))
2130 return glob_2number((GV *)sv);
2132 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2133 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2136 if (SvTYPE(sv) < SVt_IV)
2137 /* Typically the caller expects that sv_any is not NULL now. */
2138 sv_upgrade(sv, SVt_IV);
2139 /* Return 0 from the caller. */
2146 =for apidoc sv_2iv_flags
2148 Return the integer value of an SV, doing any necessary string
2149 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2150 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2156 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2161 if (SvGMAGICAL(sv)) {
2162 if (flags & SV_GMAGIC)
2167 return I_V(SvNVX(sv));
2169 if (SvPOKp(sv) && SvLEN(sv)) {
2172 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2174 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2175 == IS_NUMBER_IN_UV) {
2176 /* It's definitely an integer */
2177 if (numtype & IS_NUMBER_NEG) {
2178 if (value < (UV)IV_MIN)
2181 if (value < (UV)IV_MAX)
2186 if (ckWARN(WARN_NUMERIC))
2189 return I_V(Atof(SvPVX_const(sv)));
2194 assert(SvTYPE(sv) >= SVt_PVMG);
2195 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2196 } else if (SvTHINKFIRST(sv)) {
2200 SV * const tmpstr=AMG_CALLun(sv,numer);
2201 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2202 return SvIV(tmpstr);
2205 return PTR2IV(SvRV(sv));
2208 sv_force_normal_flags(sv, 0);
2210 if (SvREADONLY(sv) && !SvOK(sv)) {
2211 if (ckWARN(WARN_UNINITIALIZED))
2217 if (S_sv_2iuv_common(aTHX_ sv))
2220 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2221 PTR2UV(sv),SvIVX(sv)));
2222 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2226 =for apidoc sv_2uv_flags
2228 Return the unsigned integer value of an SV, doing any necessary string
2229 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2230 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2236 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2241 if (SvGMAGICAL(sv)) {
2242 if (flags & SV_GMAGIC)
2247 return U_V(SvNVX(sv));
2248 if (SvPOKp(sv) && SvLEN(sv)) {
2251 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2253 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2254 == IS_NUMBER_IN_UV) {
2255 /* It's definitely an integer */
2256 if (!(numtype & IS_NUMBER_NEG))
2260 if (ckWARN(WARN_NUMERIC))
2263 return U_V(Atof(SvPVX_const(sv)));
2268 assert(SvTYPE(sv) >= SVt_PVMG);
2269 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2270 } else if (SvTHINKFIRST(sv)) {
2274 SV *const tmpstr = AMG_CALLun(sv,numer);
2275 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2276 return SvUV(tmpstr);
2279 return PTR2UV(SvRV(sv));
2282 sv_force_normal_flags(sv, 0);
2284 if (SvREADONLY(sv) && !SvOK(sv)) {
2285 if (ckWARN(WARN_UNINITIALIZED))
2291 if (S_sv_2iuv_common(aTHX_ sv))
2295 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2296 PTR2UV(sv),SvUVX(sv)));
2297 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2303 Return the num value of an SV, doing any necessary string or integer
2304 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2311 Perl_sv_2nv(pTHX_ register SV *sv)
2316 if (SvGMAGICAL(sv)) {
2320 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2321 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2322 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2324 return Atof(SvPVX_const(sv));
2328 return (NV)SvUVX(sv);
2330 return (NV)SvIVX(sv);
2335 assert(SvTYPE(sv) >= SVt_PVMG);
2336 /* This falls through to the report_uninit near the end of the
2338 } else if (SvTHINKFIRST(sv)) {
2342 SV *const tmpstr = AMG_CALLun(sv,numer);
2343 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2344 return SvNV(tmpstr);
2347 return PTR2NV(SvRV(sv));
2350 sv_force_normal_flags(sv, 0);
2352 if (SvREADONLY(sv) && !SvOK(sv)) {
2353 if (ckWARN(WARN_UNINITIALIZED))
2358 if (SvTYPE(sv) < SVt_NV) {
2359 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2360 sv_upgrade(sv, SVt_NV);
2361 #ifdef USE_LONG_DOUBLE
2363 STORE_NUMERIC_LOCAL_SET_STANDARD();
2364 PerlIO_printf(Perl_debug_log,
2365 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2366 PTR2UV(sv), SvNVX(sv));
2367 RESTORE_NUMERIC_LOCAL();
2371 STORE_NUMERIC_LOCAL_SET_STANDARD();
2372 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2373 PTR2UV(sv), SvNVX(sv));
2374 RESTORE_NUMERIC_LOCAL();
2378 else if (SvTYPE(sv) < SVt_PVNV)
2379 sv_upgrade(sv, SVt_PVNV);
2384 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2385 #ifdef NV_PRESERVES_UV
2388 /* Only set the public NV OK flag if this NV preserves the IV */
2389 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2390 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2391 : (SvIVX(sv) == I_V(SvNVX(sv))))
2397 else if (SvPOKp(sv) && SvLEN(sv)) {
2399 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2400 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2402 #ifdef NV_PRESERVES_UV
2403 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2404 == IS_NUMBER_IN_UV) {
2405 /* It's definitely an integer */
2406 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2408 SvNV_set(sv, Atof(SvPVX_const(sv)));
2411 SvNV_set(sv, Atof(SvPVX_const(sv)));
2412 /* Only set the public NV OK flag if this NV preserves the value in
2413 the PV at least as well as an IV/UV would.
2414 Not sure how to do this 100% reliably. */
2415 /* if that shift count is out of range then Configure's test is
2416 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2418 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2419 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2420 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2421 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2422 /* Can't use strtol etc to convert this string, so don't try.
2423 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2426 /* value has been set. It may not be precise. */
2427 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2428 /* 2s complement assumption for (UV)IV_MIN */
2429 SvNOK_on(sv); /* Integer is too negative. */
2434 if (numtype & IS_NUMBER_NEG) {
2435 SvIV_set(sv, -(IV)value);
2436 } else if (value <= (UV)IV_MAX) {
2437 SvIV_set(sv, (IV)value);
2439 SvUV_set(sv, value);
2443 if (numtype & IS_NUMBER_NOT_INT) {
2444 /* I believe that even if the original PV had decimals,
2445 they are lost beyond the limit of the FP precision.
2446 However, neither is canonical, so both only get p
2447 flags. NWC, 2000/11/25 */
2448 /* Both already have p flags, so do nothing */
2450 const NV nv = SvNVX(sv);
2451 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2452 if (SvIVX(sv) == I_V(nv)) {
2455 /* It had no "." so it must be integer. */
2459 /* between IV_MAX and NV(UV_MAX).
2460 Could be slightly > UV_MAX */
2462 if (numtype & IS_NUMBER_NOT_INT) {
2463 /* UV and NV both imprecise. */
2465 const UV nv_as_uv = U_V(nv);
2467 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2476 #endif /* NV_PRESERVES_UV */
2479 if (isGV_with_GP(sv)) {
2480 glob_2number((GV *)sv);
2484 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2486 assert (SvTYPE(sv) >= SVt_NV);
2487 /* Typically the caller expects that sv_any is not NULL now. */
2488 /* XXX Ilya implies that this is a bug in callers that assume this
2489 and ideally should be fixed. */
2492 #if defined(USE_LONG_DOUBLE)
2494 STORE_NUMERIC_LOCAL_SET_STANDARD();
2495 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2496 PTR2UV(sv), SvNVX(sv));
2497 RESTORE_NUMERIC_LOCAL();
2501 STORE_NUMERIC_LOCAL_SET_STANDARD();
2502 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2503 PTR2UV(sv), SvNVX(sv));
2504 RESTORE_NUMERIC_LOCAL();
2510 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2511 * UV as a string towards the end of buf, and return pointers to start and
2514 * We assume that buf is at least TYPE_CHARS(UV) long.
2518 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2520 char *ptr = buf + TYPE_CHARS(UV);
2521 char * const ebuf = ptr;
2534 *--ptr = '0' + (char)(uv % 10);
2542 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2543 * a regexp to its stringified form.
2547 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2549 const regexp * const re = (regexp *)mg->mg_obj;
2552 const char *fptr = "msix";
2557 bool need_newline = 0;
2558 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2560 while((ch = *fptr++)) {
2562 reflags[left++] = ch;
2565 reflags[right--] = ch;
2570 reflags[left] = '-';
2574 mg->mg_len = re->prelen + 4 + left;
2576 * If /x was used, we have to worry about a regex ending with a
2577 * comment later being embedded within another regex. If so, we don't
2578 * want this regex's "commentization" to leak out to the right part of
2579 * the enclosing regex, we must cap it with a newline.
2581 * So, if /x was used, we scan backwards from the end of the regex. If
2582 * we find a '#' before we find a newline, we need to add a newline
2583 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2584 * we don't need to add anything. -jfriedl
2586 if (PMf_EXTENDED & re->reganch) {
2587 const char *endptr = re->precomp + re->prelen;
2588 while (endptr >= re->precomp) {
2589 const char c = *(endptr--);
2591 break; /* don't need another */
2593 /* we end while in a comment, so we need a newline */
2594 mg->mg_len++; /* save space for it */
2595 need_newline = 1; /* note to add it */
2601 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2602 mg->mg_ptr[0] = '(';
2603 mg->mg_ptr[1] = '?';
2604 Copy(reflags, mg->mg_ptr+2, left, char);
2605 *(mg->mg_ptr+left+2) = ':';
2606 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2608 mg->mg_ptr[mg->mg_len - 2] = '\n';
2609 mg->mg_ptr[mg->mg_len - 1] = ')';
2610 mg->mg_ptr[mg->mg_len] = 0;
2612 PL_reginterp_cnt += re->program[0].next_off;
2614 if (re->reganch & ROPT_UTF8)
2624 =for apidoc sv_2pv_flags
2626 Returns a pointer to the string value of an SV, and sets *lp to its length.
2627 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2629 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2630 usually end up here too.
2636 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2646 if (SvGMAGICAL(sv)) {
2647 if (flags & SV_GMAGIC)
2652 if (flags & SV_MUTABLE_RETURN)
2653 return SvPVX_mutable(sv);
2654 if (flags & SV_CONST_RETURN)
2655 return (char *)SvPVX_const(sv);
2658 if (SvIOKp(sv) || SvNOKp(sv)) {
2659 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2664 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2665 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2667 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2674 #ifdef FIXNEGATIVEZERO
2675 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2681 SvUPGRADE(sv, SVt_PV);
2684 s = SvGROW_mutable(sv, len + 1);
2687 return memcpy(s, tbuf, len + 1);
2693 assert(SvTYPE(sv) >= SVt_PVMG);
2694 /* This falls through to the report_uninit near the end of the
2696 } else if (SvTHINKFIRST(sv)) {
2700 SV *const tmpstr = AMG_CALLun(sv,string);
2701 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2703 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2707 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2708 if (flags & SV_CONST_RETURN) {
2709 pv = (char *) SvPVX_const(tmpstr);
2711 pv = (flags & SV_MUTABLE_RETURN)
2712 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2715 *lp = SvCUR(tmpstr);
2717 pv = sv_2pv_flags(tmpstr, lp, flags);
2729 const SV *const referent = (SV*)SvRV(sv);
2732 tsv = sv_2mortal(newSVpvs("NULLREF"));
2733 } else if (SvTYPE(referent) == SVt_PVMG
2734 && ((SvFLAGS(referent) &
2735 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2736 == (SVs_OBJECT|SVs_SMG))
2737 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2738 return stringify_regexp(sv, mg, lp);
2740 const char *const typestr = sv_reftype(referent, 0);
2742 tsv = sv_newmortal();
2743 if (SvOBJECT(referent)) {
2744 const char *const name = HvNAME_get(SvSTASH(referent));
2745 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2746 name ? name : "__ANON__" , typestr,
2750 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2758 if (SvREADONLY(sv) && !SvOK(sv)) {
2759 if (ckWARN(WARN_UNINITIALIZED))
2766 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2767 /* I'm assuming that if both IV and NV are equally valid then
2768 converting the IV is going to be more efficient */
2769 const U32 isIOK = SvIOK(sv);
2770 const U32 isUIOK = SvIsUV(sv);
2771 char buf[TYPE_CHARS(UV)];
2774 if (SvTYPE(sv) < SVt_PVIV)
2775 sv_upgrade(sv, SVt_PVIV);
2776 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2777 /* inlined from sv_setpvn */
2778 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2779 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2780 SvCUR_set(sv, ebuf - ptr);
2790 else if (SvNOKp(sv)) {
2791 const int olderrno = errno;
2792 if (SvTYPE(sv) < SVt_PVNV)
2793 sv_upgrade(sv, SVt_PVNV);
2794 /* The +20 is pure guesswork. Configure test needed. --jhi */
2795 s = SvGROW_mutable(sv, NV_DIG + 20);
2796 /* some Xenix systems wipe out errno here */
2798 if (SvNVX(sv) == 0.0)
2799 (void)strcpy(s,"0");
2803 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2806 #ifdef FIXNEGATIVEZERO
2807 if (*s == '-' && s[1] == '0' && !s[2])
2817 if (isGV_with_GP(sv))
2818 return glob_2pv((GV *)sv, lp);
2820 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2824 if (SvTYPE(sv) < SVt_PV)
2825 /* Typically the caller expects that sv_any is not NULL now. */
2826 sv_upgrade(sv, SVt_PV);
2830 const STRLEN len = s - SvPVX_const(sv);
2836 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2837 PTR2UV(sv),SvPVX_const(sv)));
2838 if (flags & SV_CONST_RETURN)
2839 return (char *)SvPVX_const(sv);
2840 if (flags & SV_MUTABLE_RETURN)
2841 return SvPVX_mutable(sv);
2846 =for apidoc sv_copypv
2848 Copies a stringified representation of the source SV into the
2849 destination SV. Automatically performs any necessary mg_get and
2850 coercion of numeric values into strings. Guaranteed to preserve
2851 UTF-8 flag even from overloaded objects. Similar in nature to
2852 sv_2pv[_flags] but operates directly on an SV instead of just the
2853 string. Mostly uses sv_2pv_flags to do its work, except when that
2854 would lose the UTF-8'ness of the PV.
2860 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2863 const char * const s = SvPV_const(ssv,len);
2864 sv_setpvn(dsv,s,len);
2872 =for apidoc sv_2pvbyte
2874 Return a pointer to the byte-encoded representation of the SV, and set *lp
2875 to its length. May cause the SV to be downgraded from UTF-8 as a
2878 Usually accessed via the C<SvPVbyte> macro.
2884 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2886 sv_utf8_downgrade(sv,0);
2887 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2891 =for apidoc sv_2pvutf8
2893 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2894 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2896 Usually accessed via the C<SvPVutf8> macro.
2902 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2904 sv_utf8_upgrade(sv);
2905 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2910 =for apidoc sv_2bool
2912 This function is only called on magical items, and is only used by
2913 sv_true() or its macro equivalent.
2919 Perl_sv_2bool(pTHX_ register SV *sv)
2928 SV * const tmpsv = AMG_CALLun(sv,bool_);
2929 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2930 return (bool)SvTRUE(tmpsv);
2932 return SvRV(sv) != 0;
2935 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2937 (*sv->sv_u.svu_pv > '0' ||
2938 Xpvtmp->xpv_cur > 1 ||
2939 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2946 return SvIVX(sv) != 0;
2949 return SvNVX(sv) != 0.0;
2951 if (isGV_with_GP(sv))
2961 =for apidoc sv_utf8_upgrade
2963 Converts the PV of an SV to its UTF-8-encoded form.
2964 Forces the SV to string form if it is not already.
2965 Always sets the SvUTF8 flag to avoid future validity checks even
2966 if all the bytes have hibit clear.
2968 This is not as a general purpose byte encoding to Unicode interface:
2969 use the Encode extension for that.
2971 =for apidoc sv_utf8_upgrade_flags
2973 Converts the PV of an SV to its UTF-8-encoded form.
2974 Forces the SV to string form if it is not already.
2975 Always sets the SvUTF8 flag to avoid future validity checks even
2976 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2977 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2978 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2980 This is not as a general purpose byte encoding to Unicode interface:
2981 use the Encode extension for that.
2987 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2990 if (sv == &PL_sv_undef)
2994 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2995 (void) sv_2pv_flags(sv,&len, flags);
2999 (void) SvPV_force(sv,len);
3008 sv_force_normal_flags(sv, 0);
3011 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3012 sv_recode_to_utf8(sv, PL_encoding);
3013 else { /* Assume Latin-1/EBCDIC */
3014 /* This function could be much more efficient if we
3015 * had a FLAG in SVs to signal if there are any hibit
3016 * chars in the PV. Given that there isn't such a flag
3017 * make the loop as fast as possible. */
3018 const U8 * const s = (U8 *) SvPVX_const(sv);
3019 const U8 * const e = (U8 *) SvEND(sv);
3024 /* Check for hi bit */
3025 if (!NATIVE_IS_INVARIANT(ch)) {
3026 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3027 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3029 SvPV_free(sv); /* No longer using what was there before. */
3030 SvPV_set(sv, (char*)recoded);
3031 SvCUR_set(sv, len - 1);
3032 SvLEN_set(sv, len); /* No longer know the real size. */
3036 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3043 =for apidoc sv_utf8_downgrade
3045 Attempts to convert the PV of an SV from characters to bytes.
3046 If the PV contains a character beyond byte, this conversion will fail;
3047 in this case, either returns false or, if C<fail_ok> is not
3050 This is not as a general purpose Unicode to byte encoding interface:
3051 use the Encode extension for that.
3057 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3060 if (SvPOKp(sv) && SvUTF8(sv)) {
3066 sv_force_normal_flags(sv, 0);
3068 s = (U8 *) SvPV(sv, len);
3069 if (!utf8_to_bytes(s, &len)) {
3074 Perl_croak(aTHX_ "Wide character in %s",
3077 Perl_croak(aTHX_ "Wide character");
3088 =for apidoc sv_utf8_encode
3090 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3091 flag off so that it looks like octets again.
3097 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3100 sv_force_normal_flags(sv, 0);
3102 if (SvREADONLY(sv)) {
3103 Perl_croak(aTHX_ PL_no_modify);
3105 (void) sv_utf8_upgrade(sv);
3110 =for apidoc sv_utf8_decode
3112 If the PV of the SV is an octet sequence in UTF-8
3113 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3114 so that it looks like a character. If the PV contains only single-byte
3115 characters, the C<SvUTF8> flag stays being off.
3116 Scans PV for validity and returns false if the PV is invalid UTF-8.
3122 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3128 /* The octets may have got themselves encoded - get them back as
3131 if (!sv_utf8_downgrade(sv, TRUE))
3134 /* it is actually just a matter of turning the utf8 flag on, but
3135 * we want to make sure everything inside is valid utf8 first.
3137 c = (const U8 *) SvPVX_const(sv);
3138 if (!is_utf8_string(c, SvCUR(sv)+1))
3140 e = (const U8 *) SvEND(sv);
3143 if (!UTF8_IS_INVARIANT(ch)) {
3153 =for apidoc sv_setsv
3155 Copies the contents of the source SV C<ssv> into the destination SV
3156 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3157 function if the source SV needs to be reused. Does not handle 'set' magic.
3158 Loosely speaking, it performs a copy-by-value, obliterating any previous
3159 content of the destination.
3161 You probably want to use one of the assortment of wrappers, such as
3162 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3163 C<SvSetMagicSV_nosteal>.
3165 =for apidoc sv_setsv_flags
3167 Copies the contents of the source SV C<ssv> into the destination SV
3168 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3169 function if the source SV needs to be reused. Does not handle 'set' magic.
3170 Loosely speaking, it performs a copy-by-value, obliterating any previous
3171 content of the destination.
3172 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3173 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3174 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3175 and C<sv_setsv_nomg> are implemented in terms of this function.
3177 You probably want to use one of the assortment of wrappers, such as
3178 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3179 C<SvSetMagicSV_nosteal>.
3181 This is the primary function for copying scalars, and most other
3182 copy-ish functions and macros use this underneath.
3188 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3190 if (dtype != SVt_PVGV) {
3191 const char * const name = GvNAME(sstr);
3192 const STRLEN len = GvNAMELEN(sstr);
3193 /* don't upgrade SVt_PVLV: it can hold a glob */
3194 if (dtype != SVt_PVLV) {
3195 if (dtype >= SVt_PV) {
3201 sv_upgrade(dstr, SVt_PVGV);
3202 (void)SvOK_off(dstr);
3205 GvSTASH(dstr) = GvSTASH(sstr);
3207 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3208 gv_name_set((GV *)dstr, name, len, GV_ADD);
3209 SvFAKE_on(dstr); /* can coerce to non-glob */
3212 #ifdef GV_UNIQUE_CHECK
3213 if (GvUNIQUE((GV*)dstr)) {
3214 Perl_croak(aTHX_ PL_no_modify);
3220 (void)SvOK_off(dstr);
3222 GvINTRO_off(dstr); /* one-shot flag */
3223 GvGP(dstr) = gp_ref(GvGP(sstr));
3224 if (SvTAINTED(sstr))
3226 if (GvIMPORTED(dstr) != GVf_IMPORTED
3227 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3229 GvIMPORTED_on(dstr);
3236 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3237 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3239 const int intro = GvINTRO(dstr);
3242 const U32 stype = SvTYPE(sref);
3245 #ifdef GV_UNIQUE_CHECK
3246 if (GvUNIQUE((GV*)dstr)) {
3247 Perl_croak(aTHX_ PL_no_modify);
3252 GvINTRO_off(dstr); /* one-shot flag */
3253 GvLINE(dstr) = CopLINE(PL_curcop);
3254 GvEGV(dstr) = (GV*)dstr;
3259 location = (SV **) &GvCV(dstr);
3260 import_flag = GVf_IMPORTED_CV;
3263 location = (SV **) &GvHV(dstr);
3264 import_flag = GVf_IMPORTED_HV;
3267 location = (SV **) &GvAV(dstr);
3268 import_flag = GVf_IMPORTED_AV;
3271 location = (SV **) &GvIOp(dstr);
3274 location = (SV **) &GvFORM(dstr);
3276 location = &GvSV(dstr);
3277 import_flag = GVf_IMPORTED_SV;
3280 if (stype == SVt_PVCV) {
3281 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3282 SvREFCNT_dec(GvCV(dstr));
3284 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3285 PL_sub_generation++;
3288 SAVEGENERICSV(*location);
3292 if (stype == SVt_PVCV && *location != sref) {
3293 CV* const cv = (CV*)*location;
3295 if (!GvCVGEN((GV*)dstr) &&
3296 (CvROOT(cv) || CvXSUB(cv)))
3298 /* Redefining a sub - warning is mandatory if
3299 it was a const and its value changed. */
3300 if (CvCONST(cv) && CvCONST((CV*)sref)
3301 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3303 /* They are 2 constant subroutines generated from
3304 the same constant. This probably means that
3305 they are really the "same" proxy subroutine
3306 instantiated in 2 places. Most likely this is
3307 when a constant is exported twice. Don't warn.
3310 else if (ckWARN(WARN_REDEFINE)
3312 && (!CvCONST((CV*)sref)
3313 || sv_cmp(cv_const_sv(cv),
3314 cv_const_sv((CV*)sref))))) {
3315 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3317 ? "Constant subroutine %s::%s redefined"
3318 : "Subroutine %s::%s redefined",
3319 HvNAME_get(GvSTASH((GV*)dstr)),
3320 GvENAME((GV*)dstr));
3324 cv_ckproto_len(cv, (GV*)dstr,
3325 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3326 SvPOK(sref) ? SvCUR(sref) : 0);
3328 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3329 GvASSUMECV_on(dstr);
3330 PL_sub_generation++;
3333 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3334 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3335 GvFLAGS(dstr) |= import_flag;
3340 if (SvTAINTED(sstr))
3346 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3349 register U32 sflags;
3355 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3357 sstr = &PL_sv_undef;
3358 stype = SvTYPE(sstr);
3359 dtype = SvTYPE(dstr);
3364 /* need to nuke the magic */
3366 SvRMAGICAL_off(dstr);
3369 /* There's a lot of redundancy below but we're going for speed here */
3374 if (dtype != SVt_PVGV) {
3375 (void)SvOK_off(dstr);
3383 sv_upgrade(dstr, SVt_IV);
3388 sv_upgrade(dstr, SVt_PVIV);
3391 (void)SvIOK_only(dstr);
3392 SvIV_set(dstr, SvIVX(sstr));
3395 /* SvTAINTED can only be true if the SV has taint magic, which in
3396 turn means that the SV type is PVMG (or greater). This is the
3397 case statement for SVt_IV, so this cannot be true (whatever gcov
3399 assert(!SvTAINTED(sstr));
3409 sv_upgrade(dstr, SVt_NV);
3414 sv_upgrade(dstr, SVt_PVNV);
3417 SvNV_set(dstr, SvNVX(sstr));
3418 (void)SvNOK_only(dstr);
3419 /* SvTAINTED can only be true if the SV has taint magic, which in
3420 turn means that the SV type is PVMG (or greater). This is the
3421 case statement for SVt_NV, so this cannot be true (whatever gcov
3423 assert(!SvTAINTED(sstr));
3430 sv_upgrade(dstr, SVt_RV);
3433 #ifdef PERL_OLD_COPY_ON_WRITE
3434 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3435 if (dtype < SVt_PVIV)
3436 sv_upgrade(dstr, SVt_PVIV);
3443 sv_upgrade(dstr, SVt_PV);
3446 if (dtype < SVt_PVIV)
3447 sv_upgrade(dstr, SVt_PVIV);
3450 if (dtype < SVt_PVNV)
3451 sv_upgrade(dstr, SVt_PVNV);
3455 const char * const type = sv_reftype(sstr,0);
3457 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3459 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3464 if (dtype <= SVt_PVGV) {
3465 glob_assign_glob(dstr, sstr, dtype);
3473 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3475 if ((int)SvTYPE(sstr) != stype) {
3476 stype = SvTYPE(sstr);
3477 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3478 glob_assign_glob(dstr, sstr, dtype);
3483 if (stype == SVt_PVLV)
3484 SvUPGRADE(dstr, SVt_PVNV);
3486 SvUPGRADE(dstr, (U32)stype);
3489 /* dstr may have been upgraded. */
3490 dtype = SvTYPE(dstr);
3491 sflags = SvFLAGS(sstr);
3493 if (sflags & SVf_ROK) {
3494 if (dtype == SVt_PVGV &&
3495 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3498 if (GvIMPORTED(dstr) != GVf_IMPORTED
3499 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3501 GvIMPORTED_on(dstr);
3506 glob_assign_glob(dstr, sstr, dtype);
3510 if (dtype >= SVt_PV) {
3511 if (dtype == SVt_PVGV) {
3512 glob_assign_ref(dstr, sstr);
3515 if (SvPVX_const(dstr)) {
3521 (void)SvOK_off(dstr);
3522 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3523 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3524 assert(!(sflags & SVp_NOK));
3525 assert(!(sflags & SVp_IOK));
3526 assert(!(sflags & SVf_NOK));
3527 assert(!(sflags & SVf_IOK));
3529 else if (dtype == SVt_PVGV) {
3530 if (!(sflags & SVf_OK)) {
3531 if (ckWARN(WARN_MISC))
3532 Perl_warner(aTHX_ packWARN(WARN_MISC),
3533 "Undefined value assigned to typeglob");
3536 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3537 if (dstr != (SV*)gv) {
3540 GvGP(dstr) = gp_ref(GvGP(gv));
3544 else if (sflags & SVp_POK) {
3548 * Check to see if we can just swipe the string. If so, it's a
3549 * possible small lose on short strings, but a big win on long ones.
3550 * It might even be a win on short strings if SvPVX_const(dstr)
3551 * has to be allocated and SvPVX_const(sstr) has to be freed.
3554 /* Whichever path we take through the next code, we want this true,
3555 and doing it now facilitates the COW check. */
3556 (void)SvPOK_only(dstr);
3559 /* We're not already COW */
3560 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3561 #ifndef PERL_OLD_COPY_ON_WRITE
3562 /* or we are, but dstr isn't a suitable target. */
3563 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3568 (sflags & SVs_TEMP) && /* slated for free anyway? */
3569 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3570 (!(flags & SV_NOSTEAL)) &&
3571 /* and we're allowed to steal temps */
3572 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3573 SvLEN(sstr) && /* and really is a string */
3574 /* and won't be needed again, potentially */
3575 !(PL_op && PL_op->op_type == OP_AASSIGN))
3576 #ifdef PERL_OLD_COPY_ON_WRITE
3577 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3578 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3579 && SvTYPE(sstr) >= SVt_PVIV)
3582 /* Failed the swipe test, and it's not a shared hash key either.
3583 Have to copy the string. */
3584 STRLEN len = SvCUR(sstr);
3585 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3586 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3587 SvCUR_set(dstr, len);
3588 *SvEND(dstr) = '\0';
3590 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3592 /* Either it's a shared hash key, or it's suitable for
3593 copy-on-write or we can swipe the string. */
3595 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3599 #ifdef PERL_OLD_COPY_ON_WRITE
3601 /* I believe I should acquire a global SV mutex if
3602 it's a COW sv (not a shared hash key) to stop
3603 it going un copy-on-write.
3604 If the source SV has gone un copy on write between up there
3605 and down here, then (assert() that) it is of the correct
3606 form to make it copy on write again */
3607 if ((sflags & (SVf_FAKE | SVf_READONLY))
3608 != (SVf_FAKE | SVf_READONLY)) {
3609 SvREADONLY_on(sstr);
3611 /* Make the source SV into a loop of 1.
3612 (about to become 2) */
3613 SV_COW_NEXT_SV_SET(sstr, sstr);
3617 /* Initial code is common. */
3618 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3623 /* making another shared SV. */
3624 STRLEN cur = SvCUR(sstr);
3625 STRLEN len = SvLEN(sstr);
3626 #ifdef PERL_OLD_COPY_ON_WRITE
3628 assert (SvTYPE(dstr) >= SVt_PVIV);
3629 /* SvIsCOW_normal */
3630 /* splice us in between source and next-after-source. */
3631 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3632 SV_COW_NEXT_SV_SET(sstr, dstr);
3633 SvPV_set(dstr, SvPVX_mutable(sstr));
3637 /* SvIsCOW_shared_hash */
3638 DEBUG_C(PerlIO_printf(Perl_debug_log,
3639 "Copy on write: Sharing hash\n"));
3641 assert (SvTYPE(dstr) >= SVt_PV);
3643 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3645 SvLEN_set(dstr, len);
3646 SvCUR_set(dstr, cur);
3647 SvREADONLY_on(dstr);
3649 /* Relesase a global SV mutex. */
3652 { /* Passes the swipe test. */
3653 SvPV_set(dstr, SvPVX_mutable(sstr));
3654 SvLEN_set(dstr, SvLEN(sstr));
3655 SvCUR_set(dstr, SvCUR(sstr));
3658 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3659 SvPV_set(sstr, NULL);
3665 if (sflags & SVp_NOK) {
3666 SvNV_set(dstr, SvNVX(sstr));
3668 if (sflags & SVp_IOK) {
3669 SvRELEASE_IVX(dstr);
3670 SvIV_set(dstr, SvIVX(sstr));
3671 /* Must do this otherwise some other overloaded use of 0x80000000
3672 gets confused. I guess SVpbm_VALID */
3673 if (sflags & SVf_IVisUV)
3676 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3679 const MAGIC * const smg = SvVSTRING_mg(sstr);
3681 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3682 smg->mg_ptr, smg->mg_len);
3683 SvRMAGICAL_on(dstr);
3687 else if (sflags & (SVp_IOK|SVp_NOK)) {
3688 (void)SvOK_off(dstr);
3689 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3691 if (sflags & SVp_IOK) {
3692 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3693 SvIV_set(dstr, SvIVX(sstr));
3695 if (sflags & SVp_NOK) {
3696 SvNV_set(dstr, SvNVX(sstr));
3700 if (isGV_with_GP(sstr)) {
3701 /* This stringification rule for globs is spread in 3 places.
3702 This feels bad. FIXME. */
3703 const U32 wasfake = sflags & SVf_FAKE;
3705 /* FAKE globs can get coerced, so need to turn this off
3706 temporarily if it is on. */
3708 gv_efullname3(dstr, (GV *)sstr, "*");
3709 SvFLAGS(sstr) |= wasfake;
3710 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3713 (void)SvOK_off(dstr);
3715 if (SvTAINTED(sstr))
3720 =for apidoc sv_setsv_mg
3722 Like C<sv_setsv>, but also handles 'set' magic.
3728 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3730 sv_setsv(dstr,sstr);
3734 #ifdef PERL_OLD_COPY_ON_WRITE
3736 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3738 STRLEN cur = SvCUR(sstr);
3739 STRLEN len = SvLEN(sstr);
3740 register char *new_pv;
3743 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3751 if (SvTHINKFIRST(dstr))
3752 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3753 else if (SvPVX_const(dstr))
3754 Safefree(SvPVX_const(dstr));
3758 SvUPGRADE(dstr, SVt_PVIV);
3760 assert (SvPOK(sstr));
3761 assert (SvPOKp(sstr));
3762 assert (!SvIOK(sstr));
3763 assert (!SvIOKp(sstr));
3764 assert (!SvNOK(sstr));
3765 assert (!SvNOKp(sstr));
3767 if (SvIsCOW(sstr)) {
3769 if (SvLEN(sstr) == 0) {
3770 /* source is a COW shared hash key. */
3771 DEBUG_C(PerlIO_printf(Perl_debug_log,
3772 "Fast copy on write: Sharing hash\n"));
3773 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3776 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3778 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3779 SvUPGRADE(sstr, SVt_PVIV);
3780 SvREADONLY_on(sstr);
3782 DEBUG_C(PerlIO_printf(Perl_debug_log,
3783 "Fast copy on write: Converting sstr to COW\n"));
3784 SV_COW_NEXT_SV_SET(dstr, sstr);
3786 SV_COW_NEXT_SV_SET(sstr, dstr);
3787 new_pv = SvPVX_mutable(sstr);
3790 SvPV_set(dstr, new_pv);
3791 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3794 SvLEN_set(dstr, len);
3795 SvCUR_set(dstr, cur);
3804 =for apidoc sv_setpvn
3806 Copies a string into an SV. The C<len> parameter indicates the number of
3807 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3808 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3814 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3817 register char *dptr;
3819 SV_CHECK_THINKFIRST_COW_DROP(sv);
3825 /* len is STRLEN which is unsigned, need to copy to signed */
3828 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3830 SvUPGRADE(sv, SVt_PV);
3832 dptr = SvGROW(sv, len + 1);
3833 Move(ptr,dptr,len,char);
3836 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3841 =for apidoc sv_setpvn_mg
3843 Like C<sv_setpvn>, but also handles 'set' magic.
3849 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3851 sv_setpvn(sv,ptr,len);
3856 =for apidoc sv_setpv
3858 Copies a string into an SV. The string must be null-terminated. Does not
3859 handle 'set' magic. See C<sv_setpv_mg>.
3865 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3868 register STRLEN len;
3870 SV_CHECK_THINKFIRST_COW_DROP(sv);
3876 SvUPGRADE(sv, SVt_PV);
3878 SvGROW(sv, len + 1);
3879 Move(ptr,SvPVX(sv),len+1,char);
3881 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3886 =for apidoc sv_setpv_mg
3888 Like C<sv_setpv>, but also handles 'set' magic.
3894 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3901 =for apidoc sv_usepvn_flags
3903 Tells an SV to use C<ptr> to find its string value. Normally the
3904 string is stored inside the SV but sv_usepvn allows the SV to use an
3905 outside string. The C<ptr> should point to memory that was allocated
3906 by C<malloc>. The string length, C<len>, must be supplied. By default
3907 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3908 so that pointer should not be freed or used by the programmer after
3909 giving it to sv_usepvn, and neither should any pointers from "behind"
3910 that pointer (e.g. ptr + 1) be used.
3912 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3913 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3914 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3915 C<len>, and already meets the requirements for storing in C<SvPVX>)
3921 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3925 SV_CHECK_THINKFIRST_COW_DROP(sv);
3926 SvUPGRADE(sv, SVt_PV);
3929 if (flags & SV_SMAGIC)
3933 if (SvPVX_const(sv))
3936 if (flags & SV_HAS_TRAILING_NUL)
3937 assert(ptr[len] == '\0');
3939 allocate = (flags & SV_HAS_TRAILING_NUL)
3940 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3941 if (flags & SV_HAS_TRAILING_NUL) {
3942 /* It's long enough - do nothing.
3943 Specfically Perl_newCONSTSUB is relying on this. */
3946 /* Force a move to shake out bugs in callers. */
3947 char *new_ptr = safemalloc(allocate);
3948 Copy(ptr, new_ptr, len, char);
3949 PoisonFree(ptr,len,char);
3953 ptr = saferealloc (ptr, allocate);
3958 SvLEN_set(sv, allocate);
3959 if (!(flags & SV_HAS_TRAILING_NUL)) {
3962 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3964 if (flags & SV_SMAGIC)
3968 #ifdef PERL_OLD_COPY_ON_WRITE
3969 /* Need to do this *after* making the SV normal, as we need the buffer
3970 pointer to remain valid until after we've copied it. If we let go too early,
3971 another thread could invalidate it by unsharing last of the same hash key
3972 (which it can do by means other than releasing copy-on-write Svs)
3973 or by changing the other copy-on-write SVs in the loop. */
3975 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3977 if (len) { /* this SV was SvIsCOW_normal(sv) */
3978 /* we need to find the SV pointing to us. */
3979 SV *current = SV_COW_NEXT_SV(after);
3981 if (current == sv) {
3982 /* The SV we point to points back to us (there were only two of us
3984 Hence other SV is no longer copy on write either. */
3986 SvREADONLY_off(after);
3988 /* We need to follow the pointers around the loop. */
3990 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3993 /* don't loop forever if the structure is bust, and we have
3994 a pointer into a closed loop. */
3995 assert (current != after);
3996 assert (SvPVX_const(current) == pvx);
3998 /* Make the SV before us point to the SV after us. */
3999 SV_COW_NEXT_SV_SET(current, after);
4002 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4007 Perl_sv_release_IVX(pTHX_ register SV *sv)
4010 sv_force_normal_flags(sv, 0);
4016 =for apidoc sv_force_normal_flags
4018 Undo various types of fakery on an SV: if the PV is a shared string, make
4019 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4020 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4021 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4022 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4023 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4024 set to some other value.) In addition, the C<flags> parameter gets passed to
4025 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4026 with flags set to 0.
4032 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4035 #ifdef PERL_OLD_COPY_ON_WRITE
4036 if (SvREADONLY(sv)) {
4037 /* At this point I believe I should acquire a global SV mutex. */
4039 const char * const pvx = SvPVX_const(sv);
4040 const STRLEN len = SvLEN(sv);
4041 const STRLEN cur = SvCUR(sv);
4042 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4044 PerlIO_printf(Perl_debug_log,
4045 "Copy on write: Force normal %ld\n",
4051 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4054 if (flags & SV_COW_DROP_PV) {
4055 /* OK, so we don't need to copy our buffer. */
4058 SvGROW(sv, cur + 1);
4059 Move(pvx,SvPVX(sv),cur,char);
4063 sv_release_COW(sv, pvx, len, next);
4068 else if (IN_PERL_RUNTIME)
4069 Perl_croak(aTHX_ PL_no_modify);
4070 /* At this point I believe that I can drop the global SV mutex. */
4073 if (SvREADONLY(sv)) {
4075 const char * const pvx = SvPVX_const(sv);
4076 const STRLEN len = SvCUR(sv);
4081 SvGROW(sv, len + 1);
4082 Move(pvx,SvPVX(sv),len,char);
4084 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4086 else if (IN_PERL_RUNTIME)
4087 Perl_croak(aTHX_ PL_no_modify);
4091 sv_unref_flags(sv, flags);
4092 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4099 Efficient removal of characters from the beginning of the string buffer.
4100 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4101 the string buffer. The C<ptr> becomes the first character of the adjusted
4102 string. Uses the "OOK hack".
4103 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4104 refer to the same chunk of data.
4110 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4112 register STRLEN delta;
4113 if (!ptr || !SvPOKp(sv))
4115 delta = ptr - SvPVX_const(sv);
4116 SV_CHECK_THINKFIRST(sv);
4117 if (SvTYPE(sv) < SVt_PVIV)
4118 sv_upgrade(sv,SVt_PVIV);
4121 if (!SvLEN(sv)) { /* make copy of shared string */
4122 const char *pvx = SvPVX_const(sv);
4123 const STRLEN len = SvCUR(sv);
4124 SvGROW(sv, len + 1);
4125 Move(pvx,SvPVX(sv),len,char);
4129 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4130 and we do that anyway inside the SvNIOK_off
4132 SvFLAGS(sv) |= SVf_OOK;
4135 SvLEN_set(sv, SvLEN(sv) - delta);
4136 SvCUR_set(sv, SvCUR(sv) - delta);
4137 SvPV_set(sv, SvPVX(sv) + delta);
4138 SvIV_set(sv, SvIVX(sv) + delta);
4142 =for apidoc sv_catpvn
4144 Concatenates the string onto the end of the string which is in the SV. The
4145 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4146 status set, then the bytes appended should be valid UTF-8.
4147 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4149 =for apidoc sv_catpvn_flags
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 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4155 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4156 in terms of this function.
4162 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4166 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4168 SvGROW(dsv, dlen + slen + 1);
4170 sstr = SvPVX_const(dsv);
4171 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4172 SvCUR_set(dsv, SvCUR(dsv) + slen);
4174 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4176 if (flags & SV_SMAGIC)
4181 =for apidoc sv_catsv
4183 Concatenates the string from SV C<ssv> onto the end of the string in
4184 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4185 not 'set' magic. See C<sv_catsv_mg>.
4187 =for apidoc sv_catsv_flags
4189 Concatenates the string from SV C<ssv> onto the end of the string in
4190 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4191 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4192 and C<sv_catsv_nomg> are implemented in terms of this function.
4197 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4202 const char *spv = SvPV_const(ssv, slen);
4204 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4205 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4206 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4207 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4208 dsv->sv_flags doesn't have that bit set.
4209 Andy Dougherty 12 Oct 2001
4211 const I32 sutf8 = DO_UTF8(ssv);
4214 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4216 dutf8 = DO_UTF8(dsv);
4218 if (dutf8 != sutf8) {
4220 /* Not modifying source SV, so taking a temporary copy. */
4221 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4223 sv_utf8_upgrade(csv);
4224 spv = SvPV_const(csv, slen);
4227 sv_utf8_upgrade_nomg(dsv);
4229 sv_catpvn_nomg(dsv, spv, slen);
4232 if (flags & SV_SMAGIC)
4237 =for apidoc sv_catpv
4239 Concatenates the string onto the end of the string which is in the SV.
4240 If the SV has the UTF-8 status set, then the bytes appended should be
4241 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4246 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4249 register STRLEN len;
4255 junk = SvPV_force(sv, tlen);
4257 SvGROW(sv, tlen + len + 1);
4259 ptr = SvPVX_const(sv);
4260 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4261 SvCUR_set(sv, SvCUR(sv) + len);
4262 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4267 =for apidoc sv_catpv_mg
4269 Like C<sv_catpv>, but also handles 'set' magic.
4275 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4284 Creates a new SV. A non-zero C<len> parameter indicates the number of
4285 bytes of preallocated string space the SV should have. An extra byte for a
4286 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4287 space is allocated.) The reference count for the new SV is set to 1.
4289 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4290 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4291 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4292 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4293 modules supporting older perls.
4299 Perl_newSV(pTHX_ STRLEN len)
4306 sv_upgrade(sv, SVt_PV);
4307 SvGROW(sv, len + 1);
4312 =for apidoc sv_magicext
4314 Adds magic to an SV, upgrading it if necessary. Applies the
4315 supplied vtable and returns a pointer to the magic added.
4317 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4318 In particular, you can add magic to SvREADONLY SVs, and add more than
4319 one instance of the same 'how'.
4321 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4322 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4323 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4324 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4326 (This is now used as a subroutine by C<sv_magic>.)
4331 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4332 const char* name, I32 namlen)
4337 if (SvTYPE(sv) < SVt_PVMG) {
4338 SvUPGRADE(sv, SVt_PVMG);
4340 Newxz(mg, 1, MAGIC);
4341 mg->mg_moremagic = SvMAGIC(sv);
4342 SvMAGIC_set(sv, mg);
4344 /* Sometimes a magic contains a reference loop, where the sv and
4345 object refer to each other. To prevent a reference loop that
4346 would prevent such objects being freed, we look for such loops
4347 and if we find one we avoid incrementing the object refcount.
4349 Note we cannot do this to avoid self-tie loops as intervening RV must
4350 have its REFCNT incremented to keep it in existence.
4353 if (!obj || obj == sv ||
4354 how == PERL_MAGIC_arylen ||
4355 how == PERL_MAGIC_qr ||
4356 how == PERL_MAGIC_symtab ||
4357 (SvTYPE(obj) == SVt_PVGV &&
4358 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4359 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4360 GvFORM(obj) == (CV*)sv)))
4365 mg->mg_obj = SvREFCNT_inc_simple(obj);
4366 mg->mg_flags |= MGf_REFCOUNTED;
4369 /* Normal self-ties simply pass a null object, and instead of
4370 using mg_obj directly, use the SvTIED_obj macro to produce a
4371 new RV as needed. For glob "self-ties", we are tieing the PVIO
4372 with an RV obj pointing to the glob containing the PVIO. In
4373 this case, to avoid a reference loop, we need to weaken the
4377 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4378 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4384 mg->mg_len = namlen;
4387 mg->mg_ptr = savepvn(name, namlen);
4388 else if (namlen == HEf_SVKEY)
4389 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4391 mg->mg_ptr = (char *) name;
4393 mg->mg_virtual = vtable;
4397 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4402 =for apidoc sv_magic
4404 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4405 then adds a new magic item of type C<how> to the head of the magic list.
4407 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4408 handling of the C<name> and C<namlen> arguments.
4410 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4411 to add more than one instance of the same 'how'.
4417 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4423 #ifdef PERL_OLD_COPY_ON_WRITE
4425 sv_force_normal_flags(sv, 0);
4427 if (SvREADONLY(sv)) {
4429 /* its okay to attach magic to shared strings; the subsequent
4430 * upgrade to PVMG will unshare the string */
4431 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4434 && how != PERL_MAGIC_regex_global
4435 && how != PERL_MAGIC_bm
4436 && how != PERL_MAGIC_fm
4437 && how != PERL_MAGIC_sv
4438 && how != PERL_MAGIC_backref
4441 Perl_croak(aTHX_ PL_no_modify);
4444 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4445 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4446 /* sv_magic() refuses to add a magic of the same 'how' as an
4449 if (how == PERL_MAGIC_taint) {
4451 /* Any scalar which already had taint magic on which someone
4452 (erroneously?) did SvIOK_on() or similar will now be
4453 incorrectly sporting public "OK" flags. */
4454 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4462 vtable = &PL_vtbl_sv;
4464 case PERL_MAGIC_overload:
4465 vtable = &PL_vtbl_amagic;
4467 case PERL_MAGIC_overload_elem:
4468 vtable = &PL_vtbl_amagicelem;
4470 case PERL_MAGIC_overload_table:
4471 vtable = &PL_vtbl_ovrld;
4474 vtable = &PL_vtbl_bm;
4476 case PERL_MAGIC_regdata:
4477 vtable = &PL_vtbl_regdata;
4479 case PERL_MAGIC_regdatum:
4480 vtable = &PL_vtbl_regdatum;
4482 case PERL_MAGIC_env:
4483 vtable = &PL_vtbl_env;
4486 vtable = &PL_vtbl_fm;
4488 case PERL_MAGIC_envelem:
4489 vtable = &PL_vtbl_envelem;
4491 case PERL_MAGIC_regex_global:
4492 vtable = &PL_vtbl_mglob;
4494 case PERL_MAGIC_isa:
4495 vtable = &PL_vtbl_isa;
4497 case PERL_MAGIC_isaelem:
4498 vtable = &PL_vtbl_isaelem;
4500 case PERL_MAGIC_nkeys:
4501 vtable = &PL_vtbl_nkeys;
4503 case PERL_MAGIC_dbfile:
4506 case PERL_MAGIC_dbline:
4507 vtable = &PL_vtbl_dbline;
4509 #ifdef USE_LOCALE_COLLATE
4510 case PERL_MAGIC_collxfrm:
4511 vtable = &PL_vtbl_collxfrm;
4513 #endif /* USE_LOCALE_COLLATE */
4514 case PERL_MAGIC_tied:
4515 vtable = &PL_vtbl_pack;
4517 case PERL_MAGIC_tiedelem:
4518 case PERL_MAGIC_tiedscalar:
4519 vtable = &PL_vtbl_packelem;
4522 vtable = &PL_vtbl_regexp;
4524 case PERL_MAGIC_hints:
4525 /* As this vtable is all NULL, we can reuse it. */
4526 case PERL_MAGIC_sig:
4527 vtable = &PL_vtbl_sig;
4529 case PERL_MAGIC_sigelem:
4530 vtable = &PL_vtbl_sigelem;
4532 case PERL_MAGIC_taint:
4533 vtable = &PL_vtbl_taint;
4535 case PERL_MAGIC_uvar:
4536 vtable = &PL_vtbl_uvar;
4538 case PERL_MAGIC_vec:
4539 vtable = &PL_vtbl_vec;
4541 case PERL_MAGIC_arylen_p:
4542 case PERL_MAGIC_rhash:
4543 case PERL_MAGIC_symtab:
4544 case PERL_MAGIC_vstring:
4547 case PERL_MAGIC_utf8:
4548 vtable = &PL_vtbl_utf8;
4550 case PERL_MAGIC_substr:
4551 vtable = &PL_vtbl_substr;
4553 case PERL_MAGIC_defelem:
4554 vtable = &PL_vtbl_defelem;
4556 case PERL_MAGIC_arylen:
4557 vtable = &PL_vtbl_arylen;
4559 case PERL_MAGIC_pos:
4560 vtable = &PL_vtbl_pos;
4562 case PERL_MAGIC_backref:
4563 vtable = &PL_vtbl_backref;
4565 case PERL_MAGIC_hintselem:
4566 vtable = &PL_vtbl_hintselem;
4568 case PERL_MAGIC_ext:
4569 /* Reserved for use by extensions not perl internals. */
4570 /* Useful for attaching extension internal data to perl vars. */
4571 /* Note that multiple extensions may clash if magical scalars */
4572 /* etc holding private data from one are passed to another. */
4576 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4579 /* Rest of work is done else where */
4580 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4583 case PERL_MAGIC_taint:
4586 case PERL_MAGIC_ext:
4587 case PERL_MAGIC_dbfile:
4594 =for apidoc sv_unmagic
4596 Removes all magic of type C<type> from an SV.
4602 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4606 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4608 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4609 for (mg = *mgp; mg; mg = *mgp) {
4610 if (mg->mg_type == type) {
4611 const MGVTBL* const vtbl = mg->mg_virtual;
4612 *mgp = mg->mg_moremagic;
4613 if (vtbl && vtbl->svt_free)
4614 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4615 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4617 Safefree(mg->mg_ptr);
4618 else if (mg->mg_len == HEf_SVKEY)
4619 SvREFCNT_dec((SV*)mg->mg_ptr);
4620 else if (mg->mg_type == PERL_MAGIC_utf8)
4621 Safefree(mg->mg_ptr);
4623 if (mg->mg_flags & MGf_REFCOUNTED)
4624 SvREFCNT_dec(mg->mg_obj);
4628 mgp = &mg->mg_moremagic;
4632 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4633 SvMAGIC_set(sv, NULL);
4640 =for apidoc sv_rvweaken
4642 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4643 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4644 push a back-reference to this RV onto the array of backreferences
4645 associated with that magic.
4651 Perl_sv_rvweaken(pTHX_ SV *sv)
4654 if (!SvOK(sv)) /* let undefs pass */
4657 Perl_croak(aTHX_ "Can't weaken a nonreference");
4658 else if (SvWEAKREF(sv)) {
4659 if (ckWARN(WARN_MISC))
4660 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4664 Perl_sv_add_backref(aTHX_ tsv, sv);
4670 /* Give tsv backref magic if it hasn't already got it, then push a
4671 * back-reference to sv onto the array associated with the backref magic.
4675 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4680 if (SvTYPE(tsv) == SVt_PVHV) {
4681 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4685 /* There is no AV in the offical place - try a fixup. */
4686 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4689 /* Aha. They've got it stowed in magic. Bring it back. */
4690 av = (AV*)mg->mg_obj;
4691 /* Stop mg_free decreasing the refernce count. */
4693 /* Stop mg_free even calling the destructor, given that
4694 there's no AV to free up. */
4696 sv_unmagic(tsv, PERL_MAGIC_backref);
4700 SvREFCNT_inc_simple_void(av);
4705 const MAGIC *const mg
4706 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4708 av = (AV*)mg->mg_obj;
4712 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4713 /* av now has a refcnt of 2, which avoids it getting freed
4714 * before us during global cleanup. The extra ref is removed
4715 * by magic_killbackrefs() when tsv is being freed */
4718 if (AvFILLp(av) >= AvMAX(av)) {
4719 av_extend(av, AvFILLp(av)+1);
4721 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4724 /* delete a back-reference to ourselves from the backref magic associated
4725 * with the SV we point to.
4729 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4736 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4737 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4738 /* We mustn't attempt to "fix up" the hash here by moving the
4739 backreference array back to the hv_aux structure, as that is stored
4740 in the main HvARRAY(), and hfreentries assumes that no-one
4741 reallocates HvARRAY() while it is running. */
4744 const MAGIC *const mg
4745 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4747 av = (AV *)mg->mg_obj;
4750 if (PL_in_clean_all)
4752 Perl_croak(aTHX_ "panic: del_backref");
4759 /* We shouldn't be in here more than once, but for paranoia reasons lets
4761 for (i = AvFILLp(av); i >= 0; i--) {
4763 const SSize_t fill = AvFILLp(av);
4765 /* We weren't the last entry.
4766 An unordered list has this property that you can take the
4767 last element off the end to fill the hole, and it's still
4768 an unordered list :-)
4773 AvFILLp(av) = fill - 1;
4779 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4781 SV **svp = AvARRAY(av);
4783 PERL_UNUSED_ARG(sv);
4785 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4786 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4787 if (svp && !SvIS_FREED(av)) {
4788 SV *const *const last = svp + AvFILLp(av);
4790 while (svp <= last) {
4792 SV *const referrer = *svp;
4793 if (SvWEAKREF(referrer)) {
4794 /* XXX Should we check that it hasn't changed? */
4795 SvRV_set(referrer, 0);
4797 SvWEAKREF_off(referrer);
4798 } else if (SvTYPE(referrer) == SVt_PVGV ||
4799 SvTYPE(referrer) == SVt_PVLV) {
4800 /* You lookin' at me? */
4801 assert(GvSTASH(referrer));
4802 assert(GvSTASH(referrer) == (HV*)sv);
4803 GvSTASH(referrer) = 0;
4806 "panic: magic_killbackrefs (flags=%"UVxf")",
4807 (UV)SvFLAGS(referrer));
4815 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4820 =for apidoc sv_insert
4822 Inserts a string at the specified offset/length within the SV. Similar to
4823 the Perl substr() function.
4829 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4834 register char *midend;
4835 register char *bigend;
4841 Perl_croak(aTHX_ "Can't modify non-existent substring");
4842 SvPV_force(bigstr, curlen);
4843 (void)SvPOK_only_UTF8(bigstr);
4844 if (offset + len > curlen) {
4845 SvGROW(bigstr, offset+len+1);
4846 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4847 SvCUR_set(bigstr, offset+len);
4851 i = littlelen - len;
4852 if (i > 0) { /* string might grow */
4853 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4854 mid = big + offset + len;
4855 midend = bigend = big + SvCUR(bigstr);
4858 while (midend > mid) /* shove everything down */
4859 *--bigend = *--midend;
4860 Move(little,big+offset,littlelen,char);
4861 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4866 Move(little,SvPVX(bigstr)+offset,len,char);
4871 big = SvPVX(bigstr);
4874 bigend = big + SvCUR(bigstr);
4876 if (midend > bigend)
4877 Perl_croak(aTHX_ "panic: sv_insert");
4879 if (mid - big > bigend - midend) { /* faster to shorten from end */
4881 Move(little, mid, littlelen,char);
4884 i = bigend - midend;
4886 Move(midend, mid, i,char);
4890 SvCUR_set(bigstr, mid - big);
4892 else if ((i = mid - big)) { /* faster from front */
4893 midend -= littlelen;
4895 sv_chop(bigstr,midend-i);
4900 Move(little, mid, littlelen,char);
4902 else if (littlelen) {
4903 midend -= littlelen;
4904 sv_chop(bigstr,midend);
4905 Move(little,midend,littlelen,char);
4908 sv_chop(bigstr,midend);
4914 =for apidoc sv_replace
4916 Make the first argument a copy of the second, then delete the original.
4917 The target SV physically takes over ownership of the body of the source SV
4918 and inherits its flags; however, the target keeps any magic it owns,
4919 and any magic in the source is discarded.
4920 Note that this is a rather specialist SV copying operation; most of the
4921 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4927 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4930 const U32 refcnt = SvREFCNT(sv);
4931 SV_CHECK_THINKFIRST_COW_DROP(sv);
4932 if (SvREFCNT(nsv) != 1) {
4933 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4934 UVuf " != 1)", (UV) SvREFCNT(nsv));
4936 if (SvMAGICAL(sv)) {
4940 sv_upgrade(nsv, SVt_PVMG);
4941 SvMAGIC_set(nsv, SvMAGIC(sv));
4942 SvFLAGS(nsv) |= SvMAGICAL(sv);
4944 SvMAGIC_set(sv, NULL);
4948 assert(!SvREFCNT(sv));
4949 #ifdef DEBUG_LEAKING_SCALARS
4950 sv->sv_flags = nsv->sv_flags;
4951 sv->sv_any = nsv->sv_any;
4952 sv->sv_refcnt = nsv->sv_refcnt;
4953 sv->sv_u = nsv->sv_u;
4955 StructCopy(nsv,sv,SV);
4957 /* Currently could join these into one piece of pointer arithmetic, but
4958 it would be unclear. */
4959 if(SvTYPE(sv) == SVt_IV)
4961 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4962 else if (SvTYPE(sv) == SVt_RV) {
4963 SvANY(sv) = &sv->sv_u.svu_rv;
4967 #ifdef PERL_OLD_COPY_ON_WRITE
4968 if (SvIsCOW_normal(nsv)) {
4969 /* We need to follow the pointers around the loop to make the
4970 previous SV point to sv, rather than nsv. */
4973 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4976 assert(SvPVX_const(current) == SvPVX_const(nsv));
4978 /* Make the SV before us point to the SV after us. */
4980 PerlIO_printf(Perl_debug_log, "previous is\n");
4982 PerlIO_printf(Perl_debug_log,
4983 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4984 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4986 SV_COW_NEXT_SV_SET(current, sv);
4989 SvREFCNT(sv) = refcnt;
4990 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4996 =for apidoc sv_clear
4998 Clear an SV: call any destructors, free up any memory used by the body,
4999 and free the body itself. The SV's head is I<not> freed, although
5000 its type is set to all 1's so that it won't inadvertently be assumed
5001 to be live during global destruction etc.
5002 This function should only be called when REFCNT is zero. Most of the time
5003 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5010 Perl_sv_clear(pTHX_ register SV *sv)
5013 const U32 type = SvTYPE(sv);
5014 const struct body_details *const sv_type_details
5015 = bodies_by_type + type;
5018 assert(SvREFCNT(sv) == 0);
5020 if (type <= SVt_IV) {
5021 /* See the comment in sv.h about the collusion between this early
5022 return and the overloading of the NULL and IV slots in the size
5028 if (PL_defstash) { /* Still have a symbol table? */
5033 stash = SvSTASH(sv);
5034 destructor = StashHANDLER(stash,DESTROY);
5036 SV* const tmpref = newRV(sv);
5037 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5039 PUSHSTACKi(PERLSI_DESTROY);
5044 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5050 if(SvREFCNT(tmpref) < 2) {
5051 /* tmpref is not kept alive! */
5053 SvRV_set(tmpref, NULL);
5056 SvREFCNT_dec(tmpref);
5058 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5062 if (PL_in_clean_objs)
5063 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5065 /* DESTROY gave object new lease on life */
5071 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5072 SvOBJECT_off(sv); /* Curse the object. */
5073 if (type != SVt_PVIO)
5074 --PL_sv_objcount; /* XXX Might want something more general */
5077 if (type >= SVt_PVMG) {
5078 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5079 SvREFCNT_dec(OURSTASH(sv));
5080 } else if (SvMAGIC(sv))
5082 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5083 SvREFCNT_dec(SvSTASH(sv));
5088 IoIFP(sv) != PerlIO_stdin() &&
5089 IoIFP(sv) != PerlIO_stdout() &&
5090 IoIFP(sv) != PerlIO_stderr())
5092 io_close((IO*)sv, FALSE);
5094 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5095 PerlDir_close(IoDIRP(sv));
5096 IoDIRP(sv) = (DIR*)NULL;
5097 Safefree(IoTOP_NAME(sv));
5098 Safefree(IoFMT_NAME(sv));
5099 Safefree(IoBOTTOM_NAME(sv));
5108 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5115 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5116 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5117 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5118 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5120 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5121 SvREFCNT_dec(LvTARG(sv));
5125 if (GvNAME_HEK(sv)) {
5126 unshare_hek(GvNAME_HEK(sv));
5128 /* If we're in a stash, we don't own a reference to it. However it does
5129 have a back reference to us, which needs to be cleared. */
5131 sv_del_backref((SV*)GvSTASH(sv), sv);
5136 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5138 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5139 /* Don't even bother with turning off the OOK flag. */
5144 SV * const target = SvRV(sv);
5146 sv_del_backref(target, sv);
5148 SvREFCNT_dec(target);
5150 #ifdef PERL_OLD_COPY_ON_WRITE
5151 else if (SvPVX_const(sv)) {
5153 /* I believe I need to grab the global SV mutex here and
5154 then recheck the COW status. */
5156 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5159 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5160 SV_COW_NEXT_SV(sv));
5161 /* And drop it here. */
5163 } else if (SvLEN(sv)) {
5164 Safefree(SvPVX_const(sv));
5168 else if (SvPVX_const(sv) && SvLEN(sv))
5169 Safefree(SvPVX_mutable(sv));
5170 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5171 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5180 SvFLAGS(sv) &= SVf_BREAK;
5181 SvFLAGS(sv) |= SVTYPEMASK;
5183 if (sv_type_details->arena) {
5184 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5185 &PL_body_roots[type]);
5187 else if (sv_type_details->body_size) {
5188 my_safefree(SvANY(sv));
5193 =for apidoc sv_newref
5195 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5202 Perl_sv_newref(pTHX_ SV *sv)
5204 PERL_UNUSED_CONTEXT;
5213 Decrement an SV's reference count, and if it drops to zero, call
5214 C<sv_clear> to invoke destructors and free up any memory used by
5215 the body; finally, deallocate the SV's head itself.
5216 Normally called via a wrapper macro C<SvREFCNT_dec>.
5222 Perl_sv_free(pTHX_ SV *sv)
5227 if (SvREFCNT(sv) == 0) {
5228 if (SvFLAGS(sv) & SVf_BREAK)
5229 /* this SV's refcnt has been artificially decremented to
5230 * trigger cleanup */
5232 if (PL_in_clean_all) /* All is fair */
5234 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5235 /* make sure SvREFCNT(sv)==0 happens very seldom */
5236 SvREFCNT(sv) = (~(U32)0)/2;
5239 if (ckWARN_d(WARN_INTERNAL)) {
5240 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5241 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5242 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5243 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5244 Perl_dump_sv_child(aTHX_ sv);
5249 if (--(SvREFCNT(sv)) > 0)
5251 Perl_sv_free2(aTHX_ sv);
5255 Perl_sv_free2(pTHX_ SV *sv)
5260 if (ckWARN_d(WARN_DEBUGGING))
5261 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5262 "Attempt to free temp prematurely: SV 0x%"UVxf
5263 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5267 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5268 /* make sure SvREFCNT(sv)==0 happens very seldom */
5269 SvREFCNT(sv) = (~(U32)0)/2;
5280 Returns the length of the string in the SV. Handles magic and type
5281 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5287 Perl_sv_len(pTHX_ register SV *sv)
5295 len = mg_length(sv);
5297 (void)SvPV_const(sv, len);
5302 =for apidoc sv_len_utf8
5304 Returns the number of characters in the string in an SV, counting wide
5305 UTF-8 bytes as a single character. Handles magic and type coercion.
5311 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5312 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5313 * (Note that the mg_len is not the length of the mg_ptr field.
5314 * This allows the cache to store the character length of the string without
5315 * needing to malloc() extra storage to attach to the mg_ptr.)
5320 Perl_sv_len_utf8(pTHX_ register SV *sv)
5326 return mg_length(sv);
5330 const U8 *s = (U8*)SvPV_const(sv, len);
5334 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5336 if (mg && mg->mg_len != -1) {
5338 if (PL_utf8cache < 0) {
5339 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5341 /* Need to turn the assertions off otherwise we may
5342 recurse infinitely while printing error messages.
5344 SAVEI8(PL_utf8cache);
5346 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5347 " real %"UVf" for %"SVf,
5348 (UV) ulen, (UV) real, (void*)sv);
5353 ulen = Perl_utf8_length(aTHX_ s, s + len);
5354 if (!SvREADONLY(sv)) {
5356 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5357 &PL_vtbl_utf8, 0, 0);
5365 return Perl_utf8_length(aTHX_ s, s + len);
5369 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5372 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5375 const U8 *s = start;
5377 while (s < send && uoffset--)
5380 /* This is the existing behaviour. Possibly it should be a croak, as
5381 it's actually a bounds error */
5387 /* Given the length of the string in both bytes and UTF-8 characters, decide
5388 whether to walk forwards or backwards to find the byte corresponding to
5389 the passed in UTF-8 offset. */
5391 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5392 STRLEN uoffset, STRLEN uend)
5394 STRLEN backw = uend - uoffset;
5395 if (uoffset < 2 * backw) {
5396 /* The assumption is that going forwards is twice the speed of going
5397 forward (that's where the 2 * backw comes from).
5398 (The real figure of course depends on the UTF-8 data.) */
5399 return sv_pos_u2b_forwards(start, send, uoffset);
5404 while (UTF8_IS_CONTINUATION(*send))
5407 return send - start;
5410 /* For the string representation of the given scalar, find the byte
5411 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5412 give another position in the string, *before* the sought offset, which
5413 (which is always true, as 0, 0 is a valid pair of positions), which should
5414 help reduce the amount of linear searching.
5415 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5416 will be used to reduce the amount of linear searching. The cache will be
5417 created if necessary, and the found value offered to it for update. */
5419 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5420 const U8 *const send, STRLEN uoffset,
5421 STRLEN uoffset0, STRLEN boffset0) {
5422 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5425 assert (uoffset >= uoffset0);
5427 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5428 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5429 if ((*mgp)->mg_ptr) {
5430 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5431 if (cache[0] == uoffset) {
5432 /* An exact match. */
5435 if (cache[2] == uoffset) {
5436 /* An exact match. */
5440 if (cache[0] < uoffset) {
5441 /* The cache already knows part of the way. */
5442 if (cache[0] > uoffset0) {
5443 /* The cache knows more than the passed in pair */
5444 uoffset0 = cache[0];
5445 boffset0 = cache[1];
5447 if ((*mgp)->mg_len != -1) {
5448 /* And we know the end too. */
5450 + sv_pos_u2b_midway(start + boffset0, send,
5452 (*mgp)->mg_len - uoffset0);
5455 + sv_pos_u2b_forwards(start + boffset0,
5456 send, uoffset - uoffset0);
5459 else if (cache[2] < uoffset) {
5460 /* We're between the two cache entries. */
5461 if (cache[2] > uoffset0) {
5462 /* and the cache knows more than the passed in pair */
5463 uoffset0 = cache[2];
5464 boffset0 = cache[3];
5468 + sv_pos_u2b_midway(start + boffset0,
5471 cache[0] - uoffset0);
5474 + sv_pos_u2b_midway(start + boffset0,
5477 cache[2] - uoffset0);
5481 else if ((*mgp)->mg_len != -1) {
5482 /* If we can take advantage of a passed in offset, do so. */
5483 /* In fact, offset0 is either 0, or less than offset, so don't
5484 need to worry about the other possibility. */
5486 + sv_pos_u2b_midway(start + boffset0, send,
5488 (*mgp)->mg_len - uoffset0);
5493 if (!found || PL_utf8cache < 0) {
5494 const STRLEN real_boffset
5495 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5496 send, uoffset - uoffset0);
5498 if (found && PL_utf8cache < 0) {
5499 if (real_boffset != boffset) {
5500 /* Need to turn the assertions off otherwise we may recurse
5501 infinitely while printing error messages. */
5502 SAVEI8(PL_utf8cache);
5504 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5505 " real %"UVf" for %"SVf,
5506 (UV) boffset, (UV) real_boffset, (void*)sv);
5509 boffset = real_boffset;
5512 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5518 =for apidoc sv_pos_u2b
5520 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5521 the start of the string, to a count of the equivalent number of bytes; if
5522 lenp is non-zero, it does the same to lenp, but this time starting from
5523 the offset, rather than from the start of the string. Handles magic and
5530 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5531 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5532 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5537 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5545 start = (U8*)SvPV_const(sv, len);
5547 STRLEN uoffset = (STRLEN) *offsetp;
5548 const U8 * const send = start + len;
5550 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5553 *offsetp = (I32) boffset;
5556 /* Convert the relative offset to absolute. */
5557 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5558 const STRLEN boffset2
5559 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5560 uoffset, boffset) - boffset;
5574 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5575 byte length pairing. The (byte) length of the total SV is passed in too,
5576 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5577 may not have updated SvCUR, so we can't rely on reading it directly.
5579 The proffered utf8/byte length pairing isn't used if the cache already has
5580 two pairs, and swapping either for the proffered pair would increase the
5581 RMS of the intervals between known byte offsets.
5583 The cache itself consists of 4 STRLEN values
5584 0: larger UTF-8 offset
5585 1: corresponding byte offset
5586 2: smaller UTF-8 offset
5587 3: corresponding byte offset
5589 Unused cache pairs have the value 0, 0.
5590 Keeping the cache "backwards" means that the invariant of
5591 cache[0] >= cache[2] is maintained even with empty slots, which means that
5592 the code that uses it doesn't need to worry if only 1 entry has actually
5593 been set to non-zero. It also makes the "position beyond the end of the
5594 cache" logic much simpler, as the first slot is always the one to start
5598 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5606 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5608 (*mgp)->mg_len = -1;
5612 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5613 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5614 (*mgp)->mg_ptr = (char *) cache;
5618 if (PL_utf8cache < 0) {
5619 const U8 *start = (const U8 *) SvPVX_const(sv);
5620 const U8 *const end = start + byte;
5621 STRLEN realutf8 = 0;
5623 while (start < end) {
5624 start += UTF8SKIP(start);
5628 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5629 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5630 doesn't? I don't know whether this difference was introduced with
5631 the caching code in 5.8.1. */
5633 if (realutf8 != utf8) {
5634 /* Need to turn the assertions off otherwise we may recurse
5635 infinitely while printing error messages. */
5636 SAVEI8(PL_utf8cache);
5638 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5639 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5643 /* Cache is held with the later position first, to simplify the code
5644 that deals with unbounded ends. */
5646 ASSERT_UTF8_CACHE(cache);
5647 if (cache[1] == 0) {
5648 /* Cache is totally empty */
5651 } else if (cache[3] == 0) {
5652 if (byte > cache[1]) {
5653 /* New one is larger, so goes first. */
5654 cache[2] = cache[0];
5655 cache[3] = cache[1];
5663 #define THREEWAY_SQUARE(a,b,c,d) \
5664 ((float)((d) - (c))) * ((float)((d) - (c))) \
5665 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5666 + ((float)((b) - (a))) * ((float)((b) - (a)))
5668 /* Cache has 2 slots in use, and we know three potential pairs.
5669 Keep the two that give the lowest RMS distance. Do the
5670 calcualation in bytes simply because we always know the byte
5671 length. squareroot has the same ordering as the positive value,
5672 so don't bother with the actual square root. */
5673 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5674 if (byte > cache[1]) {
5675 /* New position is after the existing pair of pairs. */
5676 const float keep_earlier
5677 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5678 const float keep_later
5679 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5681 if (keep_later < keep_earlier) {
5682 if (keep_later < existing) {
5683 cache[2] = cache[0];
5684 cache[3] = cache[1];
5690 if (keep_earlier < existing) {
5696 else if (byte > cache[3]) {
5697 /* New position is between the existing pair of pairs. */
5698 const float keep_earlier
5699 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5700 const float keep_later
5701 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5703 if (keep_later < keep_earlier) {
5704 if (keep_later < existing) {
5710 if (keep_earlier < existing) {
5717 /* New position is before the existing pair of pairs. */
5718 const float keep_earlier
5719 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5720 const float keep_later
5721 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5723 if (keep_later < keep_earlier) {
5724 if (keep_later < existing) {
5730 if (keep_earlier < existing) {
5731 cache[0] = cache[2];
5732 cache[1] = cache[3];
5739 ASSERT_UTF8_CACHE(cache);
5742 /* If we don't know the character offset of the end of a region, our only
5743 option is to walk forwards to the target byte offset. */
5745 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5748 while (s < target) {
5751 /* Call utf8n_to_uvchr() to validate the sequence
5752 * (unless a simple non-UTF character) */
5753 if (!UTF8_IS_INVARIANT(*s))
5754 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5765 /* We already know all of the way, now we may be able to walk back. The same
5766 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5767 backward is half the speed of walking forward. */
5769 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5772 const STRLEN forw = target - s;
5773 STRLEN backw = end - target;
5775 if (forw < 2 * backw) {
5776 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5779 while (end > target) {
5781 while (UTF8_IS_CONTINUATION(*end)) {
5790 =for apidoc sv_pos_b2u
5792 Converts the value pointed to by offsetp from a count of bytes from the
5793 start of the string, to a count of the equivalent number of UTF-8 chars.
5794 Handles magic and type coercion.
5800 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5801 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5806 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5809 const STRLEN byte = *offsetp;
5810 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5819 s = (const U8*)SvPV_const(sv, blen);
5822 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5826 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5827 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5829 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5830 if (cache[1] == byte) {
5831 /* An exact match. */
5832 *offsetp = cache[0];
5835 if (cache[3] == byte) {
5836 /* An exact match. */
5837 *offsetp = cache[2];
5841 if (cache[1] < byte) {
5842 /* We already know part of the way. */
5843 if (mg->mg_len != -1) {
5844 /* Actually, we know the end too. */
5846 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5847 s + blen, mg->mg_len - cache[0]);
5850 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5853 else if (cache[3] < byte) {
5854 /* We're between the two cached pairs, so we do the calculation
5855 offset by the byte/utf-8 positions for the earlier pair,
5856 then add the utf-8 characters from the string start to
5858 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5859 s + cache[1], cache[0] - cache[2])
5863 else { /* cache[3] > byte */
5864 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5868 ASSERT_UTF8_CACHE(cache);
5870 } else if (mg->mg_len != -1) {
5871 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5875 if (!found || PL_utf8cache < 0) {
5876 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5878 if (found && PL_utf8cache < 0) {
5879 if (len != real_len) {
5880 /* Need to turn the assertions off otherwise we may recurse
5881 infinitely while printing error messages. */
5882 SAVEI8(PL_utf8cache);
5884 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5885 " real %"UVf" for %"SVf,
5886 (UV) len, (UV) real_len, (void*)sv);
5893 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5899 Returns a boolean indicating whether the strings in the two SVs are
5900 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5901 coerce its args to strings if necessary.
5907 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5916 SV* svrecode = NULL;
5923 pv1 = SvPV_const(sv1, cur1);
5930 pv2 = SvPV_const(sv2, cur2);
5932 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5933 /* Differing utf8ness.
5934 * Do not UTF8size the comparands as a side-effect. */
5937 svrecode = newSVpvn(pv2, cur2);
5938 sv_recode_to_utf8(svrecode, PL_encoding);
5939 pv2 = SvPV_const(svrecode, cur2);
5942 svrecode = newSVpvn(pv1, cur1);
5943 sv_recode_to_utf8(svrecode, PL_encoding);
5944 pv1 = SvPV_const(svrecode, cur1);
5946 /* Now both are in UTF-8. */
5948 SvREFCNT_dec(svrecode);
5953 bool is_utf8 = TRUE;
5956 /* sv1 is the UTF-8 one,
5957 * if is equal it must be downgrade-able */
5958 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5964 /* sv2 is the UTF-8 one,
5965 * if is equal it must be downgrade-able */
5966 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5972 /* Downgrade not possible - cannot be eq */
5980 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5982 SvREFCNT_dec(svrecode);
5992 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5993 string in C<sv1> is less than, equal to, or greater than the string in
5994 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5995 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6001 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6005 const char *pv1, *pv2;
6008 SV *svrecode = NULL;
6015 pv1 = SvPV_const(sv1, cur1);
6022 pv2 = SvPV_const(sv2, cur2);
6024 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6025 /* Differing utf8ness.
6026 * Do not UTF8size the comparands as a side-effect. */
6029 svrecode = newSVpvn(pv2, cur2);
6030 sv_recode_to_utf8(svrecode, PL_encoding);
6031 pv2 = SvPV_const(svrecode, cur2);
6034 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6039 svrecode = newSVpvn(pv1, cur1);
6040 sv_recode_to_utf8(svrecode, PL_encoding);
6041 pv1 = SvPV_const(svrecode, cur1);
6044 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6050 cmp = cur2 ? -1 : 0;
6054 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6057 cmp = retval < 0 ? -1 : 1;
6058 } else if (cur1 == cur2) {
6061 cmp = cur1 < cur2 ? -1 : 1;
6065 SvREFCNT_dec(svrecode);
6073 =for apidoc sv_cmp_locale
6075 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6076 'use bytes' aware, handles get magic, and will coerce its args to strings
6077 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6083 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6086 #ifdef USE_LOCALE_COLLATE
6092 if (PL_collation_standard)
6096 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6098 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6100 if (!pv1 || !len1) {
6111 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6114 return retval < 0 ? -1 : 1;
6117 * When the result of collation is equality, that doesn't mean
6118 * that there are no differences -- some locales exclude some
6119 * characters from consideration. So to avoid false equalities,
6120 * we use the raw string as a tiebreaker.
6126 #endif /* USE_LOCALE_COLLATE */
6128 return sv_cmp(sv1, sv2);
6132 #ifdef USE_LOCALE_COLLATE
6135 =for apidoc sv_collxfrm
6137 Add Collate Transform magic to an SV if it doesn't already have it.
6139 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6140 scalar data of the variable, but transformed to such a format that a normal
6141 memory comparison can be used to compare the data according to the locale
6148 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6153 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6154 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6160 Safefree(mg->mg_ptr);
6161 s = SvPV_const(sv, len);
6162 if ((xf = mem_collxfrm(s, len, &xlen))) {
6163 if (SvREADONLY(sv)) {
6166 return xf + sizeof(PL_collation_ix);
6169 #ifdef PERL_OLD_COPY_ON_WRITE
6171 sv_force_normal_flags(sv, 0);
6173 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6187 if (mg && mg->mg_ptr) {
6189 return mg->mg_ptr + sizeof(PL_collation_ix);
6197 #endif /* USE_LOCALE_COLLATE */
6202 Get a line from the filehandle and store it into the SV, optionally
6203 appending to the currently-stored string.
6209 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6214 register STDCHAR rslast;
6215 register STDCHAR *bp;
6220 if (SvTHINKFIRST(sv))
6221 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6222 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6224 However, perlbench says it's slower, because the existing swipe code
6225 is faster than copy on write.
6226 Swings and roundabouts. */
6227 SvUPGRADE(sv, SVt_PV);
6232 if (PerlIO_isutf8(fp)) {
6234 sv_utf8_upgrade_nomg(sv);
6235 sv_pos_u2b(sv,&append,0);
6237 } else if (SvUTF8(sv)) {
6238 SV * const tsv = newSV(0);
6239 sv_gets(tsv, fp, 0);
6240 sv_utf8_upgrade_nomg(tsv);
6241 SvCUR_set(sv,append);
6244 goto return_string_or_null;
6249 if (PerlIO_isutf8(fp))
6252 if (IN_PERL_COMPILETIME) {
6253 /* we always read code in line mode */
6257 else if (RsSNARF(PL_rs)) {
6258 /* If it is a regular disk file use size from stat() as estimate
6259 of amount we are going to read -- may result in mallocing
6260 more memory than we really need if the layers below reduce
6261 the size we read (e.g. CRLF or a gzip layer).
6264 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6265 const Off_t offset = PerlIO_tell(fp);
6266 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6267 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6273 else if (RsRECORD(PL_rs)) {
6278 /* Grab the size of the record we're getting */
6279 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6280 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6283 /* VMS wants read instead of fread, because fread doesn't respect */
6284 /* RMS record boundaries. This is not necessarily a good thing to be */
6285 /* doing, but we've got no other real choice - except avoid stdio
6286 as implementation - perhaps write a :vms layer ?
6288 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6290 bytesread = PerlIO_read(fp, buffer, recsize);
6294 SvCUR_set(sv, bytesread += append);
6295 buffer[bytesread] = '\0';
6296 goto return_string_or_null;
6298 else if (RsPARA(PL_rs)) {
6304 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6305 if (PerlIO_isutf8(fp)) {
6306 rsptr = SvPVutf8(PL_rs, rslen);
6309 if (SvUTF8(PL_rs)) {
6310 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6311 Perl_croak(aTHX_ "Wide character in $/");
6314 rsptr = SvPV_const(PL_rs, rslen);
6318 rslast = rslen ? rsptr[rslen - 1] : '\0';
6320 if (rspara) { /* have to do this both before and after */
6321 do { /* to make sure file boundaries work right */
6324 i = PerlIO_getc(fp);
6328 PerlIO_ungetc(fp,i);
6334 /* See if we know enough about I/O mechanism to cheat it ! */
6336 /* This used to be #ifdef test - it is made run-time test for ease
6337 of abstracting out stdio interface. One call should be cheap
6338 enough here - and may even be a macro allowing compile
6342 if (PerlIO_fast_gets(fp)) {
6345 * We're going to steal some values from the stdio struct
6346 * and put EVERYTHING in the innermost loop into registers.
6348 register STDCHAR *ptr;
6352 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6353 /* An ungetc()d char is handled separately from the regular
6354 * buffer, so we getc() it back out and stuff it in the buffer.
6356 i = PerlIO_getc(fp);
6357 if (i == EOF) return 0;
6358 *(--((*fp)->_ptr)) = (unsigned char) i;
6362 /* Here is some breathtakingly efficient cheating */
6364 cnt = PerlIO_get_cnt(fp); /* get count into register */
6365 /* make sure we have the room */
6366 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6367 /* Not room for all of it
6368 if we are looking for a separator and room for some
6370 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6371 /* just process what we have room for */
6372 shortbuffered = cnt - SvLEN(sv) + append + 1;
6373 cnt -= shortbuffered;
6377 /* remember that cnt can be negative */
6378 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6383 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6384 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6385 DEBUG_P(PerlIO_printf(Perl_debug_log,
6386 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6387 DEBUG_P(PerlIO_printf(Perl_debug_log,
6388 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6389 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6390 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6395 while (cnt > 0) { /* this | eat */
6397 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6398 goto thats_all_folks; /* screams | sed :-) */
6402 Copy(ptr, bp, cnt, char); /* this | eat */
6403 bp += cnt; /* screams | dust */
6404 ptr += cnt; /* louder | sed :-) */
6409 if (shortbuffered) { /* oh well, must extend */
6410 cnt = shortbuffered;
6412 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6414 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6415 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6419 DEBUG_P(PerlIO_printf(Perl_debug_log,
6420 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6421 PTR2UV(ptr),(long)cnt));
6422 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6424 DEBUG_P(PerlIO_printf(Perl_debug_log,
6425 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6426 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6427 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6429 /* This used to call 'filbuf' in stdio form, but as that behaves like
6430 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6431 another abstraction. */
6432 i = PerlIO_getc(fp); /* get more characters */
6434 DEBUG_P(PerlIO_printf(Perl_debug_log,
6435 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6436 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6437 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6439 cnt = PerlIO_get_cnt(fp);
6440 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6441 DEBUG_P(PerlIO_printf(Perl_debug_log,
6442 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6444 if (i == EOF) /* all done for ever? */
6445 goto thats_really_all_folks;
6447 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6449 SvGROW(sv, bpx + cnt + 2);
6450 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6452 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6454 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6455 goto thats_all_folks;
6459 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6460 memNE((char*)bp - rslen, rsptr, rslen))
6461 goto screamer; /* go back to the fray */
6462 thats_really_all_folks:
6464 cnt += shortbuffered;
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6467 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6468 DEBUG_P(PerlIO_printf(Perl_debug_log,
6469 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6470 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6471 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6473 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6474 DEBUG_P(PerlIO_printf(Perl_debug_log,
6475 "Screamer: done, len=%ld, string=|%.*s|\n",
6476 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6480 /*The big, slow, and stupid way. */
6481 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6482 STDCHAR *buf = NULL;
6483 Newx(buf, 8192, STDCHAR);
6491 register const STDCHAR * const bpe = buf + sizeof(buf);
6493 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6494 ; /* keep reading */
6498 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6499 /* Accomodate broken VAXC compiler, which applies U8 cast to
6500 * both args of ?: operator, causing EOF to change into 255
6503 i = (U8)buf[cnt - 1];
6509 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6511 sv_catpvn(sv, (char *) buf, cnt);
6513 sv_setpvn(sv, (char *) buf, cnt);
6515 if (i != EOF && /* joy */
6517 SvCUR(sv) < rslen ||
6518 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6522 * If we're reading from a TTY and we get a short read,
6523 * indicating that the user hit his EOF character, we need
6524 * to notice it now, because if we try to read from the TTY
6525 * again, the EOF condition will disappear.
6527 * The comparison of cnt to sizeof(buf) is an optimization
6528 * that prevents unnecessary calls to feof().
6532 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6536 #ifdef USE_HEAP_INSTEAD_OF_STACK
6541 if (rspara) { /* have to do this both before and after */
6542 while (i != EOF) { /* to make sure file boundaries work right */
6543 i = PerlIO_getc(fp);
6545 PerlIO_ungetc(fp,i);
6551 return_string_or_null:
6552 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6558 Auto-increment of the value in the SV, doing string to numeric conversion
6559 if necessary. Handles 'get' magic.
6565 Perl_sv_inc(pTHX_ register SV *sv)
6574 if (SvTHINKFIRST(sv)) {
6576 sv_force_normal_flags(sv, 0);
6577 if (SvREADONLY(sv)) {
6578 if (IN_PERL_RUNTIME)
6579 Perl_croak(aTHX_ PL_no_modify);
6583 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6585 i = PTR2IV(SvRV(sv));
6590 flags = SvFLAGS(sv);
6591 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6592 /* It's (privately or publicly) a float, but not tested as an
6593 integer, so test it to see. */
6595 flags = SvFLAGS(sv);
6597 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6598 /* It's publicly an integer, or privately an integer-not-float */
6599 #ifdef PERL_PRESERVE_IVUV
6603 if (SvUVX(sv) == UV_MAX)
6604 sv_setnv(sv, UV_MAX_P1);
6606 (void)SvIOK_only_UV(sv);
6607 SvUV_set(sv, SvUVX(sv) + 1);
6609 if (SvIVX(sv) == IV_MAX)
6610 sv_setuv(sv, (UV)IV_MAX + 1);
6612 (void)SvIOK_only(sv);
6613 SvIV_set(sv, SvIVX(sv) + 1);
6618 if (flags & SVp_NOK) {
6619 (void)SvNOK_only(sv);
6620 SvNV_set(sv, SvNVX(sv) + 1.0);
6624 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6625 if ((flags & SVTYPEMASK) < SVt_PVIV)
6626 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6627 (void)SvIOK_only(sv);
6632 while (isALPHA(*d)) d++;
6633 while (isDIGIT(*d)) d++;
6635 #ifdef PERL_PRESERVE_IVUV
6636 /* Got to punt this as an integer if needs be, but we don't issue
6637 warnings. Probably ought to make the sv_iv_please() that does
6638 the conversion if possible, and silently. */
6639 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6640 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6641 /* Need to try really hard to see if it's an integer.
6642 9.22337203685478e+18 is an integer.
6643 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6644 so $a="9.22337203685478e+18"; $a+0; $a++
6645 needs to be the same as $a="9.22337203685478e+18"; $a++
6652 /* sv_2iv *should* have made this an NV */
6653 if (flags & SVp_NOK) {
6654 (void)SvNOK_only(sv);
6655 SvNV_set(sv, SvNVX(sv) + 1.0);
6658 /* I don't think we can get here. Maybe I should assert this
6659 And if we do get here I suspect that sv_setnv will croak. NWC
6661 #if defined(USE_LONG_DOUBLE)
6662 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",
6663 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6665 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6666 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6669 #endif /* PERL_PRESERVE_IVUV */
6670 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6674 while (d >= SvPVX_const(sv)) {
6682 /* MKS: The original code here died if letters weren't consecutive.
6683 * at least it didn't have to worry about non-C locales. The
6684 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6685 * arranged in order (although not consecutively) and that only
6686 * [A-Za-z] are accepted by isALPHA in the C locale.
6688 if (*d != 'z' && *d != 'Z') {
6689 do { ++*d; } while (!isALPHA(*d));
6692 *(d--) -= 'z' - 'a';
6697 *(d--) -= 'z' - 'a' + 1;
6701 /* oh,oh, the number grew */
6702 SvGROW(sv, SvCUR(sv) + 2);
6703 SvCUR_set(sv, SvCUR(sv) + 1);
6704 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6715 Auto-decrement of the value in the SV, doing string to numeric conversion
6716 if necessary. Handles 'get' magic.
6722 Perl_sv_dec(pTHX_ register SV *sv)
6730 if (SvTHINKFIRST(sv)) {
6732 sv_force_normal_flags(sv, 0);
6733 if (SvREADONLY(sv)) {
6734 if (IN_PERL_RUNTIME)
6735 Perl_croak(aTHX_ PL_no_modify);
6739 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6741 i = PTR2IV(SvRV(sv));
6746 /* Unlike sv_inc we don't have to worry about string-never-numbers
6747 and keeping them magic. But we mustn't warn on punting */
6748 flags = SvFLAGS(sv);
6749 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6750 /* It's publicly an integer, or privately an integer-not-float */
6751 #ifdef PERL_PRESERVE_IVUV
6755 if (SvUVX(sv) == 0) {
6756 (void)SvIOK_only(sv);
6760 (void)SvIOK_only_UV(sv);
6761 SvUV_set(sv, SvUVX(sv) - 1);
6764 if (SvIVX(sv) == IV_MIN)
6765 sv_setnv(sv, (NV)IV_MIN - 1.0);
6767 (void)SvIOK_only(sv);
6768 SvIV_set(sv, SvIVX(sv) - 1);
6773 if (flags & SVp_NOK) {
6774 SvNV_set(sv, SvNVX(sv) - 1.0);
6775 (void)SvNOK_only(sv);
6778 if (!(flags & SVp_POK)) {
6779 if ((flags & SVTYPEMASK) < SVt_PVIV)
6780 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6782 (void)SvIOK_only(sv);
6785 #ifdef PERL_PRESERVE_IVUV
6787 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6788 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6789 /* Need to try really hard to see if it's an integer.
6790 9.22337203685478e+18 is an integer.
6791 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6792 so $a="9.22337203685478e+18"; $a+0; $a--
6793 needs to be the same as $a="9.22337203685478e+18"; $a--
6800 /* sv_2iv *should* have made this an NV */
6801 if (flags & SVp_NOK) {
6802 (void)SvNOK_only(sv);
6803 SvNV_set(sv, SvNVX(sv) - 1.0);
6806 /* I don't think we can get here. Maybe I should assert this
6807 And if we do get here I suspect that sv_setnv will croak. NWC
6809 #if defined(USE_LONG_DOUBLE)
6810 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",
6811 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6813 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6814 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6818 #endif /* PERL_PRESERVE_IVUV */
6819 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6823 =for apidoc sv_mortalcopy
6825 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6826 The new SV is marked as mortal. It will be destroyed "soon", either by an
6827 explicit call to FREETMPS, or by an implicit call at places such as
6828 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6833 /* Make a string that will exist for the duration of the expression
6834 * evaluation. Actually, it may have to last longer than that, but
6835 * hopefully we won't free it until it has been assigned to a
6836 * permanent location. */
6839 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6845 sv_setsv(sv,oldstr);
6847 PL_tmps_stack[++PL_tmps_ix] = sv;
6853 =for apidoc sv_newmortal
6855 Creates a new null SV which is mortal. The reference count of the SV is
6856 set to 1. It will be destroyed "soon", either by an explicit call to
6857 FREETMPS, or by an implicit call at places such as statement boundaries.
6858 See also C<sv_mortalcopy> and C<sv_2mortal>.
6864 Perl_sv_newmortal(pTHX)
6870 SvFLAGS(sv) = SVs_TEMP;
6872 PL_tmps_stack[++PL_tmps_ix] = sv;
6877 =for apidoc sv_2mortal
6879 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6880 by an explicit call to FREETMPS, or by an implicit call at places such as
6881 statement boundaries. SvTEMP() is turned on which means that the SV's
6882 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6883 and C<sv_mortalcopy>.
6889 Perl_sv_2mortal(pTHX_ register SV *sv)
6894 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6897 PL_tmps_stack[++PL_tmps_ix] = sv;
6905 Creates a new SV and copies a string into it. The reference count for the
6906 SV is set to 1. If C<len> is zero, Perl will compute the length using
6907 strlen(). For efficiency, consider using C<newSVpvn> instead.
6913 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6919 sv_setpvn(sv,s,len ? len : strlen(s));
6924 =for apidoc newSVpvn
6926 Creates a new SV and copies a string into it. The reference count for the
6927 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6928 string. You are responsible for ensuring that the source string is at least
6929 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6935 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6941 sv_setpvn(sv,s,len);
6947 =for apidoc newSVhek
6949 Creates a new SV from the hash key structure. It will generate scalars that
6950 point to the shared string table where possible. Returns a new (undefined)
6951 SV if the hek is NULL.
6957 Perl_newSVhek(pTHX_ const HEK *hek)
6967 if (HEK_LEN(hek) == HEf_SVKEY) {
6968 return newSVsv(*(SV**)HEK_KEY(hek));
6970 const int flags = HEK_FLAGS(hek);
6971 if (flags & HVhek_WASUTF8) {
6973 Andreas would like keys he put in as utf8 to come back as utf8
6975 STRLEN utf8_len = HEK_LEN(hek);
6976 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6977 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6980 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6982 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6983 /* We don't have a pointer to the hv, so we have to replicate the
6984 flag into every HEK. This hv is using custom a hasing
6985 algorithm. Hence we can't return a shared string scalar, as
6986 that would contain the (wrong) hash value, and might get passed
6987 into an hv routine with a regular hash.
6988 Similarly, a hash that isn't using shared hash keys has to have
6989 the flag in every key so that we know not to try to call
6990 share_hek_kek on it. */
6992 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6997 /* This will be overwhelminly the most common case. */
6999 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7000 more efficient than sharepvn(). */
7004 sv_upgrade(sv, SVt_PV);
7005 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7006 SvCUR_set(sv, HEK_LEN(hek));
7019 =for apidoc newSVpvn_share
7021 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7022 table. If the string does not already exist in the table, it is created
7023 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7024 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7025 otherwise the hash is computed. The idea here is that as the string table
7026 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7027 hash lookup will avoid string compare.
7033 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7037 bool is_utf8 = FALSE;
7038 const char *const orig_src = src;
7041 STRLEN tmplen = -len;
7043 /* See the note in hv.c:hv_fetch() --jhi */
7044 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7048 PERL_HASH(hash, src, len);
7050 sv_upgrade(sv, SVt_PV);
7051 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7059 if (src != orig_src)
7065 #if defined(PERL_IMPLICIT_CONTEXT)
7067 /* pTHX_ magic can't cope with varargs, so this is a no-context
7068 * version of the main function, (which may itself be aliased to us).
7069 * Don't access this version directly.
7073 Perl_newSVpvf_nocontext(const char* pat, ...)
7078 va_start(args, pat);
7079 sv = vnewSVpvf(pat, &args);
7086 =for apidoc newSVpvf
7088 Creates a new SV and initializes it with the string formatted like
7095 Perl_newSVpvf(pTHX_ const char* pat, ...)
7099 va_start(args, pat);
7100 sv = vnewSVpvf(pat, &args);
7105 /* backend for newSVpvf() and newSVpvf_nocontext() */
7108 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7113 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7120 Creates a new SV and copies a floating point value into it.
7121 The reference count for the SV is set to 1.
7127 Perl_newSVnv(pTHX_ NV n)
7140 Creates a new SV and copies an integer into it. The reference count for the
7147 Perl_newSViv(pTHX_ IV i)
7160 Creates a new SV and copies an unsigned integer into it.
7161 The reference count for the SV is set to 1.
7167 Perl_newSVuv(pTHX_ UV u)
7178 =for apidoc newRV_noinc
7180 Creates an RV wrapper for an SV. The reference count for the original
7181 SV is B<not> incremented.
7187 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7193 sv_upgrade(sv, SVt_RV);
7195 SvRV_set(sv, tmpRef);
7200 /* newRV_inc is the official function name to use now.
7201 * newRV_inc is in fact #defined to newRV in sv.h
7205 Perl_newRV(pTHX_ SV *sv)
7208 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7214 Creates a new SV which is an exact duplicate of the original SV.
7221 Perl_newSVsv(pTHX_ register SV *old)
7228 if (SvTYPE(old) == SVTYPEMASK) {
7229 if (ckWARN_d(WARN_INTERNAL))
7230 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7234 /* SV_GMAGIC is the default for sv_setv()
7235 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7236 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7237 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7242 =for apidoc sv_reset
7244 Underlying implementation for the C<reset> Perl function.
7245 Note that the perl-level function is vaguely deprecated.
7251 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7254 char todo[PERL_UCHAR_MAX+1];
7259 if (!*s) { /* reset ?? searches */
7260 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7262 PMOP *pm = (PMOP *) mg->mg_obj;
7264 pm->op_pmdynflags &= ~PMdf_USED;
7271 /* reset variables */
7273 if (!HvARRAY(stash))
7276 Zero(todo, 256, char);
7279 I32 i = (unsigned char)*s;
7283 max = (unsigned char)*s++;
7284 for ( ; i <= max; i++) {
7287 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7289 for (entry = HvARRAY(stash)[i];
7291 entry = HeNEXT(entry))
7296 if (!todo[(U8)*HeKEY(entry)])
7298 gv = (GV*)HeVAL(entry);
7301 if (SvTHINKFIRST(sv)) {
7302 if (!SvREADONLY(sv) && SvROK(sv))
7304 /* XXX Is this continue a bug? Why should THINKFIRST
7305 exempt us from resetting arrays and hashes? */
7309 if (SvTYPE(sv) >= SVt_PV) {
7311 if (SvPVX_const(sv) != NULL)
7319 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7321 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7324 # if defined(USE_ENVIRON_ARRAY)
7327 # endif /* USE_ENVIRON_ARRAY */
7338 Using various gambits, try to get an IO from an SV: the IO slot if its a
7339 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7340 named after the PV if we're a string.
7346 Perl_sv_2io(pTHX_ SV *sv)
7351 switch (SvTYPE(sv)) {
7359 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7363 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7365 return sv_2io(SvRV(sv));
7366 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7372 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7381 Using various gambits, try to get a CV from an SV; in addition, try if
7382 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7383 The flags in C<lref> are passed to sv_fetchsv.
7389 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7400 switch (SvTYPE(sv)) {
7419 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7420 tryAMAGICunDEREF(to_cv);
7423 if (SvTYPE(sv) == SVt_PVCV) {
7432 Perl_croak(aTHX_ "Not a subroutine reference");
7437 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7443 /* Some flags to gv_fetchsv mean don't really create the GV */
7444 if (SvTYPE(gv) != SVt_PVGV) {
7450 if (lref && !GvCVu(gv)) {
7454 gv_efullname3(tmpsv, gv, NULL);
7455 /* XXX this is probably not what they think they're getting.
7456 * It has the same effect as "sub name;", i.e. just a forward
7458 newSUB(start_subparse(FALSE, 0),
7459 newSVOP(OP_CONST, 0, tmpsv),
7463 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7473 Returns true if the SV has a true value by Perl's rules.
7474 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7475 instead use an in-line version.
7481 Perl_sv_true(pTHX_ register SV *sv)
7486 register const XPV* const tXpv = (XPV*)SvANY(sv);
7488 (tXpv->xpv_cur > 1 ||
7489 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7496 return SvIVX(sv) != 0;
7499 return SvNVX(sv) != 0.0;
7501 return sv_2bool(sv);
7507 =for apidoc sv_pvn_force
7509 Get a sensible string out of the SV somehow.
7510 A private implementation of the C<SvPV_force> macro for compilers which
7511 can't cope with complex macro expressions. Always use the macro instead.
7513 =for apidoc sv_pvn_force_flags
7515 Get a sensible string out of the SV somehow.
7516 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7517 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7518 implemented in terms of this function.
7519 You normally want to use the various wrapper macros instead: see
7520 C<SvPV_force> and C<SvPV_force_nomg>
7526 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7529 if (SvTHINKFIRST(sv) && !SvROK(sv))
7530 sv_force_normal_flags(sv, 0);
7540 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7541 const char * const ref = sv_reftype(sv,0);
7543 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7544 ref, OP_NAME(PL_op));
7546 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7548 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7549 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7551 s = sv_2pv_flags(sv, &len, flags);
7555 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7558 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7559 SvGROW(sv, len + 1);
7560 Move(s,SvPVX(sv),len,char);
7565 SvPOK_on(sv); /* validate pointer */
7567 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7568 PTR2UV(sv),SvPVX_const(sv)));
7571 return SvPVX_mutable(sv);
7575 =for apidoc sv_pvbyten_force
7577 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7583 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7585 sv_pvn_force(sv,lp);
7586 sv_utf8_downgrade(sv,0);
7592 =for apidoc sv_pvutf8n_force
7594 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7600 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7602 sv_pvn_force(sv,lp);
7603 sv_utf8_upgrade(sv);
7609 =for apidoc sv_reftype
7611 Returns a string describing what the SV is a reference to.
7617 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7619 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7620 inside return suggests a const propagation bug in g++. */
7621 if (ob && SvOBJECT(sv)) {
7622 char * const name = HvNAME_get(SvSTASH(sv));
7623 return name ? name : (char *) "__ANON__";
7626 switch (SvTYPE(sv)) {
7643 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7644 /* tied lvalues should appear to be
7645 * scalars for backwards compatitbility */
7646 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7647 ? "SCALAR" : "LVALUE");
7648 case SVt_PVAV: return "ARRAY";
7649 case SVt_PVHV: return "HASH";
7650 case SVt_PVCV: return "CODE";
7651 case SVt_PVGV: return "GLOB";
7652 case SVt_PVFM: return "FORMAT";
7653 case SVt_PVIO: return "IO";
7654 default: return "UNKNOWN";
7660 =for apidoc sv_isobject
7662 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7663 object. If the SV is not an RV, or if the object is not blessed, then this
7670 Perl_sv_isobject(pTHX_ SV *sv)
7686 Returns a boolean indicating whether the SV is blessed into the specified
7687 class. This does not check for subtypes; use C<sv_derived_from> to verify
7688 an inheritance relationship.
7694 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7705 hvname = HvNAME_get(SvSTASH(sv));
7709 return strEQ(hvname, name);
7715 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7716 it will be upgraded to one. If C<classname> is non-null then the new SV will
7717 be blessed in the specified package. The new SV is returned and its
7718 reference count is 1.
7724 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7731 SV_CHECK_THINKFIRST_COW_DROP(rv);
7734 if (SvTYPE(rv) >= SVt_PVMG) {
7735 const U32 refcnt = SvREFCNT(rv);
7739 SvREFCNT(rv) = refcnt;
7741 sv_upgrade(rv, SVt_RV);
7742 } else if (SvROK(rv)) {
7743 SvREFCNT_dec(SvRV(rv));
7744 } else if (SvTYPE(rv) < SVt_RV)
7745 sv_upgrade(rv, SVt_RV);
7746 else if (SvTYPE(rv) > SVt_RV) {
7757 HV* const stash = gv_stashpv(classname, TRUE);
7758 (void)sv_bless(rv, stash);
7764 =for apidoc sv_setref_pv
7766 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7767 argument will be upgraded to an RV. That RV will be modified to point to
7768 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7769 into the SV. The C<classname> argument indicates the package for the
7770 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7771 will have a reference count of 1, and the RV will be returned.
7773 Do not use with other Perl types such as HV, AV, SV, CV, because those
7774 objects will become corrupted by the pointer copy process.
7776 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7782 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7786 sv_setsv(rv, &PL_sv_undef);
7790 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7795 =for apidoc sv_setref_iv
7797 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7798 argument will be upgraded to an RV. That RV will be modified to point to
7799 the new SV. The C<classname> argument indicates the package for the
7800 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7801 will have a reference count of 1, and the RV will be returned.
7807 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7809 sv_setiv(newSVrv(rv,classname), iv);
7814 =for apidoc sv_setref_uv
7816 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7817 argument will be upgraded to an RV. That RV will be modified to point to
7818 the new SV. The C<classname> argument indicates the package for the
7819 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7820 will have a reference count of 1, and the RV will be returned.
7826 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7828 sv_setuv(newSVrv(rv,classname), uv);
7833 =for apidoc sv_setref_nv
7835 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7836 argument will be upgraded to an RV. That RV will be modified to point to
7837 the new SV. The C<classname> argument indicates the package for the
7838 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7839 will have a reference count of 1, and the RV will be returned.
7845 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7847 sv_setnv(newSVrv(rv,classname), nv);
7852 =for apidoc sv_setref_pvn
7854 Copies a string into a new SV, optionally blessing the SV. The length of the
7855 string must be specified with C<n>. The C<rv> argument will be upgraded to
7856 an RV. That RV will be modified to point to the new SV. The C<classname>
7857 argument indicates the package for the blessing. Set C<classname> to
7858 C<NULL> to avoid the blessing. The new SV will have a reference count
7859 of 1, and the RV will be returned.
7861 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7867 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7869 sv_setpvn(newSVrv(rv,classname), pv, n);
7874 =for apidoc sv_bless
7876 Blesses an SV into a specified package. The SV must be an RV. The package
7877 must be designated by its stash (see C<gv_stashpv()>). The reference count
7878 of the SV is unaffected.
7884 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7889 Perl_croak(aTHX_ "Can't bless non-reference value");
7891 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7892 if (SvREADONLY(tmpRef))
7893 Perl_croak(aTHX_ PL_no_modify);
7894 if (SvOBJECT(tmpRef)) {
7895 if (SvTYPE(tmpRef) != SVt_PVIO)
7897 SvREFCNT_dec(SvSTASH(tmpRef));
7900 SvOBJECT_on(tmpRef);
7901 if (SvTYPE(tmpRef) != SVt_PVIO)
7903 SvUPGRADE(tmpRef, SVt_PVMG);
7904 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7911 if(SvSMAGICAL(tmpRef))
7912 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7920 /* Downgrades a PVGV to a PVMG.
7924 S_sv_unglob(pTHX_ SV *sv)
7928 SV * const temp = sv_newmortal();
7930 assert(SvTYPE(sv) == SVt_PVGV);
7932 gv_efullname3(temp, (GV *) sv, "*");
7938 sv_del_backref((SV*)GvSTASH(sv), sv);
7942 if (GvNAME_HEK(sv)) {
7943 unshare_hek(GvNAME_HEK(sv));
7947 /* need to keep SvANY(sv) in the right arena */
7948 xpvmg = new_XPVMG();
7949 StructCopy(SvANY(sv), xpvmg, XPVMG);
7950 del_XPVGV(SvANY(sv));
7953 SvFLAGS(sv) &= ~SVTYPEMASK;
7954 SvFLAGS(sv) |= SVt_PVMG;
7956 /* Intentionally not calling any local SET magic, as this isn't so much a
7957 set operation as merely an internal storage change. */
7958 sv_setsv_flags(sv, temp, 0);
7962 =for apidoc sv_unref_flags
7964 Unsets the RV status of the SV, and decrements the reference count of
7965 whatever was being referenced by the RV. This can almost be thought of
7966 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7967 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7968 (otherwise the decrementing is conditional on the reference count being
7969 different from one or the reference being a readonly SV).
7976 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7978 SV* const target = SvRV(ref);
7980 if (SvWEAKREF(ref)) {
7981 sv_del_backref(target, ref);
7983 SvRV_set(ref, NULL);
7986 SvRV_set(ref, NULL);
7988 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7989 assigned to as BEGIN {$a = \"Foo"} will fail. */
7990 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7991 SvREFCNT_dec(target);
7992 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7993 sv_2mortal(target); /* Schedule for freeing later */
7997 =for apidoc sv_untaint
7999 Untaint an SV. Use C<SvTAINTED_off> instead.
8004 Perl_sv_untaint(pTHX_ SV *sv)
8006 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8007 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8014 =for apidoc sv_tainted
8016 Test an SV for taintedness. Use C<SvTAINTED> instead.
8021 Perl_sv_tainted(pTHX_ SV *sv)
8023 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8024 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8025 if (mg && (mg->mg_len & 1) )
8032 =for apidoc sv_setpviv
8034 Copies an integer into the given SV, also updating its string value.
8035 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8041 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8043 char buf[TYPE_CHARS(UV)];
8045 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8047 sv_setpvn(sv, ptr, ebuf - ptr);
8051 =for apidoc sv_setpviv_mg
8053 Like C<sv_setpviv>, but also handles 'set' magic.
8059 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8065 #if defined(PERL_IMPLICIT_CONTEXT)
8067 /* pTHX_ magic can't cope with varargs, so this is a no-context
8068 * version of the main function, (which may itself be aliased to us).
8069 * Don't access this version directly.
8073 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8077 va_start(args, pat);
8078 sv_vsetpvf(sv, pat, &args);
8082 /* pTHX_ magic can't cope with varargs, so this is a no-context
8083 * version of the main function, (which may itself be aliased to us).
8084 * Don't access this version directly.
8088 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8092 va_start(args, pat);
8093 sv_vsetpvf_mg(sv, pat, &args);
8099 =for apidoc sv_setpvf
8101 Works like C<sv_catpvf> but copies the text into the SV instead of
8102 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8108 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8111 va_start(args, pat);
8112 sv_vsetpvf(sv, pat, &args);
8117 =for apidoc sv_vsetpvf
8119 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8120 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8122 Usually used via its frontend C<sv_setpvf>.
8128 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8130 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8134 =for apidoc sv_setpvf_mg
8136 Like C<sv_setpvf>, but also handles 'set' magic.
8142 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8145 va_start(args, pat);
8146 sv_vsetpvf_mg(sv, pat, &args);
8151 =for apidoc sv_vsetpvf_mg
8153 Like C<sv_vsetpvf>, but also handles 'set' magic.
8155 Usually used via its frontend C<sv_setpvf_mg>.
8161 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8163 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8167 #if defined(PERL_IMPLICIT_CONTEXT)
8169 /* pTHX_ magic can't cope with varargs, so this is a no-context
8170 * version of the main function, (which may itself be aliased to us).
8171 * Don't access this version directly.
8175 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8179 va_start(args, pat);
8180 sv_vcatpvf(sv, pat, &args);
8184 /* pTHX_ magic can't cope with varargs, so this is a no-context
8185 * version of the main function, (which may itself be aliased to us).
8186 * Don't access this version directly.
8190 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8194 va_start(args, pat);
8195 sv_vcatpvf_mg(sv, pat, &args);
8201 =for apidoc sv_catpvf
8203 Processes its arguments like C<sprintf> and appends the formatted
8204 output to an SV. If the appended data contains "wide" characters
8205 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8206 and characters >255 formatted with %c), the original SV might get
8207 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8208 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8209 valid UTF-8; if the original SV was bytes, the pattern should be too.
8214 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8217 va_start(args, pat);
8218 sv_vcatpvf(sv, pat, &args);
8223 =for apidoc sv_vcatpvf
8225 Processes its arguments like C<vsprintf> and appends the formatted output
8226 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8228 Usually used via its frontend C<sv_catpvf>.
8234 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8236 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8240 =for apidoc sv_catpvf_mg
8242 Like C<sv_catpvf>, but also handles 'set' magic.
8248 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8251 va_start(args, pat);
8252 sv_vcatpvf_mg(sv, pat, &args);
8257 =for apidoc sv_vcatpvf_mg
8259 Like C<sv_vcatpvf>, but also handles 'set' magic.
8261 Usually used via its frontend C<sv_catpvf_mg>.
8267 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8269 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8274 =for apidoc sv_vsetpvfn
8276 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8279 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8285 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8287 sv_setpvn(sv, "", 0);
8288 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8292 S_expect_number(pTHX_ char** pattern)
8296 switch (**pattern) {
8297 case '1': case '2': case '3':
8298 case '4': case '5': case '6':
8299 case '7': case '8': case '9':
8300 var = *(*pattern)++ - '0';
8301 while (isDIGIT(**pattern)) {
8302 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8304 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8312 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8314 const int neg = nv < 0;
8323 if (uv & 1 && uv == nv)
8324 uv--; /* Round to even */
8326 const unsigned dig = uv % 10;
8339 =for apidoc sv_vcatpvfn
8341 Processes its arguments like C<vsprintf> and appends the formatted output
8342 to an SV. Uses an array of SVs if the C style variable argument list is
8343 missing (NULL). When running with taint checks enabled, indicates via
8344 C<maybe_tainted> if results are untrustworthy (often due to the use of
8347 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8353 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8354 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8355 vec_utf8 = DO_UTF8(vecsv);
8357 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8360 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8368 static const char nullstr[] = "(null)";
8370 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8371 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8373 /* Times 4: a decimal digit takes more than 3 binary digits.
8374 * NV_DIG: mantissa takes than many decimal digits.
8375 * Plus 32: Playing safe. */
8376 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8377 /* large enough for "%#.#f" --chip */
8378 /* what about long double NVs? --jhi */
8380 PERL_UNUSED_ARG(maybe_tainted);
8382 /* no matter what, this is a string now */
8383 (void)SvPV_force(sv, origlen);
8385 /* special-case "", "%s", and "%-p" (SVf - see below) */
8388 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8390 const char * const s = va_arg(*args, char*);
8391 sv_catpv(sv, s ? s : nullstr);
8393 else if (svix < svmax) {
8394 sv_catsv(sv, *svargs);
8398 if (args && patlen == 3 && pat[0] == '%' &&
8399 pat[1] == '-' && pat[2] == 'p') {
8400 argsv = va_arg(*args, SV*);
8401 sv_catsv(sv, argsv);
8405 #ifndef USE_LONG_DOUBLE
8406 /* special-case "%.<number>[gf]" */
8407 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8408 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8409 unsigned digits = 0;
8413 while (*pp >= '0' && *pp <= '9')
8414 digits = 10 * digits + (*pp++ - '0');
8415 if (pp - pat == (int)patlen - 1) {
8423 /* Add check for digits != 0 because it seems that some
8424 gconverts are buggy in this case, and we don't yet have
8425 a Configure test for this. */
8426 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8427 /* 0, point, slack */
8428 Gconvert(nv, (int)digits, 0, ebuf);
8430 if (*ebuf) /* May return an empty string for digits==0 */
8433 } else if (!digits) {
8436 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8437 sv_catpvn(sv, p, l);
8443 #endif /* !USE_LONG_DOUBLE */
8445 if (!args && svix < svmax && DO_UTF8(*svargs))
8448 patend = (char*)pat + patlen;
8449 for (p = (char*)pat; p < patend; p = q) {
8452 bool vectorize = FALSE;
8453 bool vectorarg = FALSE;
8454 bool vec_utf8 = FALSE;
8460 bool has_precis = FALSE;
8462 const I32 osvix = svix;
8463 bool is_utf8 = FALSE; /* is this item utf8? */
8464 #ifdef HAS_LDBL_SPRINTF_BUG
8465 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8466 with sfio - Allen <allens@cpan.org> */
8467 bool fix_ldbl_sprintf_bug = FALSE;
8471 U8 utf8buf[UTF8_MAXBYTES+1];
8472 STRLEN esignlen = 0;
8474 const char *eptr = NULL;
8477 const U8 *vecstr = NULL;
8484 /* we need a long double target in case HAS_LONG_DOUBLE but
8487 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8495 const char *dotstr = ".";
8496 STRLEN dotstrlen = 1;
8497 I32 efix = 0; /* explicit format parameter index */
8498 I32 ewix = 0; /* explicit width index */
8499 I32 epix = 0; /* explicit precision index */
8500 I32 evix = 0; /* explicit vector index */
8501 bool asterisk = FALSE;
8503 /* echo everything up to the next format specification */
8504 for (q = p; q < patend && *q != '%'; ++q) ;
8506 if (has_utf8 && !pat_utf8)
8507 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8509 sv_catpvn(sv, p, q - p);
8516 We allow format specification elements in this order:
8517 \d+\$ explicit format parameter index
8519 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8520 0 flag (as above): repeated to allow "v02"
8521 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8522 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8524 [%bcdefginopsuxDFOUX] format (mandatory)
8529 As of perl5.9.3, printf format checking is on by default.
8530 Internally, perl uses %p formats to provide an escape to
8531 some extended formatting. This block deals with those
8532 extensions: if it does not match, (char*)q is reset and
8533 the normal format processing code is used.
8535 Currently defined extensions are:
8536 %p include pointer address (standard)
8537 %-p (SVf) include an SV (previously %_)
8538 %-<num>p include an SV with precision <num>
8539 %1p (VDf) include a v-string (as %vd)
8540 %<num>p reserved for future extensions
8542 Robin Barker 2005-07-14
8549 n = expect_number(&q);
8556 argsv = va_arg(*args, SV*);
8557 eptr = SvPVx_const(argsv, elen);
8563 else if (n == vdNUMBER) { /* VDf */
8570 if (ckWARN_d(WARN_INTERNAL))
8571 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8572 "internal %%<num>p might conflict with future printf extensions");
8578 if ( (width = expect_number(&q)) ) {
8619 if ( (ewix = expect_number(&q)) )
8628 if ((vectorarg = asterisk)) {
8641 width = expect_number(&q);
8647 vecsv = va_arg(*args, SV*);
8649 vecsv = (evix > 0 && evix <= svmax)
8650 ? svargs[evix-1] : &PL_sv_undef;
8652 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8654 dotstr = SvPV_const(vecsv, dotstrlen);
8655 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8656 bad with tied or overloaded values that return UTF8. */
8659 else if (has_utf8) {
8660 vecsv = sv_mortalcopy(vecsv);
8661 sv_utf8_upgrade(vecsv);
8662 dotstr = SvPV_const(vecsv, dotstrlen);
8669 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8670 vecsv = svargs[efix ? efix-1 : svix++];
8671 vecstr = (U8*)SvPV_const(vecsv,veclen);
8672 vec_utf8 = DO_UTF8(vecsv);
8674 /* if this is a version object, we need to convert
8675 * back into v-string notation and then let the
8676 * vectorize happen normally
8678 if (sv_derived_from(vecsv, "version")) {
8679 char *version = savesvpv(vecsv);
8680 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8681 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8682 "vector argument not supported with alpha versions");
8685 vecsv = sv_newmortal();
8686 /* scan_vstring is expected to be called during
8687 * tokenization, so we need to fake up the end
8688 * of the buffer for it
8690 PL_bufend = version + veclen;
8691 scan_vstring(version, vecsv);
8692 vecstr = (U8*)SvPV_const(vecsv, veclen);
8693 vec_utf8 = DO_UTF8(vecsv);
8705 i = va_arg(*args, int);
8707 i = (ewix ? ewix <= svmax : svix < svmax) ?
8708 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8710 width = (i < 0) ? -i : i;
8720 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8722 /* XXX: todo, support specified precision parameter */
8726 i = va_arg(*args, int);
8728 i = (ewix ? ewix <= svmax : svix < svmax)
8729 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8730 precis = (i < 0) ? 0 : i;
8735 precis = precis * 10 + (*q++ - '0');
8744 case 'I': /* Ix, I32x, and I64x */
8746 if (q[1] == '6' && q[2] == '4') {
8752 if (q[1] == '3' && q[2] == '2') {
8762 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8773 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8774 if (*(q + 1) == 'l') { /* lld, llf */
8800 if (!vectorize && !args) {
8802 const I32 i = efix-1;
8803 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8805 argsv = (svix >= 0 && svix < svmax)
8806 ? svargs[svix++] : &PL_sv_undef;
8817 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8819 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8821 eptr = (char*)utf8buf;
8822 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8836 eptr = va_arg(*args, char*);
8838 #ifdef MACOS_TRADITIONAL
8839 /* On MacOS, %#s format is used for Pascal strings */
8844 elen = strlen(eptr);
8846 eptr = (char *)nullstr;
8847 elen = sizeof nullstr - 1;
8851 eptr = SvPVx_const(argsv, elen);
8852 if (DO_UTF8(argsv)) {
8853 if (has_precis && precis < elen) {
8855 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8858 if (width) { /* fudge width (can't fudge elen) */
8859 width += elen - sv_len_utf8(argsv);
8866 if (has_precis && elen > precis)
8873 if (alt || vectorize)
8875 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8896 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8905 esignbuf[esignlen++] = plus;
8909 case 'h': iv = (short)va_arg(*args, int); break;
8910 case 'l': iv = va_arg(*args, long); break;
8911 case 'V': iv = va_arg(*args, IV); break;
8912 default: iv = va_arg(*args, int); break;
8914 case 'q': iv = va_arg(*args, Quad_t); break;
8919 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8921 case 'h': iv = (short)tiv; break;
8922 case 'l': iv = (long)tiv; break;
8924 default: iv = tiv; break;
8926 case 'q': iv = (Quad_t)tiv; break;
8930 if ( !vectorize ) /* we already set uv above */
8935 esignbuf[esignlen++] = plus;
8939 esignbuf[esignlen++] = '-';
8982 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8993 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8994 case 'l': uv = va_arg(*args, unsigned long); break;
8995 case 'V': uv = va_arg(*args, UV); break;
8996 default: uv = va_arg(*args, unsigned); break;
8998 case 'q': uv = va_arg(*args, Uquad_t); break;
9003 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9005 case 'h': uv = (unsigned short)tuv; break;
9006 case 'l': uv = (unsigned long)tuv; break;
9008 default: uv = tuv; break;
9010 case 'q': uv = (Uquad_t)tuv; break;
9017 char *ptr = ebuf + sizeof ebuf;
9023 p = (char*)((c == 'X')
9024 ? "0123456789ABCDEF" : "0123456789abcdef");
9030 esignbuf[esignlen++] = '0';
9031 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9039 if (alt && *ptr != '0')
9050 esignbuf[esignlen++] = '0';
9051 esignbuf[esignlen++] = 'b';
9054 default: /* it had better be ten or less */
9058 } while (uv /= base);
9061 elen = (ebuf + sizeof ebuf) - ptr;
9065 zeros = precis - elen;
9066 else if (precis == 0 && elen == 1 && *eptr == '0')
9072 /* FLOATING POINT */
9075 c = 'f'; /* maybe %F isn't supported here */
9083 /* This is evil, but floating point is even more evil */
9085 /* for SV-style calling, we can only get NV
9086 for C-style calling, we assume %f is double;
9087 for simplicity we allow any of %Lf, %llf, %qf for long double
9091 #if defined(USE_LONG_DOUBLE)
9095 /* [perl #20339] - we should accept and ignore %lf rather than die */
9099 #if defined(USE_LONG_DOUBLE)
9100 intsize = args ? 0 : 'q';
9104 #if defined(HAS_LONG_DOUBLE)
9113 /* now we need (long double) if intsize == 'q', else (double) */
9115 #if LONG_DOUBLESIZE > DOUBLESIZE
9117 va_arg(*args, long double) :
9118 va_arg(*args, double)
9120 va_arg(*args, double)
9125 if (c != 'e' && c != 'E') {
9127 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9128 will cast our (long double) to (double) */
9129 (void)Perl_frexp(nv, &i);
9130 if (i == PERL_INT_MIN)
9131 Perl_die(aTHX_ "panic: frexp");
9133 need = BIT_DIGITS(i);
9135 need += has_precis ? precis : 6; /* known default */
9140 #ifdef HAS_LDBL_SPRINTF_BUG
9141 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9142 with sfio - Allen <allens@cpan.org> */
9145 # define MY_DBL_MAX DBL_MAX
9146 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9147 # if DOUBLESIZE >= 8
9148 # define MY_DBL_MAX 1.7976931348623157E+308L
9150 # define MY_DBL_MAX 3.40282347E+38L
9154 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9155 # define MY_DBL_MAX_BUG 1L
9157 # define MY_DBL_MAX_BUG MY_DBL_MAX
9161 # define MY_DBL_MIN DBL_MIN
9162 # else /* XXX guessing! -Allen */
9163 # if DOUBLESIZE >= 8
9164 # define MY_DBL_MIN 2.2250738585072014E-308L
9166 # define MY_DBL_MIN 1.17549435E-38L
9170 if ((intsize == 'q') && (c == 'f') &&
9171 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9173 /* it's going to be short enough that
9174 * long double precision is not needed */
9176 if ((nv <= 0L) && (nv >= -0L))
9177 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9179 /* would use Perl_fp_class as a double-check but not
9180 * functional on IRIX - see perl.h comments */
9182 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9183 /* It's within the range that a double can represent */
9184 #if defined(DBL_MAX) && !defined(DBL_MIN)
9185 if ((nv >= ((long double)1/DBL_MAX)) ||
9186 (nv <= (-(long double)1/DBL_MAX)))
9188 fix_ldbl_sprintf_bug = TRUE;
9191 if (fix_ldbl_sprintf_bug == TRUE) {
9201 # undef MY_DBL_MAX_BUG
9204 #endif /* HAS_LDBL_SPRINTF_BUG */
9206 need += 20; /* fudge factor */
9207 if (PL_efloatsize < need) {
9208 Safefree(PL_efloatbuf);
9209 PL_efloatsize = need + 20; /* more fudge */
9210 Newx(PL_efloatbuf, PL_efloatsize, char);
9211 PL_efloatbuf[0] = '\0';
9214 if ( !(width || left || plus || alt) && fill != '0'
9215 && has_precis && intsize != 'q' ) { /* Shortcuts */
9216 /* See earlier comment about buggy Gconvert when digits,
9218 if ( c == 'g' && precis) {
9219 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9220 /* May return an empty string for digits==0 */
9221 if (*PL_efloatbuf) {
9222 elen = strlen(PL_efloatbuf);
9223 goto float_converted;
9225 } else if ( c == 'f' && !precis) {
9226 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9231 char *ptr = ebuf + sizeof ebuf;
9234 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9235 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9236 if (intsize == 'q') {
9237 /* Copy the one or more characters in a long double
9238 * format before the 'base' ([efgEFG]) character to
9239 * the format string. */
9240 static char const prifldbl[] = PERL_PRIfldbl;
9241 char const *p = prifldbl + sizeof(prifldbl) - 3;
9242 while (p >= prifldbl) { *--ptr = *p--; }
9247 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9252 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9264 /* No taint. Otherwise we are in the strange situation
9265 * where printf() taints but print($float) doesn't.
9267 #if defined(HAS_LONG_DOUBLE)
9268 elen = ((intsize == 'q')
9269 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9270 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9272 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9276 eptr = PL_efloatbuf;
9284 i = SvCUR(sv) - origlen;
9287 case 'h': *(va_arg(*args, short*)) = i; break;
9288 default: *(va_arg(*args, int*)) = i; break;
9289 case 'l': *(va_arg(*args, long*)) = i; break;
9290 case 'V': *(va_arg(*args, IV*)) = i; break;
9292 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9297 sv_setuv_mg(argsv, (UV)i);
9298 continue; /* not "break" */
9305 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9306 && ckWARN(WARN_PRINTF))
9308 SV * const msg = sv_newmortal();
9309 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9310 (PL_op->op_type == OP_PRTF) ? "" : "s");
9313 Perl_sv_catpvf(aTHX_ msg,
9314 "\"%%%c\"", c & 0xFF);
9316 Perl_sv_catpvf(aTHX_ msg,
9317 "\"%%\\%03"UVof"\"",
9320 sv_catpvs(msg, "end of string");
9321 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9324 /* output mangled stuff ... */
9330 /* ... right here, because formatting flags should not apply */
9331 SvGROW(sv, SvCUR(sv) + elen + 1);
9333 Copy(eptr, p, elen, char);
9336 SvCUR_set(sv, p - SvPVX_const(sv));
9338 continue; /* not "break" */
9341 if (is_utf8 != has_utf8) {
9344 sv_utf8_upgrade(sv);
9347 const STRLEN old_elen = elen;
9348 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9349 sv_utf8_upgrade(nsv);
9350 eptr = SvPVX_const(nsv);
9353 if (width) { /* fudge width (can't fudge elen) */
9354 width += elen - old_elen;
9360 have = esignlen + zeros + elen;
9362 Perl_croak_nocontext(PL_memory_wrap);
9364 need = (have > width ? have : width);
9367 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9368 Perl_croak_nocontext(PL_memory_wrap);
9369 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9371 if (esignlen && fill == '0') {
9373 for (i = 0; i < (int)esignlen; i++)
9377 memset(p, fill, gap);
9380 if (esignlen && fill != '0') {
9382 for (i = 0; i < (int)esignlen; i++)
9387 for (i = zeros; i; i--)
9391 Copy(eptr, p, elen, char);
9395 memset(p, ' ', gap);
9400 Copy(dotstr, p, dotstrlen, char);
9404 vectorize = FALSE; /* done iterating over vecstr */
9411 SvCUR_set(sv, p - SvPVX_const(sv));
9419 /* =========================================================================
9421 =head1 Cloning an interpreter
9423 All the macros and functions in this section are for the private use of
9424 the main function, perl_clone().
9426 The foo_dup() functions make an exact copy of an existing foo thinngy.
9427 During the course of a cloning, a hash table is used to map old addresses
9428 to new addresses. The table is created and manipulated with the
9429 ptr_table_* functions.
9433 ============================================================================*/
9436 #if defined(USE_ITHREADS)
9438 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9439 #ifndef GpREFCNT_inc
9440 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9444 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9445 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9446 please unmerge ss_dup. */
9447 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9448 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9449 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9450 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9451 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9452 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9453 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9454 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9455 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9456 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9457 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9458 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9459 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9460 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9463 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9464 regcomp.c. AMS 20010712 */
9467 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9472 struct reg_substr_datum *s;
9475 return (REGEXP *)NULL;
9477 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9480 len = r->offsets[0];
9481 npar = r->nparens+1;
9483 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9484 Copy(r->program, ret->program, len+1, regnode);
9486 Newx(ret->startp, npar, I32);
9487 Copy(r->startp, ret->startp, npar, I32);
9488 Newx(ret->endp, npar, I32);
9489 Copy(r->startp, ret->startp, npar, I32);
9491 Newx(ret->substrs, 1, struct reg_substr_data);
9492 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9493 s->min_offset = r->substrs->data[i].min_offset;
9494 s->max_offset = r->substrs->data[i].max_offset;
9495 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9496 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9499 ret->regstclass = NULL;
9502 const int count = r->data->count;
9505 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9506 char, struct reg_data);
9507 Newx(d->what, count, U8);
9510 for (i = 0; i < count; i++) {
9511 d->what[i] = r->data->what[i];
9512 switch (d->what[i]) {
9513 /* legal options are one of: sfpont
9514 see also regcomp.h and pregfree() */
9516 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9519 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9522 /* This is cheating. */
9523 Newx(d->data[i], 1, struct regnode_charclass_class);
9524 StructCopy(r->data->data[i], d->data[i],
9525 struct regnode_charclass_class);
9526 ret->regstclass = (regnode*)d->data[i];
9529 /* Compiled op trees are readonly, and can thus be
9530 shared without duplication. */
9532 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9536 d->data[i] = r->data->data[i];
9539 d->data[i] = r->data->data[i];
9541 ((reg_trie_data*)d->data[i])->refcount++;
9545 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9554 Newx(ret->offsets, 2*len+1, U32);
9555 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9557 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9558 ret->refcnt = r->refcnt;
9559 ret->minlen = r->minlen;
9560 ret->prelen = r->prelen;
9561 ret->nparens = r->nparens;
9562 ret->lastparen = r->lastparen;
9563 ret->lastcloseparen = r->lastcloseparen;
9564 ret->reganch = r->reganch;
9566 ret->sublen = r->sublen;
9568 if (RX_MATCH_COPIED(ret))
9569 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9572 #ifdef PERL_OLD_COPY_ON_WRITE
9573 ret->saved_copy = NULL;
9576 ptr_table_store(PL_ptr_table, r, ret);
9580 /* duplicate a file handle */
9583 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9587 PERL_UNUSED_ARG(type);
9590 return (PerlIO*)NULL;
9592 /* look for it in the table first */
9593 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9597 /* create anew and remember what it is */
9598 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9599 ptr_table_store(PL_ptr_table, fp, ret);
9603 /* duplicate a directory handle */
9606 Perl_dirp_dup(pTHX_ DIR *dp)
9608 PERL_UNUSED_CONTEXT;
9615 /* duplicate a typeglob */
9618 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9624 /* look for it in the table first */
9625 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9629 /* create anew and remember what it is */
9631 ptr_table_store(PL_ptr_table, gp, ret);
9634 ret->gp_refcnt = 0; /* must be before any other dups! */
9635 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9636 ret->gp_io = io_dup_inc(gp->gp_io, param);
9637 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9638 ret->gp_av = av_dup_inc(gp->gp_av, param);
9639 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9640 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9641 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9642 ret->gp_cvgen = gp->gp_cvgen;
9643 ret->gp_line = gp->gp_line;
9644 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9648 /* duplicate a chain of magic */
9651 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9653 MAGIC *mgprev = (MAGIC*)NULL;
9656 return (MAGIC*)NULL;
9657 /* look for it in the table first */
9658 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9662 for (; mg; mg = mg->mg_moremagic) {
9664 Newxz(nmg, 1, MAGIC);
9666 mgprev->mg_moremagic = nmg;
9669 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9670 nmg->mg_private = mg->mg_private;
9671 nmg->mg_type = mg->mg_type;
9672 nmg->mg_flags = mg->mg_flags;
9673 if (mg->mg_type == PERL_MAGIC_qr) {
9674 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9676 else if(mg->mg_type == PERL_MAGIC_backref) {
9677 /* The backref AV has its reference count deliberately bumped by
9679 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9681 else if (mg->mg_type == PERL_MAGIC_symtab) {
9682 nmg->mg_obj = mg->mg_obj;
9685 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9686 ? sv_dup_inc(mg->mg_obj, param)
9687 : sv_dup(mg->mg_obj, param);
9689 nmg->mg_len = mg->mg_len;
9690 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9691 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9692 if (mg->mg_len > 0) {
9693 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9694 if (mg->mg_type == PERL_MAGIC_overload_table &&
9695 AMT_AMAGIC((AMT*)mg->mg_ptr))
9697 const AMT * const amtp = (AMT*)mg->mg_ptr;
9698 AMT * const namtp = (AMT*)nmg->mg_ptr;
9700 for (i = 1; i < NofAMmeth; i++) {
9701 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9705 else if (mg->mg_len == HEf_SVKEY)
9706 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9708 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9709 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9716 /* create a new pointer-mapping table */
9719 Perl_ptr_table_new(pTHX)
9722 PERL_UNUSED_CONTEXT;
9724 Newxz(tbl, 1, PTR_TBL_t);
9727 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9731 #define PTR_TABLE_HASH(ptr) \
9732 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9735 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9736 following define) and at call to new_body_inline made below in
9737 Perl_ptr_table_store()
9740 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9742 /* map an existing pointer using a table */
9744 STATIC PTR_TBL_ENT_t *
9745 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9746 PTR_TBL_ENT_t *tblent;
9747 const UV hash = PTR_TABLE_HASH(sv);
9749 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9750 for (; tblent; tblent = tblent->next) {
9751 if (tblent->oldval == sv)
9758 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9760 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9761 PERL_UNUSED_CONTEXT;
9762 return tblent ? tblent->newval : NULL;
9765 /* add a new entry to a pointer-mapping table */
9768 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9770 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9771 PERL_UNUSED_CONTEXT;
9774 tblent->newval = newsv;
9776 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9778 new_body_inline(tblent, PTE_SVSLOT);
9780 tblent->oldval = oldsv;
9781 tblent->newval = newsv;
9782 tblent->next = tbl->tbl_ary[entry];
9783 tbl->tbl_ary[entry] = tblent;
9785 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9786 ptr_table_split(tbl);
9790 /* double the hash bucket size of an existing ptr table */
9793 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9795 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9796 const UV oldsize = tbl->tbl_max + 1;
9797 UV newsize = oldsize * 2;
9799 PERL_UNUSED_CONTEXT;
9801 Renew(ary, newsize, PTR_TBL_ENT_t*);
9802 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9803 tbl->tbl_max = --newsize;
9805 for (i=0; i < oldsize; i++, ary++) {
9806 PTR_TBL_ENT_t **curentp, **entp, *ent;
9809 curentp = ary + oldsize;
9810 for (entp = ary, ent = *ary; ent; ent = *entp) {
9811 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9813 ent->next = *curentp;
9823 /* remove all the entries from a ptr table */
9826 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9828 if (tbl && tbl->tbl_items) {
9829 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9830 UV riter = tbl->tbl_max;
9833 PTR_TBL_ENT_t *entry = array[riter];
9836 PTR_TBL_ENT_t * const oentry = entry;
9837 entry = entry->next;
9846 /* clear and free a ptr table */
9849 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9854 ptr_table_clear(tbl);
9855 Safefree(tbl->tbl_ary);
9861 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9864 SvRV_set(dstr, SvWEAKREF(sstr)
9865 ? sv_dup(SvRV(sstr), param)
9866 : sv_dup_inc(SvRV(sstr), param));
9869 else if (SvPVX_const(sstr)) {
9870 /* Has something there */
9872 /* Normal PV - clone whole allocated space */
9873 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9874 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9875 /* Not that normal - actually sstr is copy on write.
9876 But we are a true, independant SV, so: */
9877 SvREADONLY_off(dstr);
9882 /* Special case - not normally malloced for some reason */
9883 if (isGV_with_GP(sstr)) {
9884 /* Don't need to do anything here. */
9886 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9887 /* A "shared" PV - clone it as "shared" PV */
9889 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9893 /* Some other special case - random pointer */
9894 SvPV_set(dstr, SvPVX(sstr));
9900 if (SvTYPE(dstr) == SVt_RV)
9901 SvRV_set(dstr, NULL);
9903 SvPV_set(dstr, NULL);
9907 /* duplicate an SV of any type (including AV, HV etc) */
9910 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9915 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9917 /* look for it in the table first */
9918 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9922 if(param->flags & CLONEf_JOIN_IN) {
9923 /** We are joining here so we don't want do clone
9924 something that is bad **/
9925 if (SvTYPE(sstr) == SVt_PVHV) {
9926 const char * const hvname = HvNAME_get(sstr);
9928 /** don't clone stashes if they already exist **/
9929 return (SV*)gv_stashpv(hvname,0);
9933 /* create anew and remember what it is */
9936 #ifdef DEBUG_LEAKING_SCALARS
9937 dstr->sv_debug_optype = sstr->sv_debug_optype;
9938 dstr->sv_debug_line = sstr->sv_debug_line;
9939 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9940 dstr->sv_debug_cloned = 1;
9941 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9944 ptr_table_store(PL_ptr_table, sstr, dstr);
9947 SvFLAGS(dstr) = SvFLAGS(sstr);
9948 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9949 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9952 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9953 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9954 PL_watch_pvx, SvPVX_const(sstr));
9957 /* don't clone objects whose class has asked us not to */
9958 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9959 SvFLAGS(dstr) &= ~SVTYPEMASK;
9964 switch (SvTYPE(sstr)) {
9969 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9970 SvIV_set(dstr, SvIVX(sstr));
9973 SvANY(dstr) = new_XNV();
9974 SvNV_set(dstr, SvNVX(sstr));
9977 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9978 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9982 /* These are all the types that need complex bodies allocating. */
9984 const svtype sv_type = SvTYPE(sstr);
9985 const struct body_details *const sv_type_details
9986 = bodies_by_type + sv_type;
9990 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9994 if (GvUNIQUE((GV*)sstr)) {
9995 NOOP; /* Do sharing here, and fall through */
10008 assert(sv_type_details->body_size);
10009 if (sv_type_details->arena) {
10010 new_body_inline(new_body, sv_type);
10012 = (void*)((char*)new_body - sv_type_details->offset);
10014 new_body = new_NOARENA(sv_type_details);
10018 SvANY(dstr) = new_body;
10021 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10022 ((char*)SvANY(dstr)) + sv_type_details->offset,
10023 sv_type_details->copy, char);
10025 Copy(((char*)SvANY(sstr)),
10026 ((char*)SvANY(dstr)),
10027 sv_type_details->body_size + sv_type_details->offset, char);
10030 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10031 && !isGV_with_GP(dstr))
10032 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10034 /* The Copy above means that all the source (unduplicated) pointers
10035 are now in the destination. We can check the flags and the
10036 pointers in either, but it's possible that there's less cache
10037 missing by always going for the destination.
10038 FIXME - instrument and check that assumption */
10039 if (sv_type >= SVt_PVMG) {
10040 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10041 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10042 } else if (SvMAGIC(dstr))
10043 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10045 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10048 /* The cast silences a GCC warning about unhandled types. */
10049 switch ((int)sv_type) {
10061 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10062 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10063 LvTARG(dstr) = dstr;
10064 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10065 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10067 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10070 if (GvNAME_HEK(dstr))
10071 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10073 /* Don't call sv_add_backref here as it's going to be created
10074 as part of the magic cloning of the symbol table. */
10075 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10076 if(isGV_with_GP(sstr)) {
10077 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10078 at the point of this comment. */
10079 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10080 (void)GpREFCNT_inc(GvGP(dstr));
10082 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10085 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10086 if (IoOFP(dstr) == IoIFP(sstr))
10087 IoOFP(dstr) = IoIFP(dstr);
10089 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10090 /* PL_rsfp_filters entries have fake IoDIRP() */
10091 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10092 /* I have no idea why fake dirp (rsfps)
10093 should be treated differently but otherwise
10094 we end up with leaks -- sky*/
10095 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10096 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10097 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10099 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10100 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10101 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10102 if (IoDIRP(dstr)) {
10103 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10106 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10109 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10110 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10111 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10114 if (AvARRAY((AV*)sstr)) {
10115 SV **dst_ary, **src_ary;
10116 SSize_t items = AvFILLp((AV*)sstr) + 1;
10118 src_ary = AvARRAY((AV*)sstr);
10119 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10120 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10121 SvPV_set(dstr, (char*)dst_ary);
10122 AvALLOC((AV*)dstr) = dst_ary;
10123 if (AvREAL((AV*)sstr)) {
10124 while (items-- > 0)
10125 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10128 while (items-- > 0)
10129 *dst_ary++ = sv_dup(*src_ary++, param);
10131 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10132 while (items-- > 0) {
10133 *dst_ary++ = &PL_sv_undef;
10137 SvPV_set(dstr, NULL);
10138 AvALLOC((AV*)dstr) = (SV**)NULL;
10143 HEK *hvname = NULL;
10145 if (HvARRAY((HV*)sstr)) {
10147 const bool sharekeys = !!HvSHAREKEYS(sstr);
10148 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10149 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10151 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10152 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10154 HvARRAY(dstr) = (HE**)darray;
10155 while (i <= sxhv->xhv_max) {
10156 const HE *source = HvARRAY(sstr)[i];
10157 HvARRAY(dstr)[i] = source
10158 ? he_dup(source, sharekeys, param) : 0;
10162 struct xpvhv_aux * const saux = HvAUX(sstr);
10163 struct xpvhv_aux * const daux = HvAUX(dstr);
10164 /* This flag isn't copied. */
10165 /* SvOOK_on(hv) attacks the IV flags. */
10166 SvFLAGS(dstr) |= SVf_OOK;
10168 hvname = saux->xhv_name;
10170 = hvname ? hek_dup(hvname, param) : hvname;
10172 daux->xhv_riter = saux->xhv_riter;
10173 daux->xhv_eiter = saux->xhv_eiter
10174 ? he_dup(saux->xhv_eiter,
10175 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10176 daux->xhv_backreferences = saux->xhv_backreferences
10177 ? (AV*) SvREFCNT_inc(
10179 xhv_backreferences,
10185 SvPV_set(dstr, NULL);
10187 /* Record stashes for possible cloning in Perl_clone(). */
10189 av_push(param->stashes, dstr);
10193 if (!(param->flags & CLONEf_COPY_STACKS)) {
10197 /* NOTE: not refcounted */
10198 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10200 if (!CvISXSUB(dstr))
10201 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10203 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10204 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10205 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10206 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10208 /* don't dup if copying back - CvGV isn't refcounted, so the
10209 * duped GV may never be freed. A bit of a hack! DAPM */
10210 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10211 NULL : gv_dup(CvGV(dstr), param) ;
10212 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10214 CvWEAKOUTSIDE(sstr)
10215 ? cv_dup( CvOUTSIDE(dstr), param)
10216 : cv_dup_inc(CvOUTSIDE(dstr), param);
10217 if (!CvISXSUB(dstr))
10218 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10224 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10230 /* duplicate a context */
10233 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10235 PERL_CONTEXT *ncxs;
10238 return (PERL_CONTEXT*)NULL;
10240 /* look for it in the table first */
10241 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10245 /* create anew and remember what it is */
10246 Newxz(ncxs, max + 1, PERL_CONTEXT);
10247 ptr_table_store(PL_ptr_table, cxs, ncxs);
10250 PERL_CONTEXT * const cx = &cxs[ix];
10251 PERL_CONTEXT * const ncx = &ncxs[ix];
10252 ncx->cx_type = cx->cx_type;
10253 if (CxTYPE(cx) == CXt_SUBST) {
10254 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10257 ncx->blk_oldsp = cx->blk_oldsp;
10258 ncx->blk_oldcop = cx->blk_oldcop;
10259 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10260 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10261 ncx->blk_oldpm = cx->blk_oldpm;
10262 ncx->blk_gimme = cx->blk_gimme;
10263 switch (CxTYPE(cx)) {
10265 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10266 ? cv_dup_inc(cx->blk_sub.cv, param)
10267 : cv_dup(cx->blk_sub.cv,param));
10268 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10269 ? av_dup_inc(cx->blk_sub.argarray, param)
10271 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10272 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10273 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10274 ncx->blk_sub.lval = cx->blk_sub.lval;
10275 ncx->blk_sub.retop = cx->blk_sub.retop;
10276 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10277 cx->blk_sub.oldcomppad);
10280 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10281 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10282 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10283 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10284 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10285 ncx->blk_eval.retop = cx->blk_eval.retop;
10288 ncx->blk_loop.label = cx->blk_loop.label;
10289 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10290 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10291 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10292 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10293 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10294 ? cx->blk_loop.iterdata
10295 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10296 ncx->blk_loop.oldcomppad
10297 = (PAD*)ptr_table_fetch(PL_ptr_table,
10298 cx->blk_loop.oldcomppad);
10299 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10300 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10301 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10302 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10303 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10306 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10307 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10308 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10309 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10310 ncx->blk_sub.retop = cx->blk_sub.retop;
10322 /* duplicate a stack info structure */
10325 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10330 return (PERL_SI*)NULL;
10332 /* look for it in the table first */
10333 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10337 /* create anew and remember what it is */
10338 Newxz(nsi, 1, PERL_SI);
10339 ptr_table_store(PL_ptr_table, si, nsi);
10341 nsi->si_stack = av_dup_inc(si->si_stack, param);
10342 nsi->si_cxix = si->si_cxix;
10343 nsi->si_cxmax = si->si_cxmax;
10344 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10345 nsi->si_type = si->si_type;
10346 nsi->si_prev = si_dup(si->si_prev, param);
10347 nsi->si_next = si_dup(si->si_next, param);
10348 nsi->si_markoff = si->si_markoff;
10353 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10354 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10355 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10356 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10357 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10358 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10359 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10360 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10361 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10362 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10363 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10364 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10365 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10366 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10369 #define pv_dup_inc(p) SAVEPV(p)
10370 #define pv_dup(p) SAVEPV(p)
10371 #define svp_dup_inc(p,pp) any_dup(p,pp)
10373 /* map any object to the new equivent - either something in the
10374 * ptr table, or something in the interpreter structure
10378 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10383 return (void*)NULL;
10385 /* look for it in the table first */
10386 ret = ptr_table_fetch(PL_ptr_table, v);
10390 /* see if it is part of the interpreter structure */
10391 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10392 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10400 /* duplicate the save stack */
10403 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10405 ANY * const ss = proto_perl->Tsavestack;
10406 const I32 max = proto_perl->Tsavestack_max;
10407 I32 ix = proto_perl->Tsavestack_ix;
10419 void (*dptr) (void*);
10420 void (*dxptr) (pTHX_ void*);
10422 Newxz(nss, max, ANY);
10425 I32 i = POPINT(ss,ix);
10426 TOPINT(nss,ix) = i;
10428 case SAVEt_ITEM: /* normal string */
10429 case SAVEt_SV: /* scalar reference */
10430 sv = (SV*)POPPTR(ss,ix);
10431 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10432 sv = (SV*)POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10435 case SAVEt_SHARED_PVREF: /* char* in shared space */
10436 c = (char*)POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = savesharedpv(c);
10438 ptr = POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10441 case SAVEt_GENERIC_SVREF: /* generic sv */
10442 case SAVEt_SVREF: /* scalar reference */
10443 sv = (SV*)POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10445 ptr = POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10448 case SAVEt_HV: /* hash reference */
10449 case SAVEt_AV: /* array reference */
10450 sv = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10452 gv = (GV*)POPPTR(ss,ix);
10453 TOPPTR(nss,ix) = gv_dup(gv, param);
10455 case SAVEt_INT: /* int reference */
10456 ptr = POPPTR(ss,ix);
10457 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10458 intval = (int)POPINT(ss,ix);
10459 TOPINT(nss,ix) = intval;
10461 case SAVEt_LONG: /* long reference */
10462 ptr = POPPTR(ss,ix);
10463 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 longval = (long)POPLONG(ss,ix);
10465 TOPLONG(nss,ix) = longval;
10467 case SAVEt_I32: /* I32 reference */
10468 case SAVEt_I16: /* I16 reference */
10469 case SAVEt_I8: /* I8 reference */
10470 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10471 ptr = POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10474 TOPINT(nss,ix) = i;
10476 case SAVEt_IV: /* IV reference */
10477 ptr = POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10480 TOPIV(nss,ix) = iv;
10482 case SAVEt_HPTR: /* HV* reference */
10483 case SAVEt_APTR: /* AV* reference */
10484 case SAVEt_SPTR: /* SV* reference */
10485 ptr = POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10487 sv = (SV*)POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = sv_dup(sv, param);
10490 case SAVEt_VPTR: /* random* reference */
10491 ptr = POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10493 ptr = POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10496 case SAVEt_GENERIC_PVREF: /* generic char* */
10497 case SAVEt_PPTR: /* char* reference */
10498 ptr = POPPTR(ss,ix);
10499 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10500 c = (char*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = pv_dup(c);
10504 gv = (GV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = gv_dup(gv, param);
10507 case SAVEt_GP: /* scalar reference */
10508 gp = (GP*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10510 (void)GpREFCNT_inc(gp);
10511 gv = (GV*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10513 c = (char*)POPPTR(ss,ix);
10514 TOPPTR(nss,ix) = pv_dup(c);
10516 TOPIV(nss,ix) = iv;
10518 TOPIV(nss,ix) = iv;
10521 case SAVEt_MORTALIZESV:
10522 sv = (SV*)POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10526 ptr = POPPTR(ss,ix);
10527 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10528 /* these are assumed to be refcounted properly */
10530 switch (((OP*)ptr)->op_type) {
10532 case OP_LEAVESUBLV:
10536 case OP_LEAVEWRITE:
10537 TOPPTR(nss,ix) = ptr;
10542 TOPPTR(nss,ix) = NULL;
10547 TOPPTR(nss,ix) = NULL;
10550 c = (char*)POPPTR(ss,ix);
10551 TOPPTR(nss,ix) = pv_dup_inc(c);
10553 case SAVEt_CLEARSV:
10554 longval = POPLONG(ss,ix);
10555 TOPLONG(nss,ix) = longval;
10558 hv = (HV*)POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10560 c = (char*)POPPTR(ss,ix);
10561 TOPPTR(nss,ix) = pv_dup_inc(c);
10563 TOPINT(nss,ix) = i;
10565 case SAVEt_DESTRUCTOR:
10566 ptr = POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10568 dptr = POPDPTR(ss,ix);
10569 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10570 any_dup(FPTR2DPTR(void *, dptr),
10573 case SAVEt_DESTRUCTOR_X:
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10576 dxptr = POPDXPTR(ss,ix);
10577 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10578 any_dup(FPTR2DPTR(void *, dxptr),
10581 case SAVEt_REGCONTEXT:
10584 TOPINT(nss,ix) = i;
10587 case SAVEt_STACK_POS: /* Position on Perl stack */
10589 TOPINT(nss,ix) = i;
10591 case SAVEt_AELEM: /* array element */
10592 sv = (SV*)POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10595 TOPINT(nss,ix) = i;
10596 av = (AV*)POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = av_dup_inc(av, param);
10599 case SAVEt_HELEM: /* hash element */
10600 sv = (SV*)POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10602 sv = (SV*)POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10604 hv = (HV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10608 ptr = POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = ptr;
10613 TOPINT(nss,ix) = i;
10614 ptr = POPPTR(ss,ix);
10617 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10618 HINTS_REFCNT_UNLOCK;
10620 TOPPTR(nss,ix) = ptr;
10621 if (i & HINT_LOCALIZE_HH) {
10622 hv = (HV*)POPPTR(ss,ix);
10623 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10626 case SAVEt_COMPPAD:
10627 av = (AV*)POPPTR(ss,ix);
10628 TOPPTR(nss,ix) = av_dup(av, param);
10631 longval = (long)POPLONG(ss,ix);
10632 TOPLONG(nss,ix) = longval;
10633 ptr = POPPTR(ss,ix);
10634 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10635 sv = (SV*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = sv_dup(sv, param);
10639 ptr = POPPTR(ss,ix);
10640 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10641 longval = (long)POPBOOL(ss,ix);
10642 TOPBOOL(nss,ix) = (bool)longval;
10644 case SAVEt_SET_SVFLAGS:
10646 TOPINT(nss,ix) = i;
10648 TOPINT(nss,ix) = i;
10649 sv = (SV*)POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = sv_dup(sv, param);
10652 case SAVEt_RE_STATE:
10654 const struct re_save_state *const old_state
10655 = (struct re_save_state *)
10656 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10657 struct re_save_state *const new_state
10658 = (struct re_save_state *)
10659 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10661 Copy(old_state, new_state, 1, struct re_save_state);
10662 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10664 new_state->re_state_bostr
10665 = pv_dup(old_state->re_state_bostr);
10666 new_state->re_state_reginput
10667 = pv_dup(old_state->re_state_reginput);
10668 new_state->re_state_regeol
10669 = pv_dup(old_state->re_state_regeol);
10670 new_state->re_state_regstartp
10671 = any_dup(old_state->re_state_regstartp, proto_perl);
10672 new_state->re_state_regendp
10673 = any_dup(old_state->re_state_regendp, proto_perl);
10674 new_state->re_state_reglastparen
10675 = any_dup(old_state->re_state_reglastparen, proto_perl);
10676 new_state->re_state_reglastcloseparen
10677 = any_dup(old_state->re_state_reglastcloseparen,
10679 /* XXX This just has to be broken. The old save_re_context
10680 code did SAVEGENERICPV(PL_reg_start_tmp);
10681 PL_reg_start_tmp is char **.
10682 Look above to what the dup code does for
10683 SAVEt_GENERIC_PVREF
10684 It can never have worked.
10685 So this is merely a faithful copy of the exiting bug: */
10686 new_state->re_state_reg_start_tmp
10687 = (char **) pv_dup((char *)
10688 old_state->re_state_reg_start_tmp);
10689 /* I assume that it only ever "worked" because no-one called
10690 (pseudo)fork while the regexp engine had re-entered itself.
10692 #ifdef PERL_OLD_COPY_ON_WRITE
10693 new_state->re_state_nrs
10694 = sv_dup(old_state->re_state_nrs, param);
10696 new_state->re_state_reg_magic
10697 = any_dup(old_state->re_state_reg_magic, proto_perl);
10698 new_state->re_state_reg_oldcurpm
10699 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10700 new_state->re_state_reg_curpm
10701 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10702 new_state->re_state_reg_oldsaved
10703 = pv_dup(old_state->re_state_reg_oldsaved);
10704 new_state->re_state_reg_poscache
10705 = pv_dup(old_state->re_state_reg_poscache);
10706 new_state->re_state_reg_starttry
10707 = pv_dup(old_state->re_state_reg_starttry);
10710 case SAVEt_COMPILE_WARNINGS:
10711 ptr = POPPTR(ss,ix);
10712 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10715 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10723 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10724 * flag to the result. This is done for each stash before cloning starts,
10725 * so we know which stashes want their objects cloned */
10728 do_mark_cloneable_stash(pTHX_ SV *sv)
10730 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10732 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10733 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10734 if (cloner && GvCV(cloner)) {
10741 XPUSHs(sv_2mortal(newSVhek(hvname)));
10743 call_sv((SV*)GvCV(cloner), G_SCALAR);
10750 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10758 =for apidoc perl_clone
10760 Create and return a new interpreter by cloning the current one.
10762 perl_clone takes these flags as parameters:
10764 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10765 without it we only clone the data and zero the stacks,
10766 with it we copy the stacks and the new perl interpreter is
10767 ready to run at the exact same point as the previous one.
10768 The pseudo-fork code uses COPY_STACKS while the
10769 threads->new doesn't.
10771 CLONEf_KEEP_PTR_TABLE
10772 perl_clone keeps a ptr_table with the pointer of the old
10773 variable as a key and the new variable as a value,
10774 this allows it to check if something has been cloned and not
10775 clone it again but rather just use the value and increase the
10776 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10777 the ptr_table using the function
10778 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10779 reason to keep it around is if you want to dup some of your own
10780 variable who are outside the graph perl scans, example of this
10781 code is in threads.xs create
10784 This is a win32 thing, it is ignored on unix, it tells perls
10785 win32host code (which is c++) to clone itself, this is needed on
10786 win32 if you want to run two threads at the same time,
10787 if you just want to do some stuff in a separate perl interpreter
10788 and then throw it away and return to the original one,
10789 you don't need to do anything.
10794 /* XXX the above needs expanding by someone who actually understands it ! */
10795 EXTERN_C PerlInterpreter *
10796 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10799 perl_clone(PerlInterpreter *proto_perl, UV flags)
10802 #ifdef PERL_IMPLICIT_SYS
10804 /* perlhost.h so we need to call into it
10805 to clone the host, CPerlHost should have a c interface, sky */
10807 if (flags & CLONEf_CLONE_HOST) {
10808 return perl_clone_host(proto_perl,flags);
10810 return perl_clone_using(proto_perl, flags,
10812 proto_perl->IMemShared,
10813 proto_perl->IMemParse,
10815 proto_perl->IStdIO,
10819 proto_perl->IProc);
10823 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10824 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10825 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10826 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10827 struct IPerlDir* ipD, struct IPerlSock* ipS,
10828 struct IPerlProc* ipP)
10830 /* XXX many of the string copies here can be optimized if they're
10831 * constants; they need to be allocated as common memory and just
10832 * their pointers copied. */
10835 CLONE_PARAMS clone_params;
10836 CLONE_PARAMS* const param = &clone_params;
10838 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10839 /* for each stash, determine whether its objects should be cloned */
10840 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10841 PERL_SET_THX(my_perl);
10844 PoisonNew(my_perl, 1, PerlInterpreter);
10850 PL_savestack_ix = 0;
10851 PL_savestack_max = -1;
10852 PL_sig_pending = 0;
10853 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10854 # else /* !DEBUGGING */
10855 Zero(my_perl, 1, PerlInterpreter);
10856 # endif /* DEBUGGING */
10858 /* host pointers */
10860 PL_MemShared = ipMS;
10861 PL_MemParse = ipMP;
10868 #else /* !PERL_IMPLICIT_SYS */
10870 CLONE_PARAMS clone_params;
10871 CLONE_PARAMS* param = &clone_params;
10872 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10873 /* for each stash, determine whether its objects should be cloned */
10874 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10875 PERL_SET_THX(my_perl);
10878 PoisonNew(my_perl, 1, PerlInterpreter);
10884 PL_savestack_ix = 0;
10885 PL_savestack_max = -1;
10886 PL_sig_pending = 0;
10887 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10888 # else /* !DEBUGGING */
10889 Zero(my_perl, 1, PerlInterpreter);
10890 # endif /* DEBUGGING */
10891 #endif /* PERL_IMPLICIT_SYS */
10892 param->flags = flags;
10893 param->proto_perl = proto_perl;
10895 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10897 PL_body_arenas = NULL;
10898 Zero(&PL_body_roots, 1, PL_body_roots);
10900 PL_nice_chunk = NULL;
10901 PL_nice_chunk_size = 0;
10903 PL_sv_objcount = 0;
10905 PL_sv_arenaroot = NULL;
10907 PL_debug = proto_perl->Idebug;
10909 PL_hash_seed = proto_perl->Ihash_seed;
10910 PL_rehash_seed = proto_perl->Irehash_seed;
10912 #ifdef USE_REENTRANT_API
10913 /* XXX: things like -Dm will segfault here in perlio, but doing
10914 * PERL_SET_CONTEXT(proto_perl);
10915 * breaks too many other things
10917 Perl_reentrant_init(aTHX);
10920 /* create SV map for pointer relocation */
10921 PL_ptr_table = ptr_table_new();
10923 /* initialize these special pointers as early as possible */
10924 SvANY(&PL_sv_undef) = NULL;
10925 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10926 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10927 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10929 SvANY(&PL_sv_no) = new_XPVNV();
10930 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10931 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10932 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10933 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10934 SvCUR_set(&PL_sv_no, 0);
10935 SvLEN_set(&PL_sv_no, 1);
10936 SvIV_set(&PL_sv_no, 0);
10937 SvNV_set(&PL_sv_no, 0);
10938 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10940 SvANY(&PL_sv_yes) = new_XPVNV();
10941 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10942 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10943 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10944 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10945 SvCUR_set(&PL_sv_yes, 1);
10946 SvLEN_set(&PL_sv_yes, 2);
10947 SvIV_set(&PL_sv_yes, 1);
10948 SvNV_set(&PL_sv_yes, 1);
10949 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10951 /* create (a non-shared!) shared string table */
10952 PL_strtab = newHV();
10953 HvSHAREKEYS_off(PL_strtab);
10954 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10955 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10957 PL_compiling = proto_perl->Icompiling;
10959 /* These two PVs will be free'd special way so must set them same way op.c does */
10960 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10961 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10963 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10964 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10966 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10967 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10968 if (PL_compiling.cop_hints_hash) {
10970 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10971 HINTS_REFCNT_UNLOCK;
10973 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10975 /* pseudo environmental stuff */
10976 PL_origargc = proto_perl->Iorigargc;
10977 PL_origargv = proto_perl->Iorigargv;
10979 param->stashes = newAV(); /* Setup array of objects to call clone on */
10981 /* Set tainting stuff before PerlIO_debug can possibly get called */
10982 PL_tainting = proto_perl->Itainting;
10983 PL_taint_warn = proto_perl->Itaint_warn;
10985 #ifdef PERLIO_LAYERS
10986 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10987 PerlIO_clone(aTHX_ proto_perl, param);
10990 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10991 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10992 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10993 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10994 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10995 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10998 PL_minus_c = proto_perl->Iminus_c;
10999 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11000 PL_localpatches = proto_perl->Ilocalpatches;
11001 PL_splitstr = proto_perl->Isplitstr;
11002 PL_preprocess = proto_perl->Ipreprocess;
11003 PL_minus_n = proto_perl->Iminus_n;
11004 PL_minus_p = proto_perl->Iminus_p;
11005 PL_minus_l = proto_perl->Iminus_l;
11006 PL_minus_a = proto_perl->Iminus_a;
11007 PL_minus_E = proto_perl->Iminus_E;
11008 PL_minus_F = proto_perl->Iminus_F;
11009 PL_doswitches = proto_perl->Idoswitches;
11010 PL_dowarn = proto_perl->Idowarn;
11011 PL_doextract = proto_perl->Idoextract;
11012 PL_sawampersand = proto_perl->Isawampersand;
11013 PL_unsafe = proto_perl->Iunsafe;
11014 PL_inplace = SAVEPV(proto_perl->Iinplace);
11015 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11016 PL_perldb = proto_perl->Iperldb;
11017 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11018 PL_exit_flags = proto_perl->Iexit_flags;
11020 /* magical thingies */
11021 /* XXX time(&PL_basetime) when asked for? */
11022 PL_basetime = proto_perl->Ibasetime;
11023 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11025 PL_maxsysfd = proto_perl->Imaxsysfd;
11026 PL_statusvalue = proto_perl->Istatusvalue;
11028 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11030 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11032 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11034 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11035 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11036 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11038 /* Clone the regex array */
11039 PL_regex_padav = newAV();
11041 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11042 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11044 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11045 for(i = 1; i <= len; i++) {
11046 const SV * const regex = regexen[i];
11049 ? sv_dup_inc(regex, param)
11051 newSViv(PTR2IV(re_dup(
11052 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11054 av_push(PL_regex_padav, sv);
11057 PL_regex_pad = AvARRAY(PL_regex_padav);
11059 /* shortcuts to various I/O objects */
11060 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11061 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11062 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11063 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11064 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11065 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11067 /* shortcuts to regexp stuff */
11068 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11070 /* shortcuts to misc objects */
11071 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11073 /* shortcuts to debugging objects */
11074 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11075 PL_DBline = gv_dup(proto_perl->IDBline, param);
11076 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11077 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11078 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11079 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11080 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11081 PL_lineary = av_dup(proto_perl->Ilineary, param);
11082 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11084 /* symbol tables */
11085 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11086 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11087 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11088 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11089 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11091 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11092 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11093 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11094 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11095 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11096 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11098 PL_sub_generation = proto_perl->Isub_generation;
11100 /* funky return mechanisms */
11101 PL_forkprocess = proto_perl->Iforkprocess;
11103 /* subprocess state */
11104 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11106 /* internal state */
11107 PL_maxo = proto_perl->Imaxo;
11108 if (proto_perl->Iop_mask)
11109 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11112 /* PL_asserting = proto_perl->Iasserting; */
11114 /* current interpreter roots */
11115 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11116 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11117 PL_main_start = proto_perl->Imain_start;
11118 PL_eval_root = proto_perl->Ieval_root;
11119 PL_eval_start = proto_perl->Ieval_start;
11121 /* runtime control stuff */
11122 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11123 PL_copline = proto_perl->Icopline;
11125 PL_filemode = proto_perl->Ifilemode;
11126 PL_lastfd = proto_perl->Ilastfd;
11127 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11130 PL_gensym = proto_perl->Igensym;
11131 PL_preambled = proto_perl->Ipreambled;
11132 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11133 PL_laststatval = proto_perl->Ilaststatval;
11134 PL_laststype = proto_perl->Ilaststype;
11137 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11139 /* interpreter atexit processing */
11140 PL_exitlistlen = proto_perl->Iexitlistlen;
11141 if (PL_exitlistlen) {
11142 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11143 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11146 PL_exitlist = (PerlExitListEntry*)NULL;
11148 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11149 if (PL_my_cxt_size) {
11150 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11151 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11154 PL_my_cxt_list = (void**)NULL;
11155 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11156 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11157 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11159 PL_profiledata = NULL;
11160 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11161 /* PL_rsfp_filters entries have fake IoDIRP() */
11162 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11164 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11166 PAD_CLONE_VARS(proto_perl, param);
11168 #ifdef HAVE_INTERP_INTERN
11169 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11172 /* more statics moved here */
11173 PL_generation = proto_perl->Igeneration;
11174 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11176 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11177 PL_in_clean_all = proto_perl->Iin_clean_all;
11179 PL_uid = proto_perl->Iuid;
11180 PL_euid = proto_perl->Ieuid;
11181 PL_gid = proto_perl->Igid;
11182 PL_egid = proto_perl->Iegid;
11183 PL_nomemok = proto_perl->Inomemok;
11184 PL_an = proto_perl->Ian;
11185 PL_evalseq = proto_perl->Ievalseq;
11186 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11187 PL_origalen = proto_perl->Iorigalen;
11188 #ifdef PERL_USES_PL_PIDSTATUS
11189 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11191 PL_osname = SAVEPV(proto_perl->Iosname);
11192 PL_sighandlerp = proto_perl->Isighandlerp;
11194 PL_runops = proto_perl->Irunops;
11196 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11199 PL_cshlen = proto_perl->Icshlen;
11200 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11203 PL_lex_state = proto_perl->Ilex_state;
11204 PL_lex_defer = proto_perl->Ilex_defer;
11205 PL_lex_expect = proto_perl->Ilex_expect;
11206 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11207 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11208 PL_lex_starts = proto_perl->Ilex_starts;
11209 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11210 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11211 PL_lex_op = proto_perl->Ilex_op;
11212 PL_lex_inpat = proto_perl->Ilex_inpat;
11213 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11214 PL_lex_brackets = proto_perl->Ilex_brackets;
11215 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11216 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11217 PL_lex_casemods = proto_perl->Ilex_casemods;
11218 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11219 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11222 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11223 PL_lasttoke = proto_perl->Ilasttoke;
11224 PL_realtokenstart = proto_perl->Irealtokenstart;
11225 PL_faketokens = proto_perl->Ifaketokens;
11226 PL_thismad = proto_perl->Ithismad;
11227 PL_thistoken = proto_perl->Ithistoken;
11228 PL_thisopen = proto_perl->Ithisopen;
11229 PL_thisstuff = proto_perl->Ithisstuff;
11230 PL_thisclose = proto_perl->Ithisclose;
11231 PL_thiswhite = proto_perl->Ithiswhite;
11232 PL_nextwhite = proto_perl->Inextwhite;
11233 PL_skipwhite = proto_perl->Iskipwhite;
11234 PL_endwhite = proto_perl->Iendwhite;
11235 PL_curforce = proto_perl->Icurforce;
11237 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11238 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11239 PL_nexttoke = proto_perl->Inexttoke;
11242 /* XXX This is probably masking the deeper issue of why
11243 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11244 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11245 * (A little debugging with a watchpoint on it may help.)
11247 if (SvANY(proto_perl->Ilinestr)) {
11248 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11249 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11250 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11251 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11252 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11253 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11254 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11255 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11256 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11259 PL_linestr = newSV(79);
11260 sv_upgrade(PL_linestr,SVt_PVIV);
11261 sv_setpvn(PL_linestr,"",0);
11262 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11264 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11265 PL_pending_ident = proto_perl->Ipending_ident;
11266 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11268 PL_expect = proto_perl->Iexpect;
11270 PL_multi_start = proto_perl->Imulti_start;
11271 PL_multi_end = proto_perl->Imulti_end;
11272 PL_multi_open = proto_perl->Imulti_open;
11273 PL_multi_close = proto_perl->Imulti_close;
11275 PL_error_count = proto_perl->Ierror_count;
11276 PL_subline = proto_perl->Isubline;
11277 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11279 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11280 if (SvANY(proto_perl->Ilinestr)) {
11281 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11282 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11283 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11284 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11285 PL_last_lop_op = proto_perl->Ilast_lop_op;
11288 PL_last_uni = SvPVX(PL_linestr);
11289 PL_last_lop = SvPVX(PL_linestr);
11290 PL_last_lop_op = 0;
11292 PL_in_my = proto_perl->Iin_my;
11293 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11295 PL_cryptseen = proto_perl->Icryptseen;
11298 PL_hints = proto_perl->Ihints;
11300 PL_amagic_generation = proto_perl->Iamagic_generation;
11302 #ifdef USE_LOCALE_COLLATE
11303 PL_collation_ix = proto_perl->Icollation_ix;
11304 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11305 PL_collation_standard = proto_perl->Icollation_standard;
11306 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11307 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11308 #endif /* USE_LOCALE_COLLATE */
11310 #ifdef USE_LOCALE_NUMERIC
11311 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11312 PL_numeric_standard = proto_perl->Inumeric_standard;
11313 PL_numeric_local = proto_perl->Inumeric_local;
11314 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11315 #endif /* !USE_LOCALE_NUMERIC */
11317 /* utf8 character classes */
11318 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11319 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11320 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11321 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11322 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11323 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11324 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11325 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11326 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11327 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11328 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11329 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11330 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11331 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11332 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11333 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11334 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11335 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11336 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11337 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11339 /* Did the locale setup indicate UTF-8? */
11340 PL_utf8locale = proto_perl->Iutf8locale;
11341 /* Unicode features (see perlrun/-C) */
11342 PL_unicode = proto_perl->Iunicode;
11344 /* Pre-5.8 signals control */
11345 PL_signals = proto_perl->Isignals;
11347 /* times() ticks per second */
11348 PL_clocktick = proto_perl->Iclocktick;
11350 /* Recursion stopper for PerlIO_find_layer */
11351 PL_in_load_module = proto_perl->Iin_load_module;
11353 /* sort() routine */
11354 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11356 /* Not really needed/useful since the reenrant_retint is "volatile",
11357 * but do it for consistency's sake. */
11358 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11360 /* Hooks to shared SVs and locks. */
11361 PL_sharehook = proto_perl->Isharehook;
11362 PL_lockhook = proto_perl->Ilockhook;
11363 PL_unlockhook = proto_perl->Iunlockhook;
11364 PL_threadhook = proto_perl->Ithreadhook;
11366 PL_runops_std = proto_perl->Irunops_std;
11367 PL_runops_dbg = proto_perl->Irunops_dbg;
11369 #ifdef THREADS_HAVE_PIDS
11370 PL_ppid = proto_perl->Ippid;
11374 PL_last_swash_hv = NULL; /* reinits on demand */
11375 PL_last_swash_klen = 0;
11376 PL_last_swash_key[0]= '\0';
11377 PL_last_swash_tmps = (U8*)NULL;
11378 PL_last_swash_slen = 0;
11380 PL_glob_index = proto_perl->Iglob_index;
11381 PL_srand_called = proto_perl->Isrand_called;
11382 PL_uudmap['M'] = 0; /* reinits on demand */
11383 PL_bitcount = NULL; /* reinits on demand */
11385 if (proto_perl->Ipsig_pend) {
11386 Newxz(PL_psig_pend, SIG_SIZE, int);
11389 PL_psig_pend = (int*)NULL;
11392 if (proto_perl->Ipsig_ptr) {
11393 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11394 Newxz(PL_psig_name, SIG_SIZE, SV*);
11395 for (i = 1; i < SIG_SIZE; i++) {
11396 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11397 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11401 PL_psig_ptr = (SV**)NULL;
11402 PL_psig_name = (SV**)NULL;
11405 /* thrdvar.h stuff */
11407 if (flags & CLONEf_COPY_STACKS) {
11408 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11409 PL_tmps_ix = proto_perl->Ttmps_ix;
11410 PL_tmps_max = proto_perl->Ttmps_max;
11411 PL_tmps_floor = proto_perl->Ttmps_floor;
11412 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11414 while (i <= PL_tmps_ix) {
11415 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11419 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11420 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11421 Newxz(PL_markstack, i, I32);
11422 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11423 - proto_perl->Tmarkstack);
11424 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11425 - proto_perl->Tmarkstack);
11426 Copy(proto_perl->Tmarkstack, PL_markstack,
11427 PL_markstack_ptr - PL_markstack + 1, I32);
11429 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11430 * NOTE: unlike the others! */
11431 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11432 PL_scopestack_max = proto_perl->Tscopestack_max;
11433 Newxz(PL_scopestack, PL_scopestack_max, I32);
11434 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11436 /* NOTE: si_dup() looks at PL_markstack */
11437 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11439 /* PL_curstack = PL_curstackinfo->si_stack; */
11440 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11441 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11443 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11444 PL_stack_base = AvARRAY(PL_curstack);
11445 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11446 - proto_perl->Tstack_base);
11447 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11449 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11450 * NOTE: unlike the others! */
11451 PL_savestack_ix = proto_perl->Tsavestack_ix;
11452 PL_savestack_max = proto_perl->Tsavestack_max;
11453 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11454 PL_savestack = ss_dup(proto_perl, param);
11458 ENTER; /* perl_destruct() wants to LEAVE; */
11460 /* although we're not duplicating the tmps stack, we should still
11461 * add entries for any SVs on the tmps stack that got cloned by a
11462 * non-refcount means (eg a temp in @_); otherwise they will be
11465 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11466 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11467 proto_perl->Ttmps_stack[i]);
11468 if (nsv && !SvREFCNT(nsv)) {
11470 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11475 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11476 PL_top_env = &PL_start_env;
11478 PL_op = proto_perl->Top;
11481 PL_Xpv = (XPV*)NULL;
11482 PL_na = proto_perl->Tna;
11484 PL_statbuf = proto_perl->Tstatbuf;
11485 PL_statcache = proto_perl->Tstatcache;
11486 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11487 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11489 PL_timesbuf = proto_perl->Ttimesbuf;
11492 PL_tainted = proto_perl->Ttainted;
11493 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11494 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11495 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11496 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11497 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11498 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11499 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11500 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11501 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11503 PL_restartop = proto_perl->Trestartop;
11504 PL_in_eval = proto_perl->Tin_eval;
11505 PL_delaymagic = proto_perl->Tdelaymagic;
11506 PL_dirty = proto_perl->Tdirty;
11507 PL_localizing = proto_perl->Tlocalizing;
11509 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11510 PL_hv_fetch_ent_mh = NULL;
11511 PL_modcount = proto_perl->Tmodcount;
11512 PL_lastgotoprobe = NULL;
11513 PL_dumpindent = proto_perl->Tdumpindent;
11515 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11516 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11517 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11518 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11519 PL_efloatbuf = NULL; /* reinits on demand */
11520 PL_efloatsize = 0; /* reinits on demand */
11524 PL_screamfirst = NULL;
11525 PL_screamnext = NULL;
11526 PL_maxscream = -1; /* reinits on demand */
11527 PL_lastscream = NULL;
11529 PL_watchaddr = NULL;
11532 PL_regdummy = proto_perl->Tregdummy;
11533 PL_colorset = 0; /* reinits PL_colors[] */
11534 /*PL_colors[6] = {0,0,0,0,0,0};*/
11536 /* RE engine - function pointers */
11537 PL_regcompp = proto_perl->Tregcompp;
11538 PL_regexecp = proto_perl->Tregexecp;
11539 PL_regint_start = proto_perl->Tregint_start;
11540 PL_regint_string = proto_perl->Tregint_string;
11541 PL_regfree = proto_perl->Tregfree;
11542 Zero(&PL_reg_state, 1, struct re_save_state);
11543 PL_reginterp_cnt = 0;
11544 PL_regmatch_slab = NULL;
11546 /* Pluggable optimizer */
11547 PL_peepp = proto_perl->Tpeepp;
11549 PL_stashcache = newHV();
11551 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11552 ptr_table_free(PL_ptr_table);
11553 PL_ptr_table = NULL;
11556 /* Call the ->CLONE method, if it exists, for each of the stashes
11557 identified by sv_dup() above.
11559 while(av_len(param->stashes) != -1) {
11560 HV* const stash = (HV*) av_shift(param->stashes);
11561 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11562 if (cloner && GvCV(cloner)) {
11567 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11569 call_sv((SV*)GvCV(cloner), G_DISCARD);
11575 SvREFCNT_dec(param->stashes);
11577 /* orphaned? eg threads->new inside BEGIN or use */
11578 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11579 SvREFCNT_inc_simple_void(PL_compcv);
11580 SAVEFREESV(PL_compcv);
11586 #endif /* USE_ITHREADS */
11589 =head1 Unicode Support
11591 =for apidoc sv_recode_to_utf8
11593 The encoding is assumed to be an Encode object, on entry the PV
11594 of the sv is assumed to be octets in that encoding, and the sv
11595 will be converted into Unicode (and UTF-8).
11597 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11598 is not a reference, nothing is done to the sv. If the encoding is not
11599 an C<Encode::XS> Encoding object, bad things will happen.
11600 (See F<lib/encoding.pm> and L<Encode>).
11602 The PV of the sv is returned.
11607 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11610 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11624 Passing sv_yes is wrong - it needs to be or'ed set of constants
11625 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11626 remove converted chars from source.
11628 Both will default the value - let them.
11630 XPUSHs(&PL_sv_yes);
11633 call_method("decode", G_SCALAR);
11637 s = SvPV_const(uni, len);
11638 if (s != SvPVX_const(sv)) {
11639 SvGROW(sv, len + 1);
11640 Move(s, SvPVX(sv), len + 1, char);
11641 SvCUR_set(sv, len);
11648 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11652 =for apidoc sv_cat_decode
11654 The encoding is assumed to be an Encode object, the PV of the ssv is
11655 assumed to be octets in that encoding and decoding the input starts
11656 from the position which (PV + *offset) pointed to. The dsv will be
11657 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11658 when the string tstr appears in decoding output or the input ends on
11659 the PV of the ssv. The value which the offset points will be modified
11660 to the last input position on the ssv.
11662 Returns TRUE if the terminator was found, else returns FALSE.
11667 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11668 SV *ssv, int *offset, char *tstr, int tlen)
11672 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11683 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11684 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11686 call_method("cat_decode", G_SCALAR);
11688 ret = SvTRUE(TOPs);
11689 *offset = SvIV(offsv);
11695 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11700 /* ---------------------------------------------------------------------
11702 * support functions for report_uninit()
11705 /* the maxiumum size of array or hash where we will scan looking
11706 * for the undefined element that triggered the warning */
11708 #define FUV_MAX_SEARCH_SIZE 1000
11710 /* Look for an entry in the hash whose value has the same SV as val;
11711 * If so, return a mortal copy of the key. */
11714 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11717 register HE **array;
11720 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11721 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11724 array = HvARRAY(hv);
11726 for (i=HvMAX(hv); i>0; i--) {
11727 register HE *entry;
11728 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11729 if (HeVAL(entry) != val)
11731 if ( HeVAL(entry) == &PL_sv_undef ||
11732 HeVAL(entry) == &PL_sv_placeholder)
11736 if (HeKLEN(entry) == HEf_SVKEY)
11737 return sv_mortalcopy(HeKEY_sv(entry));
11738 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11744 /* Look for an entry in the array whose value has the same SV as val;
11745 * If so, return the index, otherwise return -1. */
11748 S_find_array_subscript(pTHX_ AV *av, SV* val)
11751 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11752 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11755 if (val != &PL_sv_undef) {
11756 SV ** const svp = AvARRAY(av);
11759 for (i=AvFILLp(av); i>=0; i--)
11766 /* S_varname(): return the name of a variable, optionally with a subscript.
11767 * If gv is non-zero, use the name of that global, along with gvtype (one
11768 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11769 * targ. Depending on the value of the subscript_type flag, return:
11772 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11773 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11774 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11775 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11778 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11779 SV* keyname, I32 aindex, int subscript_type)
11782 SV * const name = sv_newmortal();
11785 buffer[0] = gvtype;
11788 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11790 gv_fullname4(name, gv, buffer, 0);
11792 if ((unsigned int)SvPVX(name)[1] <= 26) {
11794 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11796 /* Swap the 1 unprintable control character for the 2 byte pretty
11797 version - ie substr($name, 1, 1) = $buffer; */
11798 sv_insert(name, 1, 1, buffer, 2);
11803 CV * const cv = find_runcv(&unused);
11807 if (!cv || !CvPADLIST(cv))
11809 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11810 sv = *av_fetch(av, targ, FALSE);
11811 /* SvLEN in a pad name is not to be trusted */
11812 sv_setpv(name, SvPV_nolen_const(sv));
11815 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11816 SV * const sv = newSV(0);
11817 *SvPVX(name) = '$';
11818 Perl_sv_catpvf(aTHX_ name, "{%s}",
11819 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11822 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11823 *SvPVX(name) = '$';
11824 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11826 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11827 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11834 =for apidoc find_uninit_var
11836 Find the name of the undefined variable (if any) that caused the operator o
11837 to issue a "Use of uninitialized value" warning.
11838 If match is true, only return a name if it's value matches uninit_sv.
11839 So roughly speaking, if a unary operator (such as OP_COS) generates a
11840 warning, then following the direct child of the op may yield an
11841 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11842 other hand, with OP_ADD there are two branches to follow, so we only print
11843 the variable name if we get an exact match.
11845 The name is returned as a mortal SV.
11847 Assumes that PL_op is the op that originally triggered the error, and that
11848 PL_comppad/PL_curpad points to the currently executing pad.
11854 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11862 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11863 uninit_sv == &PL_sv_placeholder)))
11866 switch (obase->op_type) {
11873 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11874 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11877 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11879 if (pad) { /* @lex, %lex */
11880 sv = PAD_SVl(obase->op_targ);
11884 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11885 /* @global, %global */
11886 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11889 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11891 else /* @{expr}, %{expr} */
11892 return find_uninit_var(cUNOPx(obase)->op_first,
11896 /* attempt to find a match within the aggregate */
11898 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11900 subscript_type = FUV_SUBSCRIPT_HASH;
11903 index = find_array_subscript((AV*)sv, uninit_sv);
11905 subscript_type = FUV_SUBSCRIPT_ARRAY;
11908 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11911 return varname(gv, hash ? '%' : '@', obase->op_targ,
11912 keysv, index, subscript_type);
11916 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11918 return varname(NULL, '$', obase->op_targ,
11919 NULL, 0, FUV_SUBSCRIPT_NONE);
11922 gv = cGVOPx_gv(obase);
11923 if (!gv || (match && GvSV(gv) != uninit_sv))
11925 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11928 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11931 av = (AV*)PAD_SV(obase->op_targ);
11932 if (!av || SvRMAGICAL(av))
11934 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11935 if (!svp || *svp != uninit_sv)
11938 return varname(NULL, '$', obase->op_targ,
11939 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11942 gv = cGVOPx_gv(obase);
11948 if (!av || SvRMAGICAL(av))
11950 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11951 if (!svp || *svp != uninit_sv)
11954 return varname(gv, '$', 0,
11955 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11960 o = cUNOPx(obase)->op_first;
11961 if (!o || o->op_type != OP_NULL ||
11962 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11964 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11968 if (PL_op == obase)
11969 /* $a[uninit_expr] or $h{uninit_expr} */
11970 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11973 o = cBINOPx(obase)->op_first;
11974 kid = cBINOPx(obase)->op_last;
11976 /* get the av or hv, and optionally the gv */
11978 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11979 sv = PAD_SV(o->op_targ);
11981 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11982 && cUNOPo->op_first->op_type == OP_GV)
11984 gv = cGVOPx_gv(cUNOPo->op_first);
11987 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11992 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11993 /* index is constant */
11997 if (obase->op_type == OP_HELEM) {
11998 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11999 if (!he || HeVAL(he) != uninit_sv)
12003 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12004 if (!svp || *svp != uninit_sv)
12008 if (obase->op_type == OP_HELEM)
12009 return varname(gv, '%', o->op_targ,
12010 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12012 return varname(gv, '@', o->op_targ, NULL,
12013 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12016 /* index is an expression;
12017 * attempt to find a match within the aggregate */
12018 if (obase->op_type == OP_HELEM) {
12019 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12021 return varname(gv, '%', o->op_targ,
12022 keysv, 0, FUV_SUBSCRIPT_HASH);
12025 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12027 return varname(gv, '@', o->op_targ,
12028 NULL, index, FUV_SUBSCRIPT_ARRAY);
12033 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12035 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12040 /* only examine RHS */
12041 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12044 o = cUNOPx(obase)->op_first;
12045 if (o->op_type == OP_PUSHMARK)
12048 if (!o->op_sibling) {
12049 /* one-arg version of open is highly magical */
12051 if (o->op_type == OP_GV) { /* open FOO; */
12053 if (match && GvSV(gv) != uninit_sv)
12055 return varname(gv, '$', 0,
12056 NULL, 0, FUV_SUBSCRIPT_NONE);
12058 /* other possibilities not handled are:
12059 * open $x; or open my $x; should return '${*$x}'
12060 * open expr; should return '$'.expr ideally
12066 /* ops where $_ may be an implicit arg */
12070 if ( !(obase->op_flags & OPf_STACKED)) {
12071 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12072 ? PAD_SVl(obase->op_targ)
12075 sv = sv_newmortal();
12076 sv_setpvn(sv, "$_", 2);
12084 /* skip filehandle as it can't produce 'undef' warning */
12085 o = cUNOPx(obase)->op_first;
12086 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12087 o = o->op_sibling->op_sibling;
12094 match = 1; /* XS or custom code could trigger random warnings */
12099 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12100 return sv_2mortal(newSVpvs("${$/}"));
12105 if (!(obase->op_flags & OPf_KIDS))
12107 o = cUNOPx(obase)->op_first;
12113 /* if all except one arg are constant, or have no side-effects,
12114 * or are optimized away, then it's unambiguous */
12116 for (kid=o; kid; kid = kid->op_sibling) {
12118 const OPCODE type = kid->op_type;
12119 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12120 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12121 || (type == OP_PUSHMARK)
12125 if (o2) { /* more than one found */
12132 return find_uninit_var(o2, uninit_sv, match);
12134 /* scan all args */
12136 sv = find_uninit_var(o, uninit_sv, 1);
12148 =for apidoc report_uninit
12150 Print appropriate "Use of uninitialized variable" warning
12156 Perl_report_uninit(pTHX_ SV* uninit_sv)
12160 SV* varname = NULL;
12162 varname = find_uninit_var(PL_op, uninit_sv,0);
12164 sv_insert(varname, 0, 0, " ", 1);
12166 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12167 varname ? SvPV_nolen_const(varname) : "",
12168 " in ", OP_DESC(PL_op));
12171 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12177 * c-indentation-style: bsd
12178 * c-basic-offset: 4
12179 * indent-tabs-mode: t
12182 * ex: set ts=8 sts=4 sw=4 noet: