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",
1069 start, end, bdp->arena_size, sv_type, body_size,
1070 bdp->arena_size / body_size));
1072 *root = (void *)start;
1074 while (start < end) {
1075 char * const next = start + body_size;
1076 *(void**) start = (void *)next;
1079 *(void **)start = 0;
1084 /* grab a new thing from the free list, allocating more if necessary.
1085 The inline version is used for speed in hot routines, and the
1086 function using it serves the rest (unless PURIFY).
1088 #define new_body_inline(xpv, sv_type) \
1090 void ** const r3wt = &PL_body_roots[sv_type]; \
1092 xpv = *((void **)(r3wt)) \
1093 ? *((void **)(r3wt)) : more_bodies(sv_type); \
1094 *(r3wt) = *(void**)(xpv); \
1101 S_new_body(pTHX_ svtype sv_type)
1105 new_body_inline(xpv, sv_type);
1112 =for apidoc sv_upgrade
1114 Upgrade an SV to a more complex form. Generally adds a new body type to the
1115 SV, then copies across as much information as possible from the old body.
1116 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1122 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1127 const U32 old_type = SvTYPE(sv);
1128 const struct body_details *new_type_details;
1129 const struct body_details *const old_type_details
1130 = bodies_by_type + old_type;
1132 if (new_type != SVt_PV && SvIsCOW(sv)) {
1133 sv_force_normal_flags(sv, 0);
1136 if (old_type == new_type)
1139 if (old_type > new_type)
1140 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1141 (int)old_type, (int)new_type);
1144 old_body = SvANY(sv);
1146 /* Copying structures onto other structures that have been neatly zeroed
1147 has a subtle gotcha. Consider XPVMG
1149 +------+------+------+------+------+-------+-------+
1150 | NV | CUR | LEN | IV | MAGIC | STASH |
1151 +------+------+------+------+------+-------+-------+
1152 0 4 8 12 16 20 24 28
1154 where NVs are aligned to 8 bytes, so that sizeof that structure is
1155 actually 32 bytes long, with 4 bytes of padding at the end:
1157 +------+------+------+------+------+-------+-------+------+
1158 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1159 +------+------+------+------+------+-------+-------+------+
1160 0 4 8 12 16 20 24 28 32
1162 so what happens if you allocate memory for this structure:
1164 +------+------+------+------+------+-------+-------+------+------+...
1165 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1166 +------+------+------+------+------+-------+-------+------+------+...
1167 0 4 8 12 16 20 24 28 32 36
1169 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1170 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1171 started out as zero once, but it's quite possible that it isn't. So now,
1172 rather than a nicely zeroed GP, you have it pointing somewhere random.
1175 (In fact, GP ends up pointing at a previous GP structure, because the
1176 principle cause of the padding in XPVMG getting garbage is a copy of
1177 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1179 So we are careful and work out the size of used parts of all the
1186 if (new_type < SVt_PVIV) {
1187 new_type = (new_type == SVt_NV)
1188 ? SVt_PVNV : SVt_PVIV;
1192 if (new_type < SVt_PVNV) {
1193 new_type = SVt_PVNV;
1199 assert(new_type > SVt_PV);
1200 assert(SVt_IV < SVt_PV);
1201 assert(SVt_NV < SVt_PV);
1208 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1209 there's no way that it can be safely upgraded, because perl.c
1210 expects to Safefree(SvANY(PL_mess_sv)) */
1211 assert(sv != PL_mess_sv);
1212 /* This flag bit is used to mean other things in other scalar types.
1213 Given that it only has meaning inside the pad, it shouldn't be set
1214 on anything that can get upgraded. */
1215 assert(!SvPAD_TYPED(sv));
1218 if (old_type_details->cant_upgrade)
1219 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1220 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1222 new_type_details = bodies_by_type + new_type;
1224 SvFLAGS(sv) &= ~SVTYPEMASK;
1225 SvFLAGS(sv) |= new_type;
1227 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1228 the return statements above will have triggered. */
1229 assert (new_type != SVt_NULL);
1232 assert(old_type == SVt_NULL);
1233 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1237 assert(old_type == SVt_NULL);
1238 SvANY(sv) = new_XNV();
1242 assert(old_type == SVt_NULL);
1243 SvANY(sv) = &sv->sv_u.svu_rv;
1248 assert(new_type_details->body_size);
1251 assert(new_type_details->arena);
1252 assert(new_type_details->arena_size);
1253 /* This points to the start of the allocated area. */
1254 new_body_inline(new_body, new_type);
1255 Zero(new_body, new_type_details->body_size, char);
1256 new_body = ((char *)new_body) - new_type_details->offset;
1258 /* We always allocated the full length item with PURIFY. To do this
1259 we fake things so that arena is false for all 16 types.. */
1260 new_body = new_NOARENAZ(new_type_details);
1262 SvANY(sv) = new_body;
1263 if (new_type == SVt_PVAV) {
1269 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1270 The target created by newSVrv also is, and it can have magic.
1271 However, it never has SvPVX set.
1273 if (old_type >= SVt_RV) {
1274 assert(SvPVX_const(sv) == 0);
1277 /* Could put this in the else clause below, as PVMG must have SvPVX
1278 0 already (the assertion above) */
1281 if (old_type >= SVt_PVMG) {
1282 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1283 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1289 /* XXX Is this still needed? Was it ever needed? Surely as there is
1290 no route from NV to PVIV, NOK can never be true */
1291 assert(!SvNOKp(sv));
1303 assert(new_type_details->body_size);
1304 /* We always allocated the full length item with PURIFY. To do this
1305 we fake things so that arena is false for all 16 types.. */
1306 if(new_type_details->arena) {
1307 /* This points to the start of the allocated area. */
1308 new_body_inline(new_body, new_type);
1309 Zero(new_body, new_type_details->body_size, char);
1310 new_body = ((char *)new_body) - new_type_details->offset;
1312 new_body = new_NOARENAZ(new_type_details);
1314 SvANY(sv) = new_body;
1316 if (old_type_details->copy) {
1317 /* There is now the potential for an upgrade from something without
1318 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1319 int offset = old_type_details->offset;
1320 int length = old_type_details->copy;
1322 if (new_type_details->offset > old_type_details->offset) {
1323 const int difference
1324 = new_type_details->offset - old_type_details->offset;
1325 offset += difference;
1326 length -= difference;
1328 assert (length >= 0);
1330 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1334 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1335 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1336 * correct 0.0 for us. Otherwise, if the old body didn't have an
1337 * NV slot, but the new one does, then we need to initialise the
1338 * freshly created NV slot with whatever the correct bit pattern is
1340 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1344 if (new_type == SVt_PVIO)
1345 IoPAGE_LEN(sv) = 60;
1346 if (old_type < SVt_RV)
1350 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1351 (unsigned long)new_type);
1354 if (old_type_details->arena) {
1355 /* If there was an old body, then we need to free it.
1356 Note that there is an assumption that all bodies of types that
1357 can be upgraded came from arenas. Only the more complex non-
1358 upgradable types are allowed to be directly malloc()ed. */
1360 my_safefree(old_body);
1362 del_body((void*)((char*)old_body + old_type_details->offset),
1363 &PL_body_roots[old_type]);
1369 =for apidoc sv_backoff
1371 Remove any string offset. You should normally use the C<SvOOK_off> macro
1378 Perl_sv_backoff(pTHX_ register SV *sv)
1380 PERL_UNUSED_CONTEXT;
1382 assert(SvTYPE(sv) != SVt_PVHV);
1383 assert(SvTYPE(sv) != SVt_PVAV);
1385 const char * const s = SvPVX_const(sv);
1386 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1387 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1389 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1391 SvFLAGS(sv) &= ~SVf_OOK;
1398 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1399 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1400 Use the C<SvGROW> wrapper instead.
1406 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1410 if (PL_madskills && newlen >= 0x100000) {
1411 PerlIO_printf(Perl_debug_log,
1412 "Allocation too large: %"UVxf"\n", (UV)newlen);
1414 #ifdef HAS_64K_LIMIT
1415 if (newlen >= 0x10000) {
1416 PerlIO_printf(Perl_debug_log,
1417 "Allocation too large: %"UVxf"\n", (UV)newlen);
1420 #endif /* HAS_64K_LIMIT */
1423 if (SvTYPE(sv) < SVt_PV) {
1424 sv_upgrade(sv, SVt_PV);
1425 s = SvPVX_mutable(sv);
1427 else if (SvOOK(sv)) { /* pv is offset? */
1429 s = SvPVX_mutable(sv);
1430 if (newlen > SvLEN(sv))
1431 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1432 #ifdef HAS_64K_LIMIT
1433 if (newlen >= 0x10000)
1438 s = SvPVX_mutable(sv);
1440 if (newlen > SvLEN(sv)) { /* need more room? */
1441 newlen = PERL_STRLEN_ROUNDUP(newlen);
1442 if (SvLEN(sv) && s) {
1444 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1450 s = saferealloc(s, newlen);
1453 s = safemalloc(newlen);
1454 if (SvPVX_const(sv) && SvCUR(sv)) {
1455 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1459 SvLEN_set(sv, newlen);
1465 =for apidoc sv_setiv
1467 Copies an integer into the given SV, upgrading first if necessary.
1468 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1474 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1477 SV_CHECK_THINKFIRST_COW_DROP(sv);
1478 switch (SvTYPE(sv)) {
1480 sv_upgrade(sv, SVt_IV);
1483 sv_upgrade(sv, SVt_PVNV);
1487 sv_upgrade(sv, SVt_PVIV);
1496 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1499 (void)SvIOK_only(sv); /* validate number */
1505 =for apidoc sv_setiv_mg
1507 Like C<sv_setiv>, but also handles 'set' magic.
1513 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1520 =for apidoc sv_setuv
1522 Copies an unsigned integer into the given SV, upgrading first if necessary.
1523 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1529 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1531 /* With these two if statements:
1532 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1535 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1537 If you wish to remove them, please benchmark to see what the effect is
1539 if (u <= (UV)IV_MAX) {
1540 sv_setiv(sv, (IV)u);
1549 =for apidoc sv_setuv_mg
1551 Like C<sv_setuv>, but also handles 'set' magic.
1557 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1566 =for apidoc sv_setnv
1568 Copies a double into the given SV, upgrading first if necessary.
1569 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1575 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1578 SV_CHECK_THINKFIRST_COW_DROP(sv);
1579 switch (SvTYPE(sv)) {
1582 sv_upgrade(sv, SVt_NV);
1587 sv_upgrade(sv, SVt_PVNV);
1596 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1600 (void)SvNOK_only(sv); /* validate number */
1605 =for apidoc sv_setnv_mg
1607 Like C<sv_setnv>, but also handles 'set' magic.
1613 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1619 /* Print an "isn't numeric" warning, using a cleaned-up,
1620 * printable version of the offending string
1624 S_not_a_number(pTHX_ SV *sv)
1632 dsv = sv_2mortal(newSVpvs(""));
1633 pv = sv_uni_display(dsv, sv, 10, 0);
1636 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1637 /* each *s can expand to 4 chars + "...\0",
1638 i.e. need room for 8 chars */
1640 const char *s = SvPVX_const(sv);
1641 const char * const end = s + SvCUR(sv);
1642 for ( ; s < end && d < limit; s++ ) {
1644 if (ch & 128 && !isPRINT_LC(ch)) {
1653 else if (ch == '\r') {
1657 else if (ch == '\f') {
1661 else if (ch == '\\') {
1665 else if (ch == '\0') {
1669 else if (isPRINT_LC(ch))
1686 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1687 "Argument \"%s\" isn't numeric in %s", pv,
1690 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1691 "Argument \"%s\" isn't numeric", pv);
1695 =for apidoc looks_like_number
1697 Test if the content of an SV looks like a number (or is a number).
1698 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1699 non-numeric warning), even if your atof() doesn't grok them.
1705 Perl_looks_like_number(pTHX_ SV *sv)
1707 register const char *sbegin;
1711 sbegin = SvPVX_const(sv);
1714 else if (SvPOKp(sv))
1715 sbegin = SvPV_const(sv, len);
1717 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1718 return grok_number(sbegin, len, NULL);
1722 S_glob_2number(pTHX_ GV * const gv)
1724 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1725 SV *const buffer = sv_newmortal();
1727 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1730 gv_efullname3(buffer, gv, "*");
1731 SvFLAGS(gv) |= wasfake;
1733 /* We know that all GVs stringify to something that is not-a-number,
1734 so no need to test that. */
1735 if (ckWARN(WARN_NUMERIC))
1736 not_a_number(buffer);
1737 /* We just want something true to return, so that S_sv_2iuv_common
1738 can tail call us and return true. */
1743 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1745 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1746 SV *const buffer = sv_newmortal();
1748 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1751 gv_efullname3(buffer, gv, "*");
1752 SvFLAGS(gv) |= wasfake;
1754 assert(SvPOK(buffer));
1756 *len = SvCUR(buffer);
1758 return SvPVX(buffer);
1761 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1762 until proven guilty, assume that things are not that bad... */
1767 As 64 bit platforms often have an NV that doesn't preserve all bits of
1768 an IV (an assumption perl has been based on to date) it becomes necessary
1769 to remove the assumption that the NV always carries enough precision to
1770 recreate the IV whenever needed, and that the NV is the canonical form.
1771 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1772 precision as a side effect of conversion (which would lead to insanity
1773 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1774 1) to distinguish between IV/UV/NV slots that have cached a valid
1775 conversion where precision was lost and IV/UV/NV slots that have a
1776 valid conversion which has lost no precision
1777 2) to ensure that if a numeric conversion to one form is requested that
1778 would lose precision, the precise conversion (or differently
1779 imprecise conversion) is also performed and cached, to prevent
1780 requests for different numeric formats on the same SV causing
1781 lossy conversion chains. (lossless conversion chains are perfectly
1786 SvIOKp is true if the IV slot contains a valid value
1787 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1788 SvNOKp is true if the NV slot contains a valid value
1789 SvNOK is true only if the NV value is accurate
1792 while converting from PV to NV, check to see if converting that NV to an
1793 IV(or UV) would lose accuracy over a direct conversion from PV to
1794 IV(or UV). If it would, cache both conversions, return NV, but mark
1795 SV as IOK NOKp (ie not NOK).
1797 While converting from PV to IV, check to see if converting that IV to an
1798 NV would lose accuracy over a direct conversion from PV to NV. If it
1799 would, cache both conversions, flag similarly.
1801 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1802 correctly because if IV & NV were set NV *always* overruled.
1803 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1804 changes - now IV and NV together means that the two are interchangeable:
1805 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1807 The benefit of this is that operations such as pp_add know that if
1808 SvIOK is true for both left and right operands, then integer addition
1809 can be used instead of floating point (for cases where the result won't
1810 overflow). Before, floating point was always used, which could lead to
1811 loss of precision compared with integer addition.
1813 * making IV and NV equal status should make maths accurate on 64 bit
1815 * may speed up maths somewhat if pp_add and friends start to use
1816 integers when possible instead of fp. (Hopefully the overhead in
1817 looking for SvIOK and checking for overflow will not outweigh the
1818 fp to integer speedup)
1819 * will slow down integer operations (callers of SvIV) on "inaccurate"
1820 values, as the change from SvIOK to SvIOKp will cause a call into
1821 sv_2iv each time rather than a macro access direct to the IV slot
1822 * should speed up number->string conversion on integers as IV is
1823 favoured when IV and NV are equally accurate
1825 ####################################################################
1826 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1827 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1828 On the other hand, SvUOK is true iff UV.
1829 ####################################################################
1831 Your mileage will vary depending your CPU's relative fp to integer
1835 #ifndef NV_PRESERVES_UV
1836 # define IS_NUMBER_UNDERFLOW_IV 1
1837 # define IS_NUMBER_UNDERFLOW_UV 2
1838 # define IS_NUMBER_IV_AND_UV 2
1839 # define IS_NUMBER_OVERFLOW_IV 4
1840 # define IS_NUMBER_OVERFLOW_UV 5
1842 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1844 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1846 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1849 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));
1850 if (SvNVX(sv) < (NV)IV_MIN) {
1851 (void)SvIOKp_on(sv);
1853 SvIV_set(sv, IV_MIN);
1854 return IS_NUMBER_UNDERFLOW_IV;
1856 if (SvNVX(sv) > (NV)UV_MAX) {
1857 (void)SvIOKp_on(sv);
1860 SvUV_set(sv, UV_MAX);
1861 return IS_NUMBER_OVERFLOW_UV;
1863 (void)SvIOKp_on(sv);
1865 /* Can't use strtol etc to convert this string. (See truth table in
1867 if (SvNVX(sv) <= (UV)IV_MAX) {
1868 SvIV_set(sv, I_V(SvNVX(sv)));
1869 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1870 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1872 /* Integer is imprecise. NOK, IOKp */
1874 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1877 SvUV_set(sv, U_V(SvNVX(sv)));
1878 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1879 if (SvUVX(sv) == UV_MAX) {
1880 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1881 possibly be preserved by NV. Hence, it must be overflow.
1883 return IS_NUMBER_OVERFLOW_UV;
1885 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1887 /* Integer is imprecise. NOK, IOKp */
1889 return IS_NUMBER_OVERFLOW_IV;
1891 #endif /* !NV_PRESERVES_UV*/
1894 S_sv_2iuv_common(pTHX_ SV *sv) {
1897 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1898 * without also getting a cached IV/UV from it at the same time
1899 * (ie PV->NV conversion should detect loss of accuracy and cache
1900 * IV or UV at same time to avoid this. */
1901 /* IV-over-UV optimisation - choose to cache IV if possible */
1903 if (SvTYPE(sv) == SVt_NV)
1904 sv_upgrade(sv, SVt_PVNV);
1906 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1907 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1908 certainly cast into the IV range at IV_MAX, whereas the correct
1909 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1911 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1912 if (Perl_isnan(SvNVX(sv))) {
1918 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1919 SvIV_set(sv, I_V(SvNVX(sv)));
1920 if (SvNVX(sv) == (NV) SvIVX(sv)
1921 #ifndef NV_PRESERVES_UV
1922 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1923 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1924 /* Don't flag it as "accurately an integer" if the number
1925 came from a (by definition imprecise) NV operation, and
1926 we're outside the range of NV integer precision */
1929 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1930 DEBUG_c(PerlIO_printf(Perl_debug_log,
1931 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1937 /* IV not precise. No need to convert from PV, as NV
1938 conversion would already have cached IV if it detected
1939 that PV->IV would be better than PV->NV->IV
1940 flags already correct - don't set public IOK. */
1941 DEBUG_c(PerlIO_printf(Perl_debug_log,
1942 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1947 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1948 but the cast (NV)IV_MIN rounds to a the value less (more
1949 negative) than IV_MIN which happens to be equal to SvNVX ??
1950 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1951 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1952 (NV)UVX == NVX are both true, but the values differ. :-(
1953 Hopefully for 2s complement IV_MIN is something like
1954 0x8000000000000000 which will be exact. NWC */
1957 SvUV_set(sv, U_V(SvNVX(sv)));
1959 (SvNVX(sv) == (NV) SvUVX(sv))
1960 #ifndef NV_PRESERVES_UV
1961 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1962 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1963 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1964 /* Don't flag it as "accurately an integer" if the number
1965 came from a (by definition imprecise) NV operation, and
1966 we're outside the range of NV integer precision */
1971 DEBUG_c(PerlIO_printf(Perl_debug_log,
1972 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1978 else if (SvPOKp(sv) && SvLEN(sv)) {
1980 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1981 /* We want to avoid a possible problem when we cache an IV/ a UV which
1982 may be later translated to an NV, and the resulting NV is not
1983 the same as the direct translation of the initial string
1984 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1985 be careful to ensure that the value with the .456 is around if the
1986 NV value is requested in the future).
1988 This means that if we cache such an IV/a UV, we need to cache the
1989 NV as well. Moreover, we trade speed for space, and do not
1990 cache the NV if we are sure it's not needed.
1993 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1994 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1995 == IS_NUMBER_IN_UV) {
1996 /* It's definitely an integer, only upgrade to PVIV */
1997 if (SvTYPE(sv) < SVt_PVIV)
1998 sv_upgrade(sv, SVt_PVIV);
2000 } else if (SvTYPE(sv) < SVt_PVNV)
2001 sv_upgrade(sv, SVt_PVNV);
2003 /* If NVs preserve UVs then we only use the UV value if we know that
2004 we aren't going to call atof() below. If NVs don't preserve UVs
2005 then the value returned may have more precision than atof() will
2006 return, even though value isn't perfectly accurate. */
2007 if ((numtype & (IS_NUMBER_IN_UV
2008 #ifdef NV_PRESERVES_UV
2011 )) == IS_NUMBER_IN_UV) {
2012 /* This won't turn off the public IOK flag if it was set above */
2013 (void)SvIOKp_on(sv);
2015 if (!(numtype & IS_NUMBER_NEG)) {
2017 if (value <= (UV)IV_MAX) {
2018 SvIV_set(sv, (IV)value);
2020 /* it didn't overflow, and it was positive. */
2021 SvUV_set(sv, value);
2025 /* 2s complement assumption */
2026 if (value <= (UV)IV_MIN) {
2027 SvIV_set(sv, -(IV)value);
2029 /* Too negative for an IV. This is a double upgrade, but
2030 I'm assuming it will be rare. */
2031 if (SvTYPE(sv) < SVt_PVNV)
2032 sv_upgrade(sv, SVt_PVNV);
2036 SvNV_set(sv, -(NV)value);
2037 SvIV_set(sv, IV_MIN);
2041 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2042 will be in the previous block to set the IV slot, and the next
2043 block to set the NV slot. So no else here. */
2045 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2046 != IS_NUMBER_IN_UV) {
2047 /* It wasn't an (integer that doesn't overflow the UV). */
2048 SvNV_set(sv, Atof(SvPVX_const(sv)));
2050 if (! numtype && ckWARN(WARN_NUMERIC))
2053 #if defined(USE_LONG_DOUBLE)
2054 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2055 PTR2UV(sv), SvNVX(sv)));
2057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2058 PTR2UV(sv), SvNVX(sv)));
2061 #ifdef NV_PRESERVES_UV
2062 (void)SvIOKp_on(sv);
2064 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2065 SvIV_set(sv, I_V(SvNVX(sv)));
2066 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2069 NOOP; /* Integer is imprecise. NOK, IOKp */
2071 /* UV will not work better than IV */
2073 if (SvNVX(sv) > (NV)UV_MAX) {
2075 /* Integer is inaccurate. NOK, IOKp, is UV */
2076 SvUV_set(sv, UV_MAX);
2078 SvUV_set(sv, U_V(SvNVX(sv)));
2079 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2080 NV preservse UV so can do correct comparison. */
2081 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2084 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2089 #else /* NV_PRESERVES_UV */
2090 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2091 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2092 /* The IV/UV slot will have been set from value returned by
2093 grok_number above. The NV slot has just been set using
2096 assert (SvIOKp(sv));
2098 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2099 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2100 /* Small enough to preserve all bits. */
2101 (void)SvIOKp_on(sv);
2103 SvIV_set(sv, I_V(SvNVX(sv)));
2104 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2106 /* Assumption: first non-preserved integer is < IV_MAX,
2107 this NV is in the preserved range, therefore: */
2108 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2110 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);
2114 0 0 already failed to read UV.
2115 0 1 already failed to read UV.
2116 1 0 you won't get here in this case. IV/UV
2117 slot set, public IOK, Atof() unneeded.
2118 1 1 already read UV.
2119 so there's no point in sv_2iuv_non_preserve() attempting
2120 to use atol, strtol, strtoul etc. */
2121 sv_2iuv_non_preserve (sv, numtype);
2124 #endif /* NV_PRESERVES_UV */
2128 if (isGV_with_GP(sv))
2129 return glob_2number((GV *)sv);
2131 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2132 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2135 if (SvTYPE(sv) < SVt_IV)
2136 /* Typically the caller expects that sv_any is not NULL now. */
2137 sv_upgrade(sv, SVt_IV);
2138 /* Return 0 from the caller. */
2145 =for apidoc sv_2iv_flags
2147 Return the integer value of an SV, doing any necessary string
2148 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2149 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2155 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2160 if (SvGMAGICAL(sv)) {
2161 if (flags & SV_GMAGIC)
2166 return I_V(SvNVX(sv));
2168 if (SvPOKp(sv) && SvLEN(sv)) {
2171 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2173 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2174 == IS_NUMBER_IN_UV) {
2175 /* It's definitely an integer */
2176 if (numtype & IS_NUMBER_NEG) {
2177 if (value < (UV)IV_MIN)
2180 if (value < (UV)IV_MAX)
2185 if (ckWARN(WARN_NUMERIC))
2188 return I_V(Atof(SvPVX_const(sv)));
2193 assert(SvTYPE(sv) >= SVt_PVMG);
2194 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2195 } else if (SvTHINKFIRST(sv)) {
2199 SV * const tmpstr=AMG_CALLun(sv,numer);
2200 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2201 return SvIV(tmpstr);
2204 return PTR2IV(SvRV(sv));
2207 sv_force_normal_flags(sv, 0);
2209 if (SvREADONLY(sv) && !SvOK(sv)) {
2210 if (ckWARN(WARN_UNINITIALIZED))
2216 if (S_sv_2iuv_common(aTHX_ sv))
2219 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2220 PTR2UV(sv),SvIVX(sv)));
2221 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2225 =for apidoc sv_2uv_flags
2227 Return the unsigned integer value of an SV, doing any necessary string
2228 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2229 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2235 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2240 if (SvGMAGICAL(sv)) {
2241 if (flags & SV_GMAGIC)
2246 return U_V(SvNVX(sv));
2247 if (SvPOKp(sv) && SvLEN(sv)) {
2250 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2252 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2253 == IS_NUMBER_IN_UV) {
2254 /* It's definitely an integer */
2255 if (!(numtype & IS_NUMBER_NEG))
2259 if (ckWARN(WARN_NUMERIC))
2262 return U_V(Atof(SvPVX_const(sv)));
2267 assert(SvTYPE(sv) >= SVt_PVMG);
2268 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2269 } else if (SvTHINKFIRST(sv)) {
2273 SV *const tmpstr = AMG_CALLun(sv,numer);
2274 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2275 return SvUV(tmpstr);
2278 return PTR2UV(SvRV(sv));
2281 sv_force_normal_flags(sv, 0);
2283 if (SvREADONLY(sv) && !SvOK(sv)) {
2284 if (ckWARN(WARN_UNINITIALIZED))
2290 if (S_sv_2iuv_common(aTHX_ sv))
2294 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2295 PTR2UV(sv),SvUVX(sv)));
2296 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2302 Return the num value of an SV, doing any necessary string or integer
2303 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2310 Perl_sv_2nv(pTHX_ register SV *sv)
2315 if (SvGMAGICAL(sv)) {
2319 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2320 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2321 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2323 return Atof(SvPVX_const(sv));
2327 return (NV)SvUVX(sv);
2329 return (NV)SvIVX(sv);
2334 assert(SvTYPE(sv) >= SVt_PVMG);
2335 /* This falls through to the report_uninit near the end of the
2337 } else if (SvTHINKFIRST(sv)) {
2341 SV *const tmpstr = AMG_CALLun(sv,numer);
2342 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2343 return SvNV(tmpstr);
2346 return PTR2NV(SvRV(sv));
2349 sv_force_normal_flags(sv, 0);
2351 if (SvREADONLY(sv) && !SvOK(sv)) {
2352 if (ckWARN(WARN_UNINITIALIZED))
2357 if (SvTYPE(sv) < SVt_NV) {
2358 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2359 sv_upgrade(sv, SVt_NV);
2360 #ifdef USE_LONG_DOUBLE
2362 STORE_NUMERIC_LOCAL_SET_STANDARD();
2363 PerlIO_printf(Perl_debug_log,
2364 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2365 PTR2UV(sv), SvNVX(sv));
2366 RESTORE_NUMERIC_LOCAL();
2370 STORE_NUMERIC_LOCAL_SET_STANDARD();
2371 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2372 PTR2UV(sv), SvNVX(sv));
2373 RESTORE_NUMERIC_LOCAL();
2377 else if (SvTYPE(sv) < SVt_PVNV)
2378 sv_upgrade(sv, SVt_PVNV);
2383 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2384 #ifdef NV_PRESERVES_UV
2387 /* Only set the public NV OK flag if this NV preserves the IV */
2388 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2389 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2390 : (SvIVX(sv) == I_V(SvNVX(sv))))
2396 else if (SvPOKp(sv) && SvLEN(sv)) {
2398 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2399 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2401 #ifdef NV_PRESERVES_UV
2402 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2403 == IS_NUMBER_IN_UV) {
2404 /* It's definitely an integer */
2405 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2407 SvNV_set(sv, Atof(SvPVX_const(sv)));
2410 SvNV_set(sv, Atof(SvPVX_const(sv)));
2411 /* Only set the public NV OK flag if this NV preserves the value in
2412 the PV at least as well as an IV/UV would.
2413 Not sure how to do this 100% reliably. */
2414 /* if that shift count is out of range then Configure's test is
2415 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2417 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2418 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2419 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2420 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2421 /* Can't use strtol etc to convert this string, so don't try.
2422 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2425 /* value has been set. It may not be precise. */
2426 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2427 /* 2s complement assumption for (UV)IV_MIN */
2428 SvNOK_on(sv); /* Integer is too negative. */
2433 if (numtype & IS_NUMBER_NEG) {
2434 SvIV_set(sv, -(IV)value);
2435 } else if (value <= (UV)IV_MAX) {
2436 SvIV_set(sv, (IV)value);
2438 SvUV_set(sv, value);
2442 if (numtype & IS_NUMBER_NOT_INT) {
2443 /* I believe that even if the original PV had decimals,
2444 they are lost beyond the limit of the FP precision.
2445 However, neither is canonical, so both only get p
2446 flags. NWC, 2000/11/25 */
2447 /* Both already have p flags, so do nothing */
2449 const NV nv = SvNVX(sv);
2450 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2451 if (SvIVX(sv) == I_V(nv)) {
2454 /* It had no "." so it must be integer. */
2458 /* between IV_MAX and NV(UV_MAX).
2459 Could be slightly > UV_MAX */
2461 if (numtype & IS_NUMBER_NOT_INT) {
2462 /* UV and NV both imprecise. */
2464 const UV nv_as_uv = U_V(nv);
2466 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2475 #endif /* NV_PRESERVES_UV */
2478 if (isGV_with_GP(sv)) {
2479 glob_2number((GV *)sv);
2483 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2485 assert (SvTYPE(sv) >= SVt_NV);
2486 /* Typically the caller expects that sv_any is not NULL now. */
2487 /* XXX Ilya implies that this is a bug in callers that assume this
2488 and ideally should be fixed. */
2491 #if defined(USE_LONG_DOUBLE)
2493 STORE_NUMERIC_LOCAL_SET_STANDARD();
2494 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2495 PTR2UV(sv), SvNVX(sv));
2496 RESTORE_NUMERIC_LOCAL();
2500 STORE_NUMERIC_LOCAL_SET_STANDARD();
2501 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2502 PTR2UV(sv), SvNVX(sv));
2503 RESTORE_NUMERIC_LOCAL();
2509 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2510 * UV as a string towards the end of buf, and return pointers to start and
2513 * We assume that buf is at least TYPE_CHARS(UV) long.
2517 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2519 char *ptr = buf + TYPE_CHARS(UV);
2520 char * const ebuf = ptr;
2533 *--ptr = '0' + (char)(uv % 10);
2541 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2542 * a regexp to its stringified form.
2546 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2548 const regexp * const re = (regexp *)mg->mg_obj;
2551 const char *fptr = "msix";
2556 bool need_newline = 0;
2557 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2559 while((ch = *fptr++)) {
2561 reflags[left++] = ch;
2564 reflags[right--] = ch;
2569 reflags[left] = '-';
2573 mg->mg_len = re->prelen + 4 + left;
2575 * If /x was used, we have to worry about a regex ending with a
2576 * comment later being embedded within another regex. If so, we don't
2577 * want this regex's "commentization" to leak out to the right part of
2578 * the enclosing regex, we must cap it with a newline.
2580 * So, if /x was used, we scan backwards from the end of the regex. If
2581 * we find a '#' before we find a newline, we need to add a newline
2582 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2583 * we don't need to add anything. -jfriedl
2585 if (PMf_EXTENDED & re->reganch) {
2586 const char *endptr = re->precomp + re->prelen;
2587 while (endptr >= re->precomp) {
2588 const char c = *(endptr--);
2590 break; /* don't need another */
2592 /* we end while in a comment, so we need a newline */
2593 mg->mg_len++; /* save space for it */
2594 need_newline = 1; /* note to add it */
2600 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2601 mg->mg_ptr[0] = '(';
2602 mg->mg_ptr[1] = '?';
2603 Copy(reflags, mg->mg_ptr+2, left, char);
2604 *(mg->mg_ptr+left+2) = ':';
2605 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2607 mg->mg_ptr[mg->mg_len - 2] = '\n';
2608 mg->mg_ptr[mg->mg_len - 1] = ')';
2609 mg->mg_ptr[mg->mg_len] = 0;
2611 PL_reginterp_cnt += re->program[0].next_off;
2613 if (re->reganch & ROPT_UTF8)
2623 =for apidoc sv_2pv_flags
2625 Returns a pointer to the string value of an SV, and sets *lp to its length.
2626 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2628 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2629 usually end up here too.
2635 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2645 if (SvGMAGICAL(sv)) {
2646 if (flags & SV_GMAGIC)
2651 if (flags & SV_MUTABLE_RETURN)
2652 return SvPVX_mutable(sv);
2653 if (flags & SV_CONST_RETURN)
2654 return (char *)SvPVX_const(sv);
2657 if (SvIOKp(sv) || SvNOKp(sv)) {
2658 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2664 ? snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2665 : snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2667 ? my_sprintf(tbuf, "%"UVuf, (UV)SvUVX(sv))
2668 : my_sprintf(tbuf, "%"IVdf, (IV)SvIVX(sv));
2669 #endif /* #ifdef USE_SNPRINTF */
2671 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2678 #ifdef FIXNEGATIVEZERO
2679 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2685 SvUPGRADE(sv, SVt_PV);
2688 s = SvGROW_mutable(sv, len + 1);
2691 return memcpy(s, tbuf, len + 1);
2697 assert(SvTYPE(sv) >= SVt_PVMG);
2698 /* This falls through to the report_uninit near the end of the
2700 } else if (SvTHINKFIRST(sv)) {
2704 SV *const tmpstr = AMG_CALLun(sv,string);
2705 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2707 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2711 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2712 if (flags & SV_CONST_RETURN) {
2713 pv = (char *) SvPVX_const(tmpstr);
2715 pv = (flags & SV_MUTABLE_RETURN)
2716 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2719 *lp = SvCUR(tmpstr);
2721 pv = sv_2pv_flags(tmpstr, lp, flags);
2733 const SV *const referent = (SV*)SvRV(sv);
2736 tsv = sv_2mortal(newSVpvs("NULLREF"));
2737 } else if (SvTYPE(referent) == SVt_PVMG
2738 && ((SvFLAGS(referent) &
2739 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2740 == (SVs_OBJECT|SVs_SMG))
2741 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2742 return stringify_regexp(sv, mg, lp);
2744 const char *const typestr = sv_reftype(referent, 0);
2746 tsv = sv_newmortal();
2747 if (SvOBJECT(referent)) {
2748 const char *const name = HvNAME_get(SvSTASH(referent));
2749 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2750 name ? name : "__ANON__" , typestr,
2754 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2762 if (SvREADONLY(sv) && !SvOK(sv)) {
2763 if (ckWARN(WARN_UNINITIALIZED))
2770 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2771 /* I'm assuming that if both IV and NV are equally valid then
2772 converting the IV is going to be more efficient */
2773 const U32 isIOK = SvIOK(sv);
2774 const U32 isUIOK = SvIsUV(sv);
2775 char buf[TYPE_CHARS(UV)];
2778 if (SvTYPE(sv) < SVt_PVIV)
2779 sv_upgrade(sv, SVt_PVIV);
2780 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2781 /* inlined from sv_setpvn */
2782 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2783 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2784 SvCUR_set(sv, ebuf - ptr);
2794 else if (SvNOKp(sv)) {
2795 const int olderrno = errno;
2796 if (SvTYPE(sv) < SVt_PVNV)
2797 sv_upgrade(sv, SVt_PVNV);
2798 /* The +20 is pure guesswork. Configure test needed. --jhi */
2799 s = SvGROW_mutable(sv, NV_DIG + 20);
2800 /* some Xenix systems wipe out errno here */
2802 if (SvNVX(sv) == 0.0)
2803 (void)strcpy(s,"0");
2807 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2810 #ifdef FIXNEGATIVEZERO
2811 if (*s == '-' && s[1] == '0' && !s[2])
2821 if (isGV_with_GP(sv))
2822 return glob_2pv((GV *)sv, lp);
2824 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2828 if (SvTYPE(sv) < SVt_PV)
2829 /* Typically the caller expects that sv_any is not NULL now. */
2830 sv_upgrade(sv, SVt_PV);
2834 const STRLEN len = s - SvPVX_const(sv);
2840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2841 PTR2UV(sv),SvPVX_const(sv)));
2842 if (flags & SV_CONST_RETURN)
2843 return (char *)SvPVX_const(sv);
2844 if (flags & SV_MUTABLE_RETURN)
2845 return SvPVX_mutable(sv);
2850 =for apidoc sv_copypv
2852 Copies a stringified representation of the source SV into the
2853 destination SV. Automatically performs any necessary mg_get and
2854 coercion of numeric values into strings. Guaranteed to preserve
2855 UTF-8 flag even from overloaded objects. Similar in nature to
2856 sv_2pv[_flags] but operates directly on an SV instead of just the
2857 string. Mostly uses sv_2pv_flags to do its work, except when that
2858 would lose the UTF-8'ness of the PV.
2864 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2867 const char * const s = SvPV_const(ssv,len);
2868 sv_setpvn(dsv,s,len);
2876 =for apidoc sv_2pvbyte
2878 Return a pointer to the byte-encoded representation of the SV, and set *lp
2879 to its length. May cause the SV to be downgraded from UTF-8 as a
2882 Usually accessed via the C<SvPVbyte> macro.
2888 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2890 sv_utf8_downgrade(sv,0);
2891 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2895 =for apidoc sv_2pvutf8
2897 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2898 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2900 Usually accessed via the C<SvPVutf8> macro.
2906 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2908 sv_utf8_upgrade(sv);
2909 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2914 =for apidoc sv_2bool
2916 This function is only called on magical items, and is only used by
2917 sv_true() or its macro equivalent.
2923 Perl_sv_2bool(pTHX_ register SV *sv)
2932 SV * const tmpsv = AMG_CALLun(sv,bool_);
2933 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2934 return (bool)SvTRUE(tmpsv);
2936 return SvRV(sv) != 0;
2939 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2941 (*sv->sv_u.svu_pv > '0' ||
2942 Xpvtmp->xpv_cur > 1 ||
2943 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2950 return SvIVX(sv) != 0;
2953 return SvNVX(sv) != 0.0;
2955 if (isGV_with_GP(sv))
2965 =for apidoc sv_utf8_upgrade
2967 Converts the PV of an SV to its UTF-8-encoded form.
2968 Forces the SV to string form if it is not already.
2969 Always sets the SvUTF8 flag to avoid future validity checks even
2970 if all the bytes have hibit clear.
2972 This is not as a general purpose byte encoding to Unicode interface:
2973 use the Encode extension for that.
2975 =for apidoc sv_utf8_upgrade_flags
2977 Converts the PV of an SV to its UTF-8-encoded form.
2978 Forces the SV to string form if it is not already.
2979 Always sets the SvUTF8 flag to avoid future validity checks even
2980 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2981 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2982 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2984 This is not as a general purpose byte encoding to Unicode interface:
2985 use the Encode extension for that.
2991 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2994 if (sv == &PL_sv_undef)
2998 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2999 (void) sv_2pv_flags(sv,&len, flags);
3003 (void) SvPV_force(sv,len);
3012 sv_force_normal_flags(sv, 0);
3015 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3016 sv_recode_to_utf8(sv, PL_encoding);
3017 else { /* Assume Latin-1/EBCDIC */
3018 /* This function could be much more efficient if we
3019 * had a FLAG in SVs to signal if there are any hibit
3020 * chars in the PV. Given that there isn't such a flag
3021 * make the loop as fast as possible. */
3022 const U8 * const s = (U8 *) SvPVX_const(sv);
3023 const U8 * const e = (U8 *) SvEND(sv);
3028 /* Check for hi bit */
3029 if (!NATIVE_IS_INVARIANT(ch)) {
3030 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3031 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3033 SvPV_free(sv); /* No longer using what was there before. */
3034 SvPV_set(sv, (char*)recoded);
3035 SvCUR_set(sv, len - 1);
3036 SvLEN_set(sv, len); /* No longer know the real size. */
3040 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3047 =for apidoc sv_utf8_downgrade
3049 Attempts to convert the PV of an SV from characters to bytes.
3050 If the PV contains a character beyond byte, this conversion will fail;
3051 in this case, either returns false or, if C<fail_ok> is not
3054 This is not as a general purpose Unicode to byte encoding interface:
3055 use the Encode extension for that.
3061 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3064 if (SvPOKp(sv) && SvUTF8(sv)) {
3070 sv_force_normal_flags(sv, 0);
3072 s = (U8 *) SvPV(sv, len);
3073 if (!utf8_to_bytes(s, &len)) {
3078 Perl_croak(aTHX_ "Wide character in %s",
3081 Perl_croak(aTHX_ "Wide character");
3092 =for apidoc sv_utf8_encode
3094 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3095 flag off so that it looks like octets again.
3101 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3103 (void) sv_utf8_upgrade(sv);
3105 sv_force_normal_flags(sv, 0);
3107 if (SvREADONLY(sv)) {
3108 Perl_croak(aTHX_ PL_no_modify);
3114 =for apidoc sv_utf8_decode
3116 If the PV of the SV is an octet sequence in UTF-8
3117 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3118 so that it looks like a character. If the PV contains only single-byte
3119 characters, the C<SvUTF8> flag stays being off.
3120 Scans PV for validity and returns false if the PV is invalid UTF-8.
3126 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3132 /* The octets may have got themselves encoded - get them back as
3135 if (!sv_utf8_downgrade(sv, TRUE))
3138 /* it is actually just a matter of turning the utf8 flag on, but
3139 * we want to make sure everything inside is valid utf8 first.
3141 c = (const U8 *) SvPVX_const(sv);
3142 if (!is_utf8_string(c, SvCUR(sv)+1))
3144 e = (const U8 *) SvEND(sv);
3147 if (!UTF8_IS_INVARIANT(ch)) {
3157 =for apidoc sv_setsv
3159 Copies the contents of the source SV C<ssv> into the destination SV
3160 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3161 function if the source SV needs to be reused. Does not handle 'set' magic.
3162 Loosely speaking, it performs a copy-by-value, obliterating any previous
3163 content of the destination.
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3169 =for apidoc sv_setsv_flags
3171 Copies the contents of the source SV C<ssv> into the destination SV
3172 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3173 function if the source SV needs to be reused. Does not handle 'set' magic.
3174 Loosely speaking, it performs a copy-by-value, obliterating any previous
3175 content of the destination.
3176 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3177 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3178 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3179 and C<sv_setsv_nomg> are implemented in terms of this function.
3181 You probably want to use one of the assortment of wrappers, such as
3182 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3183 C<SvSetMagicSV_nosteal>.
3185 This is the primary function for copying scalars, and most other
3186 copy-ish functions and macros use this underneath.
3192 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3194 if (dtype != SVt_PVGV) {
3195 const char * const name = GvNAME(sstr);
3196 const STRLEN len = GvNAMELEN(sstr);
3197 /* don't upgrade SVt_PVLV: it can hold a glob */
3198 if (dtype != SVt_PVLV) {
3199 if (dtype >= SVt_PV) {
3205 sv_upgrade(dstr, SVt_PVGV);
3206 (void)SvOK_off(dstr);
3209 GvSTASH(dstr) = GvSTASH(sstr);
3211 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3212 gv_name_set((GV *)dstr, name, len, GV_ADD);
3213 SvFAKE_on(dstr); /* can coerce to non-glob */
3216 #ifdef GV_UNIQUE_CHECK
3217 if (GvUNIQUE((GV*)dstr)) {
3218 Perl_croak(aTHX_ PL_no_modify);
3224 (void)SvOK_off(dstr);
3226 GvINTRO_off(dstr); /* one-shot flag */
3227 GvGP(dstr) = gp_ref(GvGP(sstr));
3228 if (SvTAINTED(sstr))
3230 if (GvIMPORTED(dstr) != GVf_IMPORTED
3231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3233 GvIMPORTED_on(dstr);
3240 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3241 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3243 const int intro = GvINTRO(dstr);
3246 const U32 stype = SvTYPE(sref);
3249 #ifdef GV_UNIQUE_CHECK
3250 if (GvUNIQUE((GV*)dstr)) {
3251 Perl_croak(aTHX_ PL_no_modify);
3256 GvINTRO_off(dstr); /* one-shot flag */
3257 GvLINE(dstr) = CopLINE(PL_curcop);
3258 GvEGV(dstr) = (GV*)dstr;
3263 location = (SV **) &GvCV(dstr);
3264 import_flag = GVf_IMPORTED_CV;
3267 location = (SV **) &GvHV(dstr);
3268 import_flag = GVf_IMPORTED_HV;
3271 location = (SV **) &GvAV(dstr);
3272 import_flag = GVf_IMPORTED_AV;
3275 location = (SV **) &GvIOp(dstr);
3278 location = (SV **) &GvFORM(dstr);
3280 location = &GvSV(dstr);
3281 import_flag = GVf_IMPORTED_SV;
3284 if (stype == SVt_PVCV) {
3285 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3286 SvREFCNT_dec(GvCV(dstr));
3288 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3289 PL_sub_generation++;
3292 SAVEGENERICSV(*location);
3296 if (stype == SVt_PVCV && *location != sref) {
3297 CV* const cv = (CV*)*location;
3299 if (!GvCVGEN((GV*)dstr) &&
3300 (CvROOT(cv) || CvXSUB(cv)))
3302 /* Redefining a sub - warning is mandatory if
3303 it was a const and its value changed. */
3304 if (CvCONST(cv) && CvCONST((CV*)sref)
3305 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3307 /* They are 2 constant subroutines generated from
3308 the same constant. This probably means that
3309 they are really the "same" proxy subroutine
3310 instantiated in 2 places. Most likely this is
3311 when a constant is exported twice. Don't warn.
3314 else if (ckWARN(WARN_REDEFINE)
3316 && (!CvCONST((CV*)sref)
3317 || sv_cmp(cv_const_sv(cv),
3318 cv_const_sv((CV*)sref))))) {
3319 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3321 ? "Constant subroutine %s::%s redefined"
3322 : "Subroutine %s::%s redefined",
3323 HvNAME_get(GvSTASH((GV*)dstr)),
3324 GvENAME((GV*)dstr));
3328 cv_ckproto_len(cv, (GV*)dstr,
3329 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3330 SvPOK(sref) ? SvCUR(sref) : 0);
3332 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3333 GvASSUMECV_on(dstr);
3334 PL_sub_generation++;
3337 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3338 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3339 GvFLAGS(dstr) |= import_flag;
3344 if (SvTAINTED(sstr))
3350 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3353 register U32 sflags;
3359 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3361 sstr = &PL_sv_undef;
3362 stype = SvTYPE(sstr);
3363 dtype = SvTYPE(dstr);
3368 /* need to nuke the magic */
3370 SvRMAGICAL_off(dstr);
3373 /* There's a lot of redundancy below but we're going for speed here */
3378 if (dtype != SVt_PVGV) {
3379 (void)SvOK_off(dstr);
3387 sv_upgrade(dstr, SVt_IV);
3392 sv_upgrade(dstr, SVt_PVIV);
3395 (void)SvIOK_only(dstr);
3396 SvIV_set(dstr, SvIVX(sstr));
3399 /* SvTAINTED can only be true if the SV has taint magic, which in
3400 turn means that the SV type is PVMG (or greater). This is the
3401 case statement for SVt_IV, so this cannot be true (whatever gcov
3403 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_NV);
3418 sv_upgrade(dstr, SVt_PVNV);
3421 SvNV_set(dstr, SvNVX(sstr));
3422 (void)SvNOK_only(dstr);
3423 /* SvTAINTED can only be true if the SV has taint magic, which in
3424 turn means that the SV type is PVMG (or greater). This is the
3425 case statement for SVt_NV, so this cannot be true (whatever gcov
3427 assert(!SvTAINTED(sstr));
3434 sv_upgrade(dstr, SVt_RV);
3437 #ifdef PERL_OLD_COPY_ON_WRITE
3438 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3439 if (dtype < SVt_PVIV)
3440 sv_upgrade(dstr, SVt_PVIV);
3447 sv_upgrade(dstr, SVt_PV);
3450 if (dtype < SVt_PVIV)
3451 sv_upgrade(dstr, SVt_PVIV);
3454 if (dtype < SVt_PVNV)
3455 sv_upgrade(dstr, SVt_PVNV);
3459 const char * const type = sv_reftype(sstr,0);
3461 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3463 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3468 if (dtype <= SVt_PVGV) {
3469 glob_assign_glob(dstr, sstr, dtype);
3477 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3479 if ((int)SvTYPE(sstr) != stype) {
3480 stype = SvTYPE(sstr);
3481 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3482 glob_assign_glob(dstr, sstr, dtype);
3487 if (stype == SVt_PVLV)
3488 SvUPGRADE(dstr, SVt_PVNV);
3490 SvUPGRADE(dstr, (U32)stype);
3493 /* dstr may have been upgraded. */
3494 dtype = SvTYPE(dstr);
3495 sflags = SvFLAGS(sstr);
3497 if (sflags & SVf_ROK) {
3498 if (dtype == SVt_PVGV &&
3499 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3502 if (GvIMPORTED(dstr) != GVf_IMPORTED
3503 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3505 GvIMPORTED_on(dstr);
3510 glob_assign_glob(dstr, sstr, dtype);
3514 if (dtype >= SVt_PV) {
3515 if (dtype == SVt_PVGV) {
3516 glob_assign_ref(dstr, sstr);
3519 if (SvPVX_const(dstr)) {
3525 (void)SvOK_off(dstr);
3526 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3527 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3528 assert(!(sflags & SVp_NOK));
3529 assert(!(sflags & SVp_IOK));
3530 assert(!(sflags & SVf_NOK));
3531 assert(!(sflags & SVf_IOK));
3533 else if (dtype == SVt_PVGV) {
3534 if (!(sflags & SVf_OK)) {
3535 if (ckWARN(WARN_MISC))
3536 Perl_warner(aTHX_ packWARN(WARN_MISC),
3537 "Undefined value assigned to typeglob");
3540 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3541 if (dstr != (SV*)gv) {
3544 GvGP(dstr) = gp_ref(GvGP(gv));
3548 else if (sflags & SVp_POK) {
3552 * Check to see if we can just swipe the string. If so, it's a
3553 * possible small lose on short strings, but a big win on long ones.
3554 * It might even be a win on short strings if SvPVX_const(dstr)
3555 * has to be allocated and SvPVX_const(sstr) has to be freed.
3558 /* Whichever path we take through the next code, we want this true,
3559 and doing it now facilitates the COW check. */
3560 (void)SvPOK_only(dstr);
3563 /* We're not already COW */
3564 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3565 #ifndef PERL_OLD_COPY_ON_WRITE
3566 /* or we are, but dstr isn't a suitable target. */
3567 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3572 (sflags & SVs_TEMP) && /* slated for free anyway? */
3573 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3574 (!(flags & SV_NOSTEAL)) &&
3575 /* and we're allowed to steal temps */
3576 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3577 SvLEN(sstr) && /* and really is a string */
3578 /* and won't be needed again, potentially */
3579 !(PL_op && PL_op->op_type == OP_AASSIGN))
3580 #ifdef PERL_OLD_COPY_ON_WRITE
3581 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3582 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3583 && SvTYPE(sstr) >= SVt_PVIV)
3586 /* Failed the swipe test, and it's not a shared hash key either.
3587 Have to copy the string. */
3588 STRLEN len = SvCUR(sstr);
3589 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3590 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3591 SvCUR_set(dstr, len);
3592 *SvEND(dstr) = '\0';
3594 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3596 /* Either it's a shared hash key, or it's suitable for
3597 copy-on-write or we can swipe the string. */
3599 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3603 #ifdef PERL_OLD_COPY_ON_WRITE
3605 /* I believe I should acquire a global SV mutex if
3606 it's a COW sv (not a shared hash key) to stop
3607 it going un copy-on-write.
3608 If the source SV has gone un copy on write between up there
3609 and down here, then (assert() that) it is of the correct
3610 form to make it copy on write again */
3611 if ((sflags & (SVf_FAKE | SVf_READONLY))
3612 != (SVf_FAKE | SVf_READONLY)) {
3613 SvREADONLY_on(sstr);
3615 /* Make the source SV into a loop of 1.
3616 (about to become 2) */
3617 SV_COW_NEXT_SV_SET(sstr, sstr);
3621 /* Initial code is common. */
3622 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3627 /* making another shared SV. */
3628 STRLEN cur = SvCUR(sstr);
3629 STRLEN len = SvLEN(sstr);
3630 #ifdef PERL_OLD_COPY_ON_WRITE
3632 assert (SvTYPE(dstr) >= SVt_PVIV);
3633 /* SvIsCOW_normal */
3634 /* splice us in between source and next-after-source. */
3635 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3636 SV_COW_NEXT_SV_SET(sstr, dstr);
3637 SvPV_set(dstr, SvPVX_mutable(sstr));
3641 /* SvIsCOW_shared_hash */
3642 DEBUG_C(PerlIO_printf(Perl_debug_log,
3643 "Copy on write: Sharing hash\n"));
3645 assert (SvTYPE(dstr) >= SVt_PV);
3647 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3649 SvLEN_set(dstr, len);
3650 SvCUR_set(dstr, cur);
3651 SvREADONLY_on(dstr);
3653 /* Relesase a global SV mutex. */
3656 { /* Passes the swipe test. */
3657 SvPV_set(dstr, SvPVX_mutable(sstr));
3658 SvLEN_set(dstr, SvLEN(sstr));
3659 SvCUR_set(dstr, SvCUR(sstr));
3662 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3663 SvPV_set(sstr, NULL);
3669 if (sflags & SVp_NOK) {
3670 SvNV_set(dstr, SvNVX(sstr));
3672 if (sflags & SVp_IOK) {
3673 SvRELEASE_IVX(dstr);
3674 SvIV_set(dstr, SvIVX(sstr));
3675 /* Must do this otherwise some other overloaded use of 0x80000000
3676 gets confused. I guess SVpbm_VALID */
3677 if (sflags & SVf_IVisUV)
3680 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3683 const MAGIC * const smg = SvVOK(sstr);
3685 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3686 smg->mg_ptr, smg->mg_len);
3687 SvRMAGICAL_on(dstr);
3691 else if (sflags & (SVp_IOK|SVp_NOK)) {
3692 (void)SvOK_off(dstr);
3693 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3695 if (sflags & SVp_IOK) {
3696 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3697 SvIV_set(dstr, SvIVX(sstr));
3699 if (sflags & SVp_NOK) {
3700 SvNV_set(dstr, SvNVX(sstr));
3704 if (isGV_with_GP(sstr)) {
3705 /* This stringification rule for globs is spread in 3 places.
3706 This feels bad. FIXME. */
3707 const U32 wasfake = sflags & SVf_FAKE;
3709 /* FAKE globs can get coerced, so need to turn this off
3710 temporarily if it is on. */
3712 gv_efullname3(dstr, (GV *)sstr, "*");
3713 SvFLAGS(sstr) |= wasfake;
3714 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3717 (void)SvOK_off(dstr);
3719 if (SvTAINTED(sstr))
3724 =for apidoc sv_setsv_mg
3726 Like C<sv_setsv>, but also handles 'set' magic.
3732 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3734 sv_setsv(dstr,sstr);
3738 #ifdef PERL_OLD_COPY_ON_WRITE
3740 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3742 STRLEN cur = SvCUR(sstr);
3743 STRLEN len = SvLEN(sstr);
3744 register char *new_pv;
3747 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3755 if (SvTHINKFIRST(dstr))
3756 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3757 else if (SvPVX_const(dstr))
3758 Safefree(SvPVX_const(dstr));
3762 SvUPGRADE(dstr, SVt_PVIV);
3764 assert (SvPOK(sstr));
3765 assert (SvPOKp(sstr));
3766 assert (!SvIOK(sstr));
3767 assert (!SvIOKp(sstr));
3768 assert (!SvNOK(sstr));
3769 assert (!SvNOKp(sstr));
3771 if (SvIsCOW(sstr)) {
3773 if (SvLEN(sstr) == 0) {
3774 /* source is a COW shared hash key. */
3775 DEBUG_C(PerlIO_printf(Perl_debug_log,
3776 "Fast copy on write: Sharing hash\n"));
3777 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3780 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3782 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3783 SvUPGRADE(sstr, SVt_PVIV);
3784 SvREADONLY_on(sstr);
3786 DEBUG_C(PerlIO_printf(Perl_debug_log,
3787 "Fast copy on write: Converting sstr to COW\n"));
3788 SV_COW_NEXT_SV_SET(dstr, sstr);
3790 SV_COW_NEXT_SV_SET(sstr, dstr);
3791 new_pv = SvPVX_mutable(sstr);
3794 SvPV_set(dstr, new_pv);
3795 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3798 SvLEN_set(dstr, len);
3799 SvCUR_set(dstr, cur);
3808 =for apidoc sv_setpvn
3810 Copies a string into an SV. The C<len> parameter indicates the number of
3811 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3812 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3818 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3821 register char *dptr;
3823 SV_CHECK_THINKFIRST_COW_DROP(sv);
3829 /* len is STRLEN which is unsigned, need to copy to signed */
3832 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3834 SvUPGRADE(sv, SVt_PV);
3836 dptr = SvGROW(sv, len + 1);
3837 Move(ptr,dptr,len,char);
3840 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3845 =for apidoc sv_setpvn_mg
3847 Like C<sv_setpvn>, but also handles 'set' magic.
3853 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3855 sv_setpvn(sv,ptr,len);
3860 =for apidoc sv_setpv
3862 Copies a string into an SV. The string must be null-terminated. Does not
3863 handle 'set' magic. See C<sv_setpv_mg>.
3869 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3872 register STRLEN len;
3874 SV_CHECK_THINKFIRST_COW_DROP(sv);
3880 SvUPGRADE(sv, SVt_PV);
3882 SvGROW(sv, len + 1);
3883 Move(ptr,SvPVX(sv),len+1,char);
3885 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3890 =for apidoc sv_setpv_mg
3892 Like C<sv_setpv>, but also handles 'set' magic.
3898 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3905 =for apidoc sv_usepvn_flags
3907 Tells an SV to use C<ptr> to find its string value. Normally the
3908 string is stored inside the SV but sv_usepvn allows the SV to use an
3909 outside string. The C<ptr> should point to memory that was allocated
3910 by C<malloc>. The string length, C<len>, must be supplied. By default
3911 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3912 so that pointer should not be freed or used by the programmer after
3913 giving it to sv_usepvn, and neither should any pointers from "behind"
3914 that pointer (e.g. ptr + 1) be used.
3916 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3917 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3918 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3919 C<len>, and already meets the requirements for storing in C<SvPVX>)
3925 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3929 SV_CHECK_THINKFIRST_COW_DROP(sv);
3930 SvUPGRADE(sv, SVt_PV);
3933 if (flags & SV_SMAGIC)
3937 if (SvPVX_const(sv))
3940 if (flags & SV_HAS_TRAILING_NUL)
3941 assert(ptr[len] == '\0');
3943 allocate = (flags & SV_HAS_TRAILING_NUL)
3944 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3945 if (flags & SV_HAS_TRAILING_NUL) {
3946 /* It's long enough - do nothing.
3947 Specfically Perl_newCONSTSUB is relying on this. */
3950 /* Force a move to shake out bugs in callers. */
3951 char *new_ptr = safemalloc(allocate);
3952 Copy(ptr, new_ptr, len, char);
3953 PoisonFree(ptr,len,char);
3957 ptr = saferealloc (ptr, allocate);
3962 SvLEN_set(sv, allocate);
3963 if (!(flags & SV_HAS_TRAILING_NUL)) {
3966 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3968 if (flags & SV_SMAGIC)
3972 #ifdef PERL_OLD_COPY_ON_WRITE
3973 /* Need to do this *after* making the SV normal, as we need the buffer
3974 pointer to remain valid until after we've copied it. If we let go too early,
3975 another thread could invalidate it by unsharing last of the same hash key
3976 (which it can do by means other than releasing copy-on-write Svs)
3977 or by changing the other copy-on-write SVs in the loop. */
3979 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3981 if (len) { /* this SV was SvIsCOW_normal(sv) */
3982 /* we need to find the SV pointing to us. */
3983 SV *current = SV_COW_NEXT_SV(after);
3985 if (current == sv) {
3986 /* The SV we point to points back to us (there were only two of us
3988 Hence other SV is no longer copy on write either. */
3990 SvREADONLY_off(after);
3992 /* We need to follow the pointers around the loop. */
3994 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3997 /* don't loop forever if the structure is bust, and we have
3998 a pointer into a closed loop. */
3999 assert (current != after);
4000 assert (SvPVX_const(current) == pvx);
4002 /* Make the SV before us point to the SV after us. */
4003 SV_COW_NEXT_SV_SET(current, after);
4006 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4011 Perl_sv_release_IVX(pTHX_ register SV *sv)
4014 sv_force_normal_flags(sv, 0);
4020 =for apidoc sv_force_normal_flags
4022 Undo various types of fakery on an SV: if the PV is a shared string, make
4023 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4024 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4025 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4026 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4027 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4028 set to some other value.) In addition, the C<flags> parameter gets passed to
4029 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4030 with flags set to 0.
4036 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4039 #ifdef PERL_OLD_COPY_ON_WRITE
4040 if (SvREADONLY(sv)) {
4041 /* At this point I believe I should acquire a global SV mutex. */
4043 const char * const pvx = SvPVX_const(sv);
4044 const STRLEN len = SvLEN(sv);
4045 const STRLEN cur = SvCUR(sv);
4046 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4048 PerlIO_printf(Perl_debug_log,
4049 "Copy on write: Force normal %ld\n",
4055 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4058 if (flags & SV_COW_DROP_PV) {
4059 /* OK, so we don't need to copy our buffer. */
4062 SvGROW(sv, cur + 1);
4063 Move(pvx,SvPVX(sv),cur,char);
4067 sv_release_COW(sv, pvx, len, next);
4072 else if (IN_PERL_RUNTIME)
4073 Perl_croak(aTHX_ PL_no_modify);
4074 /* At this point I believe that I can drop the global SV mutex. */
4077 if (SvREADONLY(sv)) {
4079 const char * const pvx = SvPVX_const(sv);
4080 const STRLEN len = SvCUR(sv);
4085 SvGROW(sv, len + 1);
4086 Move(pvx,SvPVX(sv),len,char);
4088 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4090 else if (IN_PERL_RUNTIME)
4091 Perl_croak(aTHX_ PL_no_modify);
4095 sv_unref_flags(sv, flags);
4096 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4103 Efficient removal of characters from the beginning of the string buffer.
4104 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4105 the string buffer. The C<ptr> becomes the first character of the adjusted
4106 string. Uses the "OOK hack".
4107 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4108 refer to the same chunk of data.
4114 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4116 register STRLEN delta;
4117 if (!ptr || !SvPOKp(sv))
4119 delta = ptr - SvPVX_const(sv);
4120 SV_CHECK_THINKFIRST(sv);
4121 if (SvTYPE(sv) < SVt_PVIV)
4122 sv_upgrade(sv,SVt_PVIV);
4125 if (!SvLEN(sv)) { /* make copy of shared string */
4126 const char *pvx = SvPVX_const(sv);
4127 const STRLEN len = SvCUR(sv);
4128 SvGROW(sv, len + 1);
4129 Move(pvx,SvPVX(sv),len,char);
4133 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4134 and we do that anyway inside the SvNIOK_off
4136 SvFLAGS(sv) |= SVf_OOK;
4139 SvLEN_set(sv, SvLEN(sv) - delta);
4140 SvCUR_set(sv, SvCUR(sv) - delta);
4141 SvPV_set(sv, SvPVX(sv) + delta);
4142 SvIV_set(sv, SvIVX(sv) + delta);
4146 =for apidoc sv_catpvn
4148 Concatenates the string onto the end of the string which is in the SV. The
4149 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4150 status set, then the bytes appended should be valid UTF-8.
4151 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4153 =for apidoc sv_catpvn_flags
4155 Concatenates the string onto the end of the string which is in the SV. The
4156 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4157 status set, then the bytes appended should be valid UTF-8.
4158 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4159 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4160 in terms of this function.
4166 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4170 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4172 SvGROW(dsv, dlen + slen + 1);
4174 sstr = SvPVX_const(dsv);
4175 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4176 SvCUR_set(dsv, SvCUR(dsv) + slen);
4178 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4180 if (flags & SV_SMAGIC)
4185 =for apidoc sv_catsv
4187 Concatenates the string from SV C<ssv> onto the end of the string in
4188 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4189 not 'set' magic. See C<sv_catsv_mg>.
4191 =for apidoc sv_catsv_flags
4193 Concatenates the string from SV C<ssv> onto the end of the string in
4194 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4195 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4196 and C<sv_catsv_nomg> are implemented in terms of this function.
4201 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4206 const char *spv = SvPV_const(ssv, slen);
4208 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4209 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4210 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4211 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4212 dsv->sv_flags doesn't have that bit set.
4213 Andy Dougherty 12 Oct 2001
4215 const I32 sutf8 = DO_UTF8(ssv);
4218 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4220 dutf8 = DO_UTF8(dsv);
4222 if (dutf8 != sutf8) {
4224 /* Not modifying source SV, so taking a temporary copy. */
4225 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4227 sv_utf8_upgrade(csv);
4228 spv = SvPV_const(csv, slen);
4231 sv_utf8_upgrade_nomg(dsv);
4233 sv_catpvn_nomg(dsv, spv, slen);
4236 if (flags & SV_SMAGIC)
4241 =for apidoc sv_catpv
4243 Concatenates the string onto the end of the string which is in the SV.
4244 If the SV has the UTF-8 status set, then the bytes appended should be
4245 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4250 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4253 register STRLEN len;
4259 junk = SvPV_force(sv, tlen);
4261 SvGROW(sv, tlen + len + 1);
4263 ptr = SvPVX_const(sv);
4264 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4265 SvCUR_set(sv, SvCUR(sv) + len);
4266 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4271 =for apidoc sv_catpv_mg
4273 Like C<sv_catpv>, but also handles 'set' magic.
4279 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4288 Creates a new SV. A non-zero C<len> parameter indicates the number of
4289 bytes of preallocated string space the SV should have. An extra byte for a
4290 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4291 space is allocated.) The reference count for the new SV is set to 1.
4293 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4294 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4295 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4296 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4297 modules supporting older perls.
4303 Perl_newSV(pTHX_ STRLEN len)
4310 sv_upgrade(sv, SVt_PV);
4311 SvGROW(sv, len + 1);
4316 =for apidoc sv_magicext
4318 Adds magic to an SV, upgrading it if necessary. Applies the
4319 supplied vtable and returns a pointer to the magic added.
4321 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4322 In particular, you can add magic to SvREADONLY SVs, and add more than
4323 one instance of the same 'how'.
4325 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4326 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4327 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4328 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4330 (This is now used as a subroutine by C<sv_magic>.)
4335 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4336 const char* name, I32 namlen)
4341 if (SvTYPE(sv) < SVt_PVMG) {
4342 SvUPGRADE(sv, SVt_PVMG);
4344 Newxz(mg, 1, MAGIC);
4345 mg->mg_moremagic = SvMAGIC(sv);
4346 SvMAGIC_set(sv, mg);
4348 /* Sometimes a magic contains a reference loop, where the sv and
4349 object refer to each other. To prevent a reference loop that
4350 would prevent such objects being freed, we look for such loops
4351 and if we find one we avoid incrementing the object refcount.
4353 Note we cannot do this to avoid self-tie loops as intervening RV must
4354 have its REFCNT incremented to keep it in existence.
4357 if (!obj || obj == sv ||
4358 how == PERL_MAGIC_arylen ||
4359 how == PERL_MAGIC_qr ||
4360 how == PERL_MAGIC_symtab ||
4361 (SvTYPE(obj) == SVt_PVGV &&
4362 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4363 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4364 GvFORM(obj) == (CV*)sv)))
4369 mg->mg_obj = SvREFCNT_inc_simple(obj);
4370 mg->mg_flags |= MGf_REFCOUNTED;
4373 /* Normal self-ties simply pass a null object, and instead of
4374 using mg_obj directly, use the SvTIED_obj macro to produce a
4375 new RV as needed. For glob "self-ties", we are tieing the PVIO
4376 with an RV obj pointing to the glob containing the PVIO. In
4377 this case, to avoid a reference loop, we need to weaken the
4381 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4382 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4388 mg->mg_len = namlen;
4391 mg->mg_ptr = savepvn(name, namlen);
4392 else if (namlen == HEf_SVKEY)
4393 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4395 mg->mg_ptr = (char *) name;
4397 mg->mg_virtual = vtable;
4401 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4406 =for apidoc sv_magic
4408 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4409 then adds a new magic item of type C<how> to the head of the magic list.
4411 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4412 handling of the C<name> and C<namlen> arguments.
4414 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4415 to add more than one instance of the same 'how'.
4421 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4427 #ifdef PERL_OLD_COPY_ON_WRITE
4429 sv_force_normal_flags(sv, 0);
4431 if (SvREADONLY(sv)) {
4433 /* its okay to attach magic to shared strings; the subsequent
4434 * upgrade to PVMG will unshare the string */
4435 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4438 && how != PERL_MAGIC_regex_global
4439 && how != PERL_MAGIC_bm
4440 && how != PERL_MAGIC_fm
4441 && how != PERL_MAGIC_sv
4442 && how != PERL_MAGIC_backref
4445 Perl_croak(aTHX_ PL_no_modify);
4448 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4449 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4450 /* sv_magic() refuses to add a magic of the same 'how' as an
4453 if (how == PERL_MAGIC_taint) {
4455 /* Any scalar which already had taint magic on which someone
4456 (erroneously?) did SvIOK_on() or similar will now be
4457 incorrectly sporting public "OK" flags. */
4458 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4466 vtable = &PL_vtbl_sv;
4468 case PERL_MAGIC_overload:
4469 vtable = &PL_vtbl_amagic;
4471 case PERL_MAGIC_overload_elem:
4472 vtable = &PL_vtbl_amagicelem;
4474 case PERL_MAGIC_overload_table:
4475 vtable = &PL_vtbl_ovrld;
4478 vtable = &PL_vtbl_bm;
4480 case PERL_MAGIC_regdata:
4481 vtable = &PL_vtbl_regdata;
4483 case PERL_MAGIC_regdatum:
4484 vtable = &PL_vtbl_regdatum;
4486 case PERL_MAGIC_env:
4487 vtable = &PL_vtbl_env;
4490 vtable = &PL_vtbl_fm;
4492 case PERL_MAGIC_envelem:
4493 vtable = &PL_vtbl_envelem;
4495 case PERL_MAGIC_regex_global:
4496 vtable = &PL_vtbl_mglob;
4498 case PERL_MAGIC_isa:
4499 vtable = &PL_vtbl_isa;
4501 case PERL_MAGIC_isaelem:
4502 vtable = &PL_vtbl_isaelem;
4504 case PERL_MAGIC_nkeys:
4505 vtable = &PL_vtbl_nkeys;
4507 case PERL_MAGIC_dbfile:
4510 case PERL_MAGIC_dbline:
4511 vtable = &PL_vtbl_dbline;
4513 #ifdef USE_LOCALE_COLLATE
4514 case PERL_MAGIC_collxfrm:
4515 vtable = &PL_vtbl_collxfrm;
4517 #endif /* USE_LOCALE_COLLATE */
4518 case PERL_MAGIC_tied:
4519 vtable = &PL_vtbl_pack;
4521 case PERL_MAGIC_tiedelem:
4522 case PERL_MAGIC_tiedscalar:
4523 vtable = &PL_vtbl_packelem;
4526 vtable = &PL_vtbl_regexp;
4528 case PERL_MAGIC_hints:
4529 /* As this vtable is all NULL, we can reuse it. */
4530 case PERL_MAGIC_sig:
4531 vtable = &PL_vtbl_sig;
4533 case PERL_MAGIC_sigelem:
4534 vtable = &PL_vtbl_sigelem;
4536 case PERL_MAGIC_taint:
4537 vtable = &PL_vtbl_taint;
4539 case PERL_MAGIC_uvar:
4540 vtable = &PL_vtbl_uvar;
4542 case PERL_MAGIC_vec:
4543 vtable = &PL_vtbl_vec;
4545 case PERL_MAGIC_arylen_p:
4546 case PERL_MAGIC_rhash:
4547 case PERL_MAGIC_symtab:
4548 case PERL_MAGIC_vstring:
4551 case PERL_MAGIC_utf8:
4552 vtable = &PL_vtbl_utf8;
4554 case PERL_MAGIC_substr:
4555 vtable = &PL_vtbl_substr;
4557 case PERL_MAGIC_defelem:
4558 vtable = &PL_vtbl_defelem;
4560 case PERL_MAGIC_arylen:
4561 vtable = &PL_vtbl_arylen;
4563 case PERL_MAGIC_pos:
4564 vtable = &PL_vtbl_pos;
4566 case PERL_MAGIC_backref:
4567 vtable = &PL_vtbl_backref;
4569 case PERL_MAGIC_hintselem:
4570 vtable = &PL_vtbl_hintselem;
4572 case PERL_MAGIC_ext:
4573 /* Reserved for use by extensions not perl internals. */
4574 /* Useful for attaching extension internal data to perl vars. */
4575 /* Note that multiple extensions may clash if magical scalars */
4576 /* etc holding private data from one are passed to another. */
4580 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4583 /* Rest of work is done else where */
4584 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4587 case PERL_MAGIC_taint:
4590 case PERL_MAGIC_ext:
4591 case PERL_MAGIC_dbfile:
4598 =for apidoc sv_unmagic
4600 Removes all magic of type C<type> from an SV.
4606 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4610 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4612 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4613 for (mg = *mgp; mg; mg = *mgp) {
4614 if (mg->mg_type == type) {
4615 const MGVTBL* const vtbl = mg->mg_virtual;
4616 *mgp = mg->mg_moremagic;
4617 if (vtbl && vtbl->svt_free)
4618 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4619 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4621 Safefree(mg->mg_ptr);
4622 else if (mg->mg_len == HEf_SVKEY)
4623 SvREFCNT_dec((SV*)mg->mg_ptr);
4624 else if (mg->mg_type == PERL_MAGIC_utf8)
4625 Safefree(mg->mg_ptr);
4627 if (mg->mg_flags & MGf_REFCOUNTED)
4628 SvREFCNT_dec(mg->mg_obj);
4632 mgp = &mg->mg_moremagic;
4636 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4637 SvMAGIC_set(sv, NULL);
4644 =for apidoc sv_rvweaken
4646 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4647 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4648 push a back-reference to this RV onto the array of backreferences
4649 associated with that magic.
4655 Perl_sv_rvweaken(pTHX_ SV *sv)
4658 if (!SvOK(sv)) /* let undefs pass */
4661 Perl_croak(aTHX_ "Can't weaken a nonreference");
4662 else if (SvWEAKREF(sv)) {
4663 if (ckWARN(WARN_MISC))
4664 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4668 Perl_sv_add_backref(aTHX_ tsv, sv);
4674 /* Give tsv backref magic if it hasn't already got it, then push a
4675 * back-reference to sv onto the array associated with the backref magic.
4679 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4684 if (SvTYPE(tsv) == SVt_PVHV) {
4685 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4689 /* There is no AV in the offical place - try a fixup. */
4690 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4693 /* Aha. They've got it stowed in magic. Bring it back. */
4694 av = (AV*)mg->mg_obj;
4695 /* Stop mg_free decreasing the refernce count. */
4697 /* Stop mg_free even calling the destructor, given that
4698 there's no AV to free up. */
4700 sv_unmagic(tsv, PERL_MAGIC_backref);
4704 SvREFCNT_inc_simple_void(av);
4709 const MAGIC *const mg
4710 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4712 av = (AV*)mg->mg_obj;
4716 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4717 /* av now has a refcnt of 2, which avoids it getting freed
4718 * before us during global cleanup. The extra ref is removed
4719 * by magic_killbackrefs() when tsv is being freed */
4722 if (AvFILLp(av) >= AvMAX(av)) {
4723 av_extend(av, AvFILLp(av)+1);
4725 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4728 /* delete a back-reference to ourselves from the backref magic associated
4729 * with the SV we point to.
4733 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4740 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4741 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4742 /* We mustn't attempt to "fix up" the hash here by moving the
4743 backreference array back to the hv_aux structure, as that is stored
4744 in the main HvARRAY(), and hfreentries assumes that no-one
4745 reallocates HvARRAY() while it is running. */
4748 const MAGIC *const mg
4749 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4751 av = (AV *)mg->mg_obj;
4754 if (PL_in_clean_all)
4756 Perl_croak(aTHX_ "panic: del_backref");
4763 /* We shouldn't be in here more than once, but for paranoia reasons lets
4765 for (i = AvFILLp(av); i >= 0; i--) {
4767 const SSize_t fill = AvFILLp(av);
4769 /* We weren't the last entry.
4770 An unordered list has this property that you can take the
4771 last element off the end to fill the hole, and it's still
4772 an unordered list :-)
4777 AvFILLp(av) = fill - 1;
4783 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4785 SV **svp = AvARRAY(av);
4787 PERL_UNUSED_ARG(sv);
4789 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4790 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4791 if (svp && !SvIS_FREED(av)) {
4792 SV *const *const last = svp + AvFILLp(av);
4794 while (svp <= last) {
4796 SV *const referrer = *svp;
4797 if (SvWEAKREF(referrer)) {
4798 /* XXX Should we check that it hasn't changed? */
4799 SvRV_set(referrer, 0);
4801 SvWEAKREF_off(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;
9027 p = (char*)((c == 'X')
9028 ? "0123456789ABCDEF" : "0123456789abcdef");
9034 esignbuf[esignlen++] = '0';
9035 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9043 if (alt && *ptr != '0')
9054 esignbuf[esignlen++] = '0';
9055 esignbuf[esignlen++] = 'b';
9058 default: /* it had better be ten or less */
9062 } while (uv /= base);
9065 elen = (ebuf + sizeof ebuf) - ptr;
9069 zeros = precis - elen;
9070 else if (precis == 0 && elen == 1 && *eptr == '0')
9076 /* FLOATING POINT */
9079 c = 'f'; /* maybe %F isn't supported here */
9087 /* This is evil, but floating point is even more evil */
9089 /* for SV-style calling, we can only get NV
9090 for C-style calling, we assume %f is double;
9091 for simplicity we allow any of %Lf, %llf, %qf for long double
9095 #if defined(USE_LONG_DOUBLE)
9099 /* [perl #20339] - we should accept and ignore %lf rather than die */
9103 #if defined(USE_LONG_DOUBLE)
9104 intsize = args ? 0 : 'q';
9108 #if defined(HAS_LONG_DOUBLE)
9117 /* now we need (long double) if intsize == 'q', else (double) */
9119 #if LONG_DOUBLESIZE > DOUBLESIZE
9121 va_arg(*args, long double) :
9122 va_arg(*args, double)
9124 va_arg(*args, double)
9129 if (c != 'e' && c != 'E') {
9131 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9132 will cast our (long double) to (double) */
9133 (void)Perl_frexp(nv, &i);
9134 if (i == PERL_INT_MIN)
9135 Perl_die(aTHX_ "panic: frexp");
9137 need = BIT_DIGITS(i);
9139 need += has_precis ? precis : 6; /* known default */
9144 #ifdef HAS_LDBL_SPRINTF_BUG
9145 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9146 with sfio - Allen <allens@cpan.org> */
9149 # define MY_DBL_MAX DBL_MAX
9150 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9151 # if DOUBLESIZE >= 8
9152 # define MY_DBL_MAX 1.7976931348623157E+308L
9154 # define MY_DBL_MAX 3.40282347E+38L
9158 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9159 # define MY_DBL_MAX_BUG 1L
9161 # define MY_DBL_MAX_BUG MY_DBL_MAX
9165 # define MY_DBL_MIN DBL_MIN
9166 # else /* XXX guessing! -Allen */
9167 # if DOUBLESIZE >= 8
9168 # define MY_DBL_MIN 2.2250738585072014E-308L
9170 # define MY_DBL_MIN 1.17549435E-38L
9174 if ((intsize == 'q') && (c == 'f') &&
9175 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9177 /* it's going to be short enough that
9178 * long double precision is not needed */
9180 if ((nv <= 0L) && (nv >= -0L))
9181 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9183 /* would use Perl_fp_class as a double-check but not
9184 * functional on IRIX - see perl.h comments */
9186 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9187 /* It's within the range that a double can represent */
9188 #if defined(DBL_MAX) && !defined(DBL_MIN)
9189 if ((nv >= ((long double)1/DBL_MAX)) ||
9190 (nv <= (-(long double)1/DBL_MAX)))
9192 fix_ldbl_sprintf_bug = TRUE;
9195 if (fix_ldbl_sprintf_bug == TRUE) {
9205 # undef MY_DBL_MAX_BUG
9208 #endif /* HAS_LDBL_SPRINTF_BUG */
9210 need += 20; /* fudge factor */
9211 if (PL_efloatsize < need) {
9212 Safefree(PL_efloatbuf);
9213 PL_efloatsize = need + 20; /* more fudge */
9214 Newx(PL_efloatbuf, PL_efloatsize, char);
9215 PL_efloatbuf[0] = '\0';
9218 if ( !(width || left || plus || alt) && fill != '0'
9219 && has_precis && intsize != 'q' ) { /* Shortcuts */
9220 /* See earlier comment about buggy Gconvert when digits,
9222 if ( c == 'g' && precis) {
9223 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9224 /* May return an empty string for digits==0 */
9225 if (*PL_efloatbuf) {
9226 elen = strlen(PL_efloatbuf);
9227 goto float_converted;
9229 } else if ( c == 'f' && !precis) {
9230 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9235 char *ptr = ebuf + sizeof ebuf;
9238 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9239 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9240 if (intsize == 'q') {
9241 /* Copy the one or more characters in a long double
9242 * format before the 'base' ([efgEFG]) character to
9243 * the format string. */
9244 static char const prifldbl[] = PERL_PRIfldbl;
9245 char const *p = prifldbl + sizeof(prifldbl) - 3;
9246 while (p >= prifldbl) { *--ptr = *p--; }
9251 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9256 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9268 /* No taint. Otherwise we are in the strange situation
9269 * where printf() taints but print($float) doesn't.
9271 #if defined(HAS_LONG_DOUBLE)
9272 elen = ((intsize == 'q')
9273 # ifdef USE_SNPRINTF
9274 ? snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9275 : snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9277 ? my_sprintf(PL_efloatbuf, ptr, nv)
9278 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9279 # endif /* #ifdef USE_SNPRINTF */
9281 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9285 eptr = PL_efloatbuf;
9293 i = SvCUR(sv) - origlen;
9296 case 'h': *(va_arg(*args, short*)) = i; break;
9297 default: *(va_arg(*args, int*)) = i; break;
9298 case 'l': *(va_arg(*args, long*)) = i; break;
9299 case 'V': *(va_arg(*args, IV*)) = i; break;
9301 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9306 sv_setuv_mg(argsv, (UV)i);
9307 continue; /* not "break" */
9314 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9315 && ckWARN(WARN_PRINTF))
9317 SV * const msg = sv_newmortal();
9318 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9319 (PL_op->op_type == OP_PRTF) ? "" : "s");
9322 Perl_sv_catpvf(aTHX_ msg,
9323 "\"%%%c\"", c & 0xFF);
9325 Perl_sv_catpvf(aTHX_ msg,
9326 "\"%%\\%03"UVof"\"",
9329 sv_catpvs(msg, "end of string");
9330 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9333 /* output mangled stuff ... */
9339 /* ... right here, because formatting flags should not apply */
9340 SvGROW(sv, SvCUR(sv) + elen + 1);
9342 Copy(eptr, p, elen, char);
9345 SvCUR_set(sv, p - SvPVX_const(sv));
9347 continue; /* not "break" */
9350 /* calculate width before utf8_upgrade changes it */
9351 have = esignlen + zeros + elen;
9353 Perl_croak_nocontext(PL_memory_wrap);
9355 if (is_utf8 != has_utf8) {
9358 sv_utf8_upgrade(sv);
9361 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9362 sv_utf8_upgrade(nsv);
9363 eptr = SvPVX_const(nsv);
9366 SvGROW(sv, SvCUR(sv) + elen + 1);
9371 need = (have > width ? have : width);
9374 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9375 Perl_croak_nocontext(PL_memory_wrap);
9376 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9378 if (esignlen && fill == '0') {
9380 for (i = 0; i < (int)esignlen; i++)
9384 memset(p, fill, gap);
9387 if (esignlen && fill != '0') {
9389 for (i = 0; i < (int)esignlen; i++)
9394 for (i = zeros; i; i--)
9398 Copy(eptr, p, elen, char);
9402 memset(p, ' ', gap);
9407 Copy(dotstr, p, dotstrlen, char);
9411 vectorize = FALSE; /* done iterating over vecstr */
9418 SvCUR_set(sv, p - SvPVX_const(sv));
9426 /* =========================================================================
9428 =head1 Cloning an interpreter
9430 All the macros and functions in this section are for the private use of
9431 the main function, perl_clone().
9433 The foo_dup() functions make an exact copy of an existing foo thinngy.
9434 During the course of a cloning, a hash table is used to map old addresses
9435 to new addresses. The table is created and manipulated with the
9436 ptr_table_* functions.
9440 ============================================================================*/
9443 #if defined(USE_ITHREADS)
9445 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9446 #ifndef GpREFCNT_inc
9447 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9451 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9452 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9453 please unmerge ss_dup. */
9454 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9455 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9456 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9457 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9459 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9461 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9463 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9465 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9466 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9467 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9470 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9471 regcomp.c. AMS 20010712 */
9474 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9479 struct reg_substr_datum *s;
9482 return (REGEXP *)NULL;
9484 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9487 len = r->offsets[0];
9488 npar = r->nparens+1;
9490 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9491 Copy(r->program, ret->program, len+1, regnode);
9493 Newx(ret->startp, npar, I32);
9494 Copy(r->startp, ret->startp, npar, I32);
9495 Newx(ret->endp, npar, I32);
9496 Copy(r->startp, ret->startp, npar, I32);
9498 Newx(ret->substrs, 1, struct reg_substr_data);
9499 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9500 s->min_offset = r->substrs->data[i].min_offset;
9501 s->max_offset = r->substrs->data[i].max_offset;
9502 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9503 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9506 ret->regstclass = NULL;
9509 const int count = r->data->count;
9512 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9513 char, struct reg_data);
9514 Newx(d->what, count, U8);
9517 for (i = 0; i < count; i++) {
9518 d->what[i] = r->data->what[i];
9519 switch (d->what[i]) {
9520 /* legal options are one of: sfpont
9521 see also regcomp.h and pregfree() */
9523 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9526 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9529 /* This is cheating. */
9530 Newx(d->data[i], 1, struct regnode_charclass_class);
9531 StructCopy(r->data->data[i], d->data[i],
9532 struct regnode_charclass_class);
9533 ret->regstclass = (regnode*)d->data[i];
9536 /* Compiled op trees are readonly, and can thus be
9537 shared without duplication. */
9539 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9543 d->data[i] = r->data->data[i];
9546 d->data[i] = r->data->data[i];
9548 ((reg_trie_data*)d->data[i])->refcount++;
9552 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9561 Newx(ret->offsets, 2*len+1, U32);
9562 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9564 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9565 ret->refcnt = r->refcnt;
9566 ret->minlen = r->minlen;
9567 ret->prelen = r->prelen;
9568 ret->nparens = r->nparens;
9569 ret->lastparen = r->lastparen;
9570 ret->lastcloseparen = r->lastcloseparen;
9571 ret->reganch = r->reganch;
9573 ret->sublen = r->sublen;
9575 if (RX_MATCH_COPIED(ret))
9576 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9579 #ifdef PERL_OLD_COPY_ON_WRITE
9580 ret->saved_copy = NULL;
9583 ptr_table_store(PL_ptr_table, r, ret);
9587 /* duplicate a file handle */
9590 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9594 PERL_UNUSED_ARG(type);
9597 return (PerlIO*)NULL;
9599 /* look for it in the table first */
9600 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9604 /* create anew and remember what it is */
9605 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9606 ptr_table_store(PL_ptr_table, fp, ret);
9610 /* duplicate a directory handle */
9613 Perl_dirp_dup(pTHX_ DIR *dp)
9615 PERL_UNUSED_CONTEXT;
9622 /* duplicate a typeglob */
9625 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9631 /* look for it in the table first */
9632 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9636 /* create anew and remember what it is */
9638 ptr_table_store(PL_ptr_table, gp, ret);
9641 ret->gp_refcnt = 0; /* must be before any other dups! */
9642 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9643 ret->gp_io = io_dup_inc(gp->gp_io, param);
9644 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9645 ret->gp_av = av_dup_inc(gp->gp_av, param);
9646 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9647 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9648 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9649 ret->gp_cvgen = gp->gp_cvgen;
9650 ret->gp_line = gp->gp_line;
9651 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9655 /* duplicate a chain of magic */
9658 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9660 MAGIC *mgprev = (MAGIC*)NULL;
9663 return (MAGIC*)NULL;
9664 /* look for it in the table first */
9665 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9669 for (; mg; mg = mg->mg_moremagic) {
9671 Newxz(nmg, 1, MAGIC);
9673 mgprev->mg_moremagic = nmg;
9676 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9677 nmg->mg_private = mg->mg_private;
9678 nmg->mg_type = mg->mg_type;
9679 nmg->mg_flags = mg->mg_flags;
9680 if (mg->mg_type == PERL_MAGIC_qr) {
9681 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9683 else if(mg->mg_type == PERL_MAGIC_backref) {
9684 /* The backref AV has its reference count deliberately bumped by
9686 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9688 else if (mg->mg_type == PERL_MAGIC_symtab) {
9689 nmg->mg_obj = mg->mg_obj;
9692 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9693 ? sv_dup_inc(mg->mg_obj, param)
9694 : sv_dup(mg->mg_obj, param);
9696 nmg->mg_len = mg->mg_len;
9697 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9698 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9699 if (mg->mg_len > 0) {
9700 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9701 if (mg->mg_type == PERL_MAGIC_overload_table &&
9702 AMT_AMAGIC((AMT*)mg->mg_ptr))
9704 const AMT * const amtp = (AMT*)mg->mg_ptr;
9705 AMT * const namtp = (AMT*)nmg->mg_ptr;
9707 for (i = 1; i < NofAMmeth; i++) {
9708 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9712 else if (mg->mg_len == HEf_SVKEY)
9713 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9715 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9716 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9723 /* create a new pointer-mapping table */
9726 Perl_ptr_table_new(pTHX)
9729 PERL_UNUSED_CONTEXT;
9731 Newxz(tbl, 1, PTR_TBL_t);
9734 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9738 #define PTR_TABLE_HASH(ptr) \
9739 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9742 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9743 following define) and at call to new_body_inline made below in
9744 Perl_ptr_table_store()
9747 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9749 /* map an existing pointer using a table */
9751 STATIC PTR_TBL_ENT_t *
9752 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9753 PTR_TBL_ENT_t *tblent;
9754 const UV hash = PTR_TABLE_HASH(sv);
9756 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9757 for (; tblent; tblent = tblent->next) {
9758 if (tblent->oldval == sv)
9765 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9767 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9768 PERL_UNUSED_CONTEXT;
9769 return tblent ? tblent->newval : NULL;
9772 /* add a new entry to a pointer-mapping table */
9775 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9777 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9778 PERL_UNUSED_CONTEXT;
9781 tblent->newval = newsv;
9783 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9785 new_body_inline(tblent, PTE_SVSLOT);
9787 tblent->oldval = oldsv;
9788 tblent->newval = newsv;
9789 tblent->next = tbl->tbl_ary[entry];
9790 tbl->tbl_ary[entry] = tblent;
9792 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9793 ptr_table_split(tbl);
9797 /* double the hash bucket size of an existing ptr table */
9800 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9802 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9803 const UV oldsize = tbl->tbl_max + 1;
9804 UV newsize = oldsize * 2;
9806 PERL_UNUSED_CONTEXT;
9808 Renew(ary, newsize, PTR_TBL_ENT_t*);
9809 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9810 tbl->tbl_max = --newsize;
9812 for (i=0; i < oldsize; i++, ary++) {
9813 PTR_TBL_ENT_t **curentp, **entp, *ent;
9816 curentp = ary + oldsize;
9817 for (entp = ary, ent = *ary; ent; ent = *entp) {
9818 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9820 ent->next = *curentp;
9830 /* remove all the entries from a ptr table */
9833 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9835 if (tbl && tbl->tbl_items) {
9836 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9837 UV riter = tbl->tbl_max;
9840 PTR_TBL_ENT_t *entry = array[riter];
9843 PTR_TBL_ENT_t * const oentry = entry;
9844 entry = entry->next;
9853 /* clear and free a ptr table */
9856 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9861 ptr_table_clear(tbl);
9862 Safefree(tbl->tbl_ary);
9868 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9871 SvRV_set(dstr, SvWEAKREF(sstr)
9872 ? sv_dup(SvRV(sstr), param)
9873 : sv_dup_inc(SvRV(sstr), param));
9876 else if (SvPVX_const(sstr)) {
9877 /* Has something there */
9879 /* Normal PV - clone whole allocated space */
9880 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9881 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9882 /* Not that normal - actually sstr is copy on write.
9883 But we are a true, independant SV, so: */
9884 SvREADONLY_off(dstr);
9889 /* Special case - not normally malloced for some reason */
9890 if (isGV_with_GP(sstr)) {
9891 /* Don't need to do anything here. */
9893 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9894 /* A "shared" PV - clone it as "shared" PV */
9896 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9900 /* Some other special case - random pointer */
9901 SvPV_set(dstr, SvPVX(sstr));
9907 if (SvTYPE(dstr) == SVt_RV)
9908 SvRV_set(dstr, NULL);
9910 SvPV_set(dstr, NULL);
9914 /* duplicate an SV of any type (including AV, HV etc) */
9917 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9922 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9924 /* look for it in the table first */
9925 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9929 if(param->flags & CLONEf_JOIN_IN) {
9930 /** We are joining here so we don't want do clone
9931 something that is bad **/
9932 if (SvTYPE(sstr) == SVt_PVHV) {
9933 const char * const hvname = HvNAME_get(sstr);
9935 /** don't clone stashes if they already exist **/
9936 return (SV*)gv_stashpv(hvname,0);
9940 /* create anew and remember what it is */
9943 #ifdef DEBUG_LEAKING_SCALARS
9944 dstr->sv_debug_optype = sstr->sv_debug_optype;
9945 dstr->sv_debug_line = sstr->sv_debug_line;
9946 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9947 dstr->sv_debug_cloned = 1;
9948 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9951 ptr_table_store(PL_ptr_table, sstr, dstr);
9954 SvFLAGS(dstr) = SvFLAGS(sstr);
9955 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9956 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9959 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9960 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9961 PL_watch_pvx, SvPVX_const(sstr));
9964 /* don't clone objects whose class has asked us not to */
9965 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9966 SvFLAGS(dstr) &= ~SVTYPEMASK;
9971 switch (SvTYPE(sstr)) {
9976 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9977 SvIV_set(dstr, SvIVX(sstr));
9980 SvANY(dstr) = new_XNV();
9981 SvNV_set(dstr, SvNVX(sstr));
9984 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9985 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9989 /* These are all the types that need complex bodies allocating. */
9991 const svtype sv_type = SvTYPE(sstr);
9992 const struct body_details *const sv_type_details
9993 = bodies_by_type + sv_type;
9997 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10001 if (GvUNIQUE((GV*)sstr)) {
10002 NOOP; /* Do sharing here, and fall through */
10015 assert(sv_type_details->body_size);
10016 if (sv_type_details->arena) {
10017 new_body_inline(new_body, sv_type);
10019 = (void*)((char*)new_body - sv_type_details->offset);
10021 new_body = new_NOARENA(sv_type_details);
10025 SvANY(dstr) = new_body;
10028 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10029 ((char*)SvANY(dstr)) + sv_type_details->offset,
10030 sv_type_details->copy, char);
10032 Copy(((char*)SvANY(sstr)),
10033 ((char*)SvANY(dstr)),
10034 sv_type_details->body_size + sv_type_details->offset, char);
10037 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10038 && !isGV_with_GP(dstr))
10039 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10041 /* The Copy above means that all the source (unduplicated) pointers
10042 are now in the destination. We can check the flags and the
10043 pointers in either, but it's possible that there's less cache
10044 missing by always going for the destination.
10045 FIXME - instrument and check that assumption */
10046 if (sv_type >= SVt_PVMG) {
10047 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10048 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10049 } else if (SvMAGIC(dstr))
10050 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10052 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10055 /* The cast silences a GCC warning about unhandled types. */
10056 switch ((int)sv_type) {
10068 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10069 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10070 LvTARG(dstr) = dstr;
10071 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10072 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10074 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10077 if (GvNAME_HEK(dstr))
10078 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10080 /* Don't call sv_add_backref here as it's going to be created
10081 as part of the magic cloning of the symbol table. */
10082 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10083 if(isGV_with_GP(sstr)) {
10084 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10085 at the point of this comment. */
10086 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10087 (void)GpREFCNT_inc(GvGP(dstr));
10089 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10092 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10093 if (IoOFP(dstr) == IoIFP(sstr))
10094 IoOFP(dstr) = IoIFP(dstr);
10096 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10097 /* PL_rsfp_filters entries have fake IoDIRP() */
10098 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10099 /* I have no idea why fake dirp (rsfps)
10100 should be treated differently but otherwise
10101 we end up with leaks -- sky*/
10102 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10103 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10104 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10106 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10107 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10108 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10109 if (IoDIRP(dstr)) {
10110 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10113 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10116 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10117 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10118 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10121 if (AvARRAY((AV*)sstr)) {
10122 SV **dst_ary, **src_ary;
10123 SSize_t items = AvFILLp((AV*)sstr) + 1;
10125 src_ary = AvARRAY((AV*)sstr);
10126 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10127 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10128 SvPV_set(dstr, (char*)dst_ary);
10129 AvALLOC((AV*)dstr) = dst_ary;
10130 if (AvREAL((AV*)sstr)) {
10131 while (items-- > 0)
10132 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10135 while (items-- > 0)
10136 *dst_ary++ = sv_dup(*src_ary++, param);
10138 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10139 while (items-- > 0) {
10140 *dst_ary++ = &PL_sv_undef;
10144 SvPV_set(dstr, NULL);
10145 AvALLOC((AV*)dstr) = (SV**)NULL;
10150 HEK *hvname = NULL;
10152 if (HvARRAY((HV*)sstr)) {
10154 const bool sharekeys = !!HvSHAREKEYS(sstr);
10155 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10156 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10158 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10159 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10161 HvARRAY(dstr) = (HE**)darray;
10162 while (i <= sxhv->xhv_max) {
10163 const HE *source = HvARRAY(sstr)[i];
10164 HvARRAY(dstr)[i] = source
10165 ? he_dup(source, sharekeys, param) : 0;
10169 struct xpvhv_aux * const saux = HvAUX(sstr);
10170 struct xpvhv_aux * const daux = HvAUX(dstr);
10171 /* This flag isn't copied. */
10172 /* SvOOK_on(hv) attacks the IV flags. */
10173 SvFLAGS(dstr) |= SVf_OOK;
10175 hvname = saux->xhv_name;
10177 = hvname ? hek_dup(hvname, param) : hvname;
10179 daux->xhv_riter = saux->xhv_riter;
10180 daux->xhv_eiter = saux->xhv_eiter
10181 ? he_dup(saux->xhv_eiter,
10182 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10183 daux->xhv_backreferences = saux->xhv_backreferences
10184 ? (AV*) SvREFCNT_inc(
10186 xhv_backreferences,
10192 SvPV_set(dstr, NULL);
10194 /* Record stashes for possible cloning in Perl_clone(). */
10196 av_push(param->stashes, dstr);
10200 if (!(param->flags & CLONEf_COPY_STACKS)) {
10204 /* NOTE: not refcounted */
10205 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10207 if (!CvISXSUB(dstr))
10208 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10210 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10211 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10212 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10213 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10215 /* don't dup if copying back - CvGV isn't refcounted, so the
10216 * duped GV may never be freed. A bit of a hack! DAPM */
10217 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10218 NULL : gv_dup(CvGV(dstr), param) ;
10219 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10221 CvWEAKOUTSIDE(sstr)
10222 ? cv_dup( CvOUTSIDE(dstr), param)
10223 : cv_dup_inc(CvOUTSIDE(dstr), param);
10224 if (!CvISXSUB(dstr))
10225 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10231 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10237 /* duplicate a context */
10240 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10242 PERL_CONTEXT *ncxs;
10245 return (PERL_CONTEXT*)NULL;
10247 /* look for it in the table first */
10248 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10252 /* create anew and remember what it is */
10253 Newxz(ncxs, max + 1, PERL_CONTEXT);
10254 ptr_table_store(PL_ptr_table, cxs, ncxs);
10257 PERL_CONTEXT * const cx = &cxs[ix];
10258 PERL_CONTEXT * const ncx = &ncxs[ix];
10259 ncx->cx_type = cx->cx_type;
10260 if (CxTYPE(cx) == CXt_SUBST) {
10261 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10264 ncx->blk_oldsp = cx->blk_oldsp;
10265 ncx->blk_oldcop = cx->blk_oldcop;
10266 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10267 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10268 ncx->blk_oldpm = cx->blk_oldpm;
10269 ncx->blk_gimme = cx->blk_gimme;
10270 switch (CxTYPE(cx)) {
10272 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10273 ? cv_dup_inc(cx->blk_sub.cv, param)
10274 : cv_dup(cx->blk_sub.cv,param));
10275 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10276 ? av_dup_inc(cx->blk_sub.argarray, param)
10278 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10279 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10280 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10281 ncx->blk_sub.lval = cx->blk_sub.lval;
10282 ncx->blk_sub.retop = cx->blk_sub.retop;
10285 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10286 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10287 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10288 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10289 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10290 ncx->blk_eval.retop = cx->blk_eval.retop;
10293 ncx->blk_loop.label = cx->blk_loop.label;
10294 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10295 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10296 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10297 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10298 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10299 ? cx->blk_loop.iterdata
10300 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10301 ncx->blk_loop.oldcomppad
10302 = (PAD*)ptr_table_fetch(PL_ptr_table,
10303 cx->blk_loop.oldcomppad);
10304 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10305 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10306 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10307 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10308 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10311 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10312 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10313 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10314 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10315 ncx->blk_sub.retop = cx->blk_sub.retop;
10327 /* duplicate a stack info structure */
10330 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10335 return (PERL_SI*)NULL;
10337 /* look for it in the table first */
10338 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10342 /* create anew and remember what it is */
10343 Newxz(nsi, 1, PERL_SI);
10344 ptr_table_store(PL_ptr_table, si, nsi);
10346 nsi->si_stack = av_dup_inc(si->si_stack, param);
10347 nsi->si_cxix = si->si_cxix;
10348 nsi->si_cxmax = si->si_cxmax;
10349 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10350 nsi->si_type = si->si_type;
10351 nsi->si_prev = si_dup(si->si_prev, param);
10352 nsi->si_next = si_dup(si->si_next, param);
10353 nsi->si_markoff = si->si_markoff;
10358 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10359 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10360 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10361 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10362 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10363 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10364 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10365 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10366 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10367 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10368 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10369 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10370 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10371 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10374 #define pv_dup_inc(p) SAVEPV(p)
10375 #define pv_dup(p) SAVEPV(p)
10376 #define svp_dup_inc(p,pp) any_dup(p,pp)
10378 /* map any object to the new equivent - either something in the
10379 * ptr table, or something in the interpreter structure
10383 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10388 return (void*)NULL;
10390 /* look for it in the table first */
10391 ret = ptr_table_fetch(PL_ptr_table, v);
10395 /* see if it is part of the interpreter structure */
10396 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10397 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10405 /* duplicate the save stack */
10408 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10410 ANY * const ss = proto_perl->Tsavestack;
10411 const I32 max = proto_perl->Tsavestack_max;
10412 I32 ix = proto_perl->Tsavestack_ix;
10424 void (*dptr) (void*);
10425 void (*dxptr) (pTHX_ void*);
10427 Newxz(nss, max, ANY);
10430 I32 i = POPINT(ss,ix);
10431 TOPINT(nss,ix) = i;
10433 case SAVEt_ITEM: /* normal string */
10434 case SAVEt_SV: /* scalar reference */
10435 sv = (SV*)POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10437 sv = (SV*)POPPTR(ss,ix);
10438 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10440 case SAVEt_SHARED_PVREF: /* char* in shared space */
10441 c = (char*)POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = savesharedpv(c);
10443 ptr = POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 case SAVEt_GENERIC_SVREF: /* generic sv */
10447 case SAVEt_SVREF: /* scalar reference */
10448 sv = (SV*)POPPTR(ss,ix);
10449 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10453 case SAVEt_HV: /* hash reference */
10454 case SAVEt_AV: /* array reference */
10455 sv = POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10457 gv = (GV*)POPPTR(ss,ix);
10458 TOPPTR(nss,ix) = gv_dup(gv, param);
10460 case SAVEt_INT: /* int reference */
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10463 intval = (int)POPINT(ss,ix);
10464 TOPINT(nss,ix) = intval;
10466 case SAVEt_LONG: /* long reference */
10467 ptr = POPPTR(ss,ix);
10468 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10469 longval = (long)POPLONG(ss,ix);
10470 TOPLONG(nss,ix) = longval;
10472 case SAVEt_I32: /* I32 reference */
10473 case SAVEt_I16: /* I16 reference */
10474 case SAVEt_I8: /* I8 reference */
10475 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10476 ptr = POPPTR(ss,ix);
10477 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10479 TOPINT(nss,ix) = i;
10481 case SAVEt_IV: /* IV reference */
10482 ptr = POPPTR(ss,ix);
10483 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10485 TOPIV(nss,ix) = iv;
10487 case SAVEt_HPTR: /* HV* reference */
10488 case SAVEt_APTR: /* AV* reference */
10489 case SAVEt_SPTR: /* SV* reference */
10490 ptr = POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10492 sv = (SV*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = sv_dup(sv, param);
10495 case SAVEt_VPTR: /* random* reference */
10496 ptr = POPPTR(ss,ix);
10497 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10498 ptr = POPPTR(ss,ix);
10499 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10501 case SAVEt_GENERIC_PVREF: /* generic char* */
10502 case SAVEt_PPTR: /* char* reference */
10503 ptr = POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10505 c = (char*)POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = pv_dup(c);
10509 gv = (GV*)POPPTR(ss,ix);
10510 TOPPTR(nss,ix) = gv_dup(gv, param);
10512 case SAVEt_GP: /* scalar reference */
10513 gp = (GP*)POPPTR(ss,ix);
10514 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10515 (void)GpREFCNT_inc(gp);
10516 gv = (GV*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10518 c = (char*)POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = pv_dup(c);
10521 TOPIV(nss,ix) = iv;
10523 TOPIV(nss,ix) = iv;
10526 case SAVEt_MORTALIZESV:
10527 sv = (SV*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10531 ptr = POPPTR(ss,ix);
10532 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10533 /* these are assumed to be refcounted properly */
10535 switch (((OP*)ptr)->op_type) {
10537 case OP_LEAVESUBLV:
10541 case OP_LEAVEWRITE:
10542 TOPPTR(nss,ix) = ptr;
10547 TOPPTR(nss,ix) = NULL;
10552 TOPPTR(nss,ix) = NULL;
10555 c = (char*)POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = pv_dup_inc(c);
10558 case SAVEt_CLEARSV:
10559 longval = POPLONG(ss,ix);
10560 TOPLONG(nss,ix) = longval;
10563 hv = (HV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10565 c = (char*)POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = pv_dup_inc(c);
10568 TOPINT(nss,ix) = i;
10570 case SAVEt_DESTRUCTOR:
10571 ptr = POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10573 dptr = POPDPTR(ss,ix);
10574 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10575 any_dup(FPTR2DPTR(void *, dptr),
10578 case SAVEt_DESTRUCTOR_X:
10579 ptr = POPPTR(ss,ix);
10580 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10581 dxptr = POPDXPTR(ss,ix);
10582 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10583 any_dup(FPTR2DPTR(void *, dxptr),
10586 case SAVEt_REGCONTEXT:
10589 TOPINT(nss,ix) = i;
10592 case SAVEt_STACK_POS: /* Position on Perl stack */
10594 TOPINT(nss,ix) = i;
10596 case SAVEt_AELEM: /* array element */
10597 sv = (SV*)POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10600 TOPINT(nss,ix) = i;
10601 av = (AV*)POPPTR(ss,ix);
10602 TOPPTR(nss,ix) = av_dup_inc(av, param);
10604 case SAVEt_HELEM: /* hash element */
10605 sv = (SV*)POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10607 sv = (SV*)POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10609 hv = (HV*)POPPTR(ss,ix);
10610 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10613 ptr = POPPTR(ss,ix);
10614 TOPPTR(nss,ix) = ptr;
10618 TOPINT(nss,ix) = i;
10619 ptr = POPPTR(ss,ix);
10622 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10623 HINTS_REFCNT_UNLOCK;
10625 TOPPTR(nss,ix) = ptr;
10626 if (i & HINT_LOCALIZE_HH) {
10627 hv = (HV*)POPPTR(ss,ix);
10628 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10631 case SAVEt_COMPPAD:
10632 av = (AV*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = av_dup(av, param);
10636 longval = (long)POPLONG(ss,ix);
10637 TOPLONG(nss,ix) = longval;
10638 ptr = POPPTR(ss,ix);
10639 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10640 sv = (SV*)POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = sv_dup(sv, param);
10644 ptr = POPPTR(ss,ix);
10645 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10646 longval = (long)POPBOOL(ss,ix);
10647 TOPBOOL(nss,ix) = (bool)longval;
10649 case SAVEt_SET_SVFLAGS:
10651 TOPINT(nss,ix) = i;
10653 TOPINT(nss,ix) = i;
10654 sv = (SV*)POPPTR(ss,ix);
10655 TOPPTR(nss,ix) = sv_dup(sv, param);
10657 case SAVEt_RE_STATE:
10659 const struct re_save_state *const old_state
10660 = (struct re_save_state *)
10661 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10662 struct re_save_state *const new_state
10663 = (struct re_save_state *)
10664 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10666 Copy(old_state, new_state, 1, struct re_save_state);
10667 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10669 new_state->re_state_bostr
10670 = pv_dup(old_state->re_state_bostr);
10671 new_state->re_state_reginput
10672 = pv_dup(old_state->re_state_reginput);
10673 new_state->re_state_regeol
10674 = pv_dup(old_state->re_state_regeol);
10675 new_state->re_state_regstartp
10676 = any_dup(old_state->re_state_regstartp, proto_perl);
10677 new_state->re_state_regendp
10678 = any_dup(old_state->re_state_regendp, proto_perl);
10679 new_state->re_state_reglastparen
10680 = any_dup(old_state->re_state_reglastparen, proto_perl);
10681 new_state->re_state_reglastcloseparen
10682 = any_dup(old_state->re_state_reglastcloseparen,
10684 /* XXX This just has to be broken. The old save_re_context
10685 code did SAVEGENERICPV(PL_reg_start_tmp);
10686 PL_reg_start_tmp is char **.
10687 Look above to what the dup code does for
10688 SAVEt_GENERIC_PVREF
10689 It can never have worked.
10690 So this is merely a faithful copy of the exiting bug: */
10691 new_state->re_state_reg_start_tmp
10692 = (char **) pv_dup((char *)
10693 old_state->re_state_reg_start_tmp);
10694 /* I assume that it only ever "worked" because no-one called
10695 (pseudo)fork while the regexp engine had re-entered itself.
10697 #ifdef PERL_OLD_COPY_ON_WRITE
10698 new_state->re_state_nrs
10699 = sv_dup(old_state->re_state_nrs, param);
10701 new_state->re_state_reg_magic
10702 = any_dup(old_state->re_state_reg_magic, proto_perl);
10703 new_state->re_state_reg_oldcurpm
10704 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10705 new_state->re_state_reg_curpm
10706 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10707 new_state->re_state_reg_oldsaved
10708 = pv_dup(old_state->re_state_reg_oldsaved);
10709 new_state->re_state_reg_poscache
10710 = pv_dup(old_state->re_state_reg_poscache);
10711 new_state->re_state_reg_starttry
10712 = pv_dup(old_state->re_state_reg_starttry);
10715 case SAVEt_COMPILE_WARNINGS:
10716 ptr = POPPTR(ss,ix);
10717 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10720 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10728 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10729 * flag to the result. This is done for each stash before cloning starts,
10730 * so we know which stashes want their objects cloned */
10733 do_mark_cloneable_stash(pTHX_ SV *sv)
10735 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10737 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10738 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10739 if (cloner && GvCV(cloner)) {
10746 XPUSHs(sv_2mortal(newSVhek(hvname)));
10748 call_sv((SV*)GvCV(cloner), G_SCALAR);
10755 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10763 =for apidoc perl_clone
10765 Create and return a new interpreter by cloning the current one.
10767 perl_clone takes these flags as parameters:
10769 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10770 without it we only clone the data and zero the stacks,
10771 with it we copy the stacks and the new perl interpreter is
10772 ready to run at the exact same point as the previous one.
10773 The pseudo-fork code uses COPY_STACKS while the
10774 threads->new doesn't.
10776 CLONEf_KEEP_PTR_TABLE
10777 perl_clone keeps a ptr_table with the pointer of the old
10778 variable as a key and the new variable as a value,
10779 this allows it to check if something has been cloned and not
10780 clone it again but rather just use the value and increase the
10781 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10782 the ptr_table using the function
10783 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10784 reason to keep it around is if you want to dup some of your own
10785 variable who are outside the graph perl scans, example of this
10786 code is in threads.xs create
10789 This is a win32 thing, it is ignored on unix, it tells perls
10790 win32host code (which is c++) to clone itself, this is needed on
10791 win32 if you want to run two threads at the same time,
10792 if you just want to do some stuff in a separate perl interpreter
10793 and then throw it away and return to the original one,
10794 you don't need to do anything.
10799 /* XXX the above needs expanding by someone who actually understands it ! */
10800 EXTERN_C PerlInterpreter *
10801 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10804 perl_clone(PerlInterpreter *proto_perl, UV flags)
10807 #ifdef PERL_IMPLICIT_SYS
10809 /* perlhost.h so we need to call into it
10810 to clone the host, CPerlHost should have a c interface, sky */
10812 if (flags & CLONEf_CLONE_HOST) {
10813 return perl_clone_host(proto_perl,flags);
10815 return perl_clone_using(proto_perl, flags,
10817 proto_perl->IMemShared,
10818 proto_perl->IMemParse,
10820 proto_perl->IStdIO,
10824 proto_perl->IProc);
10828 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10829 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10830 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10831 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10832 struct IPerlDir* ipD, struct IPerlSock* ipS,
10833 struct IPerlProc* ipP)
10835 /* XXX many of the string copies here can be optimized if they're
10836 * constants; they need to be allocated as common memory and just
10837 * their pointers copied. */
10840 CLONE_PARAMS clone_params;
10841 CLONE_PARAMS* const param = &clone_params;
10843 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10844 /* for each stash, determine whether its objects should be cloned */
10845 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10846 PERL_SET_THX(my_perl);
10849 PoisonNew(my_perl, 1, PerlInterpreter);
10855 PL_savestack_ix = 0;
10856 PL_savestack_max = -1;
10857 PL_sig_pending = 0;
10858 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10859 # else /* !DEBUGGING */
10860 Zero(my_perl, 1, PerlInterpreter);
10861 # endif /* DEBUGGING */
10863 /* host pointers */
10865 PL_MemShared = ipMS;
10866 PL_MemParse = ipMP;
10873 #else /* !PERL_IMPLICIT_SYS */
10875 CLONE_PARAMS clone_params;
10876 CLONE_PARAMS* param = &clone_params;
10877 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10878 /* for each stash, determine whether its objects should be cloned */
10879 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10880 PERL_SET_THX(my_perl);
10883 PoisonNew(my_perl, 1, PerlInterpreter);
10889 PL_savestack_ix = 0;
10890 PL_savestack_max = -1;
10891 PL_sig_pending = 0;
10892 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10893 # else /* !DEBUGGING */
10894 Zero(my_perl, 1, PerlInterpreter);
10895 # endif /* DEBUGGING */
10896 #endif /* PERL_IMPLICIT_SYS */
10897 param->flags = flags;
10898 param->proto_perl = proto_perl;
10900 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10902 PL_body_arenas = NULL;
10903 Zero(&PL_body_roots, 1, PL_body_roots);
10905 PL_nice_chunk = NULL;
10906 PL_nice_chunk_size = 0;
10908 PL_sv_objcount = 0;
10910 PL_sv_arenaroot = NULL;
10912 PL_debug = proto_perl->Idebug;
10914 PL_hash_seed = proto_perl->Ihash_seed;
10915 PL_rehash_seed = proto_perl->Irehash_seed;
10917 #ifdef USE_REENTRANT_API
10918 /* XXX: things like -Dm will segfault here in perlio, but doing
10919 * PERL_SET_CONTEXT(proto_perl);
10920 * breaks too many other things
10922 Perl_reentrant_init(aTHX);
10925 /* create SV map for pointer relocation */
10926 PL_ptr_table = ptr_table_new();
10928 /* initialize these special pointers as early as possible */
10929 SvANY(&PL_sv_undef) = NULL;
10930 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10931 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10932 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10934 SvANY(&PL_sv_no) = new_XPVNV();
10935 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10936 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10937 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10938 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10939 SvCUR_set(&PL_sv_no, 0);
10940 SvLEN_set(&PL_sv_no, 1);
10941 SvIV_set(&PL_sv_no, 0);
10942 SvNV_set(&PL_sv_no, 0);
10943 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10945 SvANY(&PL_sv_yes) = new_XPVNV();
10946 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10947 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10948 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10949 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10950 SvCUR_set(&PL_sv_yes, 1);
10951 SvLEN_set(&PL_sv_yes, 2);
10952 SvIV_set(&PL_sv_yes, 1);
10953 SvNV_set(&PL_sv_yes, 1);
10954 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10956 /* create (a non-shared!) shared string table */
10957 PL_strtab = newHV();
10958 HvSHAREKEYS_off(PL_strtab);
10959 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10960 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10962 PL_compiling = proto_perl->Icompiling;
10964 /* These two PVs will be free'd special way so must set them same way op.c does */
10965 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10966 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10968 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10969 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10971 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10972 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10973 if (!specialCopIO(PL_compiling.cop_io))
10974 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10975 if (PL_compiling.cop_hints) {
10977 PL_compiling.cop_hints->refcounted_he_refcnt++;
10978 HINTS_REFCNT_UNLOCK;
10980 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10982 /* pseudo environmental stuff */
10983 PL_origargc = proto_perl->Iorigargc;
10984 PL_origargv = proto_perl->Iorigargv;
10986 param->stashes = newAV(); /* Setup array of objects to call clone on */
10988 /* Set tainting stuff before PerlIO_debug can possibly get called */
10989 PL_tainting = proto_perl->Itainting;
10990 PL_taint_warn = proto_perl->Itaint_warn;
10992 #ifdef PERLIO_LAYERS
10993 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10994 PerlIO_clone(aTHX_ proto_perl, param);
10997 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10998 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10999 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11000 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11001 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11002 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11005 PL_minus_c = proto_perl->Iminus_c;
11006 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11007 PL_localpatches = proto_perl->Ilocalpatches;
11008 PL_splitstr = proto_perl->Isplitstr;
11009 PL_preprocess = proto_perl->Ipreprocess;
11010 PL_minus_n = proto_perl->Iminus_n;
11011 PL_minus_p = proto_perl->Iminus_p;
11012 PL_minus_l = proto_perl->Iminus_l;
11013 PL_minus_a = proto_perl->Iminus_a;
11014 PL_minus_E = proto_perl->Iminus_E;
11015 PL_minus_F = proto_perl->Iminus_F;
11016 PL_doswitches = proto_perl->Idoswitches;
11017 PL_dowarn = proto_perl->Idowarn;
11018 PL_doextract = proto_perl->Idoextract;
11019 PL_sawampersand = proto_perl->Isawampersand;
11020 PL_unsafe = proto_perl->Iunsafe;
11021 PL_inplace = SAVEPV(proto_perl->Iinplace);
11022 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11023 PL_perldb = proto_perl->Iperldb;
11024 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11025 PL_exit_flags = proto_perl->Iexit_flags;
11027 /* magical thingies */
11028 /* XXX time(&PL_basetime) when asked for? */
11029 PL_basetime = proto_perl->Ibasetime;
11030 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11032 PL_maxsysfd = proto_perl->Imaxsysfd;
11033 PL_statusvalue = proto_perl->Istatusvalue;
11035 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11037 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11039 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11041 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11042 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11043 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11045 /* Clone the regex array */
11046 PL_regex_padav = newAV();
11048 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11049 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11051 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11052 for(i = 1; i <= len; i++) {
11053 const SV * const regex = regexen[i];
11056 ? sv_dup_inc(regex, param)
11058 newSViv(PTR2IV(re_dup(
11059 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11061 av_push(PL_regex_padav, sv);
11064 PL_regex_pad = AvARRAY(PL_regex_padav);
11066 /* shortcuts to various I/O objects */
11067 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11068 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11069 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11070 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11071 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11072 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11074 /* shortcuts to regexp stuff */
11075 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11077 /* shortcuts to misc objects */
11078 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11080 /* shortcuts to debugging objects */
11081 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11082 PL_DBline = gv_dup(proto_perl->IDBline, param);
11083 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11084 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11085 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11086 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11087 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11088 PL_lineary = av_dup(proto_perl->Ilineary, param);
11089 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11091 /* symbol tables */
11092 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11093 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11094 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11095 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11096 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11098 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11099 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11100 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11101 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11102 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11103 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11105 PL_sub_generation = proto_perl->Isub_generation;
11107 /* funky return mechanisms */
11108 PL_forkprocess = proto_perl->Iforkprocess;
11110 /* subprocess state */
11111 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11113 /* internal state */
11114 PL_maxo = proto_perl->Imaxo;
11115 if (proto_perl->Iop_mask)
11116 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11119 /* PL_asserting = proto_perl->Iasserting; */
11121 /* current interpreter roots */
11122 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11123 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11124 PL_main_start = proto_perl->Imain_start;
11125 PL_eval_root = proto_perl->Ieval_root;
11126 PL_eval_start = proto_perl->Ieval_start;
11128 /* runtime control stuff */
11129 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11130 PL_copline = proto_perl->Icopline;
11132 PL_filemode = proto_perl->Ifilemode;
11133 PL_lastfd = proto_perl->Ilastfd;
11134 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11137 PL_gensym = proto_perl->Igensym;
11138 PL_preambled = proto_perl->Ipreambled;
11139 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11140 PL_laststatval = proto_perl->Ilaststatval;
11141 PL_laststype = proto_perl->Ilaststype;
11144 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11146 /* interpreter atexit processing */
11147 PL_exitlistlen = proto_perl->Iexitlistlen;
11148 if (PL_exitlistlen) {
11149 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11150 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11153 PL_exitlist = (PerlExitListEntry*)NULL;
11155 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11156 if (PL_my_cxt_size) {
11157 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11158 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11161 PL_my_cxt_list = (void**)NULL;
11162 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11163 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11164 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11166 PL_profiledata = NULL;
11167 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11168 /* PL_rsfp_filters entries have fake IoDIRP() */
11169 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11171 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11173 PAD_CLONE_VARS(proto_perl, param);
11175 #ifdef HAVE_INTERP_INTERN
11176 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11179 /* more statics moved here */
11180 PL_generation = proto_perl->Igeneration;
11181 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11183 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11184 PL_in_clean_all = proto_perl->Iin_clean_all;
11186 PL_uid = proto_perl->Iuid;
11187 PL_euid = proto_perl->Ieuid;
11188 PL_gid = proto_perl->Igid;
11189 PL_egid = proto_perl->Iegid;
11190 PL_nomemok = proto_perl->Inomemok;
11191 PL_an = proto_perl->Ian;
11192 PL_evalseq = proto_perl->Ievalseq;
11193 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11194 PL_origalen = proto_perl->Iorigalen;
11195 #ifdef PERL_USES_PL_PIDSTATUS
11196 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11198 PL_osname = SAVEPV(proto_perl->Iosname);
11199 PL_sighandlerp = proto_perl->Isighandlerp;
11201 PL_runops = proto_perl->Irunops;
11203 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11206 PL_cshlen = proto_perl->Icshlen;
11207 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11210 PL_lex_state = proto_perl->Ilex_state;
11211 PL_lex_defer = proto_perl->Ilex_defer;
11212 PL_lex_expect = proto_perl->Ilex_expect;
11213 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11214 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11215 PL_lex_starts = proto_perl->Ilex_starts;
11216 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11217 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11218 PL_lex_op = proto_perl->Ilex_op;
11219 PL_lex_inpat = proto_perl->Ilex_inpat;
11220 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11221 PL_lex_brackets = proto_perl->Ilex_brackets;
11222 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11223 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11224 PL_lex_casemods = proto_perl->Ilex_casemods;
11225 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11226 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11229 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11230 PL_lasttoke = proto_perl->Ilasttoke;
11231 PL_realtokenstart = proto_perl->Irealtokenstart;
11232 PL_faketokens = proto_perl->Ifaketokens;
11233 PL_thismad = proto_perl->Ithismad;
11234 PL_thistoken = proto_perl->Ithistoken;
11235 PL_thisopen = proto_perl->Ithisopen;
11236 PL_thisstuff = proto_perl->Ithisstuff;
11237 PL_thisclose = proto_perl->Ithisclose;
11238 PL_thiswhite = proto_perl->Ithiswhite;
11239 PL_nextwhite = proto_perl->Inextwhite;
11240 PL_skipwhite = proto_perl->Iskipwhite;
11241 PL_endwhite = proto_perl->Iendwhite;
11242 PL_curforce = proto_perl->Icurforce;
11244 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11245 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11246 PL_nexttoke = proto_perl->Inexttoke;
11249 /* XXX This is probably masking the deeper issue of why
11250 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11251 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11252 * (A little debugging with a watchpoint on it may help.)
11254 if (SvANY(proto_perl->Ilinestr)) {
11255 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11256 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11257 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11258 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11259 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11260 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11261 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11262 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11263 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11266 PL_linestr = newSV(79);
11267 sv_upgrade(PL_linestr,SVt_PVIV);
11268 sv_setpvn(PL_linestr,"",0);
11269 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11271 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11272 PL_pending_ident = proto_perl->Ipending_ident;
11273 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11275 PL_expect = proto_perl->Iexpect;
11277 PL_multi_start = proto_perl->Imulti_start;
11278 PL_multi_end = proto_perl->Imulti_end;
11279 PL_multi_open = proto_perl->Imulti_open;
11280 PL_multi_close = proto_perl->Imulti_close;
11282 PL_error_count = proto_perl->Ierror_count;
11283 PL_subline = proto_perl->Isubline;
11284 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11286 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11287 if (SvANY(proto_perl->Ilinestr)) {
11288 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11289 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11290 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11291 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11292 PL_last_lop_op = proto_perl->Ilast_lop_op;
11295 PL_last_uni = SvPVX(PL_linestr);
11296 PL_last_lop = SvPVX(PL_linestr);
11297 PL_last_lop_op = 0;
11299 PL_in_my = proto_perl->Iin_my;
11300 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11302 PL_cryptseen = proto_perl->Icryptseen;
11305 PL_hints = proto_perl->Ihints;
11307 PL_amagic_generation = proto_perl->Iamagic_generation;
11309 #ifdef USE_LOCALE_COLLATE
11310 PL_collation_ix = proto_perl->Icollation_ix;
11311 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11312 PL_collation_standard = proto_perl->Icollation_standard;
11313 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11314 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11315 #endif /* USE_LOCALE_COLLATE */
11317 #ifdef USE_LOCALE_NUMERIC
11318 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11319 PL_numeric_standard = proto_perl->Inumeric_standard;
11320 PL_numeric_local = proto_perl->Inumeric_local;
11321 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11322 #endif /* !USE_LOCALE_NUMERIC */
11324 /* utf8 character classes */
11325 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11326 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11327 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11328 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11329 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11330 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11331 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11332 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11333 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11334 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11335 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11336 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11337 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11338 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11339 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11340 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11341 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11342 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11343 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11344 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11346 /* Did the locale setup indicate UTF-8? */
11347 PL_utf8locale = proto_perl->Iutf8locale;
11348 /* Unicode features (see perlrun/-C) */
11349 PL_unicode = proto_perl->Iunicode;
11351 /* Pre-5.8 signals control */
11352 PL_signals = proto_perl->Isignals;
11354 /* times() ticks per second */
11355 PL_clocktick = proto_perl->Iclocktick;
11357 /* Recursion stopper for PerlIO_find_layer */
11358 PL_in_load_module = proto_perl->Iin_load_module;
11360 /* sort() routine */
11361 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11363 /* Not really needed/useful since the reenrant_retint is "volatile",
11364 * but do it for consistency's sake. */
11365 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11367 /* Hooks to shared SVs and locks. */
11368 PL_sharehook = proto_perl->Isharehook;
11369 PL_lockhook = proto_perl->Ilockhook;
11370 PL_unlockhook = proto_perl->Iunlockhook;
11371 PL_threadhook = proto_perl->Ithreadhook;
11373 PL_runops_std = proto_perl->Irunops_std;
11374 PL_runops_dbg = proto_perl->Irunops_dbg;
11376 #ifdef THREADS_HAVE_PIDS
11377 PL_ppid = proto_perl->Ippid;
11381 PL_last_swash_hv = NULL; /* reinits on demand */
11382 PL_last_swash_klen = 0;
11383 PL_last_swash_key[0]= '\0';
11384 PL_last_swash_tmps = (U8*)NULL;
11385 PL_last_swash_slen = 0;
11387 PL_glob_index = proto_perl->Iglob_index;
11388 PL_srand_called = proto_perl->Isrand_called;
11389 PL_uudmap['M'] = 0; /* reinits on demand */
11390 PL_bitcount = NULL; /* reinits on demand */
11392 if (proto_perl->Ipsig_pend) {
11393 Newxz(PL_psig_pend, SIG_SIZE, int);
11396 PL_psig_pend = (int*)NULL;
11399 if (proto_perl->Ipsig_ptr) {
11400 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11401 Newxz(PL_psig_name, SIG_SIZE, SV*);
11402 for (i = 1; i < SIG_SIZE; i++) {
11403 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11404 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11408 PL_psig_ptr = (SV**)NULL;
11409 PL_psig_name = (SV**)NULL;
11412 /* thrdvar.h stuff */
11414 if (flags & CLONEf_COPY_STACKS) {
11415 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11416 PL_tmps_ix = proto_perl->Ttmps_ix;
11417 PL_tmps_max = proto_perl->Ttmps_max;
11418 PL_tmps_floor = proto_perl->Ttmps_floor;
11419 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11421 while (i <= PL_tmps_ix) {
11422 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11426 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11427 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11428 Newxz(PL_markstack, i, I32);
11429 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11430 - proto_perl->Tmarkstack);
11431 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11432 - proto_perl->Tmarkstack);
11433 Copy(proto_perl->Tmarkstack, PL_markstack,
11434 PL_markstack_ptr - PL_markstack + 1, I32);
11436 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11437 * NOTE: unlike the others! */
11438 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11439 PL_scopestack_max = proto_perl->Tscopestack_max;
11440 Newxz(PL_scopestack, PL_scopestack_max, I32);
11441 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11443 /* NOTE: si_dup() looks at PL_markstack */
11444 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11446 /* PL_curstack = PL_curstackinfo->si_stack; */
11447 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11448 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11450 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11451 PL_stack_base = AvARRAY(PL_curstack);
11452 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11453 - proto_perl->Tstack_base);
11454 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11456 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11457 * NOTE: unlike the others! */
11458 PL_savestack_ix = proto_perl->Tsavestack_ix;
11459 PL_savestack_max = proto_perl->Tsavestack_max;
11460 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11461 PL_savestack = ss_dup(proto_perl, param);
11465 ENTER; /* perl_destruct() wants to LEAVE; */
11467 /* although we're not duplicating the tmps stack, we should still
11468 * add entries for any SVs on the tmps stack that got cloned by a
11469 * non-refcount means (eg a temp in @_); otherwise they will be
11472 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11473 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11474 proto_perl->Ttmps_stack[i]);
11475 if (nsv && !SvREFCNT(nsv)) {
11477 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11482 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11483 PL_top_env = &PL_start_env;
11485 PL_op = proto_perl->Top;
11488 PL_Xpv = (XPV*)NULL;
11489 PL_na = proto_perl->Tna;
11491 PL_statbuf = proto_perl->Tstatbuf;
11492 PL_statcache = proto_perl->Tstatcache;
11493 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11494 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11496 PL_timesbuf = proto_perl->Ttimesbuf;
11499 PL_tainted = proto_perl->Ttainted;
11500 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11501 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11502 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11503 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11504 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11505 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11506 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11507 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11508 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11510 PL_restartop = proto_perl->Trestartop;
11511 PL_in_eval = proto_perl->Tin_eval;
11512 PL_delaymagic = proto_perl->Tdelaymagic;
11513 PL_dirty = proto_perl->Tdirty;
11514 PL_localizing = proto_perl->Tlocalizing;
11516 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11517 PL_hv_fetch_ent_mh = NULL;
11518 PL_modcount = proto_perl->Tmodcount;
11519 PL_lastgotoprobe = NULL;
11520 PL_dumpindent = proto_perl->Tdumpindent;
11522 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11523 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11524 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11525 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11526 PL_efloatbuf = NULL; /* reinits on demand */
11527 PL_efloatsize = 0; /* reinits on demand */
11531 PL_screamfirst = NULL;
11532 PL_screamnext = NULL;
11533 PL_maxscream = -1; /* reinits on demand */
11534 PL_lastscream = NULL;
11536 PL_watchaddr = NULL;
11539 PL_regdummy = proto_perl->Tregdummy;
11540 PL_colorset = 0; /* reinits PL_colors[] */
11541 /*PL_colors[6] = {0,0,0,0,0,0};*/
11543 /* RE engine - function pointers */
11544 PL_regcompp = proto_perl->Tregcompp;
11545 PL_regexecp = proto_perl->Tregexecp;
11546 PL_regint_start = proto_perl->Tregint_start;
11547 PL_regint_string = proto_perl->Tregint_string;
11548 PL_regfree = proto_perl->Tregfree;
11549 Zero(&PL_reg_state, 1, struct re_save_state);
11550 PL_reginterp_cnt = 0;
11551 PL_regmatch_slab = NULL;
11553 /* Pluggable optimizer */
11554 PL_peepp = proto_perl->Tpeepp;
11556 PL_stashcache = newHV();
11558 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11559 ptr_table_free(PL_ptr_table);
11560 PL_ptr_table = NULL;
11563 /* Call the ->CLONE method, if it exists, for each of the stashes
11564 identified by sv_dup() above.
11566 while(av_len(param->stashes) != -1) {
11567 HV* const stash = (HV*) av_shift(param->stashes);
11568 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11569 if (cloner && GvCV(cloner)) {
11574 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11576 call_sv((SV*)GvCV(cloner), G_DISCARD);
11582 SvREFCNT_dec(param->stashes);
11584 /* orphaned? eg threads->new inside BEGIN or use */
11585 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11586 SvREFCNT_inc_simple_void(PL_compcv);
11587 SAVEFREESV(PL_compcv);
11593 #endif /* USE_ITHREADS */
11596 =head1 Unicode Support
11598 =for apidoc sv_recode_to_utf8
11600 The encoding is assumed to be an Encode object, on entry the PV
11601 of the sv is assumed to be octets in that encoding, and the sv
11602 will be converted into Unicode (and UTF-8).
11604 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11605 is not a reference, nothing is done to the sv. If the encoding is not
11606 an C<Encode::XS> Encoding object, bad things will happen.
11607 (See F<lib/encoding.pm> and L<Encode>).
11609 The PV of the sv is returned.
11614 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11617 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11631 Passing sv_yes is wrong - it needs to be or'ed set of constants
11632 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11633 remove converted chars from source.
11635 Both will default the value - let them.
11637 XPUSHs(&PL_sv_yes);
11640 call_method("decode", G_SCALAR);
11644 s = SvPV_const(uni, len);
11645 if (s != SvPVX_const(sv)) {
11646 SvGROW(sv, len + 1);
11647 Move(s, SvPVX(sv), len + 1, char);
11648 SvCUR_set(sv, len);
11655 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11659 =for apidoc sv_cat_decode
11661 The encoding is assumed to be an Encode object, the PV of the ssv is
11662 assumed to be octets in that encoding and decoding the input starts
11663 from the position which (PV + *offset) pointed to. The dsv will be
11664 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11665 when the string tstr appears in decoding output or the input ends on
11666 the PV of the ssv. The value which the offset points will be modified
11667 to the last input position on the ssv.
11669 Returns TRUE if the terminator was found, else returns FALSE.
11674 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11675 SV *ssv, int *offset, char *tstr, int tlen)
11679 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11690 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11691 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11693 call_method("cat_decode", G_SCALAR);
11695 ret = SvTRUE(TOPs);
11696 *offset = SvIV(offsv);
11702 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11707 /* ---------------------------------------------------------------------
11709 * support functions for report_uninit()
11712 /* the maxiumum size of array or hash where we will scan looking
11713 * for the undefined element that triggered the warning */
11715 #define FUV_MAX_SEARCH_SIZE 1000
11717 /* Look for an entry in the hash whose value has the same SV as val;
11718 * If so, return a mortal copy of the key. */
11721 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11724 register HE **array;
11727 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11728 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11731 array = HvARRAY(hv);
11733 for (i=HvMAX(hv); i>0; i--) {
11734 register HE *entry;
11735 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11736 if (HeVAL(entry) != val)
11738 if ( HeVAL(entry) == &PL_sv_undef ||
11739 HeVAL(entry) == &PL_sv_placeholder)
11743 if (HeKLEN(entry) == HEf_SVKEY)
11744 return sv_mortalcopy(HeKEY_sv(entry));
11745 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11751 /* Look for an entry in the array whose value has the same SV as val;
11752 * If so, return the index, otherwise return -1. */
11755 S_find_array_subscript(pTHX_ AV *av, SV* val)
11758 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11759 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11762 if (val != &PL_sv_undef) {
11763 SV ** const svp = AvARRAY(av);
11766 for (i=AvFILLp(av); i>=0; i--)
11773 /* S_varname(): return the name of a variable, optionally with a subscript.
11774 * If gv is non-zero, use the name of that global, along with gvtype (one
11775 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11776 * targ. Depending on the value of the subscript_type flag, return:
11779 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11780 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11781 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11782 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11785 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11786 SV* keyname, I32 aindex, int subscript_type)
11789 SV * const name = sv_newmortal();
11792 buffer[0] = gvtype;
11795 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11797 gv_fullname4(name, gv, buffer, 0);
11799 if ((unsigned int)SvPVX(name)[1] <= 26) {
11801 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11803 /* Swap the 1 unprintable control character for the 2 byte pretty
11804 version - ie substr($name, 1, 1) = $buffer; */
11805 sv_insert(name, 1, 1, buffer, 2);
11810 CV * const cv = find_runcv(&unused);
11814 if (!cv || !CvPADLIST(cv))
11816 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11817 sv = *av_fetch(av, targ, FALSE);
11818 /* SvLEN in a pad name is not to be trusted */
11819 sv_setpv(name, SvPV_nolen_const(sv));
11822 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11823 SV * const sv = newSV(0);
11824 *SvPVX(name) = '$';
11825 Perl_sv_catpvf(aTHX_ name, "{%s}",
11826 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11829 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11830 *SvPVX(name) = '$';
11831 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11833 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11834 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11841 =for apidoc find_uninit_var
11843 Find the name of the undefined variable (if any) that caused the operator o
11844 to issue a "Use of uninitialized value" warning.
11845 If match is true, only return a name if it's value matches uninit_sv.
11846 So roughly speaking, if a unary operator (such as OP_COS) generates a
11847 warning, then following the direct child of the op may yield an
11848 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11849 other hand, with OP_ADD there are two branches to follow, so we only print
11850 the variable name if we get an exact match.
11852 The name is returned as a mortal SV.
11854 Assumes that PL_op is the op that originally triggered the error, and that
11855 PL_comppad/PL_curpad points to the currently executing pad.
11861 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11869 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11870 uninit_sv == &PL_sv_placeholder)))
11873 switch (obase->op_type) {
11880 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11881 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11884 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11886 if (pad) { /* @lex, %lex */
11887 sv = PAD_SVl(obase->op_targ);
11891 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11892 /* @global, %global */
11893 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11896 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11898 else /* @{expr}, %{expr} */
11899 return find_uninit_var(cUNOPx(obase)->op_first,
11903 /* attempt to find a match within the aggregate */
11905 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11907 subscript_type = FUV_SUBSCRIPT_HASH;
11910 index = find_array_subscript((AV*)sv, uninit_sv);
11912 subscript_type = FUV_SUBSCRIPT_ARRAY;
11915 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11918 return varname(gv, hash ? '%' : '@', obase->op_targ,
11919 keysv, index, subscript_type);
11923 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11925 return varname(NULL, '$', obase->op_targ,
11926 NULL, 0, FUV_SUBSCRIPT_NONE);
11929 gv = cGVOPx_gv(obase);
11930 if (!gv || (match && GvSV(gv) != uninit_sv))
11932 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11935 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11938 av = (AV*)PAD_SV(obase->op_targ);
11939 if (!av || SvRMAGICAL(av))
11941 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11942 if (!svp || *svp != uninit_sv)
11945 return varname(NULL, '$', obase->op_targ,
11946 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11949 gv = cGVOPx_gv(obase);
11955 if (!av || SvRMAGICAL(av))
11957 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11958 if (!svp || *svp != uninit_sv)
11961 return varname(gv, '$', 0,
11962 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11967 o = cUNOPx(obase)->op_first;
11968 if (!o || o->op_type != OP_NULL ||
11969 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11971 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11975 if (PL_op == obase)
11976 /* $a[uninit_expr] or $h{uninit_expr} */
11977 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11980 o = cBINOPx(obase)->op_first;
11981 kid = cBINOPx(obase)->op_last;
11983 /* get the av or hv, and optionally the gv */
11985 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11986 sv = PAD_SV(o->op_targ);
11988 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11989 && cUNOPo->op_first->op_type == OP_GV)
11991 gv = cGVOPx_gv(cUNOPo->op_first);
11994 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11999 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12000 /* index is constant */
12004 if (obase->op_type == OP_HELEM) {
12005 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12006 if (!he || HeVAL(he) != uninit_sv)
12010 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12011 if (!svp || *svp != uninit_sv)
12015 if (obase->op_type == OP_HELEM)
12016 return varname(gv, '%', o->op_targ,
12017 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12019 return varname(gv, '@', o->op_targ, NULL,
12020 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12023 /* index is an expression;
12024 * attempt to find a match within the aggregate */
12025 if (obase->op_type == OP_HELEM) {
12026 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12028 return varname(gv, '%', o->op_targ,
12029 keysv, 0, FUV_SUBSCRIPT_HASH);
12032 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12034 return varname(gv, '@', o->op_targ,
12035 NULL, index, FUV_SUBSCRIPT_ARRAY);
12040 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12042 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12047 /* only examine RHS */
12048 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12051 o = cUNOPx(obase)->op_first;
12052 if (o->op_type == OP_PUSHMARK)
12055 if (!o->op_sibling) {
12056 /* one-arg version of open is highly magical */
12058 if (o->op_type == OP_GV) { /* open FOO; */
12060 if (match && GvSV(gv) != uninit_sv)
12062 return varname(gv, '$', 0,
12063 NULL, 0, FUV_SUBSCRIPT_NONE);
12065 /* other possibilities not handled are:
12066 * open $x; or open my $x; should return '${*$x}'
12067 * open expr; should return '$'.expr ideally
12073 /* ops where $_ may be an implicit arg */
12077 if ( !(obase->op_flags & OPf_STACKED)) {
12078 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12079 ? PAD_SVl(obase->op_targ)
12082 sv = sv_newmortal();
12083 sv_setpvn(sv, "$_", 2);
12091 /* skip filehandle as it can't produce 'undef' warning */
12092 o = cUNOPx(obase)->op_first;
12093 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12094 o = o->op_sibling->op_sibling;
12101 match = 1; /* XS or custom code could trigger random warnings */
12106 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12107 return sv_2mortal(newSVpvs("${$/}"));
12112 if (!(obase->op_flags & OPf_KIDS))
12114 o = cUNOPx(obase)->op_first;
12120 /* if all except one arg are constant, or have no side-effects,
12121 * or are optimized away, then it's unambiguous */
12123 for (kid=o; kid; kid = kid->op_sibling) {
12125 const OPCODE type = kid->op_type;
12126 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12127 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12128 || (type == OP_PUSHMARK)
12132 if (o2) { /* more than one found */
12139 return find_uninit_var(o2, uninit_sv, match);
12141 /* scan all args */
12143 sv = find_uninit_var(o, uninit_sv, 1);
12155 =for apidoc report_uninit
12157 Print appropriate "Use of uninitialized variable" warning
12163 Perl_report_uninit(pTHX_ SV* uninit_sv)
12167 SV* varname = NULL;
12169 varname = find_uninit_var(PL_op, uninit_sv,0);
12171 sv_insert(varname, 0, 0, " ", 1);
12173 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12174 varname ? SvPV_nolen_const(varname) : "",
12175 " in ", OP_DESC(PL_op));
12178 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12184 * c-indentation-style: bsd
12185 * c-basic-offset: 4
12186 * indent-tabs-mode: t
12189 * ex: set ts=8 sts=4 sw=4 noet: