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, svtype new_type)
1128 const svtype 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),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1603 (void)SvNOK_only(sv); /* validate number */
1608 =for apidoc sv_setnv_mg
1610 Like C<sv_setnv>, but also handles 'set' magic.
1616 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1622 /* Print an "isn't numeric" warning, using a cleaned-up,
1623 * printable version of the offending string
1627 S_not_a_number(pTHX_ SV *sv)
1635 dsv = sv_2mortal(newSVpvs(""));
1636 pv = sv_uni_display(dsv, sv, 10, 0);
1639 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1640 /* each *s can expand to 4 chars + "...\0",
1641 i.e. need room for 8 chars */
1643 const char *s = SvPVX_const(sv);
1644 const char * const end = s + SvCUR(sv);
1645 for ( ; s < end && d < limit; s++ ) {
1647 if (ch & 128 && !isPRINT_LC(ch)) {
1656 else if (ch == '\r') {
1660 else if (ch == '\f') {
1664 else if (ch == '\\') {
1668 else if (ch == '\0') {
1672 else if (isPRINT_LC(ch))
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric in %s", pv,
1693 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1694 "Argument \"%s\" isn't numeric", pv);
1698 =for apidoc looks_like_number
1700 Test if the content of an SV looks like a number (or is a number).
1701 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1702 non-numeric warning), even if your atof() doesn't grok them.
1708 Perl_looks_like_number(pTHX_ SV *sv)
1710 register const char *sbegin;
1714 sbegin = SvPVX_const(sv);
1717 else if (SvPOKp(sv))
1718 sbegin = SvPV_const(sv, len);
1720 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1721 return grok_number(sbegin, len, NULL);
1725 S_glob_2number(pTHX_ GV * const gv)
1727 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1728 SV *const buffer = sv_newmortal();
1730 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1733 gv_efullname3(buffer, gv, "*");
1734 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1746 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1748 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1749 SV *const buffer = sv_newmortal();
1751 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1754 gv_efullname3(buffer, gv, "*");
1755 SvFLAGS(gv) |= wasfake;
1757 assert(SvPOK(buffer));
1759 *len = SvCUR(buffer);
1761 return SvPVX(buffer);
1764 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1765 until proven guilty, assume that things are not that bad... */
1770 As 64 bit platforms often have an NV that doesn't preserve all bits of
1771 an IV (an assumption perl has been based on to date) it becomes necessary
1772 to remove the assumption that the NV always carries enough precision to
1773 recreate the IV whenever needed, and that the NV is the canonical form.
1774 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1775 precision as a side effect of conversion (which would lead to insanity
1776 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1777 1) to distinguish between IV/UV/NV slots that have cached a valid
1778 conversion where precision was lost and IV/UV/NV slots that have a
1779 valid conversion which has lost no precision
1780 2) to ensure that if a numeric conversion to one form is requested that
1781 would lose precision, the precise conversion (or differently
1782 imprecise conversion) is also performed and cached, to prevent
1783 requests for different numeric formats on the same SV causing
1784 lossy conversion chains. (lossless conversion chains are perfectly
1789 SvIOKp is true if the IV slot contains a valid value
1790 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1791 SvNOKp is true if the NV slot contains a valid value
1792 SvNOK is true only if the NV value is accurate
1795 while converting from PV to NV, check to see if converting that NV to an
1796 IV(or UV) would lose accuracy over a direct conversion from PV to
1797 IV(or UV). If it would, cache both conversions, return NV, but mark
1798 SV as IOK NOKp (ie not NOK).
1800 While converting from PV to IV, check to see if converting that IV to an
1801 NV would lose accuracy over a direct conversion from PV to NV. If it
1802 would, cache both conversions, flag similarly.
1804 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1805 correctly because if IV & NV were set NV *always* overruled.
1806 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1807 changes - now IV and NV together means that the two are interchangeable:
1808 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1810 The benefit of this is that operations such as pp_add know that if
1811 SvIOK is true for both left and right operands, then integer addition
1812 can be used instead of floating point (for cases where the result won't
1813 overflow). Before, floating point was always used, which could lead to
1814 loss of precision compared with integer addition.
1816 * making IV and NV equal status should make maths accurate on 64 bit
1818 * may speed up maths somewhat if pp_add and friends start to use
1819 integers when possible instead of fp. (Hopefully the overhead in
1820 looking for SvIOK and checking for overflow will not outweigh the
1821 fp to integer speedup)
1822 * will slow down integer operations (callers of SvIV) on "inaccurate"
1823 values, as the change from SvIOK to SvIOKp will cause a call into
1824 sv_2iv each time rather than a macro access direct to the IV slot
1825 * should speed up number->string conversion on integers as IV is
1826 favoured when IV and NV are equally accurate
1828 ####################################################################
1829 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1830 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1831 On the other hand, SvUOK is true iff UV.
1832 ####################################################################
1834 Your mileage will vary depending your CPU's relative fp to integer
1838 #ifndef NV_PRESERVES_UV
1839 # define IS_NUMBER_UNDERFLOW_IV 1
1840 # define IS_NUMBER_UNDERFLOW_UV 2
1841 # define IS_NUMBER_IV_AND_UV 2
1842 # define IS_NUMBER_OVERFLOW_IV 4
1843 # define IS_NUMBER_OVERFLOW_UV 5
1845 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1847 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1849 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1852 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));
1853 if (SvNVX(sv) < (NV)IV_MIN) {
1854 (void)SvIOKp_on(sv);
1856 SvIV_set(sv, IV_MIN);
1857 return IS_NUMBER_UNDERFLOW_IV;
1859 if (SvNVX(sv) > (NV)UV_MAX) {
1860 (void)SvIOKp_on(sv);
1863 SvUV_set(sv, UV_MAX);
1864 return IS_NUMBER_OVERFLOW_UV;
1866 (void)SvIOKp_on(sv);
1868 /* Can't use strtol etc to convert this string. (See truth table in
1870 if (SvNVX(sv) <= (UV)IV_MAX) {
1871 SvIV_set(sv, I_V(SvNVX(sv)));
1872 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1873 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1875 /* Integer is imprecise. NOK, IOKp */
1877 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1880 SvUV_set(sv, U_V(SvNVX(sv)));
1881 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1882 if (SvUVX(sv) == UV_MAX) {
1883 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1884 possibly be preserved by NV. Hence, it must be overflow.
1886 return IS_NUMBER_OVERFLOW_UV;
1888 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1890 /* Integer is imprecise. NOK, IOKp */
1892 return IS_NUMBER_OVERFLOW_IV;
1894 #endif /* !NV_PRESERVES_UV*/
1897 S_sv_2iuv_common(pTHX_ SV *sv) {
1900 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1901 * without also getting a cached IV/UV from it at the same time
1902 * (ie PV->NV conversion should detect loss of accuracy and cache
1903 * IV or UV at same time to avoid this. */
1904 /* IV-over-UV optimisation - choose to cache IV if possible */
1906 if (SvTYPE(sv) == SVt_NV)
1907 sv_upgrade(sv, SVt_PVNV);
1909 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1910 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1911 certainly cast into the IV range at IV_MAX, whereas the correct
1912 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1914 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1915 if (Perl_isnan(SvNVX(sv))) {
1921 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1922 SvIV_set(sv, I_V(SvNVX(sv)));
1923 if (SvNVX(sv) == (NV) SvIVX(sv)
1924 #ifndef NV_PRESERVES_UV
1925 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1926 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1927 /* Don't flag it as "accurately an integer" if the number
1928 came from a (by definition imprecise) NV operation, and
1929 we're outside the range of NV integer precision */
1932 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1933 DEBUG_c(PerlIO_printf(Perl_debug_log,
1934 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1940 /* IV not precise. No need to convert from PV, as NV
1941 conversion would already have cached IV if it detected
1942 that PV->IV would be better than PV->NV->IV
1943 flags already correct - don't set public IOK. */
1944 DEBUG_c(PerlIO_printf(Perl_debug_log,
1945 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1950 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1951 but the cast (NV)IV_MIN rounds to a the value less (more
1952 negative) than IV_MIN which happens to be equal to SvNVX ??
1953 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1954 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1955 (NV)UVX == NVX are both true, but the values differ. :-(
1956 Hopefully for 2s complement IV_MIN is something like
1957 0x8000000000000000 which will be exact. NWC */
1960 SvUV_set(sv, U_V(SvNVX(sv)));
1962 (SvNVX(sv) == (NV) SvUVX(sv))
1963 #ifndef NV_PRESERVES_UV
1964 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1965 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1966 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1967 /* Don't flag it as "accurately an integer" if the number
1968 came from a (by definition imprecise) NV operation, and
1969 we're outside the range of NV integer precision */
1974 DEBUG_c(PerlIO_printf(Perl_debug_log,
1975 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1981 else if (SvPOKp(sv) && SvLEN(sv)) {
1983 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1984 /* We want to avoid a possible problem when we cache an IV/ a UV which
1985 may be later translated to an NV, and the resulting NV is not
1986 the same as the direct translation of the initial string
1987 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1988 be careful to ensure that the value with the .456 is around if the
1989 NV value is requested in the future).
1991 This means that if we cache such an IV/a UV, we need to cache the
1992 NV as well. Moreover, we trade speed for space, and do not
1993 cache the NV if we are sure it's not needed.
1996 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1997 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1998 == IS_NUMBER_IN_UV) {
1999 /* It's definitely an integer, only upgrade to PVIV */
2000 if (SvTYPE(sv) < SVt_PVIV)
2001 sv_upgrade(sv, SVt_PVIV);
2003 } else if (SvTYPE(sv) < SVt_PVNV)
2004 sv_upgrade(sv, SVt_PVNV);
2006 /* If NVs preserve UVs then we only use the UV value if we know that
2007 we aren't going to call atof() below. If NVs don't preserve UVs
2008 then the value returned may have more precision than atof() will
2009 return, even though value isn't perfectly accurate. */
2010 if ((numtype & (IS_NUMBER_IN_UV
2011 #ifdef NV_PRESERVES_UV
2014 )) == IS_NUMBER_IN_UV) {
2015 /* This won't turn off the public IOK flag if it was set above */
2016 (void)SvIOKp_on(sv);
2018 if (!(numtype & IS_NUMBER_NEG)) {
2020 if (value <= (UV)IV_MAX) {
2021 SvIV_set(sv, (IV)value);
2023 /* it didn't overflow, and it was positive. */
2024 SvUV_set(sv, value);
2028 /* 2s complement assumption */
2029 if (value <= (UV)IV_MIN) {
2030 SvIV_set(sv, -(IV)value);
2032 /* Too negative for an IV. This is a double upgrade, but
2033 I'm assuming it will be rare. */
2034 if (SvTYPE(sv) < SVt_PVNV)
2035 sv_upgrade(sv, SVt_PVNV);
2039 SvNV_set(sv, -(NV)value);
2040 SvIV_set(sv, IV_MIN);
2044 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2045 will be in the previous block to set the IV slot, and the next
2046 block to set the NV slot. So no else here. */
2048 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2049 != IS_NUMBER_IN_UV) {
2050 /* It wasn't an (integer that doesn't overflow the UV). */
2051 SvNV_set(sv, Atof(SvPVX_const(sv)));
2053 if (! numtype && ckWARN(WARN_NUMERIC))
2056 #if defined(USE_LONG_DOUBLE)
2057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2058 PTR2UV(sv), SvNVX(sv)));
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2064 #ifdef NV_PRESERVES_UV
2065 (void)SvIOKp_on(sv);
2067 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2068 SvIV_set(sv, I_V(SvNVX(sv)));
2069 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2072 NOOP; /* Integer is imprecise. NOK, IOKp */
2074 /* UV will not work better than IV */
2076 if (SvNVX(sv) > (NV)UV_MAX) {
2078 /* Integer is inaccurate. NOK, IOKp, is UV */
2079 SvUV_set(sv, UV_MAX);
2081 SvUV_set(sv, U_V(SvNVX(sv)));
2082 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2083 NV preservse UV so can do correct comparison. */
2084 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2087 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2092 #else /* NV_PRESERVES_UV */
2093 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2094 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2095 /* The IV/UV slot will have been set from value returned by
2096 grok_number above. The NV slot has just been set using
2099 assert (SvIOKp(sv));
2101 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2102 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2103 /* Small enough to preserve all bits. */
2104 (void)SvIOKp_on(sv);
2106 SvIV_set(sv, I_V(SvNVX(sv)));
2107 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2109 /* Assumption: first non-preserved integer is < IV_MAX,
2110 this NV is in the preserved range, therefore: */
2111 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2113 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);
2117 0 0 already failed to read UV.
2118 0 1 already failed to read UV.
2119 1 0 you won't get here in this case. IV/UV
2120 slot set, public IOK, Atof() unneeded.
2121 1 1 already read UV.
2122 so there's no point in sv_2iuv_non_preserve() attempting
2123 to use atol, strtol, strtoul etc. */
2124 sv_2iuv_non_preserve (sv, numtype);
2127 #endif /* NV_PRESERVES_UV */
2131 if (isGV_with_GP(sv))
2132 return glob_2number((GV *)sv);
2134 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2135 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2138 if (SvTYPE(sv) < SVt_IV)
2139 /* Typically the caller expects that sv_any is not NULL now. */
2140 sv_upgrade(sv, SVt_IV);
2141 /* Return 0 from the caller. */
2148 =for apidoc sv_2iv_flags
2150 Return the integer value of an SV, doing any necessary string
2151 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2152 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2158 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2163 if (SvGMAGICAL(sv)) {
2164 if (flags & SV_GMAGIC)
2169 return I_V(SvNVX(sv));
2171 if (SvPOKp(sv) && SvLEN(sv)) {
2174 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2176 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2177 == IS_NUMBER_IN_UV) {
2178 /* It's definitely an integer */
2179 if (numtype & IS_NUMBER_NEG) {
2180 if (value < (UV)IV_MIN)
2183 if (value < (UV)IV_MAX)
2188 if (ckWARN(WARN_NUMERIC))
2191 return I_V(Atof(SvPVX_const(sv)));
2196 assert(SvTYPE(sv) >= SVt_PVMG);
2197 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2198 } else if (SvTHINKFIRST(sv)) {
2202 SV * const tmpstr=AMG_CALLun(sv,numer);
2203 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2204 return SvIV(tmpstr);
2207 return PTR2IV(SvRV(sv));
2210 sv_force_normal_flags(sv, 0);
2212 if (SvREADONLY(sv) && !SvOK(sv)) {
2213 if (ckWARN(WARN_UNINITIALIZED))
2219 if (S_sv_2iuv_common(aTHX_ sv))
2222 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2223 PTR2UV(sv),SvIVX(sv)));
2224 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2228 =for apidoc sv_2uv_flags
2230 Return the unsigned integer value of an SV, doing any necessary string
2231 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2232 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2238 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2243 if (SvGMAGICAL(sv)) {
2244 if (flags & SV_GMAGIC)
2249 return U_V(SvNVX(sv));
2250 if (SvPOKp(sv) && SvLEN(sv)) {
2253 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2255 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2256 == IS_NUMBER_IN_UV) {
2257 /* It's definitely an integer */
2258 if (!(numtype & IS_NUMBER_NEG))
2262 if (ckWARN(WARN_NUMERIC))
2265 return U_V(Atof(SvPVX_const(sv)));
2270 assert(SvTYPE(sv) >= SVt_PVMG);
2271 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2272 } else if (SvTHINKFIRST(sv)) {
2276 SV *const tmpstr = AMG_CALLun(sv,numer);
2277 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2278 return SvUV(tmpstr);
2281 return PTR2UV(SvRV(sv));
2284 sv_force_normal_flags(sv, 0);
2286 if (SvREADONLY(sv) && !SvOK(sv)) {
2287 if (ckWARN(WARN_UNINITIALIZED))
2293 if (S_sv_2iuv_common(aTHX_ sv))
2297 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2298 PTR2UV(sv),SvUVX(sv)));
2299 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2305 Return the num value of an SV, doing any necessary string or integer
2306 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2313 Perl_sv_2nv(pTHX_ register SV *sv)
2318 if (SvGMAGICAL(sv)) {
2322 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2323 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2324 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2326 return Atof(SvPVX_const(sv));
2330 return (NV)SvUVX(sv);
2332 return (NV)SvIVX(sv);
2337 assert(SvTYPE(sv) >= SVt_PVMG);
2338 /* This falls through to the report_uninit near the end of the
2340 } else if (SvTHINKFIRST(sv)) {
2344 SV *const tmpstr = AMG_CALLun(sv,numer);
2345 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2346 return SvNV(tmpstr);
2349 return PTR2NV(SvRV(sv));
2352 sv_force_normal_flags(sv, 0);
2354 if (SvREADONLY(sv) && !SvOK(sv)) {
2355 if (ckWARN(WARN_UNINITIALIZED))
2360 if (SvTYPE(sv) < SVt_NV) {
2361 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2362 sv_upgrade(sv, SVt_NV);
2363 #ifdef USE_LONG_DOUBLE
2365 STORE_NUMERIC_LOCAL_SET_STANDARD();
2366 PerlIO_printf(Perl_debug_log,
2367 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2368 PTR2UV(sv), SvNVX(sv));
2369 RESTORE_NUMERIC_LOCAL();
2373 STORE_NUMERIC_LOCAL_SET_STANDARD();
2374 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2375 PTR2UV(sv), SvNVX(sv));
2376 RESTORE_NUMERIC_LOCAL();
2380 else if (SvTYPE(sv) < SVt_PVNV)
2381 sv_upgrade(sv, SVt_PVNV);
2386 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2387 #ifdef NV_PRESERVES_UV
2390 /* Only set the public NV OK flag if this NV preserves the IV */
2391 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2392 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2393 : (SvIVX(sv) == I_V(SvNVX(sv))))
2399 else if (SvPOKp(sv) && SvLEN(sv)) {
2401 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2402 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2404 #ifdef NV_PRESERVES_UV
2405 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2406 == IS_NUMBER_IN_UV) {
2407 /* It's definitely an integer */
2408 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2410 SvNV_set(sv, Atof(SvPVX_const(sv)));
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2414 /* Only set the public NV OK flag if this NV preserves the value in
2415 the PV at least as well as an IV/UV would.
2416 Not sure how to do this 100% reliably. */
2417 /* if that shift count is out of range then Configure's test is
2418 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2420 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2421 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2422 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2423 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2424 /* Can't use strtol etc to convert this string, so don't try.
2425 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2428 /* value has been set. It may not be precise. */
2429 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2430 /* 2s complement assumption for (UV)IV_MIN */
2431 SvNOK_on(sv); /* Integer is too negative. */
2436 if (numtype & IS_NUMBER_NEG) {
2437 SvIV_set(sv, -(IV)value);
2438 } else if (value <= (UV)IV_MAX) {
2439 SvIV_set(sv, (IV)value);
2441 SvUV_set(sv, value);
2445 if (numtype & IS_NUMBER_NOT_INT) {
2446 /* I believe that even if the original PV had decimals,
2447 they are lost beyond the limit of the FP precision.
2448 However, neither is canonical, so both only get p
2449 flags. NWC, 2000/11/25 */
2450 /* Both already have p flags, so do nothing */
2452 const NV nv = SvNVX(sv);
2453 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2454 if (SvIVX(sv) == I_V(nv)) {
2457 /* It had no "." so it must be integer. */
2461 /* between IV_MAX and NV(UV_MAX).
2462 Could be slightly > UV_MAX */
2464 if (numtype & IS_NUMBER_NOT_INT) {
2465 /* UV and NV both imprecise. */
2467 const UV nv_as_uv = U_V(nv);
2469 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2478 #endif /* NV_PRESERVES_UV */
2481 if (isGV_with_GP(sv)) {
2482 glob_2number((GV *)sv);
2486 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2488 assert (SvTYPE(sv) >= SVt_NV);
2489 /* Typically the caller expects that sv_any is not NULL now. */
2490 /* XXX Ilya implies that this is a bug in callers that assume this
2491 and ideally should be fixed. */
2494 #if defined(USE_LONG_DOUBLE)
2496 STORE_NUMERIC_LOCAL_SET_STANDARD();
2497 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2498 PTR2UV(sv), SvNVX(sv));
2499 RESTORE_NUMERIC_LOCAL();
2503 STORE_NUMERIC_LOCAL_SET_STANDARD();
2504 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2505 PTR2UV(sv), SvNVX(sv));
2506 RESTORE_NUMERIC_LOCAL();
2512 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2513 * UV as a string towards the end of buf, and return pointers to start and
2516 * We assume that buf is at least TYPE_CHARS(UV) long.
2520 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2522 char *ptr = buf + TYPE_CHARS(UV);
2523 char * const ebuf = ptr;
2536 *--ptr = '0' + (char)(uv % 10);
2544 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2545 * a regexp to its stringified form.
2549 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2551 const regexp * const re = (regexp *)mg->mg_obj;
2554 const char *fptr = "msix";
2559 bool need_newline = 0;
2560 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2562 while((ch = *fptr++)) {
2564 reflags[left++] = ch;
2567 reflags[right--] = ch;
2572 reflags[left] = '-';
2576 mg->mg_len = re->prelen + 4 + left;
2578 * If /x was used, we have to worry about a regex ending with a
2579 * comment later being embedded within another regex. If so, we don't
2580 * want this regex's "commentization" to leak out to the right part of
2581 * the enclosing regex, we must cap it with a newline.
2583 * So, if /x was used, we scan backwards from the end of the regex. If
2584 * we find a '#' before we find a newline, we need to add a newline
2585 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2586 * we don't need to add anything. -jfriedl
2588 if (PMf_EXTENDED & re->reganch) {
2589 const char *endptr = re->precomp + re->prelen;
2590 while (endptr >= re->precomp) {
2591 const char c = *(endptr--);
2593 break; /* don't need another */
2595 /* we end while in a comment, so we need a newline */
2596 mg->mg_len++; /* save space for it */
2597 need_newline = 1; /* note to add it */
2603 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2604 mg->mg_ptr[0] = '(';
2605 mg->mg_ptr[1] = '?';
2606 Copy(reflags, mg->mg_ptr+2, left, char);
2607 *(mg->mg_ptr+left+2) = ':';
2608 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2610 mg->mg_ptr[mg->mg_len - 2] = '\n';
2611 mg->mg_ptr[mg->mg_len - 1] = ')';
2612 mg->mg_ptr[mg->mg_len] = 0;
2614 PL_reginterp_cnt += re->program[0].next_off;
2616 if (re->reganch & ROPT_UTF8)
2626 =for apidoc sv_2pv_flags
2628 Returns a pointer to the string value of an SV, and sets *lp to its length.
2629 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2631 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2632 usually end up here too.
2638 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2648 if (SvGMAGICAL(sv)) {
2649 if (flags & SV_GMAGIC)
2654 if (flags & SV_MUTABLE_RETURN)
2655 return SvPVX_mutable(sv);
2656 if (flags & SV_CONST_RETURN)
2657 return (char *)SvPVX_const(sv);
2660 if (SvIOKp(sv) || SvNOKp(sv)) {
2661 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2666 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2667 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2669 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2676 #ifdef FIXNEGATIVEZERO
2677 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2683 SvUPGRADE(sv, SVt_PV);
2686 s = SvGROW_mutable(sv, len + 1);
2689 return memcpy(s, tbuf, len + 1);
2695 assert(SvTYPE(sv) >= SVt_PVMG);
2696 /* This falls through to the report_uninit near the end of the
2698 } else if (SvTHINKFIRST(sv)) {
2702 SV *const tmpstr = AMG_CALLun(sv,string);
2703 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2705 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2709 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2710 if (flags & SV_CONST_RETURN) {
2711 pv = (char *) SvPVX_const(tmpstr);
2713 pv = (flags & SV_MUTABLE_RETURN)
2714 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2717 *lp = SvCUR(tmpstr);
2719 pv = sv_2pv_flags(tmpstr, lp, flags);
2731 const SV *const referent = (SV*)SvRV(sv);
2734 tsv = sv_2mortal(newSVpvs("NULLREF"));
2735 } else if (SvTYPE(referent) == SVt_PVMG
2736 && ((SvFLAGS(referent) &
2737 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2738 == (SVs_OBJECT|SVs_SMG))
2739 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2740 return stringify_regexp(sv, mg, lp);
2742 const char *const typestr = sv_reftype(referent, 0);
2744 tsv = sv_newmortal();
2745 if (SvOBJECT(referent)) {
2746 const char *const name = HvNAME_get(SvSTASH(referent));
2747 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2748 name ? name : "__ANON__" , typestr,
2752 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2760 if (SvREADONLY(sv) && !SvOK(sv)) {
2761 if (ckWARN(WARN_UNINITIALIZED))
2768 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2769 /* I'm assuming that if both IV and NV are equally valid then
2770 converting the IV is going to be more efficient */
2771 const U32 isIOK = SvIOK(sv);
2772 const U32 isUIOK = SvIsUV(sv);
2773 char buf[TYPE_CHARS(UV)];
2776 if (SvTYPE(sv) < SVt_PVIV)
2777 sv_upgrade(sv, SVt_PVIV);
2778 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2779 /* inlined from sv_setpvn */
2780 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2781 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2782 SvCUR_set(sv, ebuf - ptr);
2792 else if (SvNOKp(sv)) {
2793 const int olderrno = errno;
2794 if (SvTYPE(sv) < SVt_PVNV)
2795 sv_upgrade(sv, SVt_PVNV);
2796 /* The +20 is pure guesswork. Configure test needed. --jhi */
2797 s = SvGROW_mutable(sv, NV_DIG + 20);
2798 /* some Xenix systems wipe out errno here */
2800 if (SvNVX(sv) == 0.0)
2801 (void)strcpy(s,"0");
2805 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2808 #ifdef FIXNEGATIVEZERO
2809 if (*s == '-' && s[1] == '0' && !s[2])
2819 if (isGV_with_GP(sv))
2820 return glob_2pv((GV *)sv, lp);
2822 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2826 if (SvTYPE(sv) < SVt_PV)
2827 /* Typically the caller expects that sv_any is not NULL now. */
2828 sv_upgrade(sv, SVt_PV);
2832 const STRLEN len = s - SvPVX_const(sv);
2838 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2839 PTR2UV(sv),SvPVX_const(sv)));
2840 if (flags & SV_CONST_RETURN)
2841 return (char *)SvPVX_const(sv);
2842 if (flags & SV_MUTABLE_RETURN)
2843 return SvPVX_mutable(sv);
2848 =for apidoc sv_copypv
2850 Copies a stringified representation of the source SV into the
2851 destination SV. Automatically performs any necessary mg_get and
2852 coercion of numeric values into strings. Guaranteed to preserve
2853 UTF-8 flag even from overloaded objects. Similar in nature to
2854 sv_2pv[_flags] but operates directly on an SV instead of just the
2855 string. Mostly uses sv_2pv_flags to do its work, except when that
2856 would lose the UTF-8'ness of the PV.
2862 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2865 const char * const s = SvPV_const(ssv,len);
2866 sv_setpvn(dsv,s,len);
2874 =for apidoc sv_2pvbyte
2876 Return a pointer to the byte-encoded representation of the SV, and set *lp
2877 to its length. May cause the SV to be downgraded from UTF-8 as a
2880 Usually accessed via the C<SvPVbyte> macro.
2886 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2888 sv_utf8_downgrade(sv,0);
2889 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2893 =for apidoc sv_2pvutf8
2895 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2896 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2898 Usually accessed via the C<SvPVutf8> macro.
2904 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2906 sv_utf8_upgrade(sv);
2907 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2912 =for apidoc sv_2bool
2914 This function is only called on magical items, and is only used by
2915 sv_true() or its macro equivalent.
2921 Perl_sv_2bool(pTHX_ register SV *sv)
2930 SV * const tmpsv = AMG_CALLun(sv,bool_);
2931 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2932 return (bool)SvTRUE(tmpsv);
2934 return SvRV(sv) != 0;
2937 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2939 (*sv->sv_u.svu_pv > '0' ||
2940 Xpvtmp->xpv_cur > 1 ||
2941 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2948 return SvIVX(sv) != 0;
2951 return SvNVX(sv) != 0.0;
2953 if (isGV_with_GP(sv))
2963 =for apidoc sv_utf8_upgrade
2965 Converts the PV of an SV to its UTF-8-encoded form.
2966 Forces the SV to string form if it is not already.
2967 Always sets the SvUTF8 flag to avoid future validity checks even
2968 if all the bytes have hibit clear.
2970 This is not as a general purpose byte encoding to Unicode interface:
2971 use the Encode extension for that.
2973 =for apidoc sv_utf8_upgrade_flags
2975 Converts the PV of an SV to its UTF-8-encoded form.
2976 Forces the SV to string form if it is not already.
2977 Always sets the SvUTF8 flag to avoid future validity checks even
2978 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2979 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2980 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2982 This is not as a general purpose byte encoding to Unicode interface:
2983 use the Encode extension for that.
2989 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2992 if (sv == &PL_sv_undef)
2996 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2997 (void) sv_2pv_flags(sv,&len, flags);
3001 (void) SvPV_force(sv,len);
3010 sv_force_normal_flags(sv, 0);
3013 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3014 sv_recode_to_utf8(sv, PL_encoding);
3015 else { /* Assume Latin-1/EBCDIC */
3016 /* This function could be much more efficient if we
3017 * had a FLAG in SVs to signal if there are any hibit
3018 * chars in the PV. Given that there isn't such a flag
3019 * make the loop as fast as possible. */
3020 const U8 * const s = (U8 *) SvPVX_const(sv);
3021 const U8 * const e = (U8 *) SvEND(sv);
3026 /* Check for hi bit */
3027 if (!NATIVE_IS_INVARIANT(ch)) {
3028 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3029 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3031 SvPV_free(sv); /* No longer using what was there before. */
3032 SvPV_set(sv, (char*)recoded);
3033 SvCUR_set(sv, len - 1);
3034 SvLEN_set(sv, len); /* No longer know the real size. */
3038 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3045 =for apidoc sv_utf8_downgrade
3047 Attempts to convert the PV of an SV from characters to bytes.
3048 If the PV contains a character beyond byte, this conversion will fail;
3049 in this case, either returns false or, if C<fail_ok> is not
3052 This is not as a general purpose Unicode to byte encoding interface:
3053 use the Encode extension for that.
3059 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3062 if (SvPOKp(sv) && SvUTF8(sv)) {
3068 sv_force_normal_flags(sv, 0);
3070 s = (U8 *) SvPV(sv, len);
3071 if (!utf8_to_bytes(s, &len)) {
3076 Perl_croak(aTHX_ "Wide character in %s",
3079 Perl_croak(aTHX_ "Wide character");
3090 =for apidoc sv_utf8_encode
3092 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3093 flag off so that it looks like octets again.
3099 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3102 sv_force_normal_flags(sv, 0);
3104 if (SvREADONLY(sv)) {
3105 Perl_croak(aTHX_ PL_no_modify);
3107 (void) sv_utf8_upgrade(sv);
3112 =for apidoc sv_utf8_decode
3114 If the PV of the SV is an octet sequence in UTF-8
3115 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3116 so that it looks like a character. If the PV contains only single-byte
3117 characters, the C<SvUTF8> flag stays being off.
3118 Scans PV for validity and returns false if the PV is invalid UTF-8.
3124 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3130 /* The octets may have got themselves encoded - get them back as
3133 if (!sv_utf8_downgrade(sv, TRUE))
3136 /* it is actually just a matter of turning the utf8 flag on, but
3137 * we want to make sure everything inside is valid utf8 first.
3139 c = (const U8 *) SvPVX_const(sv);
3140 if (!is_utf8_string(c, SvCUR(sv)+1))
3142 e = (const U8 *) SvEND(sv);
3145 if (!UTF8_IS_INVARIANT(ch)) {
3155 =for apidoc sv_setsv
3157 Copies the contents of the source SV C<ssv> into the destination SV
3158 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3159 function if the source SV needs to be reused. Does not handle 'set' magic.
3160 Loosely speaking, it performs a copy-by-value, obliterating any previous
3161 content of the destination.
3163 You probably want to use one of the assortment of wrappers, such as
3164 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3165 C<SvSetMagicSV_nosteal>.
3167 =for apidoc sv_setsv_flags
3169 Copies the contents of the source SV C<ssv> into the destination SV
3170 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3171 function if the source SV needs to be reused. Does not handle 'set' magic.
3172 Loosely speaking, it performs a copy-by-value, obliterating any previous
3173 content of the destination.
3174 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3175 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3176 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3177 and C<sv_setsv_nomg> are implemented in terms of this function.
3179 You probably want to use one of the assortment of wrappers, such as
3180 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3181 C<SvSetMagicSV_nosteal>.
3183 This is the primary function for copying scalars, and most other
3184 copy-ish functions and macros use this underneath.
3190 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3192 if (dtype != SVt_PVGV) {
3193 const char * const name = GvNAME(sstr);
3194 const STRLEN len = GvNAMELEN(sstr);
3195 /* don't upgrade SVt_PVLV: it can hold a glob */
3196 if (dtype != SVt_PVLV) {
3197 if (dtype >= SVt_PV) {
3203 sv_upgrade(dstr, SVt_PVGV);
3204 (void)SvOK_off(dstr);
3207 GvSTASH(dstr) = GvSTASH(sstr);
3209 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3210 gv_name_set((GV *)dstr, name, len, GV_ADD);
3211 SvFAKE_on(dstr); /* can coerce to non-glob */
3214 #ifdef GV_UNIQUE_CHECK
3215 if (GvUNIQUE((GV*)dstr)) {
3216 Perl_croak(aTHX_ PL_no_modify);
3222 (void)SvOK_off(dstr);
3224 GvINTRO_off(dstr); /* one-shot flag */
3225 GvGP(dstr) = gp_ref(GvGP(sstr));
3226 if (SvTAINTED(sstr))
3228 if (GvIMPORTED(dstr) != GVf_IMPORTED
3229 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3231 GvIMPORTED_on(dstr);
3238 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3239 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3241 const int intro = GvINTRO(dstr);
3244 const U32 stype = SvTYPE(sref);
3247 #ifdef GV_UNIQUE_CHECK
3248 if (GvUNIQUE((GV*)dstr)) {
3249 Perl_croak(aTHX_ PL_no_modify);
3254 GvINTRO_off(dstr); /* one-shot flag */
3255 GvLINE(dstr) = CopLINE(PL_curcop);
3256 GvEGV(dstr) = (GV*)dstr;
3261 location = (SV **) &GvCV(dstr);
3262 import_flag = GVf_IMPORTED_CV;
3265 location = (SV **) &GvHV(dstr);
3266 import_flag = GVf_IMPORTED_HV;
3269 location = (SV **) &GvAV(dstr);
3270 import_flag = GVf_IMPORTED_AV;
3273 location = (SV **) &GvIOp(dstr);
3276 location = (SV **) &GvFORM(dstr);
3278 location = &GvSV(dstr);
3279 import_flag = GVf_IMPORTED_SV;
3282 if (stype == SVt_PVCV) {
3283 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3284 SvREFCNT_dec(GvCV(dstr));
3286 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3287 PL_sub_generation++;
3290 SAVEGENERICSV(*location);
3294 if (stype == SVt_PVCV && *location != sref) {
3295 CV* const cv = (CV*)*location;
3297 if (!GvCVGEN((GV*)dstr) &&
3298 (CvROOT(cv) || CvXSUB(cv)))
3300 /* Redefining a sub - warning is mandatory if
3301 it was a const and its value changed. */
3302 if (CvCONST(cv) && CvCONST((CV*)sref)
3303 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3305 /* They are 2 constant subroutines generated from
3306 the same constant. This probably means that
3307 they are really the "same" proxy subroutine
3308 instantiated in 2 places. Most likely this is
3309 when a constant is exported twice. Don't warn.
3312 else if (ckWARN(WARN_REDEFINE)
3314 && (!CvCONST((CV*)sref)
3315 || sv_cmp(cv_const_sv(cv),
3316 cv_const_sv((CV*)sref))))) {
3317 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3319 ? "Constant subroutine %s::%s redefined"
3320 : "Subroutine %s::%s redefined",
3321 HvNAME_get(GvSTASH((GV*)dstr)),
3322 GvENAME((GV*)dstr));
3326 cv_ckproto_len(cv, (GV*)dstr,
3327 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3328 SvPOK(sref) ? SvCUR(sref) : 0);
3330 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3331 GvASSUMECV_on(dstr);
3332 PL_sub_generation++;
3335 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3336 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3337 GvFLAGS(dstr) |= import_flag;
3342 if (SvTAINTED(sstr))
3348 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3351 register U32 sflags;
3353 register svtype stype;
3357 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3359 sstr = &PL_sv_undef;
3360 stype = SvTYPE(sstr);
3361 dtype = SvTYPE(dstr);
3366 /* need to nuke the magic */
3368 SvRMAGICAL_off(dstr);
3371 /* There's a lot of redundancy below but we're going for speed here */
3376 if (dtype != SVt_PVGV) {
3377 (void)SvOK_off(dstr);
3385 sv_upgrade(dstr, SVt_IV);
3390 sv_upgrade(dstr, SVt_PVIV);
3393 (void)SvIOK_only(dstr);
3394 SvIV_set(dstr, SvIVX(sstr));
3397 /* SvTAINTED can only be true if the SV has taint magic, which in
3398 turn means that the SV type is PVMG (or greater). This is the
3399 case statement for SVt_IV, so this cannot be true (whatever gcov
3401 assert(!SvTAINTED(sstr));
3411 sv_upgrade(dstr, SVt_NV);
3416 sv_upgrade(dstr, SVt_PVNV);
3419 SvNV_set(dstr, SvNVX(sstr));
3420 (void)SvNOK_only(dstr);
3421 /* SvTAINTED can only be true if the SV has taint magic, which in
3422 turn means that the SV type is PVMG (or greater). This is the
3423 case statement for SVt_NV, so this cannot be true (whatever gcov
3425 assert(!SvTAINTED(sstr));
3432 sv_upgrade(dstr, SVt_RV);
3435 #ifdef PERL_OLD_COPY_ON_WRITE
3436 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3437 if (dtype < SVt_PVIV)
3438 sv_upgrade(dstr, SVt_PVIV);
3445 sv_upgrade(dstr, SVt_PV);
3448 if (dtype < SVt_PVIV)
3449 sv_upgrade(dstr, SVt_PVIV);
3452 if (dtype < SVt_PVNV)
3453 sv_upgrade(dstr, SVt_PVNV);
3457 const char * const type = sv_reftype(sstr,0);
3459 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3461 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3466 if (dtype <= SVt_PVGV) {
3467 glob_assign_glob(dstr, sstr, dtype);
3475 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3477 if ((int)SvTYPE(sstr) != stype) {
3478 stype = SvTYPE(sstr);
3479 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3480 glob_assign_glob(dstr, sstr, dtype);
3485 if (stype == SVt_PVLV)
3486 SvUPGRADE(dstr, SVt_PVNV);
3488 SvUPGRADE(dstr, (svtype)stype);
3491 /* dstr may have been upgraded. */
3492 dtype = SvTYPE(dstr);
3493 sflags = SvFLAGS(sstr);
3495 if (sflags & SVf_ROK) {
3496 if (dtype == SVt_PVGV &&
3497 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3500 if (GvIMPORTED(dstr) != GVf_IMPORTED
3501 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3503 GvIMPORTED_on(dstr);
3508 glob_assign_glob(dstr, sstr, dtype);
3512 if (dtype >= SVt_PV) {
3513 if (dtype == SVt_PVGV) {
3514 glob_assign_ref(dstr, sstr);
3517 if (SvPVX_const(dstr)) {
3523 (void)SvOK_off(dstr);
3524 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3525 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3526 assert(!(sflags & SVp_NOK));
3527 assert(!(sflags & SVp_IOK));
3528 assert(!(sflags & SVf_NOK));
3529 assert(!(sflags & SVf_IOK));
3531 else if (dtype == SVt_PVGV) {
3532 if (!(sflags & SVf_OK)) {
3533 if (ckWARN(WARN_MISC))
3534 Perl_warner(aTHX_ packWARN(WARN_MISC),
3535 "Undefined value assigned to typeglob");
3538 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3539 if (dstr != (SV*)gv) {
3542 GvGP(dstr) = gp_ref(GvGP(gv));
3546 else if (sflags & SVp_POK) {
3550 * Check to see if we can just swipe the string. If so, it's a
3551 * possible small lose on short strings, but a big win on long ones.
3552 * It might even be a win on short strings if SvPVX_const(dstr)
3553 * has to be allocated and SvPVX_const(sstr) has to be freed.
3556 /* Whichever path we take through the next code, we want this true,
3557 and doing it now facilitates the COW check. */
3558 (void)SvPOK_only(dstr);
3561 /* We're not already COW */
3562 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3563 #ifndef PERL_OLD_COPY_ON_WRITE
3564 /* or we are, but dstr isn't a suitable target. */
3565 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3570 (sflags & SVs_TEMP) && /* slated for free anyway? */
3571 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3572 (!(flags & SV_NOSTEAL)) &&
3573 /* and we're allowed to steal temps */
3574 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3575 SvLEN(sstr) && /* and really is a string */
3576 /* and won't be needed again, potentially */
3577 !(PL_op && PL_op->op_type == OP_AASSIGN))
3578 #ifdef PERL_OLD_COPY_ON_WRITE
3579 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3580 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3581 && SvTYPE(sstr) >= SVt_PVIV)
3584 /* Failed the swipe test, and it's not a shared hash key either.
3585 Have to copy the string. */
3586 STRLEN len = SvCUR(sstr);
3587 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3588 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3589 SvCUR_set(dstr, len);
3590 *SvEND(dstr) = '\0';
3592 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3594 /* Either it's a shared hash key, or it's suitable for
3595 copy-on-write or we can swipe the string. */
3597 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3601 #ifdef PERL_OLD_COPY_ON_WRITE
3603 /* I believe I should acquire a global SV mutex if
3604 it's a COW sv (not a shared hash key) to stop
3605 it going un copy-on-write.
3606 If the source SV has gone un copy on write between up there
3607 and down here, then (assert() that) it is of the correct
3608 form to make it copy on write again */
3609 if ((sflags & (SVf_FAKE | SVf_READONLY))
3610 != (SVf_FAKE | SVf_READONLY)) {
3611 SvREADONLY_on(sstr);
3613 /* Make the source SV into a loop of 1.
3614 (about to become 2) */
3615 SV_COW_NEXT_SV_SET(sstr, sstr);
3619 /* Initial code is common. */
3620 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3625 /* making another shared SV. */
3626 STRLEN cur = SvCUR(sstr);
3627 STRLEN len = SvLEN(sstr);
3628 #ifdef PERL_OLD_COPY_ON_WRITE
3630 assert (SvTYPE(dstr) >= SVt_PVIV);
3631 /* SvIsCOW_normal */
3632 /* splice us in between source and next-after-source. */
3633 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3634 SV_COW_NEXT_SV_SET(sstr, dstr);
3635 SvPV_set(dstr, SvPVX_mutable(sstr));
3639 /* SvIsCOW_shared_hash */
3640 DEBUG_C(PerlIO_printf(Perl_debug_log,
3641 "Copy on write: Sharing hash\n"));
3643 assert (SvTYPE(dstr) >= SVt_PV);
3645 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3647 SvLEN_set(dstr, len);
3648 SvCUR_set(dstr, cur);
3649 SvREADONLY_on(dstr);
3651 /* Relesase a global SV mutex. */
3654 { /* Passes the swipe test. */
3655 SvPV_set(dstr, SvPVX_mutable(sstr));
3656 SvLEN_set(dstr, SvLEN(sstr));
3657 SvCUR_set(dstr, SvCUR(sstr));
3660 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3661 SvPV_set(sstr, NULL);
3667 if (sflags & SVp_NOK) {
3668 SvNV_set(dstr, SvNVX(sstr));
3670 if (sflags & SVp_IOK) {
3671 SvRELEASE_IVX(dstr);
3672 SvIV_set(dstr, SvIVX(sstr));
3673 /* Must do this otherwise some other overloaded use of 0x80000000
3674 gets confused. I guess SVpbm_VALID */
3675 if (sflags & SVf_IVisUV)
3678 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3681 const MAGIC * const smg = SvVSTRING_mg(sstr);
3683 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3684 smg->mg_ptr, smg->mg_len);
3685 SvRMAGICAL_on(dstr);
3689 else if (sflags & (SVp_IOK|SVp_NOK)) {
3690 (void)SvOK_off(dstr);
3691 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3693 if (sflags & SVp_IOK) {
3694 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3695 SvIV_set(dstr, SvIVX(sstr));
3697 if (sflags & SVp_NOK) {
3698 SvNV_set(dstr, SvNVX(sstr));
3702 if (isGV_with_GP(sstr)) {
3703 /* This stringification rule for globs is spread in 3 places.
3704 This feels bad. FIXME. */
3705 const U32 wasfake = sflags & SVf_FAKE;
3707 /* FAKE globs can get coerced, so need to turn this off
3708 temporarily if it is on. */
3710 gv_efullname3(dstr, (GV *)sstr, "*");
3711 SvFLAGS(sstr) |= wasfake;
3712 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3715 (void)SvOK_off(dstr);
3717 if (SvTAINTED(sstr))
3722 =for apidoc sv_setsv_mg
3724 Like C<sv_setsv>, but also handles 'set' magic.
3730 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3732 sv_setsv(dstr,sstr);
3736 #ifdef PERL_OLD_COPY_ON_WRITE
3738 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3740 STRLEN cur = SvCUR(sstr);
3741 STRLEN len = SvLEN(sstr);
3742 register char *new_pv;
3745 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3753 if (SvTHINKFIRST(dstr))
3754 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3755 else if (SvPVX_const(dstr))
3756 Safefree(SvPVX_const(dstr));
3760 SvUPGRADE(dstr, SVt_PVIV);
3762 assert (SvPOK(sstr));
3763 assert (SvPOKp(sstr));
3764 assert (!SvIOK(sstr));
3765 assert (!SvIOKp(sstr));
3766 assert (!SvNOK(sstr));
3767 assert (!SvNOKp(sstr));
3769 if (SvIsCOW(sstr)) {
3771 if (SvLEN(sstr) == 0) {
3772 /* source is a COW shared hash key. */
3773 DEBUG_C(PerlIO_printf(Perl_debug_log,
3774 "Fast copy on write: Sharing hash\n"));
3775 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3778 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3780 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3781 SvUPGRADE(sstr, SVt_PVIV);
3782 SvREADONLY_on(sstr);
3784 DEBUG_C(PerlIO_printf(Perl_debug_log,
3785 "Fast copy on write: Converting sstr to COW\n"));
3786 SV_COW_NEXT_SV_SET(dstr, sstr);
3788 SV_COW_NEXT_SV_SET(sstr, dstr);
3789 new_pv = SvPVX_mutable(sstr);
3792 SvPV_set(dstr, new_pv);
3793 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3796 SvLEN_set(dstr, len);
3797 SvCUR_set(dstr, cur);
3806 =for apidoc sv_setpvn
3808 Copies a string into an SV. The C<len> parameter indicates the number of
3809 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3810 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3816 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3819 register char *dptr;
3821 SV_CHECK_THINKFIRST_COW_DROP(sv);
3827 /* len is STRLEN which is unsigned, need to copy to signed */
3830 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3832 SvUPGRADE(sv, SVt_PV);
3834 dptr = SvGROW(sv, len + 1);
3835 Move(ptr,dptr,len,char);
3838 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3843 =for apidoc sv_setpvn_mg
3845 Like C<sv_setpvn>, but also handles 'set' magic.
3851 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3853 sv_setpvn(sv,ptr,len);
3858 =for apidoc sv_setpv
3860 Copies a string into an SV. The string must be null-terminated. Does not
3861 handle 'set' magic. See C<sv_setpv_mg>.
3867 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3870 register STRLEN len;
3872 SV_CHECK_THINKFIRST_COW_DROP(sv);
3878 SvUPGRADE(sv, SVt_PV);
3880 SvGROW(sv, len + 1);
3881 Move(ptr,SvPVX(sv),len+1,char);
3883 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3888 =for apidoc sv_setpv_mg
3890 Like C<sv_setpv>, but also handles 'set' magic.
3896 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3903 =for apidoc sv_usepvn_flags
3905 Tells an SV to use C<ptr> to find its string value. Normally the
3906 string is stored inside the SV but sv_usepvn allows the SV to use an
3907 outside string. The C<ptr> should point to memory that was allocated
3908 by C<malloc>. The string length, C<len>, must be supplied. By default
3909 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3910 so that pointer should not be freed or used by the programmer after
3911 giving it to sv_usepvn, and neither should any pointers from "behind"
3912 that pointer (e.g. ptr + 1) be used.
3914 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3915 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3916 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3917 C<len>, and already meets the requirements for storing in C<SvPVX>)
3923 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3927 SV_CHECK_THINKFIRST_COW_DROP(sv);
3928 SvUPGRADE(sv, SVt_PV);
3931 if (flags & SV_SMAGIC)
3935 if (SvPVX_const(sv))
3938 if (flags & SV_HAS_TRAILING_NUL)
3939 assert(ptr[len] == '\0');
3941 allocate = (flags & SV_HAS_TRAILING_NUL)
3942 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3943 if (flags & SV_HAS_TRAILING_NUL) {
3944 /* It's long enough - do nothing.
3945 Specfically Perl_newCONSTSUB is relying on this. */
3948 /* Force a move to shake out bugs in callers. */
3949 char *new_ptr = safemalloc(allocate);
3950 Copy(ptr, new_ptr, len, char);
3951 PoisonFree(ptr,len,char);
3955 ptr = saferealloc (ptr, allocate);
3960 SvLEN_set(sv, allocate);
3961 if (!(flags & SV_HAS_TRAILING_NUL)) {
3964 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3966 if (flags & SV_SMAGIC)
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3971 /* Need to do this *after* making the SV normal, as we need the buffer
3972 pointer to remain valid until after we've copied it. If we let go too early,
3973 another thread could invalidate it by unsharing last of the same hash key
3974 (which it can do by means other than releasing copy-on-write Svs)
3975 or by changing the other copy-on-write SVs in the loop. */
3977 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3979 if (len) { /* this SV was SvIsCOW_normal(sv) */
3980 /* we need to find the SV pointing to us. */
3981 SV *current = SV_COW_NEXT_SV(after);
3983 if (current == sv) {
3984 /* The SV we point to points back to us (there were only two of us
3986 Hence other SV is no longer copy on write either. */
3988 SvREADONLY_off(after);
3990 /* We need to follow the pointers around the loop. */
3992 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3995 /* don't loop forever if the structure is bust, and we have
3996 a pointer into a closed loop. */
3997 assert (current != after);
3998 assert (SvPVX_const(current) == pvx);
4000 /* Make the SV before us point to the SV after us. */
4001 SV_COW_NEXT_SV_SET(current, after);
4004 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4009 Perl_sv_release_IVX(pTHX_ register SV *sv)
4012 sv_force_normal_flags(sv, 0);
4018 =for apidoc sv_force_normal_flags
4020 Undo various types of fakery on an SV: if the PV is a shared string, make
4021 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4022 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4023 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4024 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4025 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4026 set to some other value.) In addition, the C<flags> parameter gets passed to
4027 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4028 with flags set to 0.
4034 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4037 #ifdef PERL_OLD_COPY_ON_WRITE
4038 if (SvREADONLY(sv)) {
4039 /* At this point I believe I should acquire a global SV mutex. */
4041 const char * const pvx = SvPVX_const(sv);
4042 const STRLEN len = SvLEN(sv);
4043 const STRLEN cur = SvCUR(sv);
4044 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4046 PerlIO_printf(Perl_debug_log,
4047 "Copy on write: Force normal %ld\n",
4053 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4056 if (flags & SV_COW_DROP_PV) {
4057 /* OK, so we don't need to copy our buffer. */
4060 SvGROW(sv, cur + 1);
4061 Move(pvx,SvPVX(sv),cur,char);
4065 sv_release_COW(sv, pvx, len, next);
4070 else if (IN_PERL_RUNTIME)
4071 Perl_croak(aTHX_ PL_no_modify);
4072 /* At this point I believe that I can drop the global SV mutex. */
4075 if (SvREADONLY(sv)) {
4077 const char * const pvx = SvPVX_const(sv);
4078 const STRLEN len = SvCUR(sv);
4083 SvGROW(sv, len + 1);
4084 Move(pvx,SvPVX(sv),len,char);
4086 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4088 else if (IN_PERL_RUNTIME)
4089 Perl_croak(aTHX_ PL_no_modify);
4093 sv_unref_flags(sv, flags);
4094 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4101 Efficient removal of characters from the beginning of the string buffer.
4102 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4103 the string buffer. The C<ptr> becomes the first character of the adjusted
4104 string. Uses the "OOK hack".
4105 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4106 refer to the same chunk of data.
4112 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4114 register STRLEN delta;
4115 if (!ptr || !SvPOKp(sv))
4117 delta = ptr - SvPVX_const(sv);
4118 SV_CHECK_THINKFIRST(sv);
4119 if (SvTYPE(sv) < SVt_PVIV)
4120 sv_upgrade(sv,SVt_PVIV);
4123 if (!SvLEN(sv)) { /* make copy of shared string */
4124 const char *pvx = SvPVX_const(sv);
4125 const STRLEN len = SvCUR(sv);
4126 SvGROW(sv, len + 1);
4127 Move(pvx,SvPVX(sv),len,char);
4131 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4132 and we do that anyway inside the SvNIOK_off
4134 SvFLAGS(sv) |= SVf_OOK;
4137 SvLEN_set(sv, SvLEN(sv) - delta);
4138 SvCUR_set(sv, SvCUR(sv) - delta);
4139 SvPV_set(sv, SvPVX(sv) + delta);
4140 SvIV_set(sv, SvIVX(sv) + delta);
4144 =for apidoc sv_catpvn
4146 Concatenates the string onto the end of the string which is in the SV. The
4147 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4148 status set, then the bytes appended should be valid UTF-8.
4149 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4151 =for apidoc sv_catpvn_flags
4153 Concatenates the string onto the end of the string which is in the SV. The
4154 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4155 status set, then the bytes appended should be valid UTF-8.
4156 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4157 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4158 in terms of this function.
4164 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4168 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4170 SvGROW(dsv, dlen + slen + 1);
4172 sstr = SvPVX_const(dsv);
4173 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4174 SvCUR_set(dsv, SvCUR(dsv) + slen);
4176 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4178 if (flags & SV_SMAGIC)
4183 =for apidoc sv_catsv
4185 Concatenates the string from SV C<ssv> onto the end of the string in
4186 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4187 not 'set' magic. See C<sv_catsv_mg>.
4189 =for apidoc sv_catsv_flags
4191 Concatenates the string from SV C<ssv> onto the end of the string in
4192 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4193 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4194 and C<sv_catsv_nomg> are implemented in terms of this function.
4199 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4204 const char *spv = SvPV_const(ssv, slen);
4206 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4207 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4208 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4209 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4210 dsv->sv_flags doesn't have that bit set.
4211 Andy Dougherty 12 Oct 2001
4213 const I32 sutf8 = DO_UTF8(ssv);
4216 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4218 dutf8 = DO_UTF8(dsv);
4220 if (dutf8 != sutf8) {
4222 /* Not modifying source SV, so taking a temporary copy. */
4223 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4225 sv_utf8_upgrade(csv);
4226 spv = SvPV_const(csv, slen);
4229 sv_utf8_upgrade_nomg(dsv);
4231 sv_catpvn_nomg(dsv, spv, slen);
4234 if (flags & SV_SMAGIC)
4239 =for apidoc sv_catpv
4241 Concatenates the string onto the end of the string which is in the SV.
4242 If the SV has the UTF-8 status set, then the bytes appended should be
4243 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4248 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4251 register STRLEN len;
4257 junk = SvPV_force(sv, tlen);
4259 SvGROW(sv, tlen + len + 1);
4261 ptr = SvPVX_const(sv);
4262 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4263 SvCUR_set(sv, SvCUR(sv) + len);
4264 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4269 =for apidoc sv_catpv_mg
4271 Like C<sv_catpv>, but also handles 'set' magic.
4277 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4286 Creates a new SV. A non-zero C<len> parameter indicates the number of
4287 bytes of preallocated string space the SV should have. An extra byte for a
4288 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4289 space is allocated.) The reference count for the new SV is set to 1.
4291 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4292 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4293 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4294 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4295 modules supporting older perls.
4301 Perl_newSV(pTHX_ STRLEN len)
4308 sv_upgrade(sv, SVt_PV);
4309 SvGROW(sv, len + 1);
4314 =for apidoc sv_magicext
4316 Adds magic to an SV, upgrading it if necessary. Applies the
4317 supplied vtable and returns a pointer to the magic added.
4319 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4320 In particular, you can add magic to SvREADONLY SVs, and add more than
4321 one instance of the same 'how'.
4323 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4324 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4325 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4326 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4328 (This is now used as a subroutine by C<sv_magic>.)
4333 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4334 const char* name, I32 namlen)
4339 if (SvTYPE(sv) < SVt_PVMG) {
4340 SvUPGRADE(sv, SVt_PVMG);
4342 Newxz(mg, 1, MAGIC);
4343 mg->mg_moremagic = SvMAGIC(sv);
4344 SvMAGIC_set(sv, mg);
4346 /* Sometimes a magic contains a reference loop, where the sv and
4347 object refer to each other. To prevent a reference loop that
4348 would prevent such objects being freed, we look for such loops
4349 and if we find one we avoid incrementing the object refcount.
4351 Note we cannot do this to avoid self-tie loops as intervening RV must
4352 have its REFCNT incremented to keep it in existence.
4355 if (!obj || obj == sv ||
4356 how == PERL_MAGIC_arylen ||
4357 how == PERL_MAGIC_qr ||
4358 how == PERL_MAGIC_symtab ||
4359 (SvTYPE(obj) == SVt_PVGV &&
4360 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4361 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4362 GvFORM(obj) == (CV*)sv)))
4367 mg->mg_obj = SvREFCNT_inc_simple(obj);
4368 mg->mg_flags |= MGf_REFCOUNTED;
4371 /* Normal self-ties simply pass a null object, and instead of
4372 using mg_obj directly, use the SvTIED_obj macro to produce a
4373 new RV as needed. For glob "self-ties", we are tieing the PVIO
4374 with an RV obj pointing to the glob containing the PVIO. In
4375 this case, to avoid a reference loop, we need to weaken the
4379 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4380 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4386 mg->mg_len = namlen;
4389 mg->mg_ptr = savepvn(name, namlen);
4390 else if (namlen == HEf_SVKEY)
4391 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4393 mg->mg_ptr = (char *) name;
4395 mg->mg_virtual = vtable;
4399 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4404 =for apidoc sv_magic
4406 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4407 then adds a new magic item of type C<how> to the head of the magic list.
4409 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4410 handling of the C<name> and C<namlen> arguments.
4412 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4413 to add more than one instance of the same 'how'.
4419 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4425 #ifdef PERL_OLD_COPY_ON_WRITE
4427 sv_force_normal_flags(sv, 0);
4429 if (SvREADONLY(sv)) {
4431 /* its okay to attach magic to shared strings; the subsequent
4432 * upgrade to PVMG will unshare the string */
4433 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4436 && how != PERL_MAGIC_regex_global
4437 && how != PERL_MAGIC_bm
4438 && how != PERL_MAGIC_fm
4439 && how != PERL_MAGIC_sv
4440 && how != PERL_MAGIC_backref
4443 Perl_croak(aTHX_ PL_no_modify);
4446 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4447 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4448 /* sv_magic() refuses to add a magic of the same 'how' as an
4451 if (how == PERL_MAGIC_taint) {
4453 /* Any scalar which already had taint magic on which someone
4454 (erroneously?) did SvIOK_on() or similar will now be
4455 incorrectly sporting public "OK" flags. */
4456 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4464 vtable = &PL_vtbl_sv;
4466 case PERL_MAGIC_overload:
4467 vtable = &PL_vtbl_amagic;
4469 case PERL_MAGIC_overload_elem:
4470 vtable = &PL_vtbl_amagicelem;
4472 case PERL_MAGIC_overload_table:
4473 vtable = &PL_vtbl_ovrld;
4476 vtable = &PL_vtbl_bm;
4478 case PERL_MAGIC_regdata:
4479 vtable = &PL_vtbl_regdata;
4481 case PERL_MAGIC_regdatum:
4482 vtable = &PL_vtbl_regdatum;
4484 case PERL_MAGIC_env:
4485 vtable = &PL_vtbl_env;
4488 vtable = &PL_vtbl_fm;
4490 case PERL_MAGIC_envelem:
4491 vtable = &PL_vtbl_envelem;
4493 case PERL_MAGIC_regex_global:
4494 vtable = &PL_vtbl_mglob;
4496 case PERL_MAGIC_isa:
4497 vtable = &PL_vtbl_isa;
4499 case PERL_MAGIC_isaelem:
4500 vtable = &PL_vtbl_isaelem;
4502 case PERL_MAGIC_nkeys:
4503 vtable = &PL_vtbl_nkeys;
4505 case PERL_MAGIC_dbfile:
4508 case PERL_MAGIC_dbline:
4509 vtable = &PL_vtbl_dbline;
4511 #ifdef USE_LOCALE_COLLATE
4512 case PERL_MAGIC_collxfrm:
4513 vtable = &PL_vtbl_collxfrm;
4515 #endif /* USE_LOCALE_COLLATE */
4516 case PERL_MAGIC_tied:
4517 vtable = &PL_vtbl_pack;
4519 case PERL_MAGIC_tiedelem:
4520 case PERL_MAGIC_tiedscalar:
4521 vtable = &PL_vtbl_packelem;
4524 vtable = &PL_vtbl_regexp;
4526 case PERL_MAGIC_hints:
4527 /* As this vtable is all NULL, we can reuse it. */
4528 case PERL_MAGIC_sig:
4529 vtable = &PL_vtbl_sig;
4531 case PERL_MAGIC_sigelem:
4532 vtable = &PL_vtbl_sigelem;
4534 case PERL_MAGIC_taint:
4535 vtable = &PL_vtbl_taint;
4537 case PERL_MAGIC_uvar:
4538 vtable = &PL_vtbl_uvar;
4540 case PERL_MAGIC_vec:
4541 vtable = &PL_vtbl_vec;
4543 case PERL_MAGIC_arylen_p:
4544 case PERL_MAGIC_rhash:
4545 case PERL_MAGIC_symtab:
4546 case PERL_MAGIC_vstring:
4549 case PERL_MAGIC_utf8:
4550 vtable = &PL_vtbl_utf8;
4552 case PERL_MAGIC_substr:
4553 vtable = &PL_vtbl_substr;
4555 case PERL_MAGIC_defelem:
4556 vtable = &PL_vtbl_defelem;
4558 case PERL_MAGIC_arylen:
4559 vtable = &PL_vtbl_arylen;
4561 case PERL_MAGIC_pos:
4562 vtable = &PL_vtbl_pos;
4564 case PERL_MAGIC_backref:
4565 vtable = &PL_vtbl_backref;
4567 case PERL_MAGIC_hintselem:
4568 vtable = &PL_vtbl_hintselem;
4570 case PERL_MAGIC_ext:
4571 /* Reserved for use by extensions not perl internals. */
4572 /* Useful for attaching extension internal data to perl vars. */
4573 /* Note that multiple extensions may clash if magical scalars */
4574 /* etc holding private data from one are passed to another. */
4578 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4581 /* Rest of work is done else where */
4582 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4585 case PERL_MAGIC_taint:
4588 case PERL_MAGIC_ext:
4589 case PERL_MAGIC_dbfile:
4596 =for apidoc sv_unmagic
4598 Removes all magic of type C<type> from an SV.
4604 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4608 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4610 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4611 for (mg = *mgp; mg; mg = *mgp) {
4612 if (mg->mg_type == type) {
4613 const MGVTBL* const vtbl = mg->mg_virtual;
4614 *mgp = mg->mg_moremagic;
4615 if (vtbl && vtbl->svt_free)
4616 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4617 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4619 Safefree(mg->mg_ptr);
4620 else if (mg->mg_len == HEf_SVKEY)
4621 SvREFCNT_dec((SV*)mg->mg_ptr);
4622 else if (mg->mg_type == PERL_MAGIC_utf8)
4623 Safefree(mg->mg_ptr);
4625 if (mg->mg_flags & MGf_REFCOUNTED)
4626 SvREFCNT_dec(mg->mg_obj);
4630 mgp = &mg->mg_moremagic;
4634 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4635 SvMAGIC_set(sv, NULL);
4642 =for apidoc sv_rvweaken
4644 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4645 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4646 push a back-reference to this RV onto the array of backreferences
4647 associated with that magic. If the RV is magical, set magic will be
4648 called after the RV is cleared.
4654 Perl_sv_rvweaken(pTHX_ SV *sv)
4657 if (!SvOK(sv)) /* let undefs pass */
4660 Perl_croak(aTHX_ "Can't weaken a nonreference");
4661 else if (SvWEAKREF(sv)) {
4662 if (ckWARN(WARN_MISC))
4663 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4667 Perl_sv_add_backref(aTHX_ tsv, sv);
4673 /* Give tsv backref magic if it hasn't already got it, then push a
4674 * back-reference to sv onto the array associated with the backref magic.
4678 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4683 if (SvTYPE(tsv) == SVt_PVHV) {
4684 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4688 /* There is no AV in the offical place - try a fixup. */
4689 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4692 /* Aha. They've got it stowed in magic. Bring it back. */
4693 av = (AV*)mg->mg_obj;
4694 /* Stop mg_free decreasing the refernce count. */
4696 /* Stop mg_free even calling the destructor, given that
4697 there's no AV to free up. */
4699 sv_unmagic(tsv, PERL_MAGIC_backref);
4703 SvREFCNT_inc_simple_void(av);
4708 const MAGIC *const mg
4709 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4711 av = (AV*)mg->mg_obj;
4715 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4716 /* av now has a refcnt of 2, which avoids it getting freed
4717 * before us during global cleanup. The extra ref is removed
4718 * by magic_killbackrefs() when tsv is being freed */
4721 if (AvFILLp(av) >= AvMAX(av)) {
4722 av_extend(av, AvFILLp(av)+1);
4724 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4727 /* delete a back-reference to ourselves from the backref magic associated
4728 * with the SV we point to.
4732 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4739 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4740 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4741 /* We mustn't attempt to "fix up" the hash here by moving the
4742 backreference array back to the hv_aux structure, as that is stored
4743 in the main HvARRAY(), and hfreentries assumes that no-one
4744 reallocates HvARRAY() while it is running. */
4747 const MAGIC *const mg
4748 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4750 av = (AV *)mg->mg_obj;
4753 if (PL_in_clean_all)
4755 Perl_croak(aTHX_ "panic: del_backref");
4762 /* We shouldn't be in here more than once, but for paranoia reasons lets
4764 for (i = AvFILLp(av); i >= 0; i--) {
4766 const SSize_t fill = AvFILLp(av);
4768 /* We weren't the last entry.
4769 An unordered list has this property that you can take the
4770 last element off the end to fill the hole, and it's still
4771 an unordered list :-)
4776 AvFILLp(av) = fill - 1;
4782 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4784 SV **svp = AvARRAY(av);
4786 PERL_UNUSED_ARG(sv);
4788 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4789 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4790 if (svp && !SvIS_FREED(av)) {
4791 SV *const *const last = svp + AvFILLp(av);
4793 while (svp <= last) {
4795 SV *const referrer = *svp;
4796 if (SvWEAKREF(referrer)) {
4797 /* XXX Should we check that it hasn't changed? */
4798 SvRV_set(referrer, 0);
4800 SvWEAKREF_off(referrer);
4801 SvSETMAGIC(referrer);
4802 } else if (SvTYPE(referrer) == SVt_PVGV ||
4803 SvTYPE(referrer) == SVt_PVLV) {
4804 /* You lookin' at me? */
4805 assert(GvSTASH(referrer));
4806 assert(GvSTASH(referrer) == (HV*)sv);
4807 GvSTASH(referrer) = 0;
4810 "panic: magic_killbackrefs (flags=%"UVxf")",
4811 (UV)SvFLAGS(referrer));
4819 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4824 =for apidoc sv_insert
4826 Inserts a string at the specified offset/length within the SV. Similar to
4827 the Perl substr() function.
4833 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4838 register char *midend;
4839 register char *bigend;
4845 Perl_croak(aTHX_ "Can't modify non-existent substring");
4846 SvPV_force(bigstr, curlen);
4847 (void)SvPOK_only_UTF8(bigstr);
4848 if (offset + len > curlen) {
4849 SvGROW(bigstr, offset+len+1);
4850 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4851 SvCUR_set(bigstr, offset+len);
4855 i = littlelen - len;
4856 if (i > 0) { /* string might grow */
4857 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4858 mid = big + offset + len;
4859 midend = bigend = big + SvCUR(bigstr);
4862 while (midend > mid) /* shove everything down */
4863 *--bigend = *--midend;
4864 Move(little,big+offset,littlelen,char);
4865 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4870 Move(little,SvPVX(bigstr)+offset,len,char);
4875 big = SvPVX(bigstr);
4878 bigend = big + SvCUR(bigstr);
4880 if (midend > bigend)
4881 Perl_croak(aTHX_ "panic: sv_insert");
4883 if (mid - big > bigend - midend) { /* faster to shorten from end */
4885 Move(little, mid, littlelen,char);
4888 i = bigend - midend;
4890 Move(midend, mid, i,char);
4894 SvCUR_set(bigstr, mid - big);
4896 else if ((i = mid - big)) { /* faster from front */
4897 midend -= littlelen;
4899 sv_chop(bigstr,midend-i);
4904 Move(little, mid, littlelen,char);
4906 else if (littlelen) {
4907 midend -= littlelen;
4908 sv_chop(bigstr,midend);
4909 Move(little,midend,littlelen,char);
4912 sv_chop(bigstr,midend);
4918 =for apidoc sv_replace
4920 Make the first argument a copy of the second, then delete the original.
4921 The target SV physically takes over ownership of the body of the source SV
4922 and inherits its flags; however, the target keeps any magic it owns,
4923 and any magic in the source is discarded.
4924 Note that this is a rather specialist SV copying operation; most of the
4925 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4931 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4934 const U32 refcnt = SvREFCNT(sv);
4935 SV_CHECK_THINKFIRST_COW_DROP(sv);
4936 if (SvREFCNT(nsv) != 1) {
4937 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4938 UVuf " != 1)", (UV) SvREFCNT(nsv));
4940 if (SvMAGICAL(sv)) {
4944 sv_upgrade(nsv, SVt_PVMG);
4945 SvMAGIC_set(nsv, SvMAGIC(sv));
4946 SvFLAGS(nsv) |= SvMAGICAL(sv);
4948 SvMAGIC_set(sv, NULL);
4952 assert(!SvREFCNT(sv));
4953 #ifdef DEBUG_LEAKING_SCALARS
4954 sv->sv_flags = nsv->sv_flags;
4955 sv->sv_any = nsv->sv_any;
4956 sv->sv_refcnt = nsv->sv_refcnt;
4957 sv->sv_u = nsv->sv_u;
4959 StructCopy(nsv,sv,SV);
4961 /* Currently could join these into one piece of pointer arithmetic, but
4962 it would be unclear. */
4963 if(SvTYPE(sv) == SVt_IV)
4965 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4966 else if (SvTYPE(sv) == SVt_RV) {
4967 SvANY(sv) = &sv->sv_u.svu_rv;
4971 #ifdef PERL_OLD_COPY_ON_WRITE
4972 if (SvIsCOW_normal(nsv)) {
4973 /* We need to follow the pointers around the loop to make the
4974 previous SV point to sv, rather than nsv. */
4977 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4980 assert(SvPVX_const(current) == SvPVX_const(nsv));
4982 /* Make the SV before us point to the SV after us. */
4984 PerlIO_printf(Perl_debug_log, "previous is\n");
4986 PerlIO_printf(Perl_debug_log,
4987 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4988 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4990 SV_COW_NEXT_SV_SET(current, sv);
4993 SvREFCNT(sv) = refcnt;
4994 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5000 =for apidoc sv_clear
5002 Clear an SV: call any destructors, free up any memory used by the body,
5003 and free the body itself. The SV's head is I<not> freed, although
5004 its type is set to all 1's so that it won't inadvertently be assumed
5005 to be live during global destruction etc.
5006 This function should only be called when REFCNT is zero. Most of the time
5007 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5014 Perl_sv_clear(pTHX_ register SV *sv)
5017 const U32 type = SvTYPE(sv);
5018 const struct body_details *const sv_type_details
5019 = bodies_by_type + type;
5022 assert(SvREFCNT(sv) == 0);
5024 if (type <= SVt_IV) {
5025 /* See the comment in sv.h about the collusion between this early
5026 return and the overloading of the NULL and IV slots in the size
5032 if (PL_defstash) { /* Still have a symbol table? */
5037 stash = SvSTASH(sv);
5038 destructor = StashHANDLER(stash,DESTROY);
5040 SV* const tmpref = newRV(sv);
5041 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5043 PUSHSTACKi(PERLSI_DESTROY);
5048 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5054 if(SvREFCNT(tmpref) < 2) {
5055 /* tmpref is not kept alive! */
5057 SvRV_set(tmpref, NULL);
5060 SvREFCNT_dec(tmpref);
5062 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5066 if (PL_in_clean_objs)
5067 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5069 /* DESTROY gave object new lease on life */
5075 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5076 SvOBJECT_off(sv); /* Curse the object. */
5077 if (type != SVt_PVIO)
5078 --PL_sv_objcount; /* XXX Might want something more general */
5081 if (type >= SVt_PVMG) {
5082 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5083 SvREFCNT_dec(OURSTASH(sv));
5084 } else if (SvMAGIC(sv))
5086 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5087 SvREFCNT_dec(SvSTASH(sv));
5092 IoIFP(sv) != PerlIO_stdin() &&
5093 IoIFP(sv) != PerlIO_stdout() &&
5094 IoIFP(sv) != PerlIO_stderr())
5096 io_close((IO*)sv, FALSE);
5098 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5099 PerlDir_close(IoDIRP(sv));
5100 IoDIRP(sv) = (DIR*)NULL;
5101 Safefree(IoTOP_NAME(sv));
5102 Safefree(IoFMT_NAME(sv));
5103 Safefree(IoBOTTOM_NAME(sv));
5112 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5119 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5120 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5121 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5122 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5124 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5125 SvREFCNT_dec(LvTARG(sv));
5129 if (GvNAME_HEK(sv)) {
5130 unshare_hek(GvNAME_HEK(sv));
5132 /* If we're in a stash, we don't own a reference to it. However it does
5133 have a back reference to us, which needs to be cleared. */
5135 sv_del_backref((SV*)GvSTASH(sv), sv);
5140 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5142 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5143 /* Don't even bother with turning off the OOK flag. */
5148 SV * const target = SvRV(sv);
5150 sv_del_backref(target, sv);
5152 SvREFCNT_dec(target);
5154 #ifdef PERL_OLD_COPY_ON_WRITE
5155 else if (SvPVX_const(sv)) {
5157 /* I believe I need to grab the global SV mutex here and
5158 then recheck the COW status. */
5160 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5163 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5164 SV_COW_NEXT_SV(sv));
5165 /* And drop it here. */
5167 } else if (SvLEN(sv)) {
5168 Safefree(SvPVX_const(sv));
5172 else if (SvPVX_const(sv) && SvLEN(sv))
5173 Safefree(SvPVX_mutable(sv));
5174 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5175 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5184 SvFLAGS(sv) &= SVf_BREAK;
5185 SvFLAGS(sv) |= SVTYPEMASK;
5187 if (sv_type_details->arena) {
5188 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5189 &PL_body_roots[type]);
5191 else if (sv_type_details->body_size) {
5192 my_safefree(SvANY(sv));
5197 =for apidoc sv_newref
5199 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5206 Perl_sv_newref(pTHX_ SV *sv)
5208 PERL_UNUSED_CONTEXT;
5217 Decrement an SV's reference count, and if it drops to zero, call
5218 C<sv_clear> to invoke destructors and free up any memory used by
5219 the body; finally, deallocate the SV's head itself.
5220 Normally called via a wrapper macro C<SvREFCNT_dec>.
5226 Perl_sv_free(pTHX_ SV *sv)
5231 if (SvREFCNT(sv) == 0) {
5232 if (SvFLAGS(sv) & SVf_BREAK)
5233 /* this SV's refcnt has been artificially decremented to
5234 * trigger cleanup */
5236 if (PL_in_clean_all) /* All is fair */
5238 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5239 /* make sure SvREFCNT(sv)==0 happens very seldom */
5240 SvREFCNT(sv) = (~(U32)0)/2;
5243 if (ckWARN_d(WARN_INTERNAL)) {
5244 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5245 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5246 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5247 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5248 Perl_dump_sv_child(aTHX_ sv);
5253 if (--(SvREFCNT(sv)) > 0)
5255 Perl_sv_free2(aTHX_ sv);
5259 Perl_sv_free2(pTHX_ SV *sv)
5264 if (ckWARN_d(WARN_DEBUGGING))
5265 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5266 "Attempt to free temp prematurely: SV 0x%"UVxf
5267 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5271 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5272 /* make sure SvREFCNT(sv)==0 happens very seldom */
5273 SvREFCNT(sv) = (~(U32)0)/2;
5284 Returns the length of the string in the SV. Handles magic and type
5285 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5291 Perl_sv_len(pTHX_ register SV *sv)
5299 len = mg_length(sv);
5301 (void)SvPV_const(sv, len);
5306 =for apidoc sv_len_utf8
5308 Returns the number of characters in the string in an SV, counting wide
5309 UTF-8 bytes as a single character. Handles magic and type coercion.
5315 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5316 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5317 * (Note that the mg_len is not the length of the mg_ptr field.
5318 * This allows the cache to store the character length of the string without
5319 * needing to malloc() extra storage to attach to the mg_ptr.)
5324 Perl_sv_len_utf8(pTHX_ register SV *sv)
5330 return mg_length(sv);
5334 const U8 *s = (U8*)SvPV_const(sv, len);
5338 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5340 if (mg && mg->mg_len != -1) {
5342 if (PL_utf8cache < 0) {
5343 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5345 /* Need to turn the assertions off otherwise we may
5346 recurse infinitely while printing error messages.
5348 SAVEI8(PL_utf8cache);
5350 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5351 " real %"UVf" for %"SVf,
5352 (UV) ulen, (UV) real, (void*)sv);
5357 ulen = Perl_utf8_length(aTHX_ s, s + len);
5358 if (!SvREADONLY(sv)) {
5360 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5361 &PL_vtbl_utf8, 0, 0);
5369 return Perl_utf8_length(aTHX_ s, s + len);
5373 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5376 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5379 const U8 *s = start;
5381 while (s < send && uoffset--)
5384 /* This is the existing behaviour. Possibly it should be a croak, as
5385 it's actually a bounds error */
5391 /* Given the length of the string in both bytes and UTF-8 characters, decide
5392 whether to walk forwards or backwards to find the byte corresponding to
5393 the passed in UTF-8 offset. */
5395 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5396 STRLEN uoffset, STRLEN uend)
5398 STRLEN backw = uend - uoffset;
5399 if (uoffset < 2 * backw) {
5400 /* The assumption is that going forwards is twice the speed of going
5401 forward (that's where the 2 * backw comes from).
5402 (The real figure of course depends on the UTF-8 data.) */
5403 return sv_pos_u2b_forwards(start, send, uoffset);
5408 while (UTF8_IS_CONTINUATION(*send))
5411 return send - start;
5414 /* For the string representation of the given scalar, find the byte
5415 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5416 give another position in the string, *before* the sought offset, which
5417 (which is always true, as 0, 0 is a valid pair of positions), which should
5418 help reduce the amount of linear searching.
5419 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5420 will be used to reduce the amount of linear searching. The cache will be
5421 created if necessary, and the found value offered to it for update. */
5423 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5424 const U8 *const send, STRLEN uoffset,
5425 STRLEN uoffset0, STRLEN boffset0) {
5426 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5429 assert (uoffset >= uoffset0);
5431 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5432 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5433 if ((*mgp)->mg_ptr) {
5434 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5435 if (cache[0] == uoffset) {
5436 /* An exact match. */
5439 if (cache[2] == uoffset) {
5440 /* An exact match. */
5444 if (cache[0] < uoffset) {
5445 /* The cache already knows part of the way. */
5446 if (cache[0] > uoffset0) {
5447 /* The cache knows more than the passed in pair */
5448 uoffset0 = cache[0];
5449 boffset0 = cache[1];
5451 if ((*mgp)->mg_len != -1) {
5452 /* And we know the end too. */
5454 + sv_pos_u2b_midway(start + boffset0, send,
5456 (*mgp)->mg_len - uoffset0);
5459 + sv_pos_u2b_forwards(start + boffset0,
5460 send, uoffset - uoffset0);
5463 else if (cache[2] < uoffset) {
5464 /* We're between the two cache entries. */
5465 if (cache[2] > uoffset0) {
5466 /* and the cache knows more than the passed in pair */
5467 uoffset0 = cache[2];
5468 boffset0 = cache[3];
5472 + sv_pos_u2b_midway(start + boffset0,
5475 cache[0] - uoffset0);
5478 + sv_pos_u2b_midway(start + boffset0,
5481 cache[2] - uoffset0);
5485 else if ((*mgp)->mg_len != -1) {
5486 /* If we can take advantage of a passed in offset, do so. */
5487 /* In fact, offset0 is either 0, or less than offset, so don't
5488 need to worry about the other possibility. */
5490 + sv_pos_u2b_midway(start + boffset0, send,
5492 (*mgp)->mg_len - uoffset0);
5497 if (!found || PL_utf8cache < 0) {
5498 const STRLEN real_boffset
5499 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5500 send, uoffset - uoffset0);
5502 if (found && PL_utf8cache < 0) {
5503 if (real_boffset != boffset) {
5504 /* Need to turn the assertions off otherwise we may recurse
5505 infinitely while printing error messages. */
5506 SAVEI8(PL_utf8cache);
5508 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5509 " real %"UVf" for %"SVf,
5510 (UV) boffset, (UV) real_boffset, (void*)sv);
5513 boffset = real_boffset;
5516 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5522 =for apidoc sv_pos_u2b
5524 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5525 the start of the string, to a count of the equivalent number of bytes; if
5526 lenp is non-zero, it does the same to lenp, but this time starting from
5527 the offset, rather than from the start of the string. Handles magic and
5534 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5535 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5536 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5541 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5549 start = (U8*)SvPV_const(sv, len);
5551 STRLEN uoffset = (STRLEN) *offsetp;
5552 const U8 * const send = start + len;
5554 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5557 *offsetp = (I32) boffset;
5560 /* Convert the relative offset to absolute. */
5561 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5562 const STRLEN boffset2
5563 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5564 uoffset, boffset) - boffset;
5578 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5579 byte length pairing. The (byte) length of the total SV is passed in too,
5580 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5581 may not have updated SvCUR, so we can't rely on reading it directly.
5583 The proffered utf8/byte length pairing isn't used if the cache already has
5584 two pairs, and swapping either for the proffered pair would increase the
5585 RMS of the intervals between known byte offsets.
5587 The cache itself consists of 4 STRLEN values
5588 0: larger UTF-8 offset
5589 1: corresponding byte offset
5590 2: smaller UTF-8 offset
5591 3: corresponding byte offset
5593 Unused cache pairs have the value 0, 0.
5594 Keeping the cache "backwards" means that the invariant of
5595 cache[0] >= cache[2] is maintained even with empty slots, which means that
5596 the code that uses it doesn't need to worry if only 1 entry has actually
5597 been set to non-zero. It also makes the "position beyond the end of the
5598 cache" logic much simpler, as the first slot is always the one to start
5602 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5610 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5612 (*mgp)->mg_len = -1;
5616 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5617 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5618 (*mgp)->mg_ptr = (char *) cache;
5622 if (PL_utf8cache < 0) {
5623 const U8 *start = (const U8 *) SvPVX_const(sv);
5624 const U8 *const end = start + byte;
5625 STRLEN realutf8 = 0;
5627 while (start < end) {
5628 start += UTF8SKIP(start);
5632 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5633 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5634 doesn't? I don't know whether this difference was introduced with
5635 the caching code in 5.8.1. */
5637 if (realutf8 != utf8) {
5638 /* Need to turn the assertions off otherwise we may recurse
5639 infinitely while printing error messages. */
5640 SAVEI8(PL_utf8cache);
5642 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5643 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5647 /* Cache is held with the later position first, to simplify the code
5648 that deals with unbounded ends. */
5650 ASSERT_UTF8_CACHE(cache);
5651 if (cache[1] == 0) {
5652 /* Cache is totally empty */
5655 } else if (cache[3] == 0) {
5656 if (byte > cache[1]) {
5657 /* New one is larger, so goes first. */
5658 cache[2] = cache[0];
5659 cache[3] = cache[1];
5667 #define THREEWAY_SQUARE(a,b,c,d) \
5668 ((float)((d) - (c))) * ((float)((d) - (c))) \
5669 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5670 + ((float)((b) - (a))) * ((float)((b) - (a)))
5672 /* Cache has 2 slots in use, and we know three potential pairs.
5673 Keep the two that give the lowest RMS distance. Do the
5674 calcualation in bytes simply because we always know the byte
5675 length. squareroot has the same ordering as the positive value,
5676 so don't bother with the actual square root. */
5677 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5678 if (byte > cache[1]) {
5679 /* New position is after the existing pair of pairs. */
5680 const float keep_earlier
5681 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5682 const float keep_later
5683 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5685 if (keep_later < keep_earlier) {
5686 if (keep_later < existing) {
5687 cache[2] = cache[0];
5688 cache[3] = cache[1];
5694 if (keep_earlier < existing) {
5700 else if (byte > cache[3]) {
5701 /* New position is between the existing pair of pairs. */
5702 const float keep_earlier
5703 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5704 const float keep_later
5705 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5707 if (keep_later < keep_earlier) {
5708 if (keep_later < existing) {
5714 if (keep_earlier < existing) {
5721 /* New position is before the existing pair of pairs. */
5722 const float keep_earlier
5723 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5724 const float keep_later
5725 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5727 if (keep_later < keep_earlier) {
5728 if (keep_later < existing) {
5734 if (keep_earlier < existing) {
5735 cache[0] = cache[2];
5736 cache[1] = cache[3];
5743 ASSERT_UTF8_CACHE(cache);
5746 /* If we don't know the character offset of the end of a region, our only
5747 option is to walk forwards to the target byte offset. */
5749 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5752 while (s < target) {
5755 /* Call utf8n_to_uvchr() to validate the sequence
5756 * (unless a simple non-UTF character) */
5757 if (!UTF8_IS_INVARIANT(*s))
5758 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5769 /* We already know all of the way, now we may be able to walk back. The same
5770 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5771 backward is half the speed of walking forward. */
5773 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5776 const STRLEN forw = target - s;
5777 STRLEN backw = end - target;
5779 if (forw < 2 * backw) {
5780 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5783 while (end > target) {
5785 while (UTF8_IS_CONTINUATION(*end)) {
5794 =for apidoc sv_pos_b2u
5796 Converts the value pointed to by offsetp from a count of bytes from the
5797 start of the string, to a count of the equivalent number of UTF-8 chars.
5798 Handles magic and type coercion.
5804 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5805 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5810 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5813 const STRLEN byte = *offsetp;
5814 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5823 s = (const U8*)SvPV_const(sv, blen);
5826 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5830 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5831 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5833 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5834 if (cache[1] == byte) {
5835 /* An exact match. */
5836 *offsetp = cache[0];
5839 if (cache[3] == byte) {
5840 /* An exact match. */
5841 *offsetp = cache[2];
5845 if (cache[1] < byte) {
5846 /* We already know part of the way. */
5847 if (mg->mg_len != -1) {
5848 /* Actually, we know the end too. */
5850 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5851 s + blen, mg->mg_len - cache[0]);
5854 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5857 else if (cache[3] < byte) {
5858 /* We're between the two cached pairs, so we do the calculation
5859 offset by the byte/utf-8 positions for the earlier pair,
5860 then add the utf-8 characters from the string start to
5862 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5863 s + cache[1], cache[0] - cache[2])
5867 else { /* cache[3] > byte */
5868 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5872 ASSERT_UTF8_CACHE(cache);
5874 } else if (mg->mg_len != -1) {
5875 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5879 if (!found || PL_utf8cache < 0) {
5880 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5882 if (found && PL_utf8cache < 0) {
5883 if (len != real_len) {
5884 /* Need to turn the assertions off otherwise we may recurse
5885 infinitely while printing error messages. */
5886 SAVEI8(PL_utf8cache);
5888 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5889 " real %"UVf" for %"SVf,
5890 (UV) len, (UV) real_len, (void*)sv);
5897 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5903 Returns a boolean indicating whether the strings in the two SVs are
5904 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5905 coerce its args to strings if necessary.
5911 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5920 SV* svrecode = NULL;
5927 pv1 = SvPV_const(sv1, cur1);
5934 pv2 = SvPV_const(sv2, cur2);
5936 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5937 /* Differing utf8ness.
5938 * Do not UTF8size the comparands as a side-effect. */
5941 svrecode = newSVpvn(pv2, cur2);
5942 sv_recode_to_utf8(svrecode, PL_encoding);
5943 pv2 = SvPV_const(svrecode, cur2);
5946 svrecode = newSVpvn(pv1, cur1);
5947 sv_recode_to_utf8(svrecode, PL_encoding);
5948 pv1 = SvPV_const(svrecode, cur1);
5950 /* Now both are in UTF-8. */
5952 SvREFCNT_dec(svrecode);
5957 bool is_utf8 = TRUE;
5960 /* sv1 is the UTF-8 one,
5961 * if is equal it must be downgrade-able */
5962 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5968 /* sv2 is the UTF-8 one,
5969 * if is equal it must be downgrade-able */
5970 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5976 /* Downgrade not possible - cannot be eq */
5984 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5986 SvREFCNT_dec(svrecode);
5996 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5997 string in C<sv1> is less than, equal to, or greater than the string in
5998 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5999 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6005 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6009 const char *pv1, *pv2;
6012 SV *svrecode = NULL;
6019 pv1 = SvPV_const(sv1, cur1);
6026 pv2 = SvPV_const(sv2, cur2);
6028 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6029 /* Differing utf8ness.
6030 * Do not UTF8size the comparands as a side-effect. */
6033 svrecode = newSVpvn(pv2, cur2);
6034 sv_recode_to_utf8(svrecode, PL_encoding);
6035 pv2 = SvPV_const(svrecode, cur2);
6038 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6043 svrecode = newSVpvn(pv1, cur1);
6044 sv_recode_to_utf8(svrecode, PL_encoding);
6045 pv1 = SvPV_const(svrecode, cur1);
6048 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6054 cmp = cur2 ? -1 : 0;
6058 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6061 cmp = retval < 0 ? -1 : 1;
6062 } else if (cur1 == cur2) {
6065 cmp = cur1 < cur2 ? -1 : 1;
6069 SvREFCNT_dec(svrecode);
6077 =for apidoc sv_cmp_locale
6079 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6080 'use bytes' aware, handles get magic, and will coerce its args to strings
6081 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6087 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6090 #ifdef USE_LOCALE_COLLATE
6096 if (PL_collation_standard)
6100 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6102 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6104 if (!pv1 || !len1) {
6115 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6118 return retval < 0 ? -1 : 1;
6121 * When the result of collation is equality, that doesn't mean
6122 * that there are no differences -- some locales exclude some
6123 * characters from consideration. So to avoid false equalities,
6124 * we use the raw string as a tiebreaker.
6130 #endif /* USE_LOCALE_COLLATE */
6132 return sv_cmp(sv1, sv2);
6136 #ifdef USE_LOCALE_COLLATE
6139 =for apidoc sv_collxfrm
6141 Add Collate Transform magic to an SV if it doesn't already have it.
6143 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6144 scalar data of the variable, but transformed to such a format that a normal
6145 memory comparison can be used to compare the data according to the locale
6152 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6157 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6158 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6164 Safefree(mg->mg_ptr);
6165 s = SvPV_const(sv, len);
6166 if ((xf = mem_collxfrm(s, len, &xlen))) {
6167 if (SvREADONLY(sv)) {
6170 return xf + sizeof(PL_collation_ix);
6173 #ifdef PERL_OLD_COPY_ON_WRITE
6175 sv_force_normal_flags(sv, 0);
6177 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6191 if (mg && mg->mg_ptr) {
6193 return mg->mg_ptr + sizeof(PL_collation_ix);
6201 #endif /* USE_LOCALE_COLLATE */
6206 Get a line from the filehandle and store it into the SV, optionally
6207 appending to the currently-stored string.
6213 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6218 register STDCHAR rslast;
6219 register STDCHAR *bp;
6224 if (SvTHINKFIRST(sv))
6225 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6226 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6228 However, perlbench says it's slower, because the existing swipe code
6229 is faster than copy on write.
6230 Swings and roundabouts. */
6231 SvUPGRADE(sv, SVt_PV);
6236 if (PerlIO_isutf8(fp)) {
6238 sv_utf8_upgrade_nomg(sv);
6239 sv_pos_u2b(sv,&append,0);
6241 } else if (SvUTF8(sv)) {
6242 SV * const tsv = newSV(0);
6243 sv_gets(tsv, fp, 0);
6244 sv_utf8_upgrade_nomg(tsv);
6245 SvCUR_set(sv,append);
6248 goto return_string_or_null;
6253 if (PerlIO_isutf8(fp))
6256 if (IN_PERL_COMPILETIME) {
6257 /* we always read code in line mode */
6261 else if (RsSNARF(PL_rs)) {
6262 /* If it is a regular disk file use size from stat() as estimate
6263 of amount we are going to read -- may result in mallocing
6264 more memory than we really need if the layers below reduce
6265 the size we read (e.g. CRLF or a gzip layer).
6268 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6269 const Off_t offset = PerlIO_tell(fp);
6270 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6271 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6277 else if (RsRECORD(PL_rs)) {
6282 /* Grab the size of the record we're getting */
6283 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6284 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6287 /* VMS wants read instead of fread, because fread doesn't respect */
6288 /* RMS record boundaries. This is not necessarily a good thing to be */
6289 /* doing, but we've got no other real choice - except avoid stdio
6290 as implementation - perhaps write a :vms layer ?
6292 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6294 bytesread = PerlIO_read(fp, buffer, recsize);
6298 SvCUR_set(sv, bytesread += append);
6299 buffer[bytesread] = '\0';
6300 goto return_string_or_null;
6302 else if (RsPARA(PL_rs)) {
6308 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6309 if (PerlIO_isutf8(fp)) {
6310 rsptr = SvPVutf8(PL_rs, rslen);
6313 if (SvUTF8(PL_rs)) {
6314 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6315 Perl_croak(aTHX_ "Wide character in $/");
6318 rsptr = SvPV_const(PL_rs, rslen);
6322 rslast = rslen ? rsptr[rslen - 1] : '\0';
6324 if (rspara) { /* have to do this both before and after */
6325 do { /* to make sure file boundaries work right */
6328 i = PerlIO_getc(fp);
6332 PerlIO_ungetc(fp,i);
6338 /* See if we know enough about I/O mechanism to cheat it ! */
6340 /* This used to be #ifdef test - it is made run-time test for ease
6341 of abstracting out stdio interface. One call should be cheap
6342 enough here - and may even be a macro allowing compile
6346 if (PerlIO_fast_gets(fp)) {
6349 * We're going to steal some values from the stdio struct
6350 * and put EVERYTHING in the innermost loop into registers.
6352 register STDCHAR *ptr;
6356 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6357 /* An ungetc()d char is handled separately from the regular
6358 * buffer, so we getc() it back out and stuff it in the buffer.
6360 i = PerlIO_getc(fp);
6361 if (i == EOF) return 0;
6362 *(--((*fp)->_ptr)) = (unsigned char) i;
6366 /* Here is some breathtakingly efficient cheating */
6368 cnt = PerlIO_get_cnt(fp); /* get count into register */
6369 /* make sure we have the room */
6370 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6371 /* Not room for all of it
6372 if we are looking for a separator and room for some
6374 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6375 /* just process what we have room for */
6376 shortbuffered = cnt - SvLEN(sv) + append + 1;
6377 cnt -= shortbuffered;
6381 /* remember that cnt can be negative */
6382 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6387 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6388 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6389 DEBUG_P(PerlIO_printf(Perl_debug_log,
6390 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6391 DEBUG_P(PerlIO_printf(Perl_debug_log,
6392 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6393 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6394 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6399 while (cnt > 0) { /* this | eat */
6401 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6402 goto thats_all_folks; /* screams | sed :-) */
6406 Copy(ptr, bp, cnt, char); /* this | eat */
6407 bp += cnt; /* screams | dust */
6408 ptr += cnt; /* louder | sed :-) */
6413 if (shortbuffered) { /* oh well, must extend */
6414 cnt = shortbuffered;
6416 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6418 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6419 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6423 DEBUG_P(PerlIO_printf(Perl_debug_log,
6424 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6425 PTR2UV(ptr),(long)cnt));
6426 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6428 DEBUG_P(PerlIO_printf(Perl_debug_log,
6429 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6430 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6431 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6433 /* This used to call 'filbuf' in stdio form, but as that behaves like
6434 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6435 another abstraction. */
6436 i = PerlIO_getc(fp); /* get more characters */
6438 DEBUG_P(PerlIO_printf(Perl_debug_log,
6439 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6440 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6441 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6443 cnt = PerlIO_get_cnt(fp);
6444 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6445 DEBUG_P(PerlIO_printf(Perl_debug_log,
6446 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6448 if (i == EOF) /* all done for ever? */
6449 goto thats_really_all_folks;
6451 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6453 SvGROW(sv, bpx + cnt + 2);
6454 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6456 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6458 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6459 goto thats_all_folks;
6463 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6464 memNE((char*)bp - rslen, rsptr, rslen))
6465 goto screamer; /* go back to the fray */
6466 thats_really_all_folks:
6468 cnt += shortbuffered;
6469 DEBUG_P(PerlIO_printf(Perl_debug_log,
6470 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6471 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6472 DEBUG_P(PerlIO_printf(Perl_debug_log,
6473 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6474 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6475 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6477 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6478 DEBUG_P(PerlIO_printf(Perl_debug_log,
6479 "Screamer: done, len=%ld, string=|%.*s|\n",
6480 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6484 /*The big, slow, and stupid way. */
6485 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6486 STDCHAR *buf = NULL;
6487 Newx(buf, 8192, STDCHAR);
6495 register const STDCHAR * const bpe = buf + sizeof(buf);
6497 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6498 ; /* keep reading */
6502 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6503 /* Accomodate broken VAXC compiler, which applies U8 cast to
6504 * both args of ?: operator, causing EOF to change into 255
6507 i = (U8)buf[cnt - 1];
6513 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6515 sv_catpvn(sv, (char *) buf, cnt);
6517 sv_setpvn(sv, (char *) buf, cnt);
6519 if (i != EOF && /* joy */
6521 SvCUR(sv) < rslen ||
6522 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6526 * If we're reading from a TTY and we get a short read,
6527 * indicating that the user hit his EOF character, we need
6528 * to notice it now, because if we try to read from the TTY
6529 * again, the EOF condition will disappear.
6531 * The comparison of cnt to sizeof(buf) is an optimization
6532 * that prevents unnecessary calls to feof().
6536 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6540 #ifdef USE_HEAP_INSTEAD_OF_STACK
6545 if (rspara) { /* have to do this both before and after */
6546 while (i != EOF) { /* to make sure file boundaries work right */
6547 i = PerlIO_getc(fp);
6549 PerlIO_ungetc(fp,i);
6555 return_string_or_null:
6556 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6562 Auto-increment of the value in the SV, doing string to numeric conversion
6563 if necessary. Handles 'get' magic.
6569 Perl_sv_inc(pTHX_ register SV *sv)
6578 if (SvTHINKFIRST(sv)) {
6580 sv_force_normal_flags(sv, 0);
6581 if (SvREADONLY(sv)) {
6582 if (IN_PERL_RUNTIME)
6583 Perl_croak(aTHX_ PL_no_modify);
6587 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6589 i = PTR2IV(SvRV(sv));
6594 flags = SvFLAGS(sv);
6595 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6596 /* It's (privately or publicly) a float, but not tested as an
6597 integer, so test it to see. */
6599 flags = SvFLAGS(sv);
6601 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6602 /* It's publicly an integer, or privately an integer-not-float */
6603 #ifdef PERL_PRESERVE_IVUV
6607 if (SvUVX(sv) == UV_MAX)
6608 sv_setnv(sv, UV_MAX_P1);
6610 (void)SvIOK_only_UV(sv);
6611 SvUV_set(sv, SvUVX(sv) + 1);
6613 if (SvIVX(sv) == IV_MAX)
6614 sv_setuv(sv, (UV)IV_MAX + 1);
6616 (void)SvIOK_only(sv);
6617 SvIV_set(sv, SvIVX(sv) + 1);
6622 if (flags & SVp_NOK) {
6623 (void)SvNOK_only(sv);
6624 SvNV_set(sv, SvNVX(sv) + 1.0);
6628 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6629 if ((flags & SVTYPEMASK) < SVt_PVIV)
6630 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6631 (void)SvIOK_only(sv);
6636 while (isALPHA(*d)) d++;
6637 while (isDIGIT(*d)) d++;
6639 #ifdef PERL_PRESERVE_IVUV
6640 /* Got to punt this as an integer if needs be, but we don't issue
6641 warnings. Probably ought to make the sv_iv_please() that does
6642 the conversion if possible, and silently. */
6643 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6644 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6645 /* Need to try really hard to see if it's an integer.
6646 9.22337203685478e+18 is an integer.
6647 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6648 so $a="9.22337203685478e+18"; $a+0; $a++
6649 needs to be the same as $a="9.22337203685478e+18"; $a++
6656 /* sv_2iv *should* have made this an NV */
6657 if (flags & SVp_NOK) {
6658 (void)SvNOK_only(sv);
6659 SvNV_set(sv, SvNVX(sv) + 1.0);
6662 /* I don't think we can get here. Maybe I should assert this
6663 And if we do get here I suspect that sv_setnv will croak. NWC
6665 #if defined(USE_LONG_DOUBLE)
6666 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",
6667 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6669 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6670 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6673 #endif /* PERL_PRESERVE_IVUV */
6674 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6678 while (d >= SvPVX_const(sv)) {
6686 /* MKS: The original code here died if letters weren't consecutive.
6687 * at least it didn't have to worry about non-C locales. The
6688 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6689 * arranged in order (although not consecutively) and that only
6690 * [A-Za-z] are accepted by isALPHA in the C locale.
6692 if (*d != 'z' && *d != 'Z') {
6693 do { ++*d; } while (!isALPHA(*d));
6696 *(d--) -= 'z' - 'a';
6701 *(d--) -= 'z' - 'a' + 1;
6705 /* oh,oh, the number grew */
6706 SvGROW(sv, SvCUR(sv) + 2);
6707 SvCUR_set(sv, SvCUR(sv) + 1);
6708 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6719 Auto-decrement of the value in the SV, doing string to numeric conversion
6720 if necessary. Handles 'get' magic.
6726 Perl_sv_dec(pTHX_ register SV *sv)
6734 if (SvTHINKFIRST(sv)) {
6736 sv_force_normal_flags(sv, 0);
6737 if (SvREADONLY(sv)) {
6738 if (IN_PERL_RUNTIME)
6739 Perl_croak(aTHX_ PL_no_modify);
6743 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6745 i = PTR2IV(SvRV(sv));
6750 /* Unlike sv_inc we don't have to worry about string-never-numbers
6751 and keeping them magic. But we mustn't warn on punting */
6752 flags = SvFLAGS(sv);
6753 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6754 /* It's publicly an integer, or privately an integer-not-float */
6755 #ifdef PERL_PRESERVE_IVUV
6759 if (SvUVX(sv) == 0) {
6760 (void)SvIOK_only(sv);
6764 (void)SvIOK_only_UV(sv);
6765 SvUV_set(sv, SvUVX(sv) - 1);
6768 if (SvIVX(sv) == IV_MIN)
6769 sv_setnv(sv, (NV)IV_MIN - 1.0);
6771 (void)SvIOK_only(sv);
6772 SvIV_set(sv, SvIVX(sv) - 1);
6777 if (flags & SVp_NOK) {
6778 SvNV_set(sv, SvNVX(sv) - 1.0);
6779 (void)SvNOK_only(sv);
6782 if (!(flags & SVp_POK)) {
6783 if ((flags & SVTYPEMASK) < SVt_PVIV)
6784 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6786 (void)SvIOK_only(sv);
6789 #ifdef PERL_PRESERVE_IVUV
6791 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6792 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6793 /* Need to try really hard to see if it's an integer.
6794 9.22337203685478e+18 is an integer.
6795 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6796 so $a="9.22337203685478e+18"; $a+0; $a--
6797 needs to be the same as $a="9.22337203685478e+18"; $a--
6804 /* sv_2iv *should* have made this an NV */
6805 if (flags & SVp_NOK) {
6806 (void)SvNOK_only(sv);
6807 SvNV_set(sv, SvNVX(sv) - 1.0);
6810 /* I don't think we can get here. Maybe I should assert this
6811 And if we do get here I suspect that sv_setnv will croak. NWC
6813 #if defined(USE_LONG_DOUBLE)
6814 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",
6815 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6817 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6818 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6822 #endif /* PERL_PRESERVE_IVUV */
6823 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6827 =for apidoc sv_mortalcopy
6829 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6830 The new SV is marked as mortal. It will be destroyed "soon", either by an
6831 explicit call to FREETMPS, or by an implicit call at places such as
6832 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6837 /* Make a string that will exist for the duration of the expression
6838 * evaluation. Actually, it may have to last longer than that, but
6839 * hopefully we won't free it until it has been assigned to a
6840 * permanent location. */
6843 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6849 sv_setsv(sv,oldstr);
6851 PL_tmps_stack[++PL_tmps_ix] = sv;
6857 =for apidoc sv_newmortal
6859 Creates a new null SV which is mortal. The reference count of the SV is
6860 set to 1. It will be destroyed "soon", either by an explicit call to
6861 FREETMPS, or by an implicit call at places such as statement boundaries.
6862 See also C<sv_mortalcopy> and C<sv_2mortal>.
6868 Perl_sv_newmortal(pTHX)
6874 SvFLAGS(sv) = SVs_TEMP;
6876 PL_tmps_stack[++PL_tmps_ix] = sv;
6881 =for apidoc sv_2mortal
6883 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6884 by an explicit call to FREETMPS, or by an implicit call at places such as
6885 statement boundaries. SvTEMP() is turned on which means that the SV's
6886 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6887 and C<sv_mortalcopy>.
6893 Perl_sv_2mortal(pTHX_ register SV *sv)
6898 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6901 PL_tmps_stack[++PL_tmps_ix] = sv;
6909 Creates a new SV and copies a string into it. The reference count for the
6910 SV is set to 1. If C<len> is zero, Perl will compute the length using
6911 strlen(). For efficiency, consider using C<newSVpvn> instead.
6917 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6923 sv_setpvn(sv,s,len ? len : strlen(s));
6928 =for apidoc newSVpvn
6930 Creates a new SV and copies a string into it. The reference count for the
6931 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6932 string. You are responsible for ensuring that the source string is at least
6933 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6939 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6945 sv_setpvn(sv,s,len);
6951 =for apidoc newSVhek
6953 Creates a new SV from the hash key structure. It will generate scalars that
6954 point to the shared string table where possible. Returns a new (undefined)
6955 SV if the hek is NULL.
6961 Perl_newSVhek(pTHX_ const HEK *hek)
6971 if (HEK_LEN(hek) == HEf_SVKEY) {
6972 return newSVsv(*(SV**)HEK_KEY(hek));
6974 const int flags = HEK_FLAGS(hek);
6975 if (flags & HVhek_WASUTF8) {
6977 Andreas would like keys he put in as utf8 to come back as utf8
6979 STRLEN utf8_len = HEK_LEN(hek);
6980 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6981 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6984 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6986 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6987 /* We don't have a pointer to the hv, so we have to replicate the
6988 flag into every HEK. This hv is using custom a hasing
6989 algorithm. Hence we can't return a shared string scalar, as
6990 that would contain the (wrong) hash value, and might get passed
6991 into an hv routine with a regular hash.
6992 Similarly, a hash that isn't using shared hash keys has to have
6993 the flag in every key so that we know not to try to call
6994 share_hek_kek on it. */
6996 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7001 /* This will be overwhelminly the most common case. */
7003 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7004 more efficient than sharepvn(). */
7008 sv_upgrade(sv, SVt_PV);
7009 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7010 SvCUR_set(sv, HEK_LEN(hek));
7023 =for apidoc newSVpvn_share
7025 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7026 table. If the string does not already exist in the table, it is created
7027 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7028 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7029 otherwise the hash is computed. The idea here is that as the string table
7030 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7031 hash lookup will avoid string compare.
7037 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7041 bool is_utf8 = FALSE;
7042 const char *const orig_src = src;
7045 STRLEN tmplen = -len;
7047 /* See the note in hv.c:hv_fetch() --jhi */
7048 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7052 PERL_HASH(hash, src, len);
7054 sv_upgrade(sv, SVt_PV);
7055 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7063 if (src != orig_src)
7069 #if defined(PERL_IMPLICIT_CONTEXT)
7071 /* pTHX_ magic can't cope with varargs, so this is a no-context
7072 * version of the main function, (which may itself be aliased to us).
7073 * Don't access this version directly.
7077 Perl_newSVpvf_nocontext(const char* pat, ...)
7082 va_start(args, pat);
7083 sv = vnewSVpvf(pat, &args);
7090 =for apidoc newSVpvf
7092 Creates a new SV and initializes it with the string formatted like
7099 Perl_newSVpvf(pTHX_ const char* pat, ...)
7103 va_start(args, pat);
7104 sv = vnewSVpvf(pat, &args);
7109 /* backend for newSVpvf() and newSVpvf_nocontext() */
7112 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7117 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7124 Creates a new SV and copies a floating point value into it.
7125 The reference count for the SV is set to 1.
7131 Perl_newSVnv(pTHX_ NV n)
7144 Creates a new SV and copies an integer into it. The reference count for the
7151 Perl_newSViv(pTHX_ IV i)
7164 Creates a new SV and copies an unsigned integer into it.
7165 The reference count for the SV is set to 1.
7171 Perl_newSVuv(pTHX_ UV u)
7182 =for apidoc newRV_noinc
7184 Creates an RV wrapper for an SV. The reference count for the original
7185 SV is B<not> incremented.
7191 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7197 sv_upgrade(sv, SVt_RV);
7199 SvRV_set(sv, tmpRef);
7204 /* newRV_inc is the official function name to use now.
7205 * newRV_inc is in fact #defined to newRV in sv.h
7209 Perl_newRV(pTHX_ SV *sv)
7212 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7218 Creates a new SV which is an exact duplicate of the original SV.
7225 Perl_newSVsv(pTHX_ register SV *old)
7232 if (SvTYPE(old) == SVTYPEMASK) {
7233 if (ckWARN_d(WARN_INTERNAL))
7234 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7238 /* SV_GMAGIC is the default for sv_setv()
7239 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7240 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7241 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7246 =for apidoc sv_reset
7248 Underlying implementation for the C<reset> Perl function.
7249 Note that the perl-level function is vaguely deprecated.
7255 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7258 char todo[PERL_UCHAR_MAX+1];
7263 if (!*s) { /* reset ?? searches */
7264 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7266 PMOP *pm = (PMOP *) mg->mg_obj;
7268 pm->op_pmdynflags &= ~PMdf_USED;
7275 /* reset variables */
7277 if (!HvARRAY(stash))
7280 Zero(todo, 256, char);
7283 I32 i = (unsigned char)*s;
7287 max = (unsigned char)*s++;
7288 for ( ; i <= max; i++) {
7291 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7293 for (entry = HvARRAY(stash)[i];
7295 entry = HeNEXT(entry))
7300 if (!todo[(U8)*HeKEY(entry)])
7302 gv = (GV*)HeVAL(entry);
7305 if (SvTHINKFIRST(sv)) {
7306 if (!SvREADONLY(sv) && SvROK(sv))
7308 /* XXX Is this continue a bug? Why should THINKFIRST
7309 exempt us from resetting arrays and hashes? */
7313 if (SvTYPE(sv) >= SVt_PV) {
7315 if (SvPVX_const(sv) != NULL)
7323 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7325 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7328 # if defined(USE_ENVIRON_ARRAY)
7331 # endif /* USE_ENVIRON_ARRAY */
7342 Using various gambits, try to get an IO from an SV: the IO slot if its a
7343 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7344 named after the PV if we're a string.
7350 Perl_sv_2io(pTHX_ SV *sv)
7355 switch (SvTYPE(sv)) {
7363 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7367 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7369 return sv_2io(SvRV(sv));
7370 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7376 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7385 Using various gambits, try to get a CV from an SV; in addition, try if
7386 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7387 The flags in C<lref> are passed to sv_fetchsv.
7393 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7404 switch (SvTYPE(sv)) {
7423 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7424 tryAMAGICunDEREF(to_cv);
7427 if (SvTYPE(sv) == SVt_PVCV) {
7436 Perl_croak(aTHX_ "Not a subroutine reference");
7441 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7447 /* Some flags to gv_fetchsv mean don't really create the GV */
7448 if (SvTYPE(gv) != SVt_PVGV) {
7454 if (lref && !GvCVu(gv)) {
7458 gv_efullname3(tmpsv, gv, NULL);
7459 /* XXX this is probably not what they think they're getting.
7460 * It has the same effect as "sub name;", i.e. just a forward
7462 newSUB(start_subparse(FALSE, 0),
7463 newSVOP(OP_CONST, 0, tmpsv),
7467 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7477 Returns true if the SV has a true value by Perl's rules.
7478 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7479 instead use an in-line version.
7485 Perl_sv_true(pTHX_ register SV *sv)
7490 register const XPV* const tXpv = (XPV*)SvANY(sv);
7492 (tXpv->xpv_cur > 1 ||
7493 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7500 return SvIVX(sv) != 0;
7503 return SvNVX(sv) != 0.0;
7505 return sv_2bool(sv);
7511 =for apidoc sv_pvn_force
7513 Get a sensible string out of the SV somehow.
7514 A private implementation of the C<SvPV_force> macro for compilers which
7515 can't cope with complex macro expressions. Always use the macro instead.
7517 =for apidoc sv_pvn_force_flags
7519 Get a sensible string out of the SV somehow.
7520 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7521 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7522 implemented in terms of this function.
7523 You normally want to use the various wrapper macros instead: see
7524 C<SvPV_force> and C<SvPV_force_nomg>
7530 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7533 if (SvTHINKFIRST(sv) && !SvROK(sv))
7534 sv_force_normal_flags(sv, 0);
7544 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7545 const char * const ref = sv_reftype(sv,0);
7547 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7548 ref, OP_NAME(PL_op));
7550 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7552 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7553 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7555 s = sv_2pv_flags(sv, &len, flags);
7559 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7562 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7563 SvGROW(sv, len + 1);
7564 Move(s,SvPVX(sv),len,char);
7569 SvPOK_on(sv); /* validate pointer */
7571 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7572 PTR2UV(sv),SvPVX_const(sv)));
7575 return SvPVX_mutable(sv);
7579 =for apidoc sv_pvbyten_force
7581 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7587 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7589 sv_pvn_force(sv,lp);
7590 sv_utf8_downgrade(sv,0);
7596 =for apidoc sv_pvutf8n_force
7598 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7604 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7606 sv_pvn_force(sv,lp);
7607 sv_utf8_upgrade(sv);
7613 =for apidoc sv_reftype
7615 Returns a string describing what the SV is a reference to.
7621 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7623 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7624 inside return suggests a const propagation bug in g++. */
7625 if (ob && SvOBJECT(sv)) {
7626 char * const name = HvNAME_get(SvSTASH(sv));
7627 return name ? name : (char *) "__ANON__";
7630 switch (SvTYPE(sv)) {
7647 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7648 /* tied lvalues should appear to be
7649 * scalars for backwards compatitbility */
7650 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7651 ? "SCALAR" : "LVALUE");
7652 case SVt_PVAV: return "ARRAY";
7653 case SVt_PVHV: return "HASH";
7654 case SVt_PVCV: return "CODE";
7655 case SVt_PVGV: return "GLOB";
7656 case SVt_PVFM: return "FORMAT";
7657 case SVt_PVIO: return "IO";
7658 default: return "UNKNOWN";
7664 =for apidoc sv_isobject
7666 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7667 object. If the SV is not an RV, or if the object is not blessed, then this
7674 Perl_sv_isobject(pTHX_ SV *sv)
7690 Returns a boolean indicating whether the SV is blessed into the specified
7691 class. This does not check for subtypes; use C<sv_derived_from> to verify
7692 an inheritance relationship.
7698 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7709 hvname = HvNAME_get(SvSTASH(sv));
7713 return strEQ(hvname, name);
7719 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7720 it will be upgraded to one. If C<classname> is non-null then the new SV will
7721 be blessed in the specified package. The new SV is returned and its
7722 reference count is 1.
7728 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7735 SV_CHECK_THINKFIRST_COW_DROP(rv);
7738 if (SvTYPE(rv) >= SVt_PVMG) {
7739 const U32 refcnt = SvREFCNT(rv);
7743 SvREFCNT(rv) = refcnt;
7745 sv_upgrade(rv, SVt_RV);
7746 } else if (SvROK(rv)) {
7747 SvREFCNT_dec(SvRV(rv));
7748 } else if (SvTYPE(rv) < SVt_RV)
7749 sv_upgrade(rv, SVt_RV);
7750 else if (SvTYPE(rv) > SVt_RV) {
7761 HV* const stash = gv_stashpv(classname, TRUE);
7762 (void)sv_bless(rv, stash);
7768 =for apidoc sv_setref_pv
7770 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7771 argument will be upgraded to an RV. That RV will be modified to point to
7772 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7773 into the SV. The C<classname> argument indicates the package for the
7774 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7775 will have a reference count of 1, and the RV will be returned.
7777 Do not use with other Perl types such as HV, AV, SV, CV, because those
7778 objects will become corrupted by the pointer copy process.
7780 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7786 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7790 sv_setsv(rv, &PL_sv_undef);
7794 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7799 =for apidoc sv_setref_iv
7801 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7802 argument will be upgraded to an RV. That RV will be modified to point to
7803 the new SV. The C<classname> argument indicates the package for the
7804 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7805 will have a reference count of 1, and the RV will be returned.
7811 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7813 sv_setiv(newSVrv(rv,classname), iv);
7818 =for apidoc sv_setref_uv
7820 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7821 argument will be upgraded to an RV. That RV will be modified to point to
7822 the new SV. The C<classname> argument indicates the package for the
7823 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7824 will have a reference count of 1, and the RV will be returned.
7830 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7832 sv_setuv(newSVrv(rv,classname), uv);
7837 =for apidoc sv_setref_nv
7839 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7840 argument will be upgraded to an RV. That RV will be modified to point to
7841 the new SV. The C<classname> argument indicates the package for the
7842 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7843 will have a reference count of 1, and the RV will be returned.
7849 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7851 sv_setnv(newSVrv(rv,classname), nv);
7856 =for apidoc sv_setref_pvn
7858 Copies a string into a new SV, optionally blessing the SV. The length of the
7859 string must be specified with C<n>. The C<rv> argument will be upgraded to
7860 an RV. That RV will be modified to point to the new SV. The C<classname>
7861 argument indicates the package for the blessing. Set C<classname> to
7862 C<NULL> to avoid the blessing. The new SV will have a reference count
7863 of 1, and the RV will be returned.
7865 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7871 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7873 sv_setpvn(newSVrv(rv,classname), pv, n);
7878 =for apidoc sv_bless
7880 Blesses an SV into a specified package. The SV must be an RV. The package
7881 must be designated by its stash (see C<gv_stashpv()>). The reference count
7882 of the SV is unaffected.
7888 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7893 Perl_croak(aTHX_ "Can't bless non-reference value");
7895 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7896 if (SvREADONLY(tmpRef))
7897 Perl_croak(aTHX_ PL_no_modify);
7898 if (SvOBJECT(tmpRef)) {
7899 if (SvTYPE(tmpRef) != SVt_PVIO)
7901 SvREFCNT_dec(SvSTASH(tmpRef));
7904 SvOBJECT_on(tmpRef);
7905 if (SvTYPE(tmpRef) != SVt_PVIO)
7907 SvUPGRADE(tmpRef, SVt_PVMG);
7908 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7915 if(SvSMAGICAL(tmpRef))
7916 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7924 /* Downgrades a PVGV to a PVMG.
7928 S_sv_unglob(pTHX_ SV *sv)
7932 SV * const temp = sv_newmortal();
7934 assert(SvTYPE(sv) == SVt_PVGV);
7936 gv_efullname3(temp, (GV *) sv, "*");
7942 sv_del_backref((SV*)GvSTASH(sv), sv);
7946 if (GvNAME_HEK(sv)) {
7947 unshare_hek(GvNAME_HEK(sv));
7951 /* need to keep SvANY(sv) in the right arena */
7952 xpvmg = new_XPVMG();
7953 StructCopy(SvANY(sv), xpvmg, XPVMG);
7954 del_XPVGV(SvANY(sv));
7957 SvFLAGS(sv) &= ~SVTYPEMASK;
7958 SvFLAGS(sv) |= SVt_PVMG;
7960 /* Intentionally not calling any local SET magic, as this isn't so much a
7961 set operation as merely an internal storage change. */
7962 sv_setsv_flags(sv, temp, 0);
7966 =for apidoc sv_unref_flags
7968 Unsets the RV status of the SV, and decrements the reference count of
7969 whatever was being referenced by the RV. This can almost be thought of
7970 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7971 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7972 (otherwise the decrementing is conditional on the reference count being
7973 different from one or the reference being a readonly SV).
7980 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7982 SV* const target = SvRV(ref);
7984 if (SvWEAKREF(ref)) {
7985 sv_del_backref(target, ref);
7987 SvRV_set(ref, NULL);
7990 SvRV_set(ref, NULL);
7992 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7993 assigned to as BEGIN {$a = \"Foo"} will fail. */
7994 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7995 SvREFCNT_dec(target);
7996 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7997 sv_2mortal(target); /* Schedule for freeing later */
8001 =for apidoc sv_untaint
8003 Untaint an SV. Use C<SvTAINTED_off> instead.
8008 Perl_sv_untaint(pTHX_ SV *sv)
8010 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8011 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8018 =for apidoc sv_tainted
8020 Test an SV for taintedness. Use C<SvTAINTED> instead.
8025 Perl_sv_tainted(pTHX_ SV *sv)
8027 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8028 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8029 if (mg && (mg->mg_len & 1) )
8036 =for apidoc sv_setpviv
8038 Copies an integer into the given SV, also updating its string value.
8039 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8045 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8047 char buf[TYPE_CHARS(UV)];
8049 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8051 sv_setpvn(sv, ptr, ebuf - ptr);
8055 =for apidoc sv_setpviv_mg
8057 Like C<sv_setpviv>, but also handles 'set' magic.
8063 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8069 #if defined(PERL_IMPLICIT_CONTEXT)
8071 /* pTHX_ magic can't cope with varargs, so this is a no-context
8072 * version of the main function, (which may itself be aliased to us).
8073 * Don't access this version directly.
8077 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8081 va_start(args, pat);
8082 sv_vsetpvf(sv, pat, &args);
8086 /* pTHX_ magic can't cope with varargs, so this is a no-context
8087 * version of the main function, (which may itself be aliased to us).
8088 * Don't access this version directly.
8092 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8096 va_start(args, pat);
8097 sv_vsetpvf_mg(sv, pat, &args);
8103 =for apidoc sv_setpvf
8105 Works like C<sv_catpvf> but copies the text into the SV instead of
8106 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8112 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8115 va_start(args, pat);
8116 sv_vsetpvf(sv, pat, &args);
8121 =for apidoc sv_vsetpvf
8123 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8124 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8126 Usually used via its frontend C<sv_setpvf>.
8132 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8134 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8138 =for apidoc sv_setpvf_mg
8140 Like C<sv_setpvf>, but also handles 'set' magic.
8146 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8149 va_start(args, pat);
8150 sv_vsetpvf_mg(sv, pat, &args);
8155 =for apidoc sv_vsetpvf_mg
8157 Like C<sv_vsetpvf>, but also handles 'set' magic.
8159 Usually used via its frontend C<sv_setpvf_mg>.
8165 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8167 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8171 #if defined(PERL_IMPLICIT_CONTEXT)
8173 /* pTHX_ magic can't cope with varargs, so this is a no-context
8174 * version of the main function, (which may itself be aliased to us).
8175 * Don't access this version directly.
8179 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8183 va_start(args, pat);
8184 sv_vcatpvf(sv, pat, &args);
8188 /* pTHX_ magic can't cope with varargs, so this is a no-context
8189 * version of the main function, (which may itself be aliased to us).
8190 * Don't access this version directly.
8194 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8198 va_start(args, pat);
8199 sv_vcatpvf_mg(sv, pat, &args);
8205 =for apidoc sv_catpvf
8207 Processes its arguments like C<sprintf> and appends the formatted
8208 output to an SV. If the appended data contains "wide" characters
8209 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8210 and characters >255 formatted with %c), the original SV might get
8211 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8212 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8213 valid UTF-8; if the original SV was bytes, the pattern should be too.
8218 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8221 va_start(args, pat);
8222 sv_vcatpvf(sv, pat, &args);
8227 =for apidoc sv_vcatpvf
8229 Processes its arguments like C<vsprintf> and appends the formatted output
8230 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8232 Usually used via its frontend C<sv_catpvf>.
8238 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8240 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8244 =for apidoc sv_catpvf_mg
8246 Like C<sv_catpvf>, but also handles 'set' magic.
8252 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8255 va_start(args, pat);
8256 sv_vcatpvf_mg(sv, pat, &args);
8261 =for apidoc sv_vcatpvf_mg
8263 Like C<sv_vcatpvf>, but also handles 'set' magic.
8265 Usually used via its frontend C<sv_catpvf_mg>.
8271 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8273 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8278 =for apidoc sv_vsetpvfn
8280 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8283 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8289 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8291 sv_setpvn(sv, "", 0);
8292 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8296 S_expect_number(pTHX_ char** pattern)
8300 switch (**pattern) {
8301 case '1': case '2': case '3':
8302 case '4': case '5': case '6':
8303 case '7': case '8': case '9':
8304 var = *(*pattern)++ - '0';
8305 while (isDIGIT(**pattern)) {
8306 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8308 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8316 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8318 const int neg = nv < 0;
8327 if (uv & 1 && uv == nv)
8328 uv--; /* Round to even */
8330 const unsigned dig = uv % 10;
8343 =for apidoc sv_vcatpvfn
8345 Processes its arguments like C<vsprintf> and appends the formatted output
8346 to an SV. Uses an array of SVs if the C style variable argument list is
8347 missing (NULL). When running with taint checks enabled, indicates via
8348 C<maybe_tainted> if results are untrustworthy (often due to the use of
8351 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8357 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8358 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8359 vec_utf8 = DO_UTF8(vecsv);
8361 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8364 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8372 static const char nullstr[] = "(null)";
8374 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8375 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8377 /* Times 4: a decimal digit takes more than 3 binary digits.
8378 * NV_DIG: mantissa takes than many decimal digits.
8379 * Plus 32: Playing safe. */
8380 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8381 /* large enough for "%#.#f" --chip */
8382 /* what about long double NVs? --jhi */
8384 PERL_UNUSED_ARG(maybe_tainted);
8386 /* no matter what, this is a string now */
8387 (void)SvPV_force(sv, origlen);
8389 /* special-case "", "%s", and "%-p" (SVf - see below) */
8392 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8394 const char * const s = va_arg(*args, char*);
8395 sv_catpv(sv, s ? s : nullstr);
8397 else if (svix < svmax) {
8398 sv_catsv(sv, *svargs);
8402 if (args && patlen == 3 && pat[0] == '%' &&
8403 pat[1] == '-' && pat[2] == 'p') {
8404 argsv = va_arg(*args, SV*);
8405 sv_catsv(sv, argsv);
8409 #ifndef USE_LONG_DOUBLE
8410 /* special-case "%.<number>[gf]" */
8411 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8412 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8413 unsigned digits = 0;
8417 while (*pp >= '0' && *pp <= '9')
8418 digits = 10 * digits + (*pp++ - '0');
8419 if (pp - pat == (int)patlen - 1) {
8427 /* Add check for digits != 0 because it seems that some
8428 gconverts are buggy in this case, and we don't yet have
8429 a Configure test for this. */
8430 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8431 /* 0, point, slack */
8432 Gconvert(nv, (int)digits, 0, ebuf);
8434 if (*ebuf) /* May return an empty string for digits==0 */
8437 } else if (!digits) {
8440 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8441 sv_catpvn(sv, p, l);
8447 #endif /* !USE_LONG_DOUBLE */
8449 if (!args && svix < svmax && DO_UTF8(*svargs))
8452 patend = (char*)pat + patlen;
8453 for (p = (char*)pat; p < patend; p = q) {
8456 bool vectorize = FALSE;
8457 bool vectorarg = FALSE;
8458 bool vec_utf8 = FALSE;
8464 bool has_precis = FALSE;
8466 const I32 osvix = svix;
8467 bool is_utf8 = FALSE; /* is this item utf8? */
8468 #ifdef HAS_LDBL_SPRINTF_BUG
8469 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8470 with sfio - Allen <allens@cpan.org> */
8471 bool fix_ldbl_sprintf_bug = FALSE;
8475 U8 utf8buf[UTF8_MAXBYTES+1];
8476 STRLEN esignlen = 0;
8478 const char *eptr = NULL;
8481 const U8 *vecstr = NULL;
8488 /* we need a long double target in case HAS_LONG_DOUBLE but
8491 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8499 const char *dotstr = ".";
8500 STRLEN dotstrlen = 1;
8501 I32 efix = 0; /* explicit format parameter index */
8502 I32 ewix = 0; /* explicit width index */
8503 I32 epix = 0; /* explicit precision index */
8504 I32 evix = 0; /* explicit vector index */
8505 bool asterisk = FALSE;
8507 /* echo everything up to the next format specification */
8508 for (q = p; q < patend && *q != '%'; ++q) ;
8510 if (has_utf8 && !pat_utf8)
8511 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8513 sv_catpvn(sv, p, q - p);
8520 We allow format specification elements in this order:
8521 \d+\$ explicit format parameter index
8523 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8524 0 flag (as above): repeated to allow "v02"
8525 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8526 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8528 [%bcdefginopsuxDFOUX] format (mandatory)
8533 As of perl5.9.3, printf format checking is on by default.
8534 Internally, perl uses %p formats to provide an escape to
8535 some extended formatting. This block deals with those
8536 extensions: if it does not match, (char*)q is reset and
8537 the normal format processing code is used.
8539 Currently defined extensions are:
8540 %p include pointer address (standard)
8541 %-p (SVf) include an SV (previously %_)
8542 %-<num>p include an SV with precision <num>
8543 %1p (VDf) include a v-string (as %vd)
8544 %<num>p reserved for future extensions
8546 Robin Barker 2005-07-14
8553 n = expect_number(&q);
8560 argsv = va_arg(*args, SV*);
8561 eptr = SvPVx_const(argsv, elen);
8567 else if (n == vdNUMBER) { /* VDf */
8574 if (ckWARN_d(WARN_INTERNAL))
8575 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8576 "internal %%<num>p might conflict with future printf extensions");
8582 if ( (width = expect_number(&q)) ) {
8623 if ( (ewix = expect_number(&q)) )
8632 if ((vectorarg = asterisk)) {
8645 width = expect_number(&q);
8651 vecsv = va_arg(*args, SV*);
8653 vecsv = (evix > 0 && evix <= svmax)
8654 ? svargs[evix-1] : &PL_sv_undef;
8656 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8658 dotstr = SvPV_const(vecsv, dotstrlen);
8659 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8660 bad with tied or overloaded values that return UTF8. */
8663 else if (has_utf8) {
8664 vecsv = sv_mortalcopy(vecsv);
8665 sv_utf8_upgrade(vecsv);
8666 dotstr = SvPV_const(vecsv, dotstrlen);
8673 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8674 vecsv = svargs[efix ? efix-1 : svix++];
8675 vecstr = (U8*)SvPV_const(vecsv,veclen);
8676 vec_utf8 = DO_UTF8(vecsv);
8678 /* if this is a version object, we need to convert
8679 * back into v-string notation and then let the
8680 * vectorize happen normally
8682 if (sv_derived_from(vecsv, "version")) {
8683 char *version = savesvpv(vecsv);
8684 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8685 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8686 "vector argument not supported with alpha versions");
8689 vecsv = sv_newmortal();
8690 /* scan_vstring is expected to be called during
8691 * tokenization, so we need to fake up the end
8692 * of the buffer for it
8694 PL_bufend = version + veclen;
8695 scan_vstring(version, vecsv);
8696 vecstr = (U8*)SvPV_const(vecsv, veclen);
8697 vec_utf8 = DO_UTF8(vecsv);
8709 i = va_arg(*args, int);
8711 i = (ewix ? ewix <= svmax : svix < svmax) ?
8712 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8714 width = (i < 0) ? -i : i;
8724 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8726 /* XXX: todo, support specified precision parameter */
8730 i = va_arg(*args, int);
8732 i = (ewix ? ewix <= svmax : svix < svmax)
8733 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8734 precis = (i < 0) ? 0 : i;
8739 precis = precis * 10 + (*q++ - '0');
8748 case 'I': /* Ix, I32x, and I64x */
8750 if (q[1] == '6' && q[2] == '4') {
8756 if (q[1] == '3' && q[2] == '2') {
8766 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8777 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8778 if (*(q + 1) == 'l') { /* lld, llf */
8804 if (!vectorize && !args) {
8806 const I32 i = efix-1;
8807 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8809 argsv = (svix >= 0 && svix < svmax)
8810 ? svargs[svix++] : &PL_sv_undef;
8821 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8823 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8825 eptr = (char*)utf8buf;
8826 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8840 eptr = va_arg(*args, char*);
8842 #ifdef MACOS_TRADITIONAL
8843 /* On MacOS, %#s format is used for Pascal strings */
8848 elen = strlen(eptr);
8850 eptr = (char *)nullstr;
8851 elen = sizeof nullstr - 1;
8855 eptr = SvPVx_const(argsv, elen);
8856 if (DO_UTF8(argsv)) {
8857 if (has_precis && precis < elen) {
8859 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8862 if (width) { /* fudge width (can't fudge elen) */
8863 width += elen - sv_len_utf8(argsv);
8870 if (has_precis && elen > precis)
8877 if (alt || vectorize)
8879 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8900 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8909 esignbuf[esignlen++] = plus;
8913 case 'h': iv = (short)va_arg(*args, int); break;
8914 case 'l': iv = va_arg(*args, long); break;
8915 case 'V': iv = va_arg(*args, IV); break;
8916 default: iv = va_arg(*args, int); break;
8918 case 'q': iv = va_arg(*args, Quad_t); break;
8923 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8925 case 'h': iv = (short)tiv; break;
8926 case 'l': iv = (long)tiv; break;
8928 default: iv = tiv; break;
8930 case 'q': iv = (Quad_t)tiv; break;
8934 if ( !vectorize ) /* we already set uv above */
8939 esignbuf[esignlen++] = plus;
8943 esignbuf[esignlen++] = '-';
8986 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8997 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8998 case 'l': uv = va_arg(*args, unsigned long); break;
8999 case 'V': uv = va_arg(*args, UV); break;
9000 default: uv = va_arg(*args, unsigned); break;
9002 case 'q': uv = va_arg(*args, Uquad_t); break;
9007 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9009 case 'h': uv = (unsigned short)tuv; break;
9010 case 'l': uv = (unsigned long)tuv; break;
9012 default: uv = tuv; break;
9014 case 'q': uv = (Uquad_t)tuv; break;
9021 char *ptr = ebuf + sizeof ebuf;
9022 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9028 p = (char*)((c == 'X')
9029 ? "0123456789ABCDEF" : "0123456789abcdef");
9035 esignbuf[esignlen++] = '0';
9036 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9044 if (alt && *ptr != '0')
9053 esignbuf[esignlen++] = '0';
9054 esignbuf[esignlen++] = 'b';
9057 default: /* it had better be ten or less */
9061 } while (uv /= base);
9064 elen = (ebuf + sizeof ebuf) - ptr;
9068 zeros = precis - elen;
9069 else if (precis == 0 && elen == 1 && *eptr == '0')
9075 /* FLOATING POINT */
9078 c = 'f'; /* maybe %F isn't supported here */
9086 /* This is evil, but floating point is even more evil */
9088 /* for SV-style calling, we can only get NV
9089 for C-style calling, we assume %f is double;
9090 for simplicity we allow any of %Lf, %llf, %qf for long double
9094 #if defined(USE_LONG_DOUBLE)
9098 /* [perl #20339] - we should accept and ignore %lf rather than die */
9102 #if defined(USE_LONG_DOUBLE)
9103 intsize = args ? 0 : 'q';
9107 #if defined(HAS_LONG_DOUBLE)
9116 /* now we need (long double) if intsize == 'q', else (double) */
9118 #if LONG_DOUBLESIZE > DOUBLESIZE
9120 va_arg(*args, long double) :
9121 va_arg(*args, double)
9123 va_arg(*args, double)
9128 if (c != 'e' && c != 'E') {
9130 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9131 will cast our (long double) to (double) */
9132 (void)Perl_frexp(nv, &i);
9133 if (i == PERL_INT_MIN)
9134 Perl_die(aTHX_ "panic: frexp");
9136 need = BIT_DIGITS(i);
9138 need += has_precis ? precis : 6; /* known default */
9143 #ifdef HAS_LDBL_SPRINTF_BUG
9144 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9145 with sfio - Allen <allens@cpan.org> */
9148 # define MY_DBL_MAX DBL_MAX
9149 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9150 # if DOUBLESIZE >= 8
9151 # define MY_DBL_MAX 1.7976931348623157E+308L
9153 # define MY_DBL_MAX 3.40282347E+38L
9157 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9158 # define MY_DBL_MAX_BUG 1L
9160 # define MY_DBL_MAX_BUG MY_DBL_MAX
9164 # define MY_DBL_MIN DBL_MIN
9165 # else /* XXX guessing! -Allen */
9166 # if DOUBLESIZE >= 8
9167 # define MY_DBL_MIN 2.2250738585072014E-308L
9169 # define MY_DBL_MIN 1.17549435E-38L
9173 if ((intsize == 'q') && (c == 'f') &&
9174 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9176 /* it's going to be short enough that
9177 * long double precision is not needed */
9179 if ((nv <= 0L) && (nv >= -0L))
9180 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9182 /* would use Perl_fp_class as a double-check but not
9183 * functional on IRIX - see perl.h comments */
9185 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9186 /* It's within the range that a double can represent */
9187 #if defined(DBL_MAX) && !defined(DBL_MIN)
9188 if ((nv >= ((long double)1/DBL_MAX)) ||
9189 (nv <= (-(long double)1/DBL_MAX)))
9191 fix_ldbl_sprintf_bug = TRUE;
9194 if (fix_ldbl_sprintf_bug == TRUE) {
9204 # undef MY_DBL_MAX_BUG
9207 #endif /* HAS_LDBL_SPRINTF_BUG */
9209 need += 20; /* fudge factor */
9210 if (PL_efloatsize < need) {
9211 Safefree(PL_efloatbuf);
9212 PL_efloatsize = need + 20; /* more fudge */
9213 Newx(PL_efloatbuf, PL_efloatsize, char);
9214 PL_efloatbuf[0] = '\0';
9217 if ( !(width || left || plus || alt) && fill != '0'
9218 && has_precis && intsize != 'q' ) { /* Shortcuts */
9219 /* See earlier comment about buggy Gconvert when digits,
9221 if ( c == 'g' && precis) {
9222 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9223 /* May return an empty string for digits==0 */
9224 if (*PL_efloatbuf) {
9225 elen = strlen(PL_efloatbuf);
9226 goto float_converted;
9228 } else if ( c == 'f' && !precis) {
9229 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9234 char *ptr = ebuf + sizeof ebuf;
9237 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9238 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9239 if (intsize == 'q') {
9240 /* Copy the one or more characters in a long double
9241 * format before the 'base' ([efgEFG]) character to
9242 * the format string. */
9243 static char const prifldbl[] = PERL_PRIfldbl;
9244 char const *p = prifldbl + sizeof(prifldbl) - 3;
9245 while (p >= prifldbl) { *--ptr = *p--; }
9250 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9255 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9267 /* No taint. Otherwise we are in the strange situation
9268 * where printf() taints but print($float) doesn't.
9270 #if defined(HAS_LONG_DOUBLE)
9271 elen = ((intsize == 'q')
9272 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9273 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9275 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9279 eptr = PL_efloatbuf;
9287 i = SvCUR(sv) - origlen;
9290 case 'h': *(va_arg(*args, short*)) = i; break;
9291 default: *(va_arg(*args, int*)) = i; break;
9292 case 'l': *(va_arg(*args, long*)) = i; break;
9293 case 'V': *(va_arg(*args, IV*)) = i; break;
9295 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9300 sv_setuv_mg(argsv, (UV)i);
9301 continue; /* not "break" */
9308 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9309 && ckWARN(WARN_PRINTF))
9311 SV * const msg = sv_newmortal();
9312 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9313 (PL_op->op_type == OP_PRTF) ? "" : "s");
9316 Perl_sv_catpvf(aTHX_ msg,
9317 "\"%%%c\"", c & 0xFF);
9319 Perl_sv_catpvf(aTHX_ msg,
9320 "\"%%\\%03"UVof"\"",
9323 sv_catpvs(msg, "end of string");
9324 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9327 /* output mangled stuff ... */
9333 /* ... right here, because formatting flags should not apply */
9334 SvGROW(sv, SvCUR(sv) + elen + 1);
9336 Copy(eptr, p, elen, char);
9339 SvCUR_set(sv, p - SvPVX_const(sv));
9341 continue; /* not "break" */
9344 if (is_utf8 != has_utf8) {
9347 sv_utf8_upgrade(sv);
9350 const STRLEN old_elen = elen;
9351 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9352 sv_utf8_upgrade(nsv);
9353 eptr = SvPVX_const(nsv);
9356 if (width) { /* fudge width (can't fudge elen) */
9357 width += elen - old_elen;
9363 have = esignlen + zeros + elen;
9365 Perl_croak_nocontext(PL_memory_wrap);
9367 need = (have > width ? have : width);
9370 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9371 Perl_croak_nocontext(PL_memory_wrap);
9372 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9374 if (esignlen && fill == '0') {
9376 for (i = 0; i < (int)esignlen; i++)
9380 memset(p, fill, gap);
9383 if (esignlen && fill != '0') {
9385 for (i = 0; i < (int)esignlen; i++)
9390 for (i = zeros; i; i--)
9394 Copy(eptr, p, elen, char);
9398 memset(p, ' ', gap);
9403 Copy(dotstr, p, dotstrlen, char);
9407 vectorize = FALSE; /* done iterating over vecstr */
9414 SvCUR_set(sv, p - SvPVX_const(sv));
9422 /* =========================================================================
9424 =head1 Cloning an interpreter
9426 All the macros and functions in this section are for the private use of
9427 the main function, perl_clone().
9429 The foo_dup() functions make an exact copy of an existing foo thinngy.
9430 During the course of a cloning, a hash table is used to map old addresses
9431 to new addresses. The table is created and manipulated with the
9432 ptr_table_* functions.
9436 ============================================================================*/
9439 #if defined(USE_ITHREADS)
9441 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9442 #ifndef GpREFCNT_inc
9443 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9447 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9448 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9449 please unmerge ss_dup. */
9450 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9451 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9452 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9453 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9454 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9455 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9456 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9457 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9459 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9461 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9463 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9466 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9467 regcomp.c. AMS 20010712 */
9470 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9475 struct reg_substr_datum *s;
9478 return (REGEXP *)NULL;
9480 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9483 len = r->offsets[0];
9484 npar = r->nparens+1;
9486 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9487 Copy(r->program, ret->program, len+1, regnode);
9489 Newx(ret->startp, npar, I32);
9490 Copy(r->startp, ret->startp, npar, I32);
9491 Newx(ret->endp, npar, I32);
9492 Copy(r->startp, ret->startp, npar, I32);
9494 Newx(ret->substrs, 1, struct reg_substr_data);
9495 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9496 s->min_offset = r->substrs->data[i].min_offset;
9497 s->max_offset = r->substrs->data[i].max_offset;
9498 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9499 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9502 ret->regstclass = NULL;
9505 const int count = r->data->count;
9508 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9509 char, struct reg_data);
9510 Newx(d->what, count, U8);
9513 for (i = 0; i < count; i++) {
9514 d->what[i] = r->data->what[i];
9515 switch (d->what[i]) {
9516 /* legal options are one of: sfpont
9517 see also regcomp.h and pregfree() */
9519 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9522 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9525 /* This is cheating. */
9526 Newx(d->data[i], 1, struct regnode_charclass_class);
9527 StructCopy(r->data->data[i], d->data[i],
9528 struct regnode_charclass_class);
9529 ret->regstclass = (regnode*)d->data[i];
9532 /* Compiled op trees are readonly, and can thus be
9533 shared without duplication. */
9535 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9539 d->data[i] = r->data->data[i];
9542 d->data[i] = r->data->data[i];
9544 ((reg_trie_data*)d->data[i])->refcount++;
9548 d->data[i] = r->data->data[i];
9550 ((reg_ac_data*)d->data[i])->refcount++;
9552 /* Trie stclasses are readonly and can thus be shared
9553 * without duplication. We free the stclass in pregfree
9554 * when the corresponding reg_ac_data struct is freed.
9556 ret->regstclass= r->regstclass;
9559 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9568 Newx(ret->offsets, 2*len+1, U32);
9569 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9571 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9572 ret->refcnt = r->refcnt;
9573 ret->minlen = r->minlen;
9574 ret->prelen = r->prelen;
9575 ret->nparens = r->nparens;
9576 ret->lastparen = r->lastparen;
9577 ret->lastcloseparen = r->lastcloseparen;
9578 ret->reganch = r->reganch;
9580 ret->sublen = r->sublen;
9582 if (RX_MATCH_COPIED(ret))
9583 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9586 #ifdef PERL_OLD_COPY_ON_WRITE
9587 ret->saved_copy = NULL;
9590 ptr_table_store(PL_ptr_table, r, ret);
9594 /* duplicate a file handle */
9597 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9601 PERL_UNUSED_ARG(type);
9604 return (PerlIO*)NULL;
9606 /* look for it in the table first */
9607 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9611 /* create anew and remember what it is */
9612 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9613 ptr_table_store(PL_ptr_table, fp, ret);
9617 /* duplicate a directory handle */
9620 Perl_dirp_dup(pTHX_ DIR *dp)
9622 PERL_UNUSED_CONTEXT;
9629 /* duplicate a typeglob */
9632 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9638 /* look for it in the table first */
9639 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9643 /* create anew and remember what it is */
9645 ptr_table_store(PL_ptr_table, gp, ret);
9648 ret->gp_refcnt = 0; /* must be before any other dups! */
9649 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9650 ret->gp_io = io_dup_inc(gp->gp_io, param);
9651 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9652 ret->gp_av = av_dup_inc(gp->gp_av, param);
9653 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9654 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9655 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9656 ret->gp_cvgen = gp->gp_cvgen;
9657 ret->gp_line = gp->gp_line;
9658 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9662 /* duplicate a chain of magic */
9665 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9667 MAGIC *mgprev = (MAGIC*)NULL;
9670 return (MAGIC*)NULL;
9671 /* look for it in the table first */
9672 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9676 for (; mg; mg = mg->mg_moremagic) {
9678 Newxz(nmg, 1, MAGIC);
9680 mgprev->mg_moremagic = nmg;
9683 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9684 nmg->mg_private = mg->mg_private;
9685 nmg->mg_type = mg->mg_type;
9686 nmg->mg_flags = mg->mg_flags;
9687 if (mg->mg_type == PERL_MAGIC_qr) {
9688 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9690 else if(mg->mg_type == PERL_MAGIC_backref) {
9691 /* The backref AV has its reference count deliberately bumped by
9693 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9695 else if (mg->mg_type == PERL_MAGIC_symtab) {
9696 nmg->mg_obj = mg->mg_obj;
9699 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9700 ? sv_dup_inc(mg->mg_obj, param)
9701 : sv_dup(mg->mg_obj, param);
9703 nmg->mg_len = mg->mg_len;
9704 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9705 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9706 if (mg->mg_len > 0) {
9707 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9708 if (mg->mg_type == PERL_MAGIC_overload_table &&
9709 AMT_AMAGIC((AMT*)mg->mg_ptr))
9711 const AMT * const amtp = (AMT*)mg->mg_ptr;
9712 AMT * const namtp = (AMT*)nmg->mg_ptr;
9714 for (i = 1; i < NofAMmeth; i++) {
9715 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9719 else if (mg->mg_len == HEf_SVKEY)
9720 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9722 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9723 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9730 /* create a new pointer-mapping table */
9733 Perl_ptr_table_new(pTHX)
9736 PERL_UNUSED_CONTEXT;
9738 Newxz(tbl, 1, PTR_TBL_t);
9741 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9745 #define PTR_TABLE_HASH(ptr) \
9746 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9749 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9750 following define) and at call to new_body_inline made below in
9751 Perl_ptr_table_store()
9754 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9756 /* map an existing pointer using a table */
9758 STATIC PTR_TBL_ENT_t *
9759 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9760 PTR_TBL_ENT_t *tblent;
9761 const UV hash = PTR_TABLE_HASH(sv);
9763 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9764 for (; tblent; tblent = tblent->next) {
9765 if (tblent->oldval == sv)
9772 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9774 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9775 PERL_UNUSED_CONTEXT;
9776 return tblent ? tblent->newval : NULL;
9779 /* add a new entry to a pointer-mapping table */
9782 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9784 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9785 PERL_UNUSED_CONTEXT;
9788 tblent->newval = newsv;
9790 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9792 new_body_inline(tblent, PTE_SVSLOT);
9794 tblent->oldval = oldsv;
9795 tblent->newval = newsv;
9796 tblent->next = tbl->tbl_ary[entry];
9797 tbl->tbl_ary[entry] = tblent;
9799 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9800 ptr_table_split(tbl);
9804 /* double the hash bucket size of an existing ptr table */
9807 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9809 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9810 const UV oldsize = tbl->tbl_max + 1;
9811 UV newsize = oldsize * 2;
9813 PERL_UNUSED_CONTEXT;
9815 Renew(ary, newsize, PTR_TBL_ENT_t*);
9816 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9817 tbl->tbl_max = --newsize;
9819 for (i=0; i < oldsize; i++, ary++) {
9820 PTR_TBL_ENT_t **curentp, **entp, *ent;
9823 curentp = ary + oldsize;
9824 for (entp = ary, ent = *ary; ent; ent = *entp) {
9825 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9827 ent->next = *curentp;
9837 /* remove all the entries from a ptr table */
9840 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9842 if (tbl && tbl->tbl_items) {
9843 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9844 UV riter = tbl->tbl_max;
9847 PTR_TBL_ENT_t *entry = array[riter];
9850 PTR_TBL_ENT_t * const oentry = entry;
9851 entry = entry->next;
9860 /* clear and free a ptr table */
9863 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9868 ptr_table_clear(tbl);
9869 Safefree(tbl->tbl_ary);
9875 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9878 SvRV_set(dstr, SvWEAKREF(sstr)
9879 ? sv_dup(SvRV(sstr), param)
9880 : sv_dup_inc(SvRV(sstr), param));
9883 else if (SvPVX_const(sstr)) {
9884 /* Has something there */
9886 /* Normal PV - clone whole allocated space */
9887 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9888 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9889 /* Not that normal - actually sstr is copy on write.
9890 But we are a true, independant SV, so: */
9891 SvREADONLY_off(dstr);
9896 /* Special case - not normally malloced for some reason */
9897 if (isGV_with_GP(sstr)) {
9898 /* Don't need to do anything here. */
9900 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9901 /* A "shared" PV - clone it as "shared" PV */
9903 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9907 /* Some other special case - random pointer */
9908 SvPV_set(dstr, SvPVX(sstr));
9914 if (SvTYPE(dstr) == SVt_RV)
9915 SvRV_set(dstr, NULL);
9917 SvPV_set(dstr, NULL);
9921 /* duplicate an SV of any type (including AV, HV etc) */
9924 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9929 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9931 /* look for it in the table first */
9932 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9936 if(param->flags & CLONEf_JOIN_IN) {
9937 /** We are joining here so we don't want do clone
9938 something that is bad **/
9939 if (SvTYPE(sstr) == SVt_PVHV) {
9940 const char * const hvname = HvNAME_get(sstr);
9942 /** don't clone stashes if they already exist **/
9943 return (SV*)gv_stashpv(hvname,0);
9947 /* create anew and remember what it is */
9950 #ifdef DEBUG_LEAKING_SCALARS
9951 dstr->sv_debug_optype = sstr->sv_debug_optype;
9952 dstr->sv_debug_line = sstr->sv_debug_line;
9953 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9954 dstr->sv_debug_cloned = 1;
9955 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9958 ptr_table_store(PL_ptr_table, sstr, dstr);
9961 SvFLAGS(dstr) = SvFLAGS(sstr);
9962 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9963 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9966 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9967 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9968 PL_watch_pvx, SvPVX_const(sstr));
9971 /* don't clone objects whose class has asked us not to */
9972 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9973 SvFLAGS(dstr) &= ~SVTYPEMASK;
9978 switch (SvTYPE(sstr)) {
9983 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9984 SvIV_set(dstr, SvIVX(sstr));
9987 SvANY(dstr) = new_XNV();
9988 SvNV_set(dstr, SvNVX(sstr));
9991 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9992 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9996 /* These are all the types that need complex bodies allocating. */
9998 const svtype sv_type = SvTYPE(sstr);
9999 const struct body_details *const sv_type_details
10000 = bodies_by_type + sv_type;
10004 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10008 if (GvUNIQUE((GV*)sstr)) {
10009 NOOP; /* Do sharing here, and fall through */
10022 assert(sv_type_details->body_size);
10023 if (sv_type_details->arena) {
10024 new_body_inline(new_body, sv_type);
10026 = (void*)((char*)new_body - sv_type_details->offset);
10028 new_body = new_NOARENA(sv_type_details);
10032 SvANY(dstr) = new_body;
10035 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10036 ((char*)SvANY(dstr)) + sv_type_details->offset,
10037 sv_type_details->copy, char);
10039 Copy(((char*)SvANY(sstr)),
10040 ((char*)SvANY(dstr)),
10041 sv_type_details->body_size + sv_type_details->offset, char);
10044 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10045 && !isGV_with_GP(dstr))
10046 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10048 /* The Copy above means that all the source (unduplicated) pointers
10049 are now in the destination. We can check the flags and the
10050 pointers in either, but it's possible that there's less cache
10051 missing by always going for the destination.
10052 FIXME - instrument and check that assumption */
10053 if (sv_type >= SVt_PVMG) {
10054 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10055 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10056 } else if (SvMAGIC(dstr))
10057 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10059 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10062 /* The cast silences a GCC warning about unhandled types. */
10063 switch ((int)sv_type) {
10075 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10076 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10077 LvTARG(dstr) = dstr;
10078 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10079 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10081 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10084 if (GvNAME_HEK(dstr))
10085 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10087 /* Don't call sv_add_backref here as it's going to be created
10088 as part of the magic cloning of the symbol table. */
10089 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10090 if(isGV_with_GP(sstr)) {
10091 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10092 at the point of this comment. */
10093 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10094 (void)GpREFCNT_inc(GvGP(dstr));
10096 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10099 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10100 if (IoOFP(dstr) == IoIFP(sstr))
10101 IoOFP(dstr) = IoIFP(dstr);
10103 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10104 /* PL_rsfp_filters entries have fake IoDIRP() */
10105 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10106 /* I have no idea why fake dirp (rsfps)
10107 should be treated differently but otherwise
10108 we end up with leaks -- sky*/
10109 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10110 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10111 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10113 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10114 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10115 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10116 if (IoDIRP(dstr)) {
10117 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10120 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10123 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10124 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10125 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10128 if (AvARRAY((AV*)sstr)) {
10129 SV **dst_ary, **src_ary;
10130 SSize_t items = AvFILLp((AV*)sstr) + 1;
10132 src_ary = AvARRAY((AV*)sstr);
10133 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10134 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10135 SvPV_set(dstr, (char*)dst_ary);
10136 AvALLOC((AV*)dstr) = dst_ary;
10137 if (AvREAL((AV*)sstr)) {
10138 while (items-- > 0)
10139 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10142 while (items-- > 0)
10143 *dst_ary++ = sv_dup(*src_ary++, param);
10145 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10146 while (items-- > 0) {
10147 *dst_ary++ = &PL_sv_undef;
10151 SvPV_set(dstr, NULL);
10152 AvALLOC((AV*)dstr) = (SV**)NULL;
10156 if (HvARRAY((HV*)sstr)) {
10158 const bool sharekeys = !!HvSHAREKEYS(sstr);
10159 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10160 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10162 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10163 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10165 HvARRAY(dstr) = (HE**)darray;
10166 while (i <= sxhv->xhv_max) {
10167 const HE * const source = HvARRAY(sstr)[i];
10168 HvARRAY(dstr)[i] = source
10169 ? he_dup(source, sharekeys, param) : 0;
10174 const struct xpvhv_aux * const saux = HvAUX(sstr);
10175 struct xpvhv_aux * const daux = HvAUX(dstr);
10176 /* This flag isn't copied. */
10177 /* SvOOK_on(hv) attacks the IV flags. */
10178 SvFLAGS(dstr) |= SVf_OOK;
10180 hvname = saux->xhv_name;
10181 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10183 daux->xhv_riter = saux->xhv_riter;
10184 daux->xhv_eiter = saux->xhv_eiter
10185 ? he_dup(saux->xhv_eiter,
10186 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10187 daux->xhv_backreferences =
10188 saux->xhv_backreferences
10189 ? (AV*) SvREFCNT_inc(
10190 sv_dup((SV*)saux->xhv_backreferences, param))
10192 /* Record stashes for possible cloning in Perl_clone(). */
10194 av_push(param->stashes, dstr);
10198 SvPV_set(dstr, NULL);
10201 if (!(param->flags & CLONEf_COPY_STACKS)) {
10205 /* NOTE: not refcounted */
10206 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10208 if (!CvISXSUB(dstr))
10209 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10211 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10212 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10213 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10214 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10216 /* don't dup if copying back - CvGV isn't refcounted, so the
10217 * duped GV may never be freed. A bit of a hack! DAPM */
10218 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10219 NULL : gv_dup(CvGV(dstr), param) ;
10220 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10222 CvWEAKOUTSIDE(sstr)
10223 ? cv_dup( CvOUTSIDE(dstr), param)
10224 : cv_dup_inc(CvOUTSIDE(dstr), param);
10225 if (!CvISXSUB(dstr))
10226 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10232 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10238 /* duplicate a context */
10241 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10243 PERL_CONTEXT *ncxs;
10246 return (PERL_CONTEXT*)NULL;
10248 /* look for it in the table first */
10249 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10253 /* create anew and remember what it is */
10254 Newxz(ncxs, max + 1, PERL_CONTEXT);
10255 ptr_table_store(PL_ptr_table, cxs, ncxs);
10258 PERL_CONTEXT * const cx = &cxs[ix];
10259 PERL_CONTEXT * const ncx = &ncxs[ix];
10260 ncx->cx_type = cx->cx_type;
10261 if (CxTYPE(cx) == CXt_SUBST) {
10262 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10265 ncx->blk_oldsp = cx->blk_oldsp;
10266 ncx->blk_oldcop = cx->blk_oldcop;
10267 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10268 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10269 ncx->blk_oldpm = cx->blk_oldpm;
10270 ncx->blk_gimme = cx->blk_gimme;
10271 switch (CxTYPE(cx)) {
10273 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10274 ? cv_dup_inc(cx->blk_sub.cv, param)
10275 : cv_dup(cx->blk_sub.cv,param));
10276 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10277 ? av_dup_inc(cx->blk_sub.argarray, param)
10279 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10280 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10281 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10282 ncx->blk_sub.lval = cx->blk_sub.lval;
10283 ncx->blk_sub.retop = cx->blk_sub.retop;
10284 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10285 cx->blk_sub.oldcomppad);
10288 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10289 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10290 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10291 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10292 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10293 ncx->blk_eval.retop = cx->blk_eval.retop;
10296 ncx->blk_loop.label = cx->blk_loop.label;
10297 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10298 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10299 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10300 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10301 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10302 ? cx->blk_loop.iterdata
10303 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10304 ncx->blk_loop.oldcomppad
10305 = (PAD*)ptr_table_fetch(PL_ptr_table,
10306 cx->blk_loop.oldcomppad);
10307 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10308 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10309 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10310 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10311 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10314 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10315 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10316 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10317 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10318 ncx->blk_sub.retop = cx->blk_sub.retop;
10330 /* duplicate a stack info structure */
10333 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10338 return (PERL_SI*)NULL;
10340 /* look for it in the table first */
10341 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10345 /* create anew and remember what it is */
10346 Newxz(nsi, 1, PERL_SI);
10347 ptr_table_store(PL_ptr_table, si, nsi);
10349 nsi->si_stack = av_dup_inc(si->si_stack, param);
10350 nsi->si_cxix = si->si_cxix;
10351 nsi->si_cxmax = si->si_cxmax;
10352 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10353 nsi->si_type = si->si_type;
10354 nsi->si_prev = si_dup(si->si_prev, param);
10355 nsi->si_next = si_dup(si->si_next, param);
10356 nsi->si_markoff = si->si_markoff;
10361 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10362 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10363 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10364 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10365 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10366 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10367 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10368 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10369 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10370 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10371 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10372 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10373 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10374 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10377 #define pv_dup_inc(p) SAVEPV(p)
10378 #define pv_dup(p) SAVEPV(p)
10379 #define svp_dup_inc(p,pp) any_dup(p,pp)
10381 /* map any object to the new equivent - either something in the
10382 * ptr table, or something in the interpreter structure
10386 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10391 return (void*)NULL;
10393 /* look for it in the table first */
10394 ret = ptr_table_fetch(PL_ptr_table, v);
10398 /* see if it is part of the interpreter structure */
10399 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10400 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10408 /* duplicate the save stack */
10411 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10413 ANY * const ss = proto_perl->Tsavestack;
10414 const I32 max = proto_perl->Tsavestack_max;
10415 I32 ix = proto_perl->Tsavestack_ix;
10427 void (*dptr) (void*);
10428 void (*dxptr) (pTHX_ void*);
10430 Newxz(nss, max, ANY);
10433 I32 i = POPINT(ss,ix);
10434 TOPINT(nss,ix) = i;
10436 case SAVEt_ITEM: /* normal string */
10437 case SAVEt_SV: /* scalar reference */
10438 sv = (SV*)POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10440 sv = (SV*)POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10443 case SAVEt_SHARED_PVREF: /* char* in shared space */
10444 c = (char*)POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = savesharedpv(c);
10446 ptr = POPPTR(ss,ix);
10447 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10449 case SAVEt_GENERIC_SVREF: /* generic sv */
10450 case SAVEt_SVREF: /* scalar reference */
10451 sv = (SV*)POPPTR(ss,ix);
10452 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10453 ptr = POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10456 case SAVEt_HV: /* hash reference */
10457 case SAVEt_AV: /* array reference */
10458 sv = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10460 gv = (GV*)POPPTR(ss,ix);
10461 TOPPTR(nss,ix) = gv_dup(gv, param);
10463 case SAVEt_INT: /* int reference */
10464 ptr = POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10466 intval = (int)POPINT(ss,ix);
10467 TOPINT(nss,ix) = intval;
10469 case SAVEt_LONG: /* long reference */
10470 ptr = POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10472 longval = (long)POPLONG(ss,ix);
10473 TOPLONG(nss,ix) = longval;
10475 case SAVEt_I32: /* I32 reference */
10476 case SAVEt_I16: /* I16 reference */
10477 case SAVEt_I8: /* I8 reference */
10478 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10479 ptr = POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10482 TOPINT(nss,ix) = i;
10484 case SAVEt_IV: /* IV reference */
10485 ptr = POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10488 TOPIV(nss,ix) = iv;
10490 case SAVEt_HPTR: /* HV* reference */
10491 case SAVEt_APTR: /* AV* reference */
10492 case SAVEt_SPTR: /* SV* reference */
10493 ptr = POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10495 sv = (SV*)POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = sv_dup(sv, param);
10498 case SAVEt_VPTR: /* random* reference */
10499 ptr = POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10501 ptr = POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10504 case SAVEt_GENERIC_PVREF: /* generic char* */
10505 case SAVEt_PPTR: /* char* reference */
10506 ptr = POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10508 c = (char*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = pv_dup(c);
10512 gv = (GV*)POPPTR(ss,ix);
10513 TOPPTR(nss,ix) = gv_dup(gv, param);
10515 case SAVEt_GP: /* scalar reference */
10516 gp = (GP*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10518 (void)GpREFCNT_inc(gp);
10519 gv = (GV*)POPPTR(ss,ix);
10520 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10521 c = (char*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = pv_dup(c);
10524 TOPIV(nss,ix) = iv;
10526 TOPIV(nss,ix) = iv;
10529 case SAVEt_MORTALIZESV:
10530 sv = (SV*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10534 ptr = POPPTR(ss,ix);
10535 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10536 /* these are assumed to be refcounted properly */
10538 switch (((OP*)ptr)->op_type) {
10540 case OP_LEAVESUBLV:
10544 case OP_LEAVEWRITE:
10545 TOPPTR(nss,ix) = ptr;
10550 TOPPTR(nss,ix) = NULL;
10555 TOPPTR(nss,ix) = NULL;
10558 c = (char*)POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = pv_dup_inc(c);
10561 case SAVEt_CLEARSV:
10562 longval = POPLONG(ss,ix);
10563 TOPLONG(nss,ix) = longval;
10566 hv = (HV*)POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10568 c = (char*)POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = pv_dup_inc(c);
10571 TOPINT(nss,ix) = i;
10573 case SAVEt_DESTRUCTOR:
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10576 dptr = POPDPTR(ss,ix);
10577 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10578 any_dup(FPTR2DPTR(void *, dptr),
10581 case SAVEt_DESTRUCTOR_X:
10582 ptr = POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10584 dxptr = POPDXPTR(ss,ix);
10585 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10586 any_dup(FPTR2DPTR(void *, dxptr),
10589 case SAVEt_REGCONTEXT:
10592 TOPINT(nss,ix) = i;
10595 case SAVEt_STACK_POS: /* Position on Perl stack */
10597 TOPINT(nss,ix) = i;
10599 case SAVEt_AELEM: /* array element */
10600 sv = (SV*)POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10603 TOPINT(nss,ix) = i;
10604 av = (AV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = av_dup_inc(av, param);
10607 case SAVEt_HELEM: /* hash element */
10608 sv = (SV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10610 sv = (SV*)POPPTR(ss,ix);
10611 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10612 hv = (HV*)POPPTR(ss,ix);
10613 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10616 ptr = POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = ptr;
10621 TOPINT(nss,ix) = i;
10622 ptr = POPPTR(ss,ix);
10625 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10626 HINTS_REFCNT_UNLOCK;
10628 TOPPTR(nss,ix) = ptr;
10629 if (i & HINT_LOCALIZE_HH) {
10630 hv = (HV*)POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10634 case SAVEt_COMPPAD:
10635 av = (AV*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = av_dup(av, param);
10639 longval = (long)POPLONG(ss,ix);
10640 TOPLONG(nss,ix) = longval;
10641 ptr = POPPTR(ss,ix);
10642 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10643 sv = (SV*)POPPTR(ss,ix);
10644 TOPPTR(nss,ix) = sv_dup(sv, param);
10647 ptr = POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10649 longval = (long)POPBOOL(ss,ix);
10650 TOPBOOL(nss,ix) = (bool)longval;
10652 case SAVEt_SET_SVFLAGS:
10654 TOPINT(nss,ix) = i;
10656 TOPINT(nss,ix) = i;
10657 sv = (SV*)POPPTR(ss,ix);
10658 TOPPTR(nss,ix) = sv_dup(sv, param);
10660 case SAVEt_RE_STATE:
10662 const struct re_save_state *const old_state
10663 = (struct re_save_state *)
10664 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10665 struct re_save_state *const new_state
10666 = (struct re_save_state *)
10667 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10669 Copy(old_state, new_state, 1, struct re_save_state);
10670 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10672 new_state->re_state_bostr
10673 = pv_dup(old_state->re_state_bostr);
10674 new_state->re_state_reginput
10675 = pv_dup(old_state->re_state_reginput);
10676 new_state->re_state_regeol
10677 = pv_dup(old_state->re_state_regeol);
10678 new_state->re_state_regstartp
10679 = any_dup(old_state->re_state_regstartp, proto_perl);
10680 new_state->re_state_regendp
10681 = any_dup(old_state->re_state_regendp, proto_perl);
10682 new_state->re_state_reglastparen
10683 = any_dup(old_state->re_state_reglastparen, proto_perl);
10684 new_state->re_state_reglastcloseparen
10685 = any_dup(old_state->re_state_reglastcloseparen,
10687 /* XXX This just has to be broken. The old save_re_context
10688 code did SAVEGENERICPV(PL_reg_start_tmp);
10689 PL_reg_start_tmp is char **.
10690 Look above to what the dup code does for
10691 SAVEt_GENERIC_PVREF
10692 It can never have worked.
10693 So this is merely a faithful copy of the exiting bug: */
10694 new_state->re_state_reg_start_tmp
10695 = (char **) pv_dup((char *)
10696 old_state->re_state_reg_start_tmp);
10697 /* I assume that it only ever "worked" because no-one called
10698 (pseudo)fork while the regexp engine had re-entered itself.
10700 #ifdef PERL_OLD_COPY_ON_WRITE
10701 new_state->re_state_nrs
10702 = sv_dup(old_state->re_state_nrs, param);
10704 new_state->re_state_reg_magic
10705 = any_dup(old_state->re_state_reg_magic, proto_perl);
10706 new_state->re_state_reg_oldcurpm
10707 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10708 new_state->re_state_reg_curpm
10709 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10710 new_state->re_state_reg_oldsaved
10711 = pv_dup(old_state->re_state_reg_oldsaved);
10712 new_state->re_state_reg_poscache
10713 = pv_dup(old_state->re_state_reg_poscache);
10714 new_state->re_state_reg_starttry
10715 = pv_dup(old_state->re_state_reg_starttry);
10718 case SAVEt_COMPILE_WARNINGS:
10719 ptr = POPPTR(ss,ix);
10720 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10723 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10731 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10732 * flag to the result. This is done for each stash before cloning starts,
10733 * so we know which stashes want their objects cloned */
10736 do_mark_cloneable_stash(pTHX_ SV *sv)
10738 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10740 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10741 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10742 if (cloner && GvCV(cloner)) {
10749 XPUSHs(sv_2mortal(newSVhek(hvname)));
10751 call_sv((SV*)GvCV(cloner), G_SCALAR);
10758 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10766 =for apidoc perl_clone
10768 Create and return a new interpreter by cloning the current one.
10770 perl_clone takes these flags as parameters:
10772 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10773 without it we only clone the data and zero the stacks,
10774 with it we copy the stacks and the new perl interpreter is
10775 ready to run at the exact same point as the previous one.
10776 The pseudo-fork code uses COPY_STACKS while the
10777 threads->new doesn't.
10779 CLONEf_KEEP_PTR_TABLE
10780 perl_clone keeps a ptr_table with the pointer of the old
10781 variable as a key and the new variable as a value,
10782 this allows it to check if something has been cloned and not
10783 clone it again but rather just use the value and increase the
10784 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10785 the ptr_table using the function
10786 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10787 reason to keep it around is if you want to dup some of your own
10788 variable who are outside the graph perl scans, example of this
10789 code is in threads.xs create
10792 This is a win32 thing, it is ignored on unix, it tells perls
10793 win32host code (which is c++) to clone itself, this is needed on
10794 win32 if you want to run two threads at the same time,
10795 if you just want to do some stuff in a separate perl interpreter
10796 and then throw it away and return to the original one,
10797 you don't need to do anything.
10802 /* XXX the above needs expanding by someone who actually understands it ! */
10803 EXTERN_C PerlInterpreter *
10804 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10807 perl_clone(PerlInterpreter *proto_perl, UV flags)
10810 #ifdef PERL_IMPLICIT_SYS
10812 /* perlhost.h so we need to call into it
10813 to clone the host, CPerlHost should have a c interface, sky */
10815 if (flags & CLONEf_CLONE_HOST) {
10816 return perl_clone_host(proto_perl,flags);
10818 return perl_clone_using(proto_perl, flags,
10820 proto_perl->IMemShared,
10821 proto_perl->IMemParse,
10823 proto_perl->IStdIO,
10827 proto_perl->IProc);
10831 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10832 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10833 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10834 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10835 struct IPerlDir* ipD, struct IPerlSock* ipS,
10836 struct IPerlProc* ipP)
10838 /* XXX many of the string copies here can be optimized if they're
10839 * constants; they need to be allocated as common memory and just
10840 * their pointers copied. */
10843 CLONE_PARAMS clone_params;
10844 CLONE_PARAMS* const param = &clone_params;
10846 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10847 /* for each stash, determine whether its objects should be cloned */
10848 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10849 PERL_SET_THX(my_perl);
10852 PoisonNew(my_perl, 1, PerlInterpreter);
10858 PL_savestack_ix = 0;
10859 PL_savestack_max = -1;
10860 PL_sig_pending = 0;
10861 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10862 # else /* !DEBUGGING */
10863 Zero(my_perl, 1, PerlInterpreter);
10864 # endif /* DEBUGGING */
10866 /* host pointers */
10868 PL_MemShared = ipMS;
10869 PL_MemParse = ipMP;
10876 #else /* !PERL_IMPLICIT_SYS */
10878 CLONE_PARAMS clone_params;
10879 CLONE_PARAMS* param = &clone_params;
10880 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10881 /* for each stash, determine whether its objects should be cloned */
10882 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10883 PERL_SET_THX(my_perl);
10886 PoisonNew(my_perl, 1, PerlInterpreter);
10892 PL_savestack_ix = 0;
10893 PL_savestack_max = -1;
10894 PL_sig_pending = 0;
10895 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10896 # else /* !DEBUGGING */
10897 Zero(my_perl, 1, PerlInterpreter);
10898 # endif /* DEBUGGING */
10899 #endif /* PERL_IMPLICIT_SYS */
10900 param->flags = flags;
10901 param->proto_perl = proto_perl;
10903 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10905 PL_body_arenas = NULL;
10906 Zero(&PL_body_roots, 1, PL_body_roots);
10908 PL_nice_chunk = NULL;
10909 PL_nice_chunk_size = 0;
10911 PL_sv_objcount = 0;
10913 PL_sv_arenaroot = NULL;
10915 PL_debug = proto_perl->Idebug;
10917 PL_hash_seed = proto_perl->Ihash_seed;
10918 PL_rehash_seed = proto_perl->Irehash_seed;
10920 #ifdef USE_REENTRANT_API
10921 /* XXX: things like -Dm will segfault here in perlio, but doing
10922 * PERL_SET_CONTEXT(proto_perl);
10923 * breaks too many other things
10925 Perl_reentrant_init(aTHX);
10928 /* create SV map for pointer relocation */
10929 PL_ptr_table = ptr_table_new();
10931 /* initialize these special pointers as early as possible */
10932 SvANY(&PL_sv_undef) = NULL;
10933 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10934 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10935 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10937 SvANY(&PL_sv_no) = new_XPVNV();
10938 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10939 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10940 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10941 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10942 SvCUR_set(&PL_sv_no, 0);
10943 SvLEN_set(&PL_sv_no, 1);
10944 SvIV_set(&PL_sv_no, 0);
10945 SvNV_set(&PL_sv_no, 0);
10946 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10948 SvANY(&PL_sv_yes) = new_XPVNV();
10949 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10950 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10951 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10952 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10953 SvCUR_set(&PL_sv_yes, 1);
10954 SvLEN_set(&PL_sv_yes, 2);
10955 SvIV_set(&PL_sv_yes, 1);
10956 SvNV_set(&PL_sv_yes, 1);
10957 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10959 /* create (a non-shared!) shared string table */
10960 PL_strtab = newHV();
10961 HvSHAREKEYS_off(PL_strtab);
10962 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10963 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10965 PL_compiling = proto_perl->Icompiling;
10967 /* These two PVs will be free'd special way so must set them same way op.c does */
10968 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10969 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10971 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10972 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10974 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10975 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10976 if (PL_compiling.cop_hints_hash) {
10978 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10979 HINTS_REFCNT_UNLOCK;
10981 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10983 /* pseudo environmental stuff */
10984 PL_origargc = proto_perl->Iorigargc;
10985 PL_origargv = proto_perl->Iorigargv;
10987 param->stashes = newAV(); /* Setup array of objects to call clone on */
10989 /* Set tainting stuff before PerlIO_debug can possibly get called */
10990 PL_tainting = proto_perl->Itainting;
10991 PL_taint_warn = proto_perl->Itaint_warn;
10993 #ifdef PERLIO_LAYERS
10994 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10995 PerlIO_clone(aTHX_ proto_perl, param);
10998 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10999 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11000 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11001 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11002 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11003 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11006 PL_minus_c = proto_perl->Iminus_c;
11007 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11008 PL_localpatches = proto_perl->Ilocalpatches;
11009 PL_splitstr = proto_perl->Isplitstr;
11010 PL_preprocess = proto_perl->Ipreprocess;
11011 PL_minus_n = proto_perl->Iminus_n;
11012 PL_minus_p = proto_perl->Iminus_p;
11013 PL_minus_l = proto_perl->Iminus_l;
11014 PL_minus_a = proto_perl->Iminus_a;
11015 PL_minus_E = proto_perl->Iminus_E;
11016 PL_minus_F = proto_perl->Iminus_F;
11017 PL_doswitches = proto_perl->Idoswitches;
11018 PL_dowarn = proto_perl->Idowarn;
11019 PL_doextract = proto_perl->Idoextract;
11020 PL_sawampersand = proto_perl->Isawampersand;
11021 PL_unsafe = proto_perl->Iunsafe;
11022 PL_inplace = SAVEPV(proto_perl->Iinplace);
11023 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11024 PL_perldb = proto_perl->Iperldb;
11025 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11026 PL_exit_flags = proto_perl->Iexit_flags;
11028 /* magical thingies */
11029 /* XXX time(&PL_basetime) when asked for? */
11030 PL_basetime = proto_perl->Ibasetime;
11031 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11033 PL_maxsysfd = proto_perl->Imaxsysfd;
11034 PL_statusvalue = proto_perl->Istatusvalue;
11036 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11038 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11040 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11042 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11043 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11044 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11046 /* Clone the regex array */
11047 PL_regex_padav = newAV();
11049 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11050 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11052 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11053 for(i = 1; i <= len; i++) {
11054 const SV * const regex = regexen[i];
11057 ? sv_dup_inc(regex, param)
11059 newSViv(PTR2IV(re_dup(
11060 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11062 av_push(PL_regex_padav, sv);
11065 PL_regex_pad = AvARRAY(PL_regex_padav);
11067 /* shortcuts to various I/O objects */
11068 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11069 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11070 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11071 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11072 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11073 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11075 /* shortcuts to regexp stuff */
11076 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11078 /* shortcuts to misc objects */
11079 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11081 /* shortcuts to debugging objects */
11082 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11083 PL_DBline = gv_dup(proto_perl->IDBline, param);
11084 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11085 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11086 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11087 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11088 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11089 PL_lineary = av_dup(proto_perl->Ilineary, param);
11090 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11092 /* symbol tables */
11093 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11094 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11095 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11096 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11097 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11099 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11100 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11101 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11102 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11103 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11104 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11106 PL_sub_generation = proto_perl->Isub_generation;
11108 /* funky return mechanisms */
11109 PL_forkprocess = proto_perl->Iforkprocess;
11111 /* subprocess state */
11112 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11114 /* internal state */
11115 PL_maxo = proto_perl->Imaxo;
11116 if (proto_perl->Iop_mask)
11117 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11120 /* PL_asserting = proto_perl->Iasserting; */
11122 /* current interpreter roots */
11123 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11124 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11125 PL_main_start = proto_perl->Imain_start;
11126 PL_eval_root = proto_perl->Ieval_root;
11127 PL_eval_start = proto_perl->Ieval_start;
11129 /* runtime control stuff */
11130 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11131 PL_copline = proto_perl->Icopline;
11133 PL_filemode = proto_perl->Ifilemode;
11134 PL_lastfd = proto_perl->Ilastfd;
11135 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11138 PL_gensym = proto_perl->Igensym;
11139 PL_preambled = proto_perl->Ipreambled;
11140 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11141 PL_laststatval = proto_perl->Ilaststatval;
11142 PL_laststype = proto_perl->Ilaststype;
11145 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11147 /* interpreter atexit processing */
11148 PL_exitlistlen = proto_perl->Iexitlistlen;
11149 if (PL_exitlistlen) {
11150 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11151 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11154 PL_exitlist = (PerlExitListEntry*)NULL;
11156 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11157 if (PL_my_cxt_size) {
11158 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11159 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11162 PL_my_cxt_list = (void**)NULL;
11163 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11164 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11165 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11167 PL_profiledata = NULL;
11168 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11169 /* PL_rsfp_filters entries have fake IoDIRP() */
11170 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11172 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11174 PAD_CLONE_VARS(proto_perl, param);
11176 #ifdef HAVE_INTERP_INTERN
11177 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11180 /* more statics moved here */
11181 PL_generation = proto_perl->Igeneration;
11182 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11184 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11185 PL_in_clean_all = proto_perl->Iin_clean_all;
11187 PL_uid = proto_perl->Iuid;
11188 PL_euid = proto_perl->Ieuid;
11189 PL_gid = proto_perl->Igid;
11190 PL_egid = proto_perl->Iegid;
11191 PL_nomemok = proto_perl->Inomemok;
11192 PL_an = proto_perl->Ian;
11193 PL_evalseq = proto_perl->Ievalseq;
11194 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11195 PL_origalen = proto_perl->Iorigalen;
11196 #ifdef PERL_USES_PL_PIDSTATUS
11197 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11199 PL_osname = SAVEPV(proto_perl->Iosname);
11200 PL_sighandlerp = proto_perl->Isighandlerp;
11202 PL_runops = proto_perl->Irunops;
11204 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11207 PL_cshlen = proto_perl->Icshlen;
11208 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11211 PL_lex_state = proto_perl->Ilex_state;
11212 PL_lex_defer = proto_perl->Ilex_defer;
11213 PL_lex_expect = proto_perl->Ilex_expect;
11214 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11215 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11216 PL_lex_starts = proto_perl->Ilex_starts;
11217 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11218 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11219 PL_lex_op = proto_perl->Ilex_op;
11220 PL_lex_inpat = proto_perl->Ilex_inpat;
11221 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11222 PL_lex_brackets = proto_perl->Ilex_brackets;
11223 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11224 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11225 PL_lex_casemods = proto_perl->Ilex_casemods;
11226 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11227 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11230 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11231 PL_lasttoke = proto_perl->Ilasttoke;
11232 PL_realtokenstart = proto_perl->Irealtokenstart;
11233 PL_faketokens = proto_perl->Ifaketokens;
11234 PL_thismad = proto_perl->Ithismad;
11235 PL_thistoken = proto_perl->Ithistoken;
11236 PL_thisopen = proto_perl->Ithisopen;
11237 PL_thisstuff = proto_perl->Ithisstuff;
11238 PL_thisclose = proto_perl->Ithisclose;
11239 PL_thiswhite = proto_perl->Ithiswhite;
11240 PL_nextwhite = proto_perl->Inextwhite;
11241 PL_skipwhite = proto_perl->Iskipwhite;
11242 PL_endwhite = proto_perl->Iendwhite;
11243 PL_curforce = proto_perl->Icurforce;
11245 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11246 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11247 PL_nexttoke = proto_perl->Inexttoke;
11250 /* XXX This is probably masking the deeper issue of why
11251 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11252 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11253 * (A little debugging with a watchpoint on it may help.)
11255 if (SvANY(proto_perl->Ilinestr)) {
11256 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11257 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11258 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11259 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11260 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11261 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11262 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11263 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11264 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11267 PL_linestr = newSV(79);
11268 sv_upgrade(PL_linestr,SVt_PVIV);
11269 sv_setpvn(PL_linestr,"",0);
11270 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11272 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11273 PL_pending_ident = proto_perl->Ipending_ident;
11274 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11276 PL_expect = proto_perl->Iexpect;
11278 PL_multi_start = proto_perl->Imulti_start;
11279 PL_multi_end = proto_perl->Imulti_end;
11280 PL_multi_open = proto_perl->Imulti_open;
11281 PL_multi_close = proto_perl->Imulti_close;
11283 PL_error_count = proto_perl->Ierror_count;
11284 PL_subline = proto_perl->Isubline;
11285 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11287 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11288 if (SvANY(proto_perl->Ilinestr)) {
11289 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11290 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11291 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11292 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11293 PL_last_lop_op = proto_perl->Ilast_lop_op;
11296 PL_last_uni = SvPVX(PL_linestr);
11297 PL_last_lop = SvPVX(PL_linestr);
11298 PL_last_lop_op = 0;
11300 PL_in_my = proto_perl->Iin_my;
11301 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11303 PL_cryptseen = proto_perl->Icryptseen;
11306 PL_hints = proto_perl->Ihints;
11308 PL_amagic_generation = proto_perl->Iamagic_generation;
11310 #ifdef USE_LOCALE_COLLATE
11311 PL_collation_ix = proto_perl->Icollation_ix;
11312 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11313 PL_collation_standard = proto_perl->Icollation_standard;
11314 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11315 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11316 #endif /* USE_LOCALE_COLLATE */
11318 #ifdef USE_LOCALE_NUMERIC
11319 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11320 PL_numeric_standard = proto_perl->Inumeric_standard;
11321 PL_numeric_local = proto_perl->Inumeric_local;
11322 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11323 #endif /* !USE_LOCALE_NUMERIC */
11325 /* utf8 character classes */
11326 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11327 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11328 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11329 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11330 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11331 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11332 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11333 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11334 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11335 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11336 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11337 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11338 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11339 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11340 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11341 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11342 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11343 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11344 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11345 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11347 /* Did the locale setup indicate UTF-8? */
11348 PL_utf8locale = proto_perl->Iutf8locale;
11349 /* Unicode features (see perlrun/-C) */
11350 PL_unicode = proto_perl->Iunicode;
11352 /* Pre-5.8 signals control */
11353 PL_signals = proto_perl->Isignals;
11355 /* times() ticks per second */
11356 PL_clocktick = proto_perl->Iclocktick;
11358 /* Recursion stopper for PerlIO_find_layer */
11359 PL_in_load_module = proto_perl->Iin_load_module;
11361 /* sort() routine */
11362 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11364 /* Not really needed/useful since the reenrant_retint is "volatile",
11365 * but do it for consistency's sake. */
11366 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11368 /* Hooks to shared SVs and locks. */
11369 PL_sharehook = proto_perl->Isharehook;
11370 PL_lockhook = proto_perl->Ilockhook;
11371 PL_unlockhook = proto_perl->Iunlockhook;
11372 PL_threadhook = proto_perl->Ithreadhook;
11374 PL_runops_std = proto_perl->Irunops_std;
11375 PL_runops_dbg = proto_perl->Irunops_dbg;
11377 #ifdef THREADS_HAVE_PIDS
11378 PL_ppid = proto_perl->Ippid;
11382 PL_last_swash_hv = NULL; /* reinits on demand */
11383 PL_last_swash_klen = 0;
11384 PL_last_swash_key[0]= '\0';
11385 PL_last_swash_tmps = (U8*)NULL;
11386 PL_last_swash_slen = 0;
11388 PL_glob_index = proto_perl->Iglob_index;
11389 PL_srand_called = proto_perl->Isrand_called;
11390 PL_uudmap['M'] = 0; /* reinits on demand */
11391 PL_bitcount = NULL; /* reinits on demand */
11393 if (proto_perl->Ipsig_pend) {
11394 Newxz(PL_psig_pend, SIG_SIZE, int);
11397 PL_psig_pend = (int*)NULL;
11400 if (proto_perl->Ipsig_ptr) {
11401 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11402 Newxz(PL_psig_name, SIG_SIZE, SV*);
11403 for (i = 1; i < SIG_SIZE; i++) {
11404 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11405 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11409 PL_psig_ptr = (SV**)NULL;
11410 PL_psig_name = (SV**)NULL;
11413 /* thrdvar.h stuff */
11415 if (flags & CLONEf_COPY_STACKS) {
11416 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11417 PL_tmps_ix = proto_perl->Ttmps_ix;
11418 PL_tmps_max = proto_perl->Ttmps_max;
11419 PL_tmps_floor = proto_perl->Ttmps_floor;
11420 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11422 while (i <= PL_tmps_ix) {
11423 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11427 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11428 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11429 Newxz(PL_markstack, i, I32);
11430 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11431 - proto_perl->Tmarkstack);
11432 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11433 - proto_perl->Tmarkstack);
11434 Copy(proto_perl->Tmarkstack, PL_markstack,
11435 PL_markstack_ptr - PL_markstack + 1, I32);
11437 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11438 * NOTE: unlike the others! */
11439 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11440 PL_scopestack_max = proto_perl->Tscopestack_max;
11441 Newxz(PL_scopestack, PL_scopestack_max, I32);
11442 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11444 /* NOTE: si_dup() looks at PL_markstack */
11445 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11447 /* PL_curstack = PL_curstackinfo->si_stack; */
11448 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11449 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11451 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11452 PL_stack_base = AvARRAY(PL_curstack);
11453 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11454 - proto_perl->Tstack_base);
11455 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11457 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11458 * NOTE: unlike the others! */
11459 PL_savestack_ix = proto_perl->Tsavestack_ix;
11460 PL_savestack_max = proto_perl->Tsavestack_max;
11461 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11462 PL_savestack = ss_dup(proto_perl, param);
11466 ENTER; /* perl_destruct() wants to LEAVE; */
11468 /* although we're not duplicating the tmps stack, we should still
11469 * add entries for any SVs on the tmps stack that got cloned by a
11470 * non-refcount means (eg a temp in @_); otherwise they will be
11473 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11474 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11475 proto_perl->Ttmps_stack[i]);
11476 if (nsv && !SvREFCNT(nsv)) {
11478 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11483 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11484 PL_top_env = &PL_start_env;
11486 PL_op = proto_perl->Top;
11489 PL_Xpv = (XPV*)NULL;
11490 PL_na = proto_perl->Tna;
11492 PL_statbuf = proto_perl->Tstatbuf;
11493 PL_statcache = proto_perl->Tstatcache;
11494 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11495 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11497 PL_timesbuf = proto_perl->Ttimesbuf;
11500 PL_tainted = proto_perl->Ttainted;
11501 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11502 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11503 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11504 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11505 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11506 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11507 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11508 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11509 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11511 PL_restartop = proto_perl->Trestartop;
11512 PL_in_eval = proto_perl->Tin_eval;
11513 PL_delaymagic = proto_perl->Tdelaymagic;
11514 PL_dirty = proto_perl->Tdirty;
11515 PL_localizing = proto_perl->Tlocalizing;
11517 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11518 PL_hv_fetch_ent_mh = NULL;
11519 PL_modcount = proto_perl->Tmodcount;
11520 PL_lastgotoprobe = NULL;
11521 PL_dumpindent = proto_perl->Tdumpindent;
11523 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11524 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11525 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11526 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11527 PL_efloatbuf = NULL; /* reinits on demand */
11528 PL_efloatsize = 0; /* reinits on demand */
11532 PL_screamfirst = NULL;
11533 PL_screamnext = NULL;
11534 PL_maxscream = -1; /* reinits on demand */
11535 PL_lastscream = NULL;
11537 PL_watchaddr = NULL;
11540 PL_regdummy = proto_perl->Tregdummy;
11541 PL_colorset = 0; /* reinits PL_colors[] */
11542 /*PL_colors[6] = {0,0,0,0,0,0};*/
11544 /* RE engine - function pointers */
11545 PL_regcompp = proto_perl->Tregcompp;
11546 PL_regexecp = proto_perl->Tregexecp;
11547 PL_regint_start = proto_perl->Tregint_start;
11548 PL_regint_string = proto_perl->Tregint_string;
11549 PL_regfree = proto_perl->Tregfree;
11550 Zero(&PL_reg_state, 1, struct re_save_state);
11551 PL_reginterp_cnt = 0;
11552 PL_regmatch_slab = NULL;
11554 /* Pluggable optimizer */
11555 PL_peepp = proto_perl->Tpeepp;
11557 PL_stashcache = newHV();
11559 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11560 ptr_table_free(PL_ptr_table);
11561 PL_ptr_table = NULL;
11564 /* Call the ->CLONE method, if it exists, for each of the stashes
11565 identified by sv_dup() above.
11567 while(av_len(param->stashes) != -1) {
11568 HV* const stash = (HV*) av_shift(param->stashes);
11569 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11570 if (cloner && GvCV(cloner)) {
11575 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11577 call_sv((SV*)GvCV(cloner), G_DISCARD);
11583 SvREFCNT_dec(param->stashes);
11585 /* orphaned? eg threads->new inside BEGIN or use */
11586 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11587 SvREFCNT_inc_simple_void(PL_compcv);
11588 SAVEFREESV(PL_compcv);
11594 #endif /* USE_ITHREADS */
11597 =head1 Unicode Support
11599 =for apidoc sv_recode_to_utf8
11601 The encoding is assumed to be an Encode object, on entry the PV
11602 of the sv is assumed to be octets in that encoding, and the sv
11603 will be converted into Unicode (and UTF-8).
11605 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11606 is not a reference, nothing is done to the sv. If the encoding is not
11607 an C<Encode::XS> Encoding object, bad things will happen.
11608 (See F<lib/encoding.pm> and L<Encode>).
11610 The PV of the sv is returned.
11615 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11618 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11632 Passing sv_yes is wrong - it needs to be or'ed set of constants
11633 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11634 remove converted chars from source.
11636 Both will default the value - let them.
11638 XPUSHs(&PL_sv_yes);
11641 call_method("decode", G_SCALAR);
11645 s = SvPV_const(uni, len);
11646 if (s != SvPVX_const(sv)) {
11647 SvGROW(sv, len + 1);
11648 Move(s, SvPVX(sv), len + 1, char);
11649 SvCUR_set(sv, len);
11656 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11660 =for apidoc sv_cat_decode
11662 The encoding is assumed to be an Encode object, the PV of the ssv is
11663 assumed to be octets in that encoding and decoding the input starts
11664 from the position which (PV + *offset) pointed to. The dsv will be
11665 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11666 when the string tstr appears in decoding output or the input ends on
11667 the PV of the ssv. The value which the offset points will be modified
11668 to the last input position on the ssv.
11670 Returns TRUE if the terminator was found, else returns FALSE.
11675 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11676 SV *ssv, int *offset, char *tstr, int tlen)
11680 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11691 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11692 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11694 call_method("cat_decode", G_SCALAR);
11696 ret = SvTRUE(TOPs);
11697 *offset = SvIV(offsv);
11703 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11708 /* ---------------------------------------------------------------------
11710 * support functions for report_uninit()
11713 /* the maxiumum size of array or hash where we will scan looking
11714 * for the undefined element that triggered the warning */
11716 #define FUV_MAX_SEARCH_SIZE 1000
11718 /* Look for an entry in the hash whose value has the same SV as val;
11719 * If so, return a mortal copy of the key. */
11722 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11725 register HE **array;
11728 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11729 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11732 array = HvARRAY(hv);
11734 for (i=HvMAX(hv); i>0; i--) {
11735 register HE *entry;
11736 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11737 if (HeVAL(entry) != val)
11739 if ( HeVAL(entry) == &PL_sv_undef ||
11740 HeVAL(entry) == &PL_sv_placeholder)
11744 if (HeKLEN(entry) == HEf_SVKEY)
11745 return sv_mortalcopy(HeKEY_sv(entry));
11746 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11752 /* Look for an entry in the array whose value has the same SV as val;
11753 * If so, return the index, otherwise return -1. */
11756 S_find_array_subscript(pTHX_ AV *av, SV* val)
11759 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11760 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11763 if (val != &PL_sv_undef) {
11764 SV ** const svp = AvARRAY(av);
11767 for (i=AvFILLp(av); i>=0; i--)
11774 /* S_varname(): return the name of a variable, optionally with a subscript.
11775 * If gv is non-zero, use the name of that global, along with gvtype (one
11776 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11777 * targ. Depending on the value of the subscript_type flag, return:
11780 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11781 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11782 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11783 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11786 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11787 SV* keyname, I32 aindex, int subscript_type)
11790 SV * const name = sv_newmortal();
11793 buffer[0] = gvtype;
11796 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11798 gv_fullname4(name, gv, buffer, 0);
11800 if ((unsigned int)SvPVX(name)[1] <= 26) {
11802 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11804 /* Swap the 1 unprintable control character for the 2 byte pretty
11805 version - ie substr($name, 1, 1) = $buffer; */
11806 sv_insert(name, 1, 1, buffer, 2);
11811 CV * const cv = find_runcv(&unused);
11815 if (!cv || !CvPADLIST(cv))
11817 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11818 sv = *av_fetch(av, targ, FALSE);
11819 /* SvLEN in a pad name is not to be trusted */
11820 sv_setpv(name, SvPV_nolen_const(sv));
11823 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11824 SV * const sv = newSV(0);
11825 *SvPVX(name) = '$';
11826 Perl_sv_catpvf(aTHX_ name, "{%s}",
11827 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11830 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11831 *SvPVX(name) = '$';
11832 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11834 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11835 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11842 =for apidoc find_uninit_var
11844 Find the name of the undefined variable (if any) that caused the operator o
11845 to issue a "Use of uninitialized value" warning.
11846 If match is true, only return a name if it's value matches uninit_sv.
11847 So roughly speaking, if a unary operator (such as OP_COS) generates a
11848 warning, then following the direct child of the op may yield an
11849 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11850 other hand, with OP_ADD there are two branches to follow, so we only print
11851 the variable name if we get an exact match.
11853 The name is returned as a mortal SV.
11855 Assumes that PL_op is the op that originally triggered the error, and that
11856 PL_comppad/PL_curpad points to the currently executing pad.
11862 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11870 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11871 uninit_sv == &PL_sv_placeholder)))
11874 switch (obase->op_type) {
11881 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11882 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11885 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11887 if (pad) { /* @lex, %lex */
11888 sv = PAD_SVl(obase->op_targ);
11892 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11893 /* @global, %global */
11894 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11897 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11899 else /* @{expr}, %{expr} */
11900 return find_uninit_var(cUNOPx(obase)->op_first,
11904 /* attempt to find a match within the aggregate */
11906 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11908 subscript_type = FUV_SUBSCRIPT_HASH;
11911 index = find_array_subscript((AV*)sv, uninit_sv);
11913 subscript_type = FUV_SUBSCRIPT_ARRAY;
11916 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11919 return varname(gv, hash ? '%' : '@', obase->op_targ,
11920 keysv, index, subscript_type);
11924 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11926 return varname(NULL, '$', obase->op_targ,
11927 NULL, 0, FUV_SUBSCRIPT_NONE);
11930 gv = cGVOPx_gv(obase);
11931 if (!gv || (match && GvSV(gv) != uninit_sv))
11933 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11936 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11939 av = (AV*)PAD_SV(obase->op_targ);
11940 if (!av || SvRMAGICAL(av))
11942 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11943 if (!svp || *svp != uninit_sv)
11946 return varname(NULL, '$', obase->op_targ,
11947 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11950 gv = cGVOPx_gv(obase);
11956 if (!av || SvRMAGICAL(av))
11958 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11959 if (!svp || *svp != uninit_sv)
11962 return varname(gv, '$', 0,
11963 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11968 o = cUNOPx(obase)->op_first;
11969 if (!o || o->op_type != OP_NULL ||
11970 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11972 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11976 if (PL_op == obase)
11977 /* $a[uninit_expr] or $h{uninit_expr} */
11978 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11981 o = cBINOPx(obase)->op_first;
11982 kid = cBINOPx(obase)->op_last;
11984 /* get the av or hv, and optionally the gv */
11986 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11987 sv = PAD_SV(o->op_targ);
11989 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11990 && cUNOPo->op_first->op_type == OP_GV)
11992 gv = cGVOPx_gv(cUNOPo->op_first);
11995 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12000 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12001 /* index is constant */
12005 if (obase->op_type == OP_HELEM) {
12006 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12007 if (!he || HeVAL(he) != uninit_sv)
12011 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12012 if (!svp || *svp != uninit_sv)
12016 if (obase->op_type == OP_HELEM)
12017 return varname(gv, '%', o->op_targ,
12018 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12020 return varname(gv, '@', o->op_targ, NULL,
12021 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12024 /* index is an expression;
12025 * attempt to find a match within the aggregate */
12026 if (obase->op_type == OP_HELEM) {
12027 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12029 return varname(gv, '%', o->op_targ,
12030 keysv, 0, FUV_SUBSCRIPT_HASH);
12033 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12035 return varname(gv, '@', o->op_targ,
12036 NULL, index, FUV_SUBSCRIPT_ARRAY);
12041 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12043 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12048 /* only examine RHS */
12049 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12052 o = cUNOPx(obase)->op_first;
12053 if (o->op_type == OP_PUSHMARK)
12056 if (!o->op_sibling) {
12057 /* one-arg version of open is highly magical */
12059 if (o->op_type == OP_GV) { /* open FOO; */
12061 if (match && GvSV(gv) != uninit_sv)
12063 return varname(gv, '$', 0,
12064 NULL, 0, FUV_SUBSCRIPT_NONE);
12066 /* other possibilities not handled are:
12067 * open $x; or open my $x; should return '${*$x}'
12068 * open expr; should return '$'.expr ideally
12074 /* ops where $_ may be an implicit arg */
12078 if ( !(obase->op_flags & OPf_STACKED)) {
12079 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12080 ? PAD_SVl(obase->op_targ)
12083 sv = sv_newmortal();
12084 sv_setpvn(sv, "$_", 2);
12092 /* skip filehandle as it can't produce 'undef' warning */
12093 o = cUNOPx(obase)->op_first;
12094 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12095 o = o->op_sibling->op_sibling;
12102 match = 1; /* XS or custom code could trigger random warnings */
12107 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12108 return sv_2mortal(newSVpvs("${$/}"));
12113 if (!(obase->op_flags & OPf_KIDS))
12115 o = cUNOPx(obase)->op_first;
12121 /* if all except one arg are constant, or have no side-effects,
12122 * or are optimized away, then it's unambiguous */
12124 for (kid=o; kid; kid = kid->op_sibling) {
12126 const OPCODE type = kid->op_type;
12127 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12128 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12129 || (type == OP_PUSHMARK)
12133 if (o2) { /* more than one found */
12140 return find_uninit_var(o2, uninit_sv, match);
12142 /* scan all args */
12144 sv = find_uninit_var(o, uninit_sv, 1);
12156 =for apidoc report_uninit
12158 Print appropriate "Use of uninitialized variable" warning
12164 Perl_report_uninit(pTHX_ SV* uninit_sv)
12168 SV* varname = NULL;
12170 varname = find_uninit_var(PL_op, uninit_sv,0);
12172 sv_insert(varname, 0, 0, " ", 1);
12174 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12175 varname ? SvPV_nolen_const(varname) : "",
12176 " in ", OP_DESC(PL_op));
12179 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12185 * c-indentation-style: bsd
12186 * c-basic-offset: 4
12187 * indent-tabs-mode: t
12190 * ex: set ts=8 sts=4 sw=4 noet: