3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
1280 if (old_type >= SVt_PVMG) {
1281 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1284 sv->sv_u.svu_array = NULL; /* or svu_hash */
1290 /* XXX Is this still needed? Was it ever needed? Surely as there is
1291 no route from NV to PVIV, NOK can never be true */
1292 assert(!SvNOKp(sv));
1304 assert(new_type_details->body_size);
1305 /* We always allocated the full length item with PURIFY. To do this
1306 we fake things so that arena is false for all 16 types.. */
1307 if(new_type_details->arena) {
1308 /* This points to the start of the allocated area. */
1309 new_body_inline(new_body, new_type);
1310 Zero(new_body, new_type_details->body_size, char);
1311 new_body = ((char *)new_body) - new_type_details->offset;
1313 new_body = new_NOARENAZ(new_type_details);
1315 SvANY(sv) = new_body;
1317 if (old_type_details->copy) {
1318 /* There is now the potential for an upgrade from something without
1319 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1320 int offset = old_type_details->offset;
1321 int length = old_type_details->copy;
1323 if (new_type_details->offset > old_type_details->offset) {
1324 const int difference
1325 = new_type_details->offset - old_type_details->offset;
1326 offset += difference;
1327 length -= difference;
1329 assert (length >= 0);
1331 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1335 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1336 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1337 * correct 0.0 for us. Otherwise, if the old body didn't have an
1338 * NV slot, but the new one does, then we need to initialise the
1339 * freshly created NV slot with whatever the correct bit pattern is
1341 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1345 if (new_type == SVt_PVIO)
1346 IoPAGE_LEN(sv) = 60;
1347 if (old_type < SVt_RV)
1351 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1352 (unsigned long)new_type);
1355 if (old_type_details->arena) {
1356 /* If there was an old body, then we need to free it.
1357 Note that there is an assumption that all bodies of types that
1358 can be upgraded came from arenas. Only the more complex non-
1359 upgradable types are allowed to be directly malloc()ed. */
1361 my_safefree(old_body);
1363 del_body((void*)((char*)old_body + old_type_details->offset),
1364 &PL_body_roots[old_type]);
1370 =for apidoc sv_backoff
1372 Remove any string offset. You should normally use the C<SvOOK_off> macro
1379 Perl_sv_backoff(pTHX_ register SV *sv)
1381 PERL_UNUSED_CONTEXT;
1383 assert(SvTYPE(sv) != SVt_PVHV);
1384 assert(SvTYPE(sv) != SVt_PVAV);
1386 const char * const s = SvPVX_const(sv);
1387 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1388 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1390 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1392 SvFLAGS(sv) &= ~SVf_OOK;
1399 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1400 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1401 Use the C<SvGROW> wrapper instead.
1407 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1411 if (PL_madskills && newlen >= 0x100000) {
1412 PerlIO_printf(Perl_debug_log,
1413 "Allocation too large: %"UVxf"\n", (UV)newlen);
1415 #ifdef HAS_64K_LIMIT
1416 if (newlen >= 0x10000) {
1417 PerlIO_printf(Perl_debug_log,
1418 "Allocation too large: %"UVxf"\n", (UV)newlen);
1421 #endif /* HAS_64K_LIMIT */
1424 if (SvTYPE(sv) < SVt_PV) {
1425 sv_upgrade(sv, SVt_PV);
1426 s = SvPVX_mutable(sv);
1428 else if (SvOOK(sv)) { /* pv is offset? */
1430 s = SvPVX_mutable(sv);
1431 if (newlen > SvLEN(sv))
1432 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1433 #ifdef HAS_64K_LIMIT
1434 if (newlen >= 0x10000)
1439 s = SvPVX_mutable(sv);
1441 if (newlen > SvLEN(sv)) { /* need more room? */
1442 newlen = PERL_STRLEN_ROUNDUP(newlen);
1443 if (SvLEN(sv) && s) {
1445 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1451 s = (char*)saferealloc(s, newlen);
1454 s = (char*)safemalloc(newlen);
1455 if (SvPVX_const(sv) && SvCUR(sv)) {
1456 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1460 SvLEN_set(sv, newlen);
1466 =for apidoc sv_setiv
1468 Copies an integer into the given SV, upgrading first if necessary.
1469 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1475 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1478 SV_CHECK_THINKFIRST_COW_DROP(sv);
1479 switch (SvTYPE(sv)) {
1481 sv_upgrade(sv, SVt_IV);
1484 sv_upgrade(sv, SVt_PVNV);
1488 sv_upgrade(sv, SVt_PVIV);
1497 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
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),
1601 (void)SvNOK_only(sv); /* validate number */
1606 =for apidoc sv_setnv_mg
1608 Like C<sv_setnv>, but also handles 'set' magic.
1614 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1620 /* Print an "isn't numeric" warning, using a cleaned-up,
1621 * printable version of the offending string
1625 S_not_a_number(pTHX_ SV *sv)
1633 dsv = sv_2mortal(newSVpvs(""));
1634 pv = sv_uni_display(dsv, sv, 10, 0);
1637 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1638 /* each *s can expand to 4 chars + "...\0",
1639 i.e. need room for 8 chars */
1641 const char *s = SvPVX_const(sv);
1642 const char * const end = s + SvCUR(sv);
1643 for ( ; s < end && d < limit; s++ ) {
1645 if (ch & 128 && !isPRINT_LC(ch)) {
1654 else if (ch == '\r') {
1658 else if (ch == '\f') {
1662 else if (ch == '\\') {
1666 else if (ch == '\0') {
1670 else if (isPRINT_LC(ch))
1687 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1688 "Argument \"%s\" isn't numeric in %s", pv,
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric", pv);
1696 =for apidoc looks_like_number
1698 Test if the content of an SV looks like a number (or is a number).
1699 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1700 non-numeric warning), even if your atof() doesn't grok them.
1706 Perl_looks_like_number(pTHX_ SV *sv)
1708 register const char *sbegin;
1712 sbegin = SvPVX_const(sv);
1715 else if (SvPOKp(sv))
1716 sbegin = SvPV_const(sv, len);
1718 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1719 return grok_number(sbegin, len, NULL);
1723 S_glob_2number(pTHX_ GV * const gv)
1725 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1726 SV *const buffer = sv_newmortal();
1728 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1731 gv_efullname3(buffer, gv, "*");
1732 SvFLAGS(gv) |= wasfake;
1734 /* We know that all GVs stringify to something that is not-a-number,
1735 so no need to test that. */
1736 if (ckWARN(WARN_NUMERIC))
1737 not_a_number(buffer);
1738 /* We just want something true to return, so that S_sv_2iuv_common
1739 can tail call us and return true. */
1744 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1746 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1747 SV *const buffer = sv_newmortal();
1749 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1752 gv_efullname3(buffer, gv, "*");
1753 SvFLAGS(gv) |= wasfake;
1755 assert(SvPOK(buffer));
1757 *len = SvCUR(buffer);
1759 return SvPVX(buffer);
1762 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1763 until proven guilty, assume that things are not that bad... */
1768 As 64 bit platforms often have an NV that doesn't preserve all bits of
1769 an IV (an assumption perl has been based on to date) it becomes necessary
1770 to remove the assumption that the NV always carries enough precision to
1771 recreate the IV whenever needed, and that the NV is the canonical form.
1772 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1773 precision as a side effect of conversion (which would lead to insanity
1774 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1775 1) to distinguish between IV/UV/NV slots that have cached a valid
1776 conversion where precision was lost and IV/UV/NV slots that have a
1777 valid conversion which has lost no precision
1778 2) to ensure that if a numeric conversion to one form is requested that
1779 would lose precision, the precise conversion (or differently
1780 imprecise conversion) is also performed and cached, to prevent
1781 requests for different numeric formats on the same SV causing
1782 lossy conversion chains. (lossless conversion chains are perfectly
1787 SvIOKp is true if the IV slot contains a valid value
1788 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1789 SvNOKp is true if the NV slot contains a valid value
1790 SvNOK is true only if the NV value is accurate
1793 while converting from PV to NV, check to see if converting that NV to an
1794 IV(or UV) would lose accuracy over a direct conversion from PV to
1795 IV(or UV). If it would, cache both conversions, return NV, but mark
1796 SV as IOK NOKp (ie not NOK).
1798 While converting from PV to IV, check to see if converting that IV to an
1799 NV would lose accuracy over a direct conversion from PV to NV. If it
1800 would, cache both conversions, flag similarly.
1802 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1803 correctly because if IV & NV were set NV *always* overruled.
1804 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1805 changes - now IV and NV together means that the two are interchangeable:
1806 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1808 The benefit of this is that operations such as pp_add know that if
1809 SvIOK is true for both left and right operands, then integer addition
1810 can be used instead of floating point (for cases where the result won't
1811 overflow). Before, floating point was always used, which could lead to
1812 loss of precision compared with integer addition.
1814 * making IV and NV equal status should make maths accurate on 64 bit
1816 * may speed up maths somewhat if pp_add and friends start to use
1817 integers when possible instead of fp. (Hopefully the overhead in
1818 looking for SvIOK and checking for overflow will not outweigh the
1819 fp to integer speedup)
1820 * will slow down integer operations (callers of SvIV) on "inaccurate"
1821 values, as the change from SvIOK to SvIOKp will cause a call into
1822 sv_2iv each time rather than a macro access direct to the IV slot
1823 * should speed up number->string conversion on integers as IV is
1824 favoured when IV and NV are equally accurate
1826 ####################################################################
1827 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1828 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1829 On the other hand, SvUOK is true iff UV.
1830 ####################################################################
1832 Your mileage will vary depending your CPU's relative fp to integer
1836 #ifndef NV_PRESERVES_UV
1837 # define IS_NUMBER_UNDERFLOW_IV 1
1838 # define IS_NUMBER_UNDERFLOW_UV 2
1839 # define IS_NUMBER_IV_AND_UV 2
1840 # define IS_NUMBER_OVERFLOW_IV 4
1841 # define IS_NUMBER_OVERFLOW_UV 5
1843 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1845 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1847 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1850 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1851 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));
1852 if (SvNVX(sv) < (NV)IV_MIN) {
1853 (void)SvIOKp_on(sv);
1855 SvIV_set(sv, IV_MIN);
1856 return IS_NUMBER_UNDERFLOW_IV;
1858 if (SvNVX(sv) > (NV)UV_MAX) {
1859 (void)SvIOKp_on(sv);
1862 SvUV_set(sv, UV_MAX);
1863 return IS_NUMBER_OVERFLOW_UV;
1865 (void)SvIOKp_on(sv);
1867 /* Can't use strtol etc to convert this string. (See truth table in
1869 if (SvNVX(sv) <= (UV)IV_MAX) {
1870 SvIV_set(sv, I_V(SvNVX(sv)));
1871 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1872 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1879 SvUV_set(sv, U_V(SvNVX(sv)));
1880 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1881 if (SvUVX(sv) == UV_MAX) {
1882 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1883 possibly be preserved by NV. Hence, it must be overflow.
1885 return IS_NUMBER_OVERFLOW_UV;
1887 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1889 /* Integer is imprecise. NOK, IOKp */
1891 return IS_NUMBER_OVERFLOW_IV;
1893 #endif /* !NV_PRESERVES_UV*/
1896 S_sv_2iuv_common(pTHX_ SV *sv) {
1899 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1900 * without also getting a cached IV/UV from it at the same time
1901 * (ie PV->NV conversion should detect loss of accuracy and cache
1902 * IV or UV at same time to avoid this. */
1903 /* IV-over-UV optimisation - choose to cache IV if possible */
1905 if (SvTYPE(sv) == SVt_NV)
1906 sv_upgrade(sv, SVt_PVNV);
1908 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1909 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1910 certainly cast into the IV range at IV_MAX, whereas the correct
1911 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1913 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1914 if (Perl_isnan(SvNVX(sv))) {
1920 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1921 SvIV_set(sv, I_V(SvNVX(sv)));
1922 if (SvNVX(sv) == (NV) SvIVX(sv)
1923 #ifndef NV_PRESERVES_UV
1924 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1925 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1926 /* Don't flag it as "accurately an integer" if the number
1927 came from a (by definition imprecise) NV operation, and
1928 we're outside the range of NV integer precision */
1931 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1932 DEBUG_c(PerlIO_printf(Perl_debug_log,
1933 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1939 /* IV not precise. No need to convert from PV, as NV
1940 conversion would already have cached IV if it detected
1941 that PV->IV would be better than PV->NV->IV
1942 flags already correct - don't set public IOK. */
1943 DEBUG_c(PerlIO_printf(Perl_debug_log,
1944 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1949 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1950 but the cast (NV)IV_MIN rounds to a the value less (more
1951 negative) than IV_MIN which happens to be equal to SvNVX ??
1952 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1953 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1954 (NV)UVX == NVX are both true, but the values differ. :-(
1955 Hopefully for 2s complement IV_MIN is something like
1956 0x8000000000000000 which will be exact. NWC */
1959 SvUV_set(sv, U_V(SvNVX(sv)));
1961 (SvNVX(sv) == (NV) SvUVX(sv))
1962 #ifndef NV_PRESERVES_UV
1963 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1964 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1965 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1966 /* Don't flag it as "accurately an integer" if the number
1967 came from a (by definition imprecise) NV operation, and
1968 we're outside the range of NV integer precision */
1973 DEBUG_c(PerlIO_printf(Perl_debug_log,
1974 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1980 else if (SvPOKp(sv) && SvLEN(sv)) {
1982 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1983 /* We want to avoid a possible problem when we cache an IV/ a UV which
1984 may be later translated to an NV, and the resulting NV is not
1985 the same as the direct translation of the initial string
1986 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1987 be careful to ensure that the value with the .456 is around if the
1988 NV value is requested in the future).
1990 This means that if we cache such an IV/a UV, we need to cache the
1991 NV as well. Moreover, we trade speed for space, and do not
1992 cache the NV if we are sure it's not needed.
1995 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1996 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1997 == IS_NUMBER_IN_UV) {
1998 /* It's definitely an integer, only upgrade to PVIV */
1999 if (SvTYPE(sv) < SVt_PVIV)
2000 sv_upgrade(sv, SVt_PVIV);
2002 } else if (SvTYPE(sv) < SVt_PVNV)
2003 sv_upgrade(sv, SVt_PVNV);
2005 /* If NVs preserve UVs then we only use the UV value if we know that
2006 we aren't going to call atof() below. If NVs don't preserve UVs
2007 then the value returned may have more precision than atof() will
2008 return, even though value isn't perfectly accurate. */
2009 if ((numtype & (IS_NUMBER_IN_UV
2010 #ifdef NV_PRESERVES_UV
2013 )) == IS_NUMBER_IN_UV) {
2014 /* This won't turn off the public IOK flag if it was set above */
2015 (void)SvIOKp_on(sv);
2017 if (!(numtype & IS_NUMBER_NEG)) {
2019 if (value <= (UV)IV_MAX) {
2020 SvIV_set(sv, (IV)value);
2022 /* it didn't overflow, and it was positive. */
2023 SvUV_set(sv, value);
2027 /* 2s complement assumption */
2028 if (value <= (UV)IV_MIN) {
2029 SvIV_set(sv, -(IV)value);
2031 /* Too negative for an IV. This is a double upgrade, but
2032 I'm assuming it will be rare. */
2033 if (SvTYPE(sv) < SVt_PVNV)
2034 sv_upgrade(sv, SVt_PVNV);
2038 SvNV_set(sv, -(NV)value);
2039 SvIV_set(sv, IV_MIN);
2043 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2044 will be in the previous block to set the IV slot, and the next
2045 block to set the NV slot. So no else here. */
2047 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2048 != IS_NUMBER_IN_UV) {
2049 /* It wasn't an (integer that doesn't overflow the UV). */
2050 SvNV_set(sv, Atof(SvPVX_const(sv)));
2052 if (! numtype && ckWARN(WARN_NUMERIC))
2055 #if defined(USE_LONG_DOUBLE)
2056 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2057 PTR2UV(sv), SvNVX(sv)));
2059 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2060 PTR2UV(sv), SvNVX(sv)));
2063 #ifdef NV_PRESERVES_UV
2064 (void)SvIOKp_on(sv);
2066 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2067 SvIV_set(sv, I_V(SvNVX(sv)));
2068 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2071 NOOP; /* Integer is imprecise. NOK, IOKp */
2073 /* UV will not work better than IV */
2075 if (SvNVX(sv) > (NV)UV_MAX) {
2077 /* Integer is inaccurate. NOK, IOKp, is UV */
2078 SvUV_set(sv, UV_MAX);
2080 SvUV_set(sv, U_V(SvNVX(sv)));
2081 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2082 NV preservse UV so can do correct comparison. */
2083 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2086 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2091 #else /* NV_PRESERVES_UV */
2092 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2093 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2094 /* The IV/UV slot will have been set from value returned by
2095 grok_number above. The NV slot has just been set using
2098 assert (SvIOKp(sv));
2100 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2101 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2102 /* Small enough to preserve all bits. */
2103 (void)SvIOKp_on(sv);
2105 SvIV_set(sv, I_V(SvNVX(sv)));
2106 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2108 /* Assumption: first non-preserved integer is < IV_MAX,
2109 this NV is in the preserved range, therefore: */
2110 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2112 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);
2116 0 0 already failed to read UV.
2117 0 1 already failed to read UV.
2118 1 0 you won't get here in this case. IV/UV
2119 slot set, public IOK, Atof() unneeded.
2120 1 1 already read UV.
2121 so there's no point in sv_2iuv_non_preserve() attempting
2122 to use atol, strtol, strtoul etc. */
2123 sv_2iuv_non_preserve (sv, numtype);
2126 #endif /* NV_PRESERVES_UV */
2130 if (isGV_with_GP(sv))
2131 return glob_2number((GV *)sv);
2133 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2134 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2137 if (SvTYPE(sv) < SVt_IV)
2138 /* Typically the caller expects that sv_any is not NULL now. */
2139 sv_upgrade(sv, SVt_IV);
2140 /* Return 0 from the caller. */
2147 =for apidoc sv_2iv_flags
2149 Return the integer value of an SV, doing any necessary string
2150 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2151 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2157 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2162 if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2163 /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2164 cache IVs just in case. In practice it seems that they never
2165 actually anywhere accessible by user Perl code, let alone get used
2166 in anything other than a string context. */
2167 if (flags & SV_GMAGIC)
2172 return I_V(SvNVX(sv));
2174 if (SvPOKp(sv) && SvLEN(sv)) {
2177 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == IS_NUMBER_IN_UV) {
2181 /* It's definitely an integer */
2182 if (numtype & IS_NUMBER_NEG) {
2183 if (value < (UV)IV_MIN)
2186 if (value < (UV)IV_MAX)
2191 if (ckWARN(WARN_NUMERIC))
2194 return I_V(Atof(SvPVX_const(sv)));
2199 assert(SvTYPE(sv) >= SVt_PVMG);
2200 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2201 } else if (SvTHINKFIRST(sv)) {
2205 SV * const tmpstr=AMG_CALLun(sv,numer);
2206 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207 return SvIV(tmpstr);
2210 return PTR2IV(SvRV(sv));
2213 sv_force_normal_flags(sv, 0);
2215 if (SvREADONLY(sv) && !SvOK(sv)) {
2216 if (ckWARN(WARN_UNINITIALIZED))
2222 if (S_sv_2iuv_common(aTHX_ sv))
2225 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226 PTR2UV(sv),SvIVX(sv)));
2227 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2231 =for apidoc sv_2uv_flags
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2246 if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2247 /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2248 cache IVs just in case. */
2249 if (flags & SV_GMAGIC)
2254 return U_V(SvNVX(sv));
2255 if (SvPOKp(sv) && SvLEN(sv)) {
2258 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2260 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2261 == IS_NUMBER_IN_UV) {
2262 /* It's definitely an integer */
2263 if (!(numtype & IS_NUMBER_NEG))
2267 if (ckWARN(WARN_NUMERIC))
2270 return U_V(Atof(SvPVX_const(sv)));
2275 assert(SvTYPE(sv) >= SVt_PVMG);
2276 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2277 } else if (SvTHINKFIRST(sv)) {
2281 SV *const tmpstr = AMG_CALLun(sv,numer);
2282 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2283 return SvUV(tmpstr);
2286 return PTR2UV(SvRV(sv));
2289 sv_force_normal_flags(sv, 0);
2291 if (SvREADONLY(sv) && !SvOK(sv)) {
2292 if (ckWARN(WARN_UNINITIALIZED))
2298 if (S_sv_2iuv_common(aTHX_ sv))
2302 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2303 PTR2UV(sv),SvUVX(sv)));
2304 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2310 Return the num value of an SV, doing any necessary string or integer
2311 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2318 Perl_sv_2nv(pTHX_ register SV *sv)
2323 if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2324 /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2325 cache IVs just in case. */
2329 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2330 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2331 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2333 return Atof(SvPVX_const(sv));
2337 return (NV)SvUVX(sv);
2339 return (NV)SvIVX(sv);
2344 assert(SvTYPE(sv) >= SVt_PVMG);
2345 /* This falls through to the report_uninit near the end of the
2347 } else if (SvTHINKFIRST(sv)) {
2351 SV *const tmpstr = AMG_CALLun(sv,numer);
2352 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2353 return SvNV(tmpstr);
2356 return PTR2NV(SvRV(sv));
2359 sv_force_normal_flags(sv, 0);
2361 if (SvREADONLY(sv) && !SvOK(sv)) {
2362 if (ckWARN(WARN_UNINITIALIZED))
2367 if (SvTYPE(sv) < SVt_NV) {
2368 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2369 sv_upgrade(sv, SVt_NV);
2370 #ifdef USE_LONG_DOUBLE
2372 STORE_NUMERIC_LOCAL_SET_STANDARD();
2373 PerlIO_printf(Perl_debug_log,
2374 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2375 PTR2UV(sv), SvNVX(sv));
2376 RESTORE_NUMERIC_LOCAL();
2380 STORE_NUMERIC_LOCAL_SET_STANDARD();
2381 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2382 PTR2UV(sv), SvNVX(sv));
2383 RESTORE_NUMERIC_LOCAL();
2387 else if (SvTYPE(sv) < SVt_PVNV)
2388 sv_upgrade(sv, SVt_PVNV);
2393 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2394 #ifdef NV_PRESERVES_UV
2397 /* Only set the public NV OK flag if this NV preserves the IV */
2398 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2399 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2400 : (SvIVX(sv) == I_V(SvNVX(sv))))
2406 else if (SvPOKp(sv) && SvLEN(sv)) {
2408 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2409 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2411 #ifdef NV_PRESERVES_UV
2412 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2413 == IS_NUMBER_IN_UV) {
2414 /* It's definitely an integer */
2415 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2417 SvNV_set(sv, Atof(SvPVX_const(sv)));
2420 SvNV_set(sv, Atof(SvPVX_const(sv)));
2421 /* Only set the public NV OK flag if this NV preserves the value in
2422 the PV at least as well as an IV/UV would.
2423 Not sure how to do this 100% reliably. */
2424 /* if that shift count is out of range then Configure's test is
2425 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2427 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2428 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2429 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2430 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2431 /* Can't use strtol etc to convert this string, so don't try.
2432 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2435 /* value has been set. It may not be precise. */
2436 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2437 /* 2s complement assumption for (UV)IV_MIN */
2438 SvNOK_on(sv); /* Integer is too negative. */
2443 if (numtype & IS_NUMBER_NEG) {
2444 SvIV_set(sv, -(IV)value);
2445 } else if (value <= (UV)IV_MAX) {
2446 SvIV_set(sv, (IV)value);
2448 SvUV_set(sv, value);
2452 if (numtype & IS_NUMBER_NOT_INT) {
2453 /* I believe that even if the original PV had decimals,
2454 they are lost beyond the limit of the FP precision.
2455 However, neither is canonical, so both only get p
2456 flags. NWC, 2000/11/25 */
2457 /* Both already have p flags, so do nothing */
2459 const NV nv = SvNVX(sv);
2460 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2461 if (SvIVX(sv) == I_V(nv)) {
2464 /* It had no "." so it must be integer. */
2468 /* between IV_MAX and NV(UV_MAX).
2469 Could be slightly > UV_MAX */
2471 if (numtype & IS_NUMBER_NOT_INT) {
2472 /* UV and NV both imprecise. */
2474 const UV nv_as_uv = U_V(nv);
2476 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2485 #endif /* NV_PRESERVES_UV */
2488 if (isGV_with_GP(sv)) {
2489 glob_2number((GV *)sv);
2493 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2495 assert (SvTYPE(sv) >= SVt_NV);
2496 /* Typically the caller expects that sv_any is not NULL now. */
2497 /* XXX Ilya implies that this is a bug in callers that assume this
2498 and ideally should be fixed. */
2501 #if defined(USE_LONG_DOUBLE)
2503 STORE_NUMERIC_LOCAL_SET_STANDARD();
2504 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2505 PTR2UV(sv), SvNVX(sv));
2506 RESTORE_NUMERIC_LOCAL();
2510 STORE_NUMERIC_LOCAL_SET_STANDARD();
2511 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2512 PTR2UV(sv), SvNVX(sv));
2513 RESTORE_NUMERIC_LOCAL();
2519 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2520 * UV as a string towards the end of buf, and return pointers to start and
2523 * We assume that buf is at least TYPE_CHARS(UV) long.
2527 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2529 char *ptr = buf + TYPE_CHARS(UV);
2530 char * const ebuf = ptr;
2543 *--ptr = '0' + (char)(uv % 10);
2552 =for apidoc sv_2pv_flags
2554 Returns a pointer to the string value of an SV, and sets *lp to its length.
2555 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2557 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2558 usually end up here too.
2564 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2574 if (SvGMAGICAL(sv)) {
2575 if (flags & SV_GMAGIC)
2580 if (flags & SV_MUTABLE_RETURN)
2581 return SvPVX_mutable(sv);
2582 if (flags & SV_CONST_RETURN)
2583 return (char *)SvPVX_const(sv);
2586 if (SvIOKp(sv) || SvNOKp(sv)) {
2587 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2592 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2593 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2595 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2602 #ifdef FIXNEGATIVEZERO
2603 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2609 SvUPGRADE(sv, SVt_PV);
2612 s = SvGROW_mutable(sv, len + 1);
2615 return (char*)memcpy(s, tbuf, len + 1);
2621 assert(SvTYPE(sv) >= SVt_PVMG);
2622 /* This falls through to the report_uninit near the end of the
2624 } else if (SvTHINKFIRST(sv)) {
2628 SV *const tmpstr = AMG_CALLun(sv,string);
2629 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2631 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2635 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2636 if (flags & SV_CONST_RETURN) {
2637 pv = (char *) SvPVX_const(tmpstr);
2639 pv = (flags & SV_MUTABLE_RETURN)
2640 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2643 *lp = SvCUR(tmpstr);
2645 pv = sv_2pv_flags(tmpstr, lp, flags);
2659 const SV *const referent = (SV*)SvRV(sv);
2663 retval = buffer = savepvn("NULLREF", len);
2664 } else if (SvTYPE(referent) == SVt_PVMG
2665 && ((SvFLAGS(referent) &
2666 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2667 == (SVs_OBJECT|SVs_SMG))
2668 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2673 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2678 PL_reginterp_cnt += haseval;
2681 const char *const typestr = sv_reftype(referent, 0);
2682 const STRLEN typelen = strlen(typestr);
2683 UV addr = PTR2UV(referent);
2684 const char *stashname = NULL;
2685 STRLEN stashnamelen = 0; /* hush, gcc */
2686 const char *buffer_end;
2688 if (SvOBJECT(referent)) {
2689 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2692 stashname = HEK_KEY(name);
2693 stashnamelen = HEK_LEN(name);
2695 if (HEK_UTF8(name)) {
2701 stashname = "__ANON__";
2704 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2705 + 2 * sizeof(UV) + 2 /* )\0 */;
2707 len = typelen + 3 /* (0x */
2708 + 2 * sizeof(UV) + 2 /* )\0 */;
2711 Newx(buffer, len, char);
2712 buffer_end = retval = buffer + len;
2714 /* Working backwards */
2718 *--retval = PL_hexdigit[addr & 15];
2719 } while (addr >>= 4);
2725 memcpy(retval, typestr, typelen);
2729 retval -= stashnamelen;
2730 memcpy(retval, stashname, stashnamelen);
2732 /* retval may not neccesarily have reached the start of the
2734 assert (retval >= buffer);
2736 len = buffer_end - retval - 1; /* -1 for that \0 */
2744 if (SvREADONLY(sv) && !SvOK(sv)) {
2745 if (ckWARN(WARN_UNINITIALIZED))
2752 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2753 /* I'm assuming that if both IV and NV are equally valid then
2754 converting the IV is going to be more efficient */
2755 const U32 isUIOK = SvIsUV(sv);
2756 char buf[TYPE_CHARS(UV)];
2759 if (SvTYPE(sv) < SVt_PVIV)
2760 sv_upgrade(sv, SVt_PVIV);
2761 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2762 /* inlined from sv_setpvn */
2763 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2764 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2765 SvCUR_set(sv, ebuf - ptr);
2769 else if (SvNOKp(sv)) {
2770 const int olderrno = errno;
2771 if (SvTYPE(sv) < SVt_PVNV)
2772 sv_upgrade(sv, SVt_PVNV);
2773 /* The +20 is pure guesswork. Configure test needed. --jhi */
2774 s = SvGROW_mutable(sv, NV_DIG + 20);
2775 /* some Xenix systems wipe out errno here */
2777 if (SvNVX(sv) == 0.0)
2778 my_strlcpy(s, "0", SvLEN(sv));
2782 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2785 #ifdef FIXNEGATIVEZERO
2786 if (*s == '-' && s[1] == '0' && !s[2])
2787 my_strlcpy(s, "0", SvLEN(s));
2796 if (isGV_with_GP(sv))
2797 return glob_2pv((GV *)sv, lp);
2799 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2803 if (SvTYPE(sv) < SVt_PV)
2804 /* Typically the caller expects that sv_any is not NULL now. */
2805 sv_upgrade(sv, SVt_PV);
2809 const STRLEN len = s - SvPVX_const(sv);
2815 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2816 PTR2UV(sv),SvPVX_const(sv)));
2817 if (flags & SV_CONST_RETURN)
2818 return (char *)SvPVX_const(sv);
2819 if (flags & SV_MUTABLE_RETURN)
2820 return SvPVX_mutable(sv);
2825 =for apidoc sv_copypv
2827 Copies a stringified representation of the source SV into the
2828 destination SV. Automatically performs any necessary mg_get and
2829 coercion of numeric values into strings. Guaranteed to preserve
2830 UTF-8 flag even from overloaded objects. Similar in nature to
2831 sv_2pv[_flags] but operates directly on an SV instead of just the
2832 string. Mostly uses sv_2pv_flags to do its work, except when that
2833 would lose the UTF-8'ness of the PV.
2839 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2842 const char * const s = SvPV_const(ssv,len);
2843 sv_setpvn(dsv,s,len);
2851 =for apidoc sv_2pvbyte
2853 Return a pointer to the byte-encoded representation of the SV, and set *lp
2854 to its length. May cause the SV to be downgraded from UTF-8 as a
2857 Usually accessed via the C<SvPVbyte> macro.
2863 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2865 sv_utf8_downgrade(sv,0);
2866 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2870 =for apidoc sv_2pvutf8
2872 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2873 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2875 Usually accessed via the C<SvPVutf8> macro.
2881 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2883 sv_utf8_upgrade(sv);
2884 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2889 =for apidoc sv_2bool
2891 This function is only called on magical items, and is only used by
2892 sv_true() or its macro equivalent.
2898 Perl_sv_2bool(pTHX_ register SV *sv)
2907 SV * const tmpsv = AMG_CALLun(sv,bool_);
2908 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2909 return (bool)SvTRUE(tmpsv);
2911 return SvRV(sv) != 0;
2914 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2916 (*sv->sv_u.svu_pv > '0' ||
2917 Xpvtmp->xpv_cur > 1 ||
2918 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2925 return SvIVX(sv) != 0;
2928 return SvNVX(sv) != 0.0;
2930 if (isGV_with_GP(sv))
2940 =for apidoc sv_utf8_upgrade
2942 Converts the PV of an SV to its UTF-8-encoded form.
2943 Forces the SV to string form if it is not already.
2944 Always sets the SvUTF8 flag to avoid future validity checks even
2945 if all the bytes have hibit clear.
2947 This is not as a general purpose byte encoding to Unicode interface:
2948 use the Encode extension for that.
2950 =for apidoc sv_utf8_upgrade_flags
2952 Converts the PV of an SV to its UTF-8-encoded form.
2953 Forces the SV to string form if it is not already.
2954 Always sets the SvUTF8 flag to avoid future validity checks even
2955 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2956 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2957 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2959 This is not as a general purpose byte encoding to Unicode interface:
2960 use the Encode extension for that.
2966 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2969 if (sv == &PL_sv_undef)
2973 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2974 (void) sv_2pv_flags(sv,&len, flags);
2978 (void) SvPV_force(sv,len);
2987 sv_force_normal_flags(sv, 0);
2990 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2991 sv_recode_to_utf8(sv, PL_encoding);
2992 else { /* Assume Latin-1/EBCDIC */
2993 /* This function could be much more efficient if we
2994 * had a FLAG in SVs to signal if there are any hibit
2995 * chars in the PV. Given that there isn't such a flag
2996 * make the loop as fast as possible. */
2997 const U8 * const s = (U8 *) SvPVX_const(sv);
2998 const U8 * const e = (U8 *) SvEND(sv);
3003 /* Check for hi bit */
3004 if (!NATIVE_IS_INVARIANT(ch)) {
3005 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3006 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3008 SvPV_free(sv); /* No longer using what was there before. */
3009 SvPV_set(sv, (char*)recoded);
3010 SvCUR_set(sv, len - 1);
3011 SvLEN_set(sv, len); /* No longer know the real size. */
3015 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3022 =for apidoc sv_utf8_downgrade
3024 Attempts to convert the PV of an SV from characters to bytes.
3025 If the PV contains a character beyond byte, this conversion will fail;
3026 in this case, either returns false or, if C<fail_ok> is not
3029 This is not as a general purpose Unicode to byte encoding interface:
3030 use the Encode extension for that.
3036 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3039 if (SvPOKp(sv) && SvUTF8(sv)) {
3045 sv_force_normal_flags(sv, 0);
3047 s = (U8 *) SvPV(sv, len);
3048 if (!utf8_to_bytes(s, &len)) {
3053 Perl_croak(aTHX_ "Wide character in %s",
3056 Perl_croak(aTHX_ "Wide character");
3067 =for apidoc sv_utf8_encode
3069 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3070 flag off so that it looks like octets again.
3076 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3079 sv_force_normal_flags(sv, 0);
3081 if (SvREADONLY(sv)) {
3082 Perl_croak(aTHX_ PL_no_modify);
3084 (void) sv_utf8_upgrade(sv);
3089 =for apidoc sv_utf8_decode
3091 If the PV of the SV is an octet sequence in UTF-8
3092 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3093 so that it looks like a character. If the PV contains only single-byte
3094 characters, the C<SvUTF8> flag stays being off.
3095 Scans PV for validity and returns false if the PV is invalid UTF-8.
3101 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3107 /* The octets may have got themselves encoded - get them back as
3110 if (!sv_utf8_downgrade(sv, TRUE))
3113 /* it is actually just a matter of turning the utf8 flag on, but
3114 * we want to make sure everything inside is valid utf8 first.
3116 c = (const U8 *) SvPVX_const(sv);
3117 if (!is_utf8_string(c, SvCUR(sv)+1))
3119 e = (const U8 *) SvEND(sv);
3122 if (!UTF8_IS_INVARIANT(ch)) {
3132 =for apidoc sv_setsv
3134 Copies the contents of the source SV C<ssv> into the destination SV
3135 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3136 function if the source SV needs to be reused. Does not handle 'set' magic.
3137 Loosely speaking, it performs a copy-by-value, obliterating any previous
3138 content of the destination.
3140 You probably want to use one of the assortment of wrappers, such as
3141 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3142 C<SvSetMagicSV_nosteal>.
3144 =for apidoc sv_setsv_flags
3146 Copies the contents of the source SV C<ssv> into the destination SV
3147 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3148 function if the source SV needs to be reused. Does not handle 'set' magic.
3149 Loosely speaking, it performs a copy-by-value, obliterating any previous
3150 content of the destination.
3151 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3152 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3153 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3154 and C<sv_setsv_nomg> are implemented in terms of this function.
3156 You probably want to use one of the assortment of wrappers, such as
3157 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3158 C<SvSetMagicSV_nosteal>.
3160 This is the primary function for copying scalars, and most other
3161 copy-ish functions and macros use this underneath.
3167 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3169 if (dtype != SVt_PVGV) {
3170 const char * const name = GvNAME(sstr);
3171 const STRLEN len = GvNAMELEN(sstr);
3172 /* don't upgrade SVt_PVLV: it can hold a glob */
3173 if (dtype != SVt_PVLV) {
3174 if (dtype >= SVt_PV) {
3180 sv_upgrade(dstr, SVt_PVGV);
3181 (void)SvOK_off(dstr);
3184 GvSTASH(dstr) = GvSTASH(sstr);
3186 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3187 gv_name_set((GV *)dstr, name, len, GV_ADD);
3188 SvFAKE_on(dstr); /* can coerce to non-glob */
3191 #ifdef GV_UNIQUE_CHECK
3192 if (GvUNIQUE((GV*)dstr)) {
3193 Perl_croak(aTHX_ PL_no_modify);
3199 (void)SvOK_off(dstr);
3201 GvINTRO_off(dstr); /* one-shot flag */
3202 GvGP(dstr) = gp_ref(GvGP(sstr));
3203 if (SvTAINTED(sstr))
3205 if (GvIMPORTED(dstr) != GVf_IMPORTED
3206 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3208 GvIMPORTED_on(dstr);
3215 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3216 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3218 const int intro = GvINTRO(dstr);
3221 const U32 stype = SvTYPE(sref);
3224 #ifdef GV_UNIQUE_CHECK
3225 if (GvUNIQUE((GV*)dstr)) {
3226 Perl_croak(aTHX_ PL_no_modify);
3231 GvINTRO_off(dstr); /* one-shot flag */
3232 GvLINE(dstr) = CopLINE(PL_curcop);
3233 GvEGV(dstr) = (GV*)dstr;
3238 location = (SV **) &GvCV(dstr);
3239 import_flag = GVf_IMPORTED_CV;
3242 location = (SV **) &GvHV(dstr);
3243 import_flag = GVf_IMPORTED_HV;
3246 location = (SV **) &GvAV(dstr);
3247 import_flag = GVf_IMPORTED_AV;
3250 location = (SV **) &GvIOp(dstr);
3253 location = (SV **) &GvFORM(dstr);
3255 location = &GvSV(dstr);
3256 import_flag = GVf_IMPORTED_SV;
3259 if (stype == SVt_PVCV) {
3260 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3261 SvREFCNT_dec(GvCV(dstr));
3263 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3264 PL_sub_generation++;
3267 SAVEGENERICSV(*location);
3271 if (stype == SVt_PVCV && *location != sref) {
3272 CV* const cv = (CV*)*location;
3274 if (!GvCVGEN((GV*)dstr) &&
3275 (CvROOT(cv) || CvXSUB(cv)))
3277 /* Redefining a sub - warning is mandatory if
3278 it was a const and its value changed. */
3279 if (CvCONST(cv) && CvCONST((CV*)sref)
3280 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3282 /* They are 2 constant subroutines generated from
3283 the same constant. This probably means that
3284 they are really the "same" proxy subroutine
3285 instantiated in 2 places. Most likely this is
3286 when a constant is exported twice. Don't warn.
3289 else if (ckWARN(WARN_REDEFINE)
3291 && (!CvCONST((CV*)sref)
3292 || sv_cmp(cv_const_sv(cv),
3293 cv_const_sv((CV*)sref))))) {
3294 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3297 ? "Constant subroutine %s::%s redefined"
3298 : "Subroutine %s::%s redefined"),
3299 HvNAME_get(GvSTASH((GV*)dstr)),
3300 GvENAME((GV*)dstr));
3304 cv_ckproto_len(cv, (GV*)dstr,
3305 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3306 SvPOK(sref) ? SvCUR(sref) : 0);
3308 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3309 GvASSUMECV_on(dstr);
3310 PL_sub_generation++;
3313 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3314 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3315 GvFLAGS(dstr) |= import_flag;
3320 if (SvTAINTED(sstr))
3326 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3329 register U32 sflags;
3331 register svtype stype;
3336 if (SvIS_FREED(dstr)) {
3337 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3338 " to a freed scalar %p", sstr, dstr);
3340 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3342 sstr = &PL_sv_undef;
3343 if (SvIS_FREED(sstr)) {
3344 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3347 stype = SvTYPE(sstr);
3348 dtype = SvTYPE(dstr);
3353 /* need to nuke the magic */
3355 SvRMAGICAL_off(dstr);
3358 /* There's a lot of redundancy below but we're going for speed here */
3363 if (dtype != SVt_PVGV) {
3364 (void)SvOK_off(dstr);
3372 sv_upgrade(dstr, SVt_IV);
3377 sv_upgrade(dstr, SVt_PVIV);
3380 (void)SvIOK_only(dstr);
3381 SvIV_set(dstr, SvIVX(sstr));
3384 /* SvTAINTED can only be true if the SV has taint magic, which in
3385 turn means that the SV type is PVMG (or greater). This is the
3386 case statement for SVt_IV, so this cannot be true (whatever gcov
3388 assert(!SvTAINTED(sstr));
3398 sv_upgrade(dstr, SVt_NV);
3403 sv_upgrade(dstr, SVt_PVNV);
3406 SvNV_set(dstr, SvNVX(sstr));
3407 (void)SvNOK_only(dstr);
3408 /* SvTAINTED can only be true if the SV has taint magic, which in
3409 turn means that the SV type is PVMG (or greater). This is the
3410 case statement for SVt_NV, so this cannot be true (whatever gcov
3412 assert(!SvTAINTED(sstr));
3419 sv_upgrade(dstr, SVt_RV);
3422 #ifdef PERL_OLD_COPY_ON_WRITE
3423 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3424 if (dtype < SVt_PVIV)
3425 sv_upgrade(dstr, SVt_PVIV);
3432 sv_upgrade(dstr, SVt_PV);
3435 if (dtype < SVt_PVIV)
3436 sv_upgrade(dstr, SVt_PVIV);
3439 if (dtype < SVt_PVNV)
3440 sv_upgrade(dstr, SVt_PVNV);
3444 const char * const type = sv_reftype(sstr,0);
3446 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3448 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3453 if (dtype <= SVt_PVGV) {
3454 glob_assign_glob(dstr, sstr, dtype);
3462 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3464 if (SvTYPE(sstr) != stype) {
3465 stype = SvTYPE(sstr);
3466 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3467 glob_assign_glob(dstr, sstr, dtype);
3472 if (stype == SVt_PVLV)
3473 SvUPGRADE(dstr, SVt_PVNV);
3475 SvUPGRADE(dstr, (svtype)stype);
3478 /* dstr may have been upgraded. */
3479 dtype = SvTYPE(dstr);
3480 sflags = SvFLAGS(sstr);
3482 if (dtype == SVt_PVCV) {
3483 /* Assigning to a subroutine sets the prototype. */
3486 const char *const ptr = SvPV_const(sstr, len);
3488 SvGROW(dstr, len + 1);
3489 Copy(ptr, SvPVX(dstr), len + 1, char);
3490 SvCUR_set(dstr, len);
3495 } else if (sflags & SVf_ROK) {
3496 if (dtype == SVt_PVGV && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3499 if (GvIMPORTED(dstr) != GVf_IMPORTED
3500 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3502 GvIMPORTED_on(dstr);
3507 glob_assign_glob(dstr, sstr, dtype);
3511 if (dtype >= SVt_PV) {
3512 if (dtype == SVt_PVGV) {
3513 glob_assign_ref(dstr, sstr);
3516 if (SvPVX_const(dstr)) {
3522 (void)SvOK_off(dstr);
3523 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3524 SvFLAGS(dstr) |= sflags & SVf_ROK;
3525 assert(!(sflags & SVp_NOK));
3526 assert(!(sflags & SVp_IOK));
3527 assert(!(sflags & SVf_NOK));
3528 assert(!(sflags & SVf_IOK));
3530 else if (dtype == SVt_PVGV) {
3531 if (!(sflags & SVf_OK)) {
3532 if (ckWARN(WARN_MISC))
3533 Perl_warner(aTHX_ packWARN(WARN_MISC),
3534 "Undefined value assigned to typeglob");
3537 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3538 if (dstr != (SV*)gv) {
3541 GvGP(dstr) = gp_ref(GvGP(gv));
3545 else if (sflags & SVp_POK) {
3549 * Check to see if we can just swipe the string. If so, it's a
3550 * possible small lose on short strings, but a big win on long ones.
3551 * It might even be a win on short strings if SvPVX_const(dstr)
3552 * has to be allocated and SvPVX_const(sstr) has to be freed.
3553 * Likewise if we can set up COW rather than doing an actual copy, we
3554 * drop to the else clause, as the swipe code and the COW setup code
3555 * have much in common.
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 /* If we're already COW then this clause is not true, and if COW
3564 is allowed then we drop down to the else and make dest COW
3565 with us. If caller hasn't said that we're allowed to COW
3566 shared hash keys then we don't do the COW setup, even if the
3567 source scalar is a shared hash key scalar. */
3568 (((flags & SV_COW_SHARED_HASH_KEYS)
3569 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3570 : 1 /* If making a COW copy is forbidden then the behaviour we
3571 desire is as if the source SV isn't actually already
3572 COW, even if it is. So we act as if the source flags
3573 are not COW, rather than actually testing them. */
3575 #ifndef PERL_OLD_COPY_ON_WRITE
3576 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3577 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3578 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3579 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3580 but in turn, it's somewhat dead code, never expected to go
3581 live, but more kept as a placeholder on how to do it better
3582 in a newer implementation. */
3583 /* If we are COW and dstr is a suitable target then we drop down
3584 into the else and make dest a COW of us. */
3585 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3590 (sflags & SVs_TEMP) && /* slated for free anyway? */
3591 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3592 (!(flags & SV_NOSTEAL)) &&
3593 /* and we're allowed to steal temps */
3594 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3595 SvLEN(sstr) && /* and really is a string */
3596 /* and won't be needed again, potentially */
3597 !(PL_op && PL_op->op_type == OP_AASSIGN))
3598 #ifdef PERL_OLD_COPY_ON_WRITE
3599 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3600 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3601 && SvTYPE(sstr) >= SVt_PVIV)
3604 /* Failed the swipe test, and it's not a shared hash key either.
3605 Have to copy the string. */
3606 STRLEN len = SvCUR(sstr);
3607 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3608 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3609 SvCUR_set(dstr, len);
3610 *SvEND(dstr) = '\0';
3612 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3614 /* Either it's a shared hash key, or it's suitable for
3615 copy-on-write or we can swipe the string. */
3617 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3621 #ifdef PERL_OLD_COPY_ON_WRITE
3623 /* I believe I should acquire a global SV mutex if
3624 it's a COW sv (not a shared hash key) to stop
3625 it going un copy-on-write.
3626 If the source SV has gone un copy on write between up there
3627 and down here, then (assert() that) it is of the correct
3628 form to make it copy on write again */
3629 if ((sflags & (SVf_FAKE | SVf_READONLY))
3630 != (SVf_FAKE | SVf_READONLY)) {
3631 SvREADONLY_on(sstr);
3633 /* Make the source SV into a loop of 1.
3634 (about to become 2) */
3635 SV_COW_NEXT_SV_SET(sstr, sstr);
3639 /* Initial code is common. */
3640 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3645 /* making another shared SV. */
3646 STRLEN cur = SvCUR(sstr);
3647 STRLEN len = SvLEN(sstr);
3648 #ifdef PERL_OLD_COPY_ON_WRITE
3650 assert (SvTYPE(dstr) >= SVt_PVIV);
3651 /* SvIsCOW_normal */
3652 /* splice us in between source and next-after-source. */
3653 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3654 SV_COW_NEXT_SV_SET(sstr, dstr);
3655 SvPV_set(dstr, SvPVX_mutable(sstr));
3659 /* SvIsCOW_shared_hash */
3660 DEBUG_C(PerlIO_printf(Perl_debug_log,
3661 "Copy on write: Sharing hash\n"));
3663 assert (SvTYPE(dstr) >= SVt_PV);
3665 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3667 SvLEN_set(dstr, len);
3668 SvCUR_set(dstr, cur);
3669 SvREADONLY_on(dstr);
3671 /* Relesase a global SV mutex. */
3674 { /* Passes the swipe test. */
3675 SvPV_set(dstr, SvPVX_mutable(sstr));
3676 SvLEN_set(dstr, SvLEN(sstr));
3677 SvCUR_set(dstr, SvCUR(sstr));
3680 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3681 SvPV_set(sstr, NULL);
3687 if (sflags & SVp_NOK) {
3688 SvNV_set(dstr, SvNVX(sstr));
3690 if (sflags & SVp_IOK) {
3691 SvRELEASE_IVX(dstr);
3692 SvIV_set(dstr, SvIVX(sstr));
3693 /* Must do this otherwise some other overloaded use of 0x80000000
3694 gets confused. I guess SVpbm_VALID */
3695 if (sflags & SVf_IVisUV)
3698 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3700 const MAGIC * const smg = SvVSTRING_mg(sstr);
3702 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3703 smg->mg_ptr, smg->mg_len);
3704 SvRMAGICAL_on(dstr);
3708 else if (sflags & (SVp_IOK|SVp_NOK)) {
3709 (void)SvOK_off(dstr);
3710 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3711 if (sflags & SVp_IOK) {
3712 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3713 SvIV_set(dstr, SvIVX(sstr));
3715 if (sflags & SVp_NOK) {
3716 SvNV_set(dstr, SvNVX(sstr));
3720 if (isGV_with_GP(sstr)) {
3721 /* This stringification rule for globs is spread in 3 places.
3722 This feels bad. FIXME. */
3723 const U32 wasfake = sflags & SVf_FAKE;
3725 /* FAKE globs can get coerced, so need to turn this off
3726 temporarily if it is on. */
3728 gv_efullname3(dstr, (GV *)sstr, "*");
3729 SvFLAGS(sstr) |= wasfake;
3732 (void)SvOK_off(dstr);
3734 if (SvTAINTED(sstr))
3739 =for apidoc sv_setsv_mg
3741 Like C<sv_setsv>, but also handles 'set' magic.
3747 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3749 sv_setsv(dstr,sstr);
3753 #ifdef PERL_OLD_COPY_ON_WRITE
3755 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3757 STRLEN cur = SvCUR(sstr);
3758 STRLEN len = SvLEN(sstr);
3759 register char *new_pv;
3762 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3770 if (SvTHINKFIRST(dstr))
3771 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3772 else if (SvPVX_const(dstr))
3773 Safefree(SvPVX_const(dstr));
3777 SvUPGRADE(dstr, SVt_PVIV);
3779 assert (SvPOK(sstr));
3780 assert (SvPOKp(sstr));
3781 assert (!SvIOK(sstr));
3782 assert (!SvIOKp(sstr));
3783 assert (!SvNOK(sstr));
3784 assert (!SvNOKp(sstr));
3786 if (SvIsCOW(sstr)) {
3788 if (SvLEN(sstr) == 0) {
3789 /* source is a COW shared hash key. */
3790 DEBUG_C(PerlIO_printf(Perl_debug_log,
3791 "Fast copy on write: Sharing hash\n"));
3792 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3795 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3797 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3798 SvUPGRADE(sstr, SVt_PVIV);
3799 SvREADONLY_on(sstr);
3801 DEBUG_C(PerlIO_printf(Perl_debug_log,
3802 "Fast copy on write: Converting sstr to COW\n"));
3803 SV_COW_NEXT_SV_SET(dstr, sstr);
3805 SV_COW_NEXT_SV_SET(sstr, dstr);
3806 new_pv = SvPVX_mutable(sstr);
3809 SvPV_set(dstr, new_pv);
3810 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3813 SvLEN_set(dstr, len);
3814 SvCUR_set(dstr, cur);
3823 =for apidoc sv_setpvn
3825 Copies a string into an SV. The C<len> parameter indicates the number of
3826 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3827 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3833 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3836 register char *dptr;
3838 SV_CHECK_THINKFIRST_COW_DROP(sv);
3844 /* len is STRLEN which is unsigned, need to copy to signed */
3847 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3849 SvUPGRADE(sv, SVt_PV);
3851 dptr = SvGROW(sv, len + 1);
3852 Move(ptr,dptr,len,char);
3855 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3860 =for apidoc sv_setpvn_mg
3862 Like C<sv_setpvn>, but also handles 'set' magic.
3868 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3870 sv_setpvn(sv,ptr,len);
3875 =for apidoc sv_setpv
3877 Copies a string into an SV. The string must be null-terminated. Does not
3878 handle 'set' magic. See C<sv_setpv_mg>.
3884 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3887 register STRLEN len;
3889 SV_CHECK_THINKFIRST_COW_DROP(sv);
3895 SvUPGRADE(sv, SVt_PV);
3897 SvGROW(sv, len + 1);
3898 Move(ptr,SvPVX(sv),len+1,char);
3900 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3905 =for apidoc sv_setpv_mg
3907 Like C<sv_setpv>, but also handles 'set' magic.
3913 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3920 =for apidoc sv_usepvn_flags
3922 Tells an SV to use C<ptr> to find its string value. Normally the
3923 string is stored inside the SV but sv_usepvn allows the SV to use an
3924 outside string. The C<ptr> should point to memory that was allocated
3925 by C<malloc>. The string length, C<len>, must be supplied. By default
3926 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3927 so that pointer should not be freed or used by the programmer after
3928 giving it to sv_usepvn, and neither should any pointers from "behind"
3929 that pointer (e.g. ptr + 1) be used.
3931 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3932 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3933 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3934 C<len>, and already meets the requirements for storing in C<SvPVX>)
3940 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3944 SV_CHECK_THINKFIRST_COW_DROP(sv);
3945 SvUPGRADE(sv, SVt_PV);
3948 if (flags & SV_SMAGIC)
3952 if (SvPVX_const(sv))
3956 if (flags & SV_HAS_TRAILING_NUL)
3957 assert(ptr[len] == '\0');
3960 allocate = (flags & SV_HAS_TRAILING_NUL)
3961 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3962 if (flags & SV_HAS_TRAILING_NUL) {
3963 /* It's long enough - do nothing.
3964 Specfically Perl_newCONSTSUB is relying on this. */
3967 /* Force a move to shake out bugs in callers. */
3968 char *new_ptr = (char*)safemalloc(allocate);
3969 Copy(ptr, new_ptr, len, char);
3970 PoisonFree(ptr,len,char);
3974 ptr = (char*) saferealloc (ptr, allocate);
3979 SvLEN_set(sv, allocate);
3980 if (!(flags & SV_HAS_TRAILING_NUL)) {
3983 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3985 if (flags & SV_SMAGIC)
3989 #ifdef PERL_OLD_COPY_ON_WRITE
3990 /* Need to do this *after* making the SV normal, as we need the buffer
3991 pointer to remain valid until after we've copied it. If we let go too early,
3992 another thread could invalidate it by unsharing last of the same hash key
3993 (which it can do by means other than releasing copy-on-write Svs)
3994 or by changing the other copy-on-write SVs in the loop. */
3996 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3998 if (len) { /* this SV was SvIsCOW_normal(sv) */
3999 /* we need to find the SV pointing to us. */
4000 SV *current = SV_COW_NEXT_SV(after);
4002 if (current == sv) {
4003 /* The SV we point to points back to us (there were only two of us
4005 Hence other SV is no longer copy on write either. */
4007 SvREADONLY_off(after);
4009 /* We need to follow the pointers around the loop. */
4011 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4014 /* don't loop forever if the structure is bust, and we have
4015 a pointer into a closed loop. */
4016 assert (current != after);
4017 assert (SvPVX_const(current) == pvx);
4019 /* Make the SV before us point to the SV after us. */
4020 SV_COW_NEXT_SV_SET(current, after);
4023 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4028 Perl_sv_release_IVX(pTHX_ register SV *sv)
4031 sv_force_normal_flags(sv, 0);
4037 =for apidoc sv_force_normal_flags
4039 Undo various types of fakery on an SV: if the PV is a shared string, make
4040 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4041 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4042 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4043 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4044 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4045 set to some other value.) In addition, the C<flags> parameter gets passed to
4046 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4047 with flags set to 0.
4053 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4056 #ifdef PERL_OLD_COPY_ON_WRITE
4057 if (SvREADONLY(sv)) {
4058 /* At this point I believe I should acquire a global SV mutex. */
4060 const char * const pvx = SvPVX_const(sv);
4061 const STRLEN len = SvLEN(sv);
4062 const STRLEN cur = SvCUR(sv);
4063 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4065 PerlIO_printf(Perl_debug_log,
4066 "Copy on write: Force normal %ld\n",
4072 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4075 if (flags & SV_COW_DROP_PV) {
4076 /* OK, so we don't need to copy our buffer. */
4079 SvGROW(sv, cur + 1);
4080 Move(pvx,SvPVX(sv),cur,char);
4084 sv_release_COW(sv, pvx, len, next);
4089 else if (IN_PERL_RUNTIME)
4090 Perl_croak(aTHX_ PL_no_modify);
4091 /* At this point I believe that I can drop the global SV mutex. */
4094 if (SvREADONLY(sv)) {
4096 const char * const pvx = SvPVX_const(sv);
4097 const STRLEN len = SvCUR(sv);
4102 SvGROW(sv, len + 1);
4103 Move(pvx,SvPVX(sv),len,char);
4105 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4107 else if (IN_PERL_RUNTIME)
4108 Perl_croak(aTHX_ PL_no_modify);
4112 sv_unref_flags(sv, flags);
4113 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4120 Efficient removal of characters from the beginning of the string buffer.
4121 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4122 the string buffer. The C<ptr> becomes the first character of the adjusted
4123 string. Uses the "OOK hack".
4124 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4125 refer to the same chunk of data.
4131 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4133 register STRLEN delta;
4134 if (!ptr || !SvPOKp(sv))
4136 delta = ptr - SvPVX_const(sv);
4137 SV_CHECK_THINKFIRST(sv);
4138 if (SvTYPE(sv) < SVt_PVIV)
4139 sv_upgrade(sv,SVt_PVIV);
4142 if (!SvLEN(sv)) { /* make copy of shared string */
4143 const char *pvx = SvPVX_const(sv);
4144 const STRLEN len = SvCUR(sv);
4145 SvGROW(sv, len + 1);
4146 Move(pvx,SvPVX(sv),len,char);
4150 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4151 and we do that anyway inside the SvNIOK_off
4153 SvFLAGS(sv) |= SVf_OOK;
4156 SvLEN_set(sv, SvLEN(sv) - delta);
4157 SvCUR_set(sv, SvCUR(sv) - delta);
4158 SvPV_set(sv, SvPVX(sv) + delta);
4159 SvIV_set(sv, SvIVX(sv) + delta);
4163 =for apidoc sv_catpvn
4165 Concatenates the string onto the end of the string which is in the SV. The
4166 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4167 status set, then the bytes appended should be valid UTF-8.
4168 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4170 =for apidoc sv_catpvn_flags
4172 Concatenates the string onto the end of the string which is in the SV. The
4173 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4174 status set, then the bytes appended should be valid UTF-8.
4175 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4176 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4177 in terms of this function.
4183 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4187 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4189 SvGROW(dsv, dlen + slen + 1);
4191 sstr = SvPVX_const(dsv);
4192 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4193 SvCUR_set(dsv, SvCUR(dsv) + slen);
4195 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4197 if (flags & SV_SMAGIC)
4202 =for apidoc sv_catsv
4204 Concatenates the string from SV C<ssv> onto the end of the string in
4205 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4206 not 'set' magic. See C<sv_catsv_mg>.
4208 =for apidoc sv_catsv_flags
4210 Concatenates the string from SV C<ssv> onto the end of the string in
4211 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4212 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4213 and C<sv_catsv_nomg> are implemented in terms of this function.
4218 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4223 const char *spv = SvPV_const(ssv, slen);
4225 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4226 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4227 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4228 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4229 dsv->sv_flags doesn't have that bit set.
4230 Andy Dougherty 12 Oct 2001
4232 const I32 sutf8 = DO_UTF8(ssv);
4235 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4237 dutf8 = DO_UTF8(dsv);
4239 if (dutf8 != sutf8) {
4241 /* Not modifying source SV, so taking a temporary copy. */
4242 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4244 sv_utf8_upgrade(csv);
4245 spv = SvPV_const(csv, slen);
4248 sv_utf8_upgrade_nomg(dsv);
4250 sv_catpvn_nomg(dsv, spv, slen);
4253 if (flags & SV_SMAGIC)
4258 =for apidoc sv_catpv
4260 Concatenates the string onto the end of the string which is in the SV.
4261 If the SV has the UTF-8 status set, then the bytes appended should be
4262 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4267 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4270 register STRLEN len;
4276 junk = SvPV_force(sv, tlen);
4278 SvGROW(sv, tlen + len + 1);
4280 ptr = SvPVX_const(sv);
4281 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4282 SvCUR_set(sv, SvCUR(sv) + len);
4283 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4288 =for apidoc sv_catpv_mg
4290 Like C<sv_catpv>, but also handles 'set' magic.
4296 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4305 Creates a new SV. A non-zero C<len> parameter indicates the number of
4306 bytes of preallocated string space the SV should have. An extra byte for a
4307 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4308 space is allocated.) The reference count for the new SV is set to 1.
4310 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4311 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4312 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4313 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4314 modules supporting older perls.
4320 Perl_newSV(pTHX_ STRLEN len)
4327 sv_upgrade(sv, SVt_PV);
4328 SvGROW(sv, len + 1);
4333 =for apidoc sv_magicext
4335 Adds magic to an SV, upgrading it if necessary. Applies the
4336 supplied vtable and returns a pointer to the magic added.
4338 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4339 In particular, you can add magic to SvREADONLY SVs, and add more than
4340 one instance of the same 'how'.
4342 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4343 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4344 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4345 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4347 (This is now used as a subroutine by C<sv_magic>.)
4352 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4353 const char* name, I32 namlen)
4358 if (SvTYPE(sv) < SVt_PVMG) {
4359 SvUPGRADE(sv, SVt_PVMG);
4361 Newxz(mg, 1, MAGIC);
4362 mg->mg_moremagic = SvMAGIC(sv);
4363 SvMAGIC_set(sv, mg);
4365 /* Sometimes a magic contains a reference loop, where the sv and
4366 object refer to each other. To prevent a reference loop that
4367 would prevent such objects being freed, we look for such loops
4368 and if we find one we avoid incrementing the object refcount.
4370 Note we cannot do this to avoid self-tie loops as intervening RV must
4371 have its REFCNT incremented to keep it in existence.
4374 if (!obj || obj == sv ||
4375 how == PERL_MAGIC_arylen ||
4376 how == PERL_MAGIC_qr ||
4377 how == PERL_MAGIC_symtab ||
4378 (SvTYPE(obj) == SVt_PVGV &&
4379 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4380 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4381 GvFORM(obj) == (CV*)sv)))
4386 mg->mg_obj = SvREFCNT_inc_simple(obj);
4387 mg->mg_flags |= MGf_REFCOUNTED;
4390 /* Normal self-ties simply pass a null object, and instead of
4391 using mg_obj directly, use the SvTIED_obj macro to produce a
4392 new RV as needed. For glob "self-ties", we are tieing the PVIO
4393 with an RV obj pointing to the glob containing the PVIO. In
4394 this case, to avoid a reference loop, we need to weaken the
4398 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4399 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4405 mg->mg_len = namlen;
4408 mg->mg_ptr = savepvn(name, namlen);
4409 else if (namlen == HEf_SVKEY)
4410 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4412 mg->mg_ptr = (char *) name;
4414 mg->mg_virtual = vtable;
4418 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4423 =for apidoc sv_magic
4425 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4426 then adds a new magic item of type C<how> to the head of the magic list.
4428 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4429 handling of the C<name> and C<namlen> arguments.
4431 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4432 to add more than one instance of the same 'how'.
4438 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4444 #ifdef PERL_OLD_COPY_ON_WRITE
4446 sv_force_normal_flags(sv, 0);
4448 if (SvREADONLY(sv)) {
4450 /* its okay to attach magic to shared strings; the subsequent
4451 * upgrade to PVMG will unshare the string */
4452 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4455 && how != PERL_MAGIC_regex_global
4456 && how != PERL_MAGIC_bm
4457 && how != PERL_MAGIC_fm
4458 && how != PERL_MAGIC_sv
4459 && how != PERL_MAGIC_backref
4462 Perl_croak(aTHX_ PL_no_modify);
4465 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4466 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4467 /* sv_magic() refuses to add a magic of the same 'how' as an
4470 if (how == PERL_MAGIC_taint) {
4472 /* Any scalar which already had taint magic on which someone
4473 (erroneously?) did SvIOK_on() or similar will now be
4474 incorrectly sporting public "OK" flags. */
4475 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4483 vtable = &PL_vtbl_sv;
4485 case PERL_MAGIC_overload:
4486 vtable = &PL_vtbl_amagic;
4488 case PERL_MAGIC_overload_elem:
4489 vtable = &PL_vtbl_amagicelem;
4491 case PERL_MAGIC_overload_table:
4492 vtable = &PL_vtbl_ovrld;
4495 vtable = &PL_vtbl_bm;
4497 case PERL_MAGIC_regdata:
4498 vtable = &PL_vtbl_regdata;
4500 case PERL_MAGIC_regdata_names:
4501 vtable = &PL_vtbl_regdata_names;
4503 case PERL_MAGIC_regdatum:
4504 vtable = &PL_vtbl_regdatum;
4506 case PERL_MAGIC_env:
4507 vtable = &PL_vtbl_env;
4510 vtable = &PL_vtbl_fm;
4512 case PERL_MAGIC_envelem:
4513 vtable = &PL_vtbl_envelem;
4515 case PERL_MAGIC_regex_global:
4516 vtable = &PL_vtbl_mglob;
4518 case PERL_MAGIC_isa:
4519 vtable = &PL_vtbl_isa;
4521 case PERL_MAGIC_isaelem:
4522 vtable = &PL_vtbl_isaelem;
4524 case PERL_MAGIC_nkeys:
4525 vtable = &PL_vtbl_nkeys;
4527 case PERL_MAGIC_dbfile:
4530 case PERL_MAGIC_dbline:
4531 vtable = &PL_vtbl_dbline;
4533 #ifdef USE_LOCALE_COLLATE
4534 case PERL_MAGIC_collxfrm:
4535 vtable = &PL_vtbl_collxfrm;
4537 #endif /* USE_LOCALE_COLLATE */
4538 case PERL_MAGIC_tied:
4539 vtable = &PL_vtbl_pack;
4541 case PERL_MAGIC_tiedelem:
4542 case PERL_MAGIC_tiedscalar:
4543 vtable = &PL_vtbl_packelem;
4546 vtable = &PL_vtbl_regexp;
4548 case PERL_MAGIC_hints:
4549 /* As this vtable is all NULL, we can reuse it. */
4550 case PERL_MAGIC_sig:
4551 vtable = &PL_vtbl_sig;
4553 case PERL_MAGIC_sigelem:
4554 vtable = &PL_vtbl_sigelem;
4556 case PERL_MAGIC_taint:
4557 vtable = &PL_vtbl_taint;
4559 case PERL_MAGIC_uvar:
4560 vtable = &PL_vtbl_uvar;
4562 case PERL_MAGIC_vec:
4563 vtable = &PL_vtbl_vec;
4565 case PERL_MAGIC_arylen_p:
4566 case PERL_MAGIC_rhash:
4567 case PERL_MAGIC_symtab:
4568 case PERL_MAGIC_vstring:
4571 case PERL_MAGIC_utf8:
4572 vtable = &PL_vtbl_utf8;
4574 case PERL_MAGIC_substr:
4575 vtable = &PL_vtbl_substr;
4577 case PERL_MAGIC_defelem:
4578 vtable = &PL_vtbl_defelem;
4580 case PERL_MAGIC_arylen:
4581 vtable = &PL_vtbl_arylen;
4583 case PERL_MAGIC_pos:
4584 vtable = &PL_vtbl_pos;
4586 case PERL_MAGIC_backref:
4587 vtable = &PL_vtbl_backref;
4589 case PERL_MAGIC_hintselem:
4590 vtable = &PL_vtbl_hintselem;
4592 case PERL_MAGIC_ext:
4593 /* Reserved for use by extensions not perl internals. */
4594 /* Useful for attaching extension internal data to perl vars. */
4595 /* Note that multiple extensions may clash if magical scalars */
4596 /* etc holding private data from one are passed to another. */
4600 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4603 /* Rest of work is done else where */
4604 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4607 case PERL_MAGIC_taint:
4610 case PERL_MAGIC_ext:
4611 case PERL_MAGIC_dbfile:
4618 =for apidoc sv_unmagic
4620 Removes all magic of type C<type> from an SV.
4626 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4630 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4632 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4633 for (mg = *mgp; mg; mg = *mgp) {
4634 if (mg->mg_type == type) {
4635 const MGVTBL* const vtbl = mg->mg_virtual;
4636 *mgp = mg->mg_moremagic;
4637 if (vtbl && vtbl->svt_free)
4638 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4639 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4641 Safefree(mg->mg_ptr);
4642 else if (mg->mg_len == HEf_SVKEY)
4643 SvREFCNT_dec((SV*)mg->mg_ptr);
4644 else if (mg->mg_type == PERL_MAGIC_utf8)
4645 Safefree(mg->mg_ptr);
4647 if (mg->mg_flags & MGf_REFCOUNTED)
4648 SvREFCNT_dec(mg->mg_obj);
4652 mgp = &mg->mg_moremagic;
4656 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4657 SvMAGIC_set(sv, NULL);
4664 =for apidoc sv_rvweaken
4666 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4667 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4668 push a back-reference to this RV onto the array of backreferences
4669 associated with that magic. If the RV is magical, set magic will be
4670 called after the RV is cleared.
4676 Perl_sv_rvweaken(pTHX_ SV *sv)
4679 if (!SvOK(sv)) /* let undefs pass */
4682 Perl_croak(aTHX_ "Can't weaken a nonreference");
4683 else if (SvWEAKREF(sv)) {
4684 if (ckWARN(WARN_MISC))
4685 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4689 Perl_sv_add_backref(aTHX_ tsv, sv);
4695 /* Give tsv backref magic if it hasn't already got it, then push a
4696 * back-reference to sv onto the array associated with the backref magic.
4700 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4705 if (SvTYPE(tsv) == SVt_PVHV) {
4706 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4710 /* There is no AV in the offical place - try a fixup. */
4711 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4714 /* Aha. They've got it stowed in magic. Bring it back. */
4715 av = (AV*)mg->mg_obj;
4716 /* Stop mg_free decreasing the refernce count. */
4718 /* Stop mg_free even calling the destructor, given that
4719 there's no AV to free up. */
4721 sv_unmagic(tsv, PERL_MAGIC_backref);
4725 SvREFCNT_inc_simple_void(av);
4730 const MAGIC *const mg
4731 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4733 av = (AV*)mg->mg_obj;
4737 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4738 /* av now has a refcnt of 2, which avoids it getting freed
4739 * before us during global cleanup. The extra ref is removed
4740 * by magic_killbackrefs() when tsv is being freed */
4743 if (AvFILLp(av) >= AvMAX(av)) {
4744 av_extend(av, AvFILLp(av)+1);
4746 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4749 /* delete a back-reference to ourselves from the backref magic associated
4750 * with the SV we point to.
4754 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4761 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4762 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4763 /* We mustn't attempt to "fix up" the hash here by moving the
4764 backreference array back to the hv_aux structure, as that is stored
4765 in the main HvARRAY(), and hfreentries assumes that no-one
4766 reallocates HvARRAY() while it is running. */
4769 const MAGIC *const mg
4770 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4772 av = (AV *)mg->mg_obj;
4775 if (PL_in_clean_all)
4777 Perl_croak(aTHX_ "panic: del_backref");
4784 /* We shouldn't be in here more than once, but for paranoia reasons lets
4786 for (i = AvFILLp(av); i >= 0; i--) {
4788 const SSize_t fill = AvFILLp(av);
4790 /* We weren't the last entry.
4791 An unordered list has this property that you can take the
4792 last element off the end to fill the hole, and it's still
4793 an unordered list :-)
4798 AvFILLp(av) = fill - 1;
4804 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4806 SV **svp = AvARRAY(av);
4808 PERL_UNUSED_ARG(sv);
4810 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4811 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4812 if (svp && !SvIS_FREED(av)) {
4813 SV *const *const last = svp + AvFILLp(av);
4815 while (svp <= last) {
4817 SV *const referrer = *svp;
4818 if (SvWEAKREF(referrer)) {
4819 /* XXX Should we check that it hasn't changed? */
4820 SvRV_set(referrer, 0);
4822 SvWEAKREF_off(referrer);
4823 SvSETMAGIC(referrer);
4824 } else if (SvTYPE(referrer) == SVt_PVGV ||
4825 SvTYPE(referrer) == SVt_PVLV) {
4826 /* You lookin' at me? */
4827 assert(GvSTASH(referrer));
4828 assert(GvSTASH(referrer) == (HV*)sv);
4829 GvSTASH(referrer) = 0;
4832 "panic: magic_killbackrefs (flags=%"UVxf")",
4833 (UV)SvFLAGS(referrer));
4841 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4846 =for apidoc sv_insert
4848 Inserts a string at the specified offset/length within the SV. Similar to
4849 the Perl substr() function.
4855 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4860 register char *midend;
4861 register char *bigend;
4867 Perl_croak(aTHX_ "Can't modify non-existent substring");
4868 SvPV_force(bigstr, curlen);
4869 (void)SvPOK_only_UTF8(bigstr);
4870 if (offset + len > curlen) {
4871 SvGROW(bigstr, offset+len+1);
4872 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4873 SvCUR_set(bigstr, offset+len);
4877 i = littlelen - len;
4878 if (i > 0) { /* string might grow */
4879 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4880 mid = big + offset + len;
4881 midend = bigend = big + SvCUR(bigstr);
4884 while (midend > mid) /* shove everything down */
4885 *--bigend = *--midend;
4886 Move(little,big+offset,littlelen,char);
4887 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4892 Move(little,SvPVX(bigstr)+offset,len,char);
4897 big = SvPVX(bigstr);
4900 bigend = big + SvCUR(bigstr);
4902 if (midend > bigend)
4903 Perl_croak(aTHX_ "panic: sv_insert");
4905 if (mid - big > bigend - midend) { /* faster to shorten from end */
4907 Move(little, mid, littlelen,char);
4910 i = bigend - midend;
4912 Move(midend, mid, i,char);
4916 SvCUR_set(bigstr, mid - big);
4918 else if ((i = mid - big)) { /* faster from front */
4919 midend -= littlelen;
4921 sv_chop(bigstr,midend-i);
4926 Move(little, mid, littlelen,char);
4928 else if (littlelen) {
4929 midend -= littlelen;
4930 sv_chop(bigstr,midend);
4931 Move(little,midend,littlelen,char);
4934 sv_chop(bigstr,midend);
4940 =for apidoc sv_replace
4942 Make the first argument a copy of the second, then delete the original.
4943 The target SV physically takes over ownership of the body of the source SV
4944 and inherits its flags; however, the target keeps any magic it owns,
4945 and any magic in the source is discarded.
4946 Note that this is a rather specialist SV copying operation; most of the
4947 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4953 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4956 const U32 refcnt = SvREFCNT(sv);
4957 SV_CHECK_THINKFIRST_COW_DROP(sv);
4958 if (SvREFCNT(nsv) != 1) {
4959 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4960 UVuf " != 1)", (UV) SvREFCNT(nsv));
4962 if (SvMAGICAL(sv)) {
4966 sv_upgrade(nsv, SVt_PVMG);
4967 SvMAGIC_set(nsv, SvMAGIC(sv));
4968 SvFLAGS(nsv) |= SvMAGICAL(sv);
4970 SvMAGIC_set(sv, NULL);
4974 assert(!SvREFCNT(sv));
4975 #ifdef DEBUG_LEAKING_SCALARS
4976 sv->sv_flags = nsv->sv_flags;
4977 sv->sv_any = nsv->sv_any;
4978 sv->sv_refcnt = nsv->sv_refcnt;
4979 sv->sv_u = nsv->sv_u;
4981 StructCopy(nsv,sv,SV);
4983 /* Currently could join these into one piece of pointer arithmetic, but
4984 it would be unclear. */
4985 if(SvTYPE(sv) == SVt_IV)
4987 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4988 else if (SvTYPE(sv) == SVt_RV) {
4989 SvANY(sv) = &sv->sv_u.svu_rv;
4993 #ifdef PERL_OLD_COPY_ON_WRITE
4994 if (SvIsCOW_normal(nsv)) {
4995 /* We need to follow the pointers around the loop to make the
4996 previous SV point to sv, rather than nsv. */
4999 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5002 assert(SvPVX_const(current) == SvPVX_const(nsv));
5004 /* Make the SV before us point to the SV after us. */
5006 PerlIO_printf(Perl_debug_log, "previous is\n");
5008 PerlIO_printf(Perl_debug_log,
5009 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5010 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5012 SV_COW_NEXT_SV_SET(current, sv);
5015 SvREFCNT(sv) = refcnt;
5016 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5022 =for apidoc sv_clear
5024 Clear an SV: call any destructors, free up any memory used by the body,
5025 and free the body itself. The SV's head is I<not> freed, although
5026 its type is set to all 1's so that it won't inadvertently be assumed
5027 to be live during global destruction etc.
5028 This function should only be called when REFCNT is zero. Most of the time
5029 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5036 Perl_sv_clear(pTHX_ register SV *sv)
5039 const U32 type = SvTYPE(sv);
5040 const struct body_details *const sv_type_details
5041 = bodies_by_type + type;
5044 assert(SvREFCNT(sv) == 0);
5046 if (type <= SVt_IV) {
5047 /* See the comment in sv.h about the collusion between this early
5048 return and the overloading of the NULL and IV slots in the size
5054 if (PL_defstash) { /* Still have a symbol table? */
5059 stash = SvSTASH(sv);
5060 destructor = StashHANDLER(stash,DESTROY);
5062 SV* const tmpref = newRV(sv);
5063 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5065 PUSHSTACKi(PERLSI_DESTROY);
5070 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5076 if(SvREFCNT(tmpref) < 2) {
5077 /* tmpref is not kept alive! */
5079 SvRV_set(tmpref, NULL);
5082 SvREFCNT_dec(tmpref);
5084 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5088 if (PL_in_clean_objs)
5089 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5091 /* DESTROY gave object new lease on life */
5097 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5098 SvOBJECT_off(sv); /* Curse the object. */
5099 if (type != SVt_PVIO)
5100 --PL_sv_objcount; /* XXX Might want something more general */
5103 if (type >= SVt_PVMG) {
5104 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5105 SvREFCNT_dec(OURSTASH(sv));
5106 } else if (SvMAGIC(sv))
5108 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5109 SvREFCNT_dec(SvSTASH(sv));
5114 IoIFP(sv) != PerlIO_stdin() &&
5115 IoIFP(sv) != PerlIO_stdout() &&
5116 IoIFP(sv) != PerlIO_stderr())
5118 io_close((IO*)sv, FALSE);
5120 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5121 PerlDir_close(IoDIRP(sv));
5122 IoDIRP(sv) = (DIR*)NULL;
5123 Safefree(IoTOP_NAME(sv));
5124 Safefree(IoFMT_NAME(sv));
5125 Safefree(IoBOTTOM_NAME(sv));
5134 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5141 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5142 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5143 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5144 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5146 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5147 SvREFCNT_dec(LvTARG(sv));
5151 if (GvNAME_HEK(sv)) {
5152 unshare_hek(GvNAME_HEK(sv));
5154 /* If we're in a stash, we don't own a reference to it. However it does
5155 have a back reference to us, which needs to be cleared. */
5157 sv_del_backref((SV*)GvSTASH(sv), sv);
5162 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5164 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5165 /* Don't even bother with turning off the OOK flag. */
5170 SV * const target = SvRV(sv);
5172 sv_del_backref(target, sv);
5174 SvREFCNT_dec(target);
5176 #ifdef PERL_OLD_COPY_ON_WRITE
5177 else if (SvPVX_const(sv)) {
5179 /* I believe I need to grab the global SV mutex here and
5180 then recheck the COW status. */
5182 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5185 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5186 SV_COW_NEXT_SV(sv));
5187 /* And drop it here. */
5189 } else if (SvLEN(sv)) {
5190 Safefree(SvPVX_const(sv));
5194 else if (SvPVX_const(sv) && SvLEN(sv))
5195 Safefree(SvPVX_mutable(sv));
5196 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5197 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5206 SvFLAGS(sv) &= SVf_BREAK;
5207 SvFLAGS(sv) |= SVTYPEMASK;
5209 if (sv_type_details->arena) {
5210 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5211 &PL_body_roots[type]);
5213 else if (sv_type_details->body_size) {
5214 my_safefree(SvANY(sv));
5219 =for apidoc sv_newref
5221 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5228 Perl_sv_newref(pTHX_ SV *sv)
5230 PERL_UNUSED_CONTEXT;
5239 Decrement an SV's reference count, and if it drops to zero, call
5240 C<sv_clear> to invoke destructors and free up any memory used by
5241 the body; finally, deallocate the SV's head itself.
5242 Normally called via a wrapper macro C<SvREFCNT_dec>.
5248 Perl_sv_free(pTHX_ SV *sv)
5253 if (SvREFCNT(sv) == 0) {
5254 if (SvFLAGS(sv) & SVf_BREAK)
5255 /* this SV's refcnt has been artificially decremented to
5256 * trigger cleanup */
5258 if (PL_in_clean_all) /* All is fair */
5260 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5261 /* make sure SvREFCNT(sv)==0 happens very seldom */
5262 SvREFCNT(sv) = (~(U32)0)/2;
5265 if (ckWARN_d(WARN_INTERNAL)) {
5266 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5267 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5268 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5269 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5270 Perl_dump_sv_child(aTHX_ sv);
5275 if (--(SvREFCNT(sv)) > 0)
5277 Perl_sv_free2(aTHX_ sv);
5281 Perl_sv_free2(pTHX_ SV *sv)
5286 if (ckWARN_d(WARN_DEBUGGING))
5287 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5288 "Attempt to free temp prematurely: SV 0x%"UVxf
5289 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5293 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5294 /* make sure SvREFCNT(sv)==0 happens very seldom */
5295 SvREFCNT(sv) = (~(U32)0)/2;
5306 Returns the length of the string in the SV. Handles magic and type
5307 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5313 Perl_sv_len(pTHX_ register SV *sv)
5321 len = mg_length(sv);
5323 (void)SvPV_const(sv, len);
5328 =for apidoc sv_len_utf8
5330 Returns the number of characters in the string in an SV, counting wide
5331 UTF-8 bytes as a single character. Handles magic and type coercion.
5337 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5338 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5339 * (Note that the mg_len is not the length of the mg_ptr field.
5340 * This allows the cache to store the character length of the string without
5341 * needing to malloc() extra storage to attach to the mg_ptr.)
5346 Perl_sv_len_utf8(pTHX_ register SV *sv)
5352 return mg_length(sv);
5356 const U8 *s = (U8*)SvPV_const(sv, len);
5360 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5362 if (mg && mg->mg_len != -1) {
5364 if (PL_utf8cache < 0) {
5365 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5367 /* Need to turn the assertions off otherwise we may
5368 recurse infinitely while printing error messages.
5370 SAVEI8(PL_utf8cache);
5372 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5373 " real %"UVuf" for %"SVf,
5374 (UV) ulen, (UV) real, (void*)sv);
5379 ulen = Perl_utf8_length(aTHX_ s, s + len);
5380 if (!SvREADONLY(sv)) {
5382 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5383 &PL_vtbl_utf8, 0, 0);
5391 return Perl_utf8_length(aTHX_ s, s + len);
5395 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5398 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5401 const U8 *s = start;
5403 while (s < send && uoffset--)
5406 /* This is the existing behaviour. Possibly it should be a croak, as
5407 it's actually a bounds error */
5413 /* Given the length of the string in both bytes and UTF-8 characters, decide
5414 whether to walk forwards or backwards to find the byte corresponding to
5415 the passed in UTF-8 offset. */
5417 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5418 STRLEN uoffset, STRLEN uend)
5420 STRLEN backw = uend - uoffset;
5421 if (uoffset < 2 * backw) {
5422 /* The assumption is that going forwards is twice the speed of going
5423 forward (that's where the 2 * backw comes from).
5424 (The real figure of course depends on the UTF-8 data.) */
5425 return sv_pos_u2b_forwards(start, send, uoffset);
5430 while (UTF8_IS_CONTINUATION(*send))
5433 return send - start;
5436 /* For the string representation of the given scalar, find the byte
5437 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5438 give another position in the string, *before* the sought offset, which
5439 (which is always true, as 0, 0 is a valid pair of positions), which should
5440 help reduce the amount of linear searching.
5441 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5442 will be used to reduce the amount of linear searching. The cache will be
5443 created if necessary, and the found value offered to it for update. */
5445 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5446 const U8 *const send, STRLEN uoffset,
5447 STRLEN uoffset0, STRLEN boffset0) {
5448 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5451 assert (uoffset >= uoffset0);
5453 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5454 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5455 if ((*mgp)->mg_ptr) {
5456 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5457 if (cache[0] == uoffset) {
5458 /* An exact match. */
5461 if (cache[2] == uoffset) {
5462 /* An exact match. */
5466 if (cache[0] < uoffset) {
5467 /* The cache already knows part of the way. */
5468 if (cache[0] > uoffset0) {
5469 /* The cache knows more than the passed in pair */
5470 uoffset0 = cache[0];
5471 boffset0 = cache[1];
5473 if ((*mgp)->mg_len != -1) {
5474 /* And we know the end too. */
5476 + sv_pos_u2b_midway(start + boffset0, send,
5478 (*mgp)->mg_len - uoffset0);
5481 + sv_pos_u2b_forwards(start + boffset0,
5482 send, uoffset - uoffset0);
5485 else if (cache[2] < uoffset) {
5486 /* We're between the two cache entries. */
5487 if (cache[2] > uoffset0) {
5488 /* and the cache knows more than the passed in pair */
5489 uoffset0 = cache[2];
5490 boffset0 = cache[3];
5494 + sv_pos_u2b_midway(start + boffset0,
5497 cache[0] - uoffset0);
5500 + sv_pos_u2b_midway(start + boffset0,
5503 cache[2] - uoffset0);
5507 else if ((*mgp)->mg_len != -1) {
5508 /* If we can take advantage of a passed in offset, do so. */
5509 /* In fact, offset0 is either 0, or less than offset, so don't
5510 need to worry about the other possibility. */
5512 + sv_pos_u2b_midway(start + boffset0, send,
5514 (*mgp)->mg_len - uoffset0);
5519 if (!found || PL_utf8cache < 0) {
5520 const STRLEN real_boffset
5521 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5522 send, uoffset - uoffset0);
5524 if (found && PL_utf8cache < 0) {
5525 if (real_boffset != boffset) {
5526 /* Need to turn the assertions off otherwise we may recurse
5527 infinitely while printing error messages. */
5528 SAVEI8(PL_utf8cache);
5530 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5531 " real %"UVuf" for %"SVf,
5532 (UV) boffset, (UV) real_boffset, (void*)sv);
5535 boffset = real_boffset;
5538 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5544 =for apidoc sv_pos_u2b
5546 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5547 the start of the string, to a count of the equivalent number of bytes; if
5548 lenp is non-zero, it does the same to lenp, but this time starting from
5549 the offset, rather than from the start of the string. Handles magic and
5556 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5557 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5558 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5563 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5571 start = (U8*)SvPV_const(sv, len);
5573 STRLEN uoffset = (STRLEN) *offsetp;
5574 const U8 * const send = start + len;
5576 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5579 *offsetp = (I32) boffset;
5582 /* Convert the relative offset to absolute. */
5583 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5584 const STRLEN boffset2
5585 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5586 uoffset, boffset) - boffset;
5600 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5601 byte length pairing. The (byte) length of the total SV is passed in too,
5602 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5603 may not have updated SvCUR, so we can't rely on reading it directly.
5605 The proffered utf8/byte length pairing isn't used if the cache already has
5606 two pairs, and swapping either for the proffered pair would increase the
5607 RMS of the intervals between known byte offsets.
5609 The cache itself consists of 4 STRLEN values
5610 0: larger UTF-8 offset
5611 1: corresponding byte offset
5612 2: smaller UTF-8 offset
5613 3: corresponding byte offset
5615 Unused cache pairs have the value 0, 0.
5616 Keeping the cache "backwards" means that the invariant of
5617 cache[0] >= cache[2] is maintained even with empty slots, which means that
5618 the code that uses it doesn't need to worry if only 1 entry has actually
5619 been set to non-zero. It also makes the "position beyond the end of the
5620 cache" logic much simpler, as the first slot is always the one to start
5624 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5632 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5634 (*mgp)->mg_len = -1;
5638 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5639 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5640 (*mgp)->mg_ptr = (char *) cache;
5644 if (PL_utf8cache < 0) {
5645 const U8 *start = (const U8 *) SvPVX_const(sv);
5646 const STRLEN realutf8 = utf8_length(start, start + byte);
5648 if (realutf8 != utf8) {
5649 /* Need to turn the assertions off otherwise we may recurse
5650 infinitely while printing error messages. */
5651 SAVEI8(PL_utf8cache);
5653 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5654 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5658 /* Cache is held with the later position first, to simplify the code
5659 that deals with unbounded ends. */
5661 ASSERT_UTF8_CACHE(cache);
5662 if (cache[1] == 0) {
5663 /* Cache is totally empty */
5666 } else if (cache[3] == 0) {
5667 if (byte > cache[1]) {
5668 /* New one is larger, so goes first. */
5669 cache[2] = cache[0];
5670 cache[3] = cache[1];
5678 #define THREEWAY_SQUARE(a,b,c,d) \
5679 ((float)((d) - (c))) * ((float)((d) - (c))) \
5680 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5681 + ((float)((b) - (a))) * ((float)((b) - (a)))
5683 /* Cache has 2 slots in use, and we know three potential pairs.
5684 Keep the two that give the lowest RMS distance. Do the
5685 calcualation in bytes simply because we always know the byte
5686 length. squareroot has the same ordering as the positive value,
5687 so don't bother with the actual square root. */
5688 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5689 if (byte > cache[1]) {
5690 /* New position is after the existing pair of pairs. */
5691 const float keep_earlier
5692 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5693 const float keep_later
5694 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5696 if (keep_later < keep_earlier) {
5697 if (keep_later < existing) {
5698 cache[2] = cache[0];
5699 cache[3] = cache[1];
5705 if (keep_earlier < existing) {
5711 else if (byte > cache[3]) {
5712 /* New position is between the existing pair of pairs. */
5713 const float keep_earlier
5714 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5715 const float keep_later
5716 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5718 if (keep_later < keep_earlier) {
5719 if (keep_later < existing) {
5725 if (keep_earlier < existing) {
5732 /* New position is before the existing pair of pairs. */
5733 const float keep_earlier
5734 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5735 const float keep_later
5736 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5738 if (keep_later < keep_earlier) {
5739 if (keep_later < existing) {
5745 if (keep_earlier < existing) {
5746 cache[0] = cache[2];
5747 cache[1] = cache[3];
5754 ASSERT_UTF8_CACHE(cache);
5757 /* We already know all of the way, now we may be able to walk back. The same
5758 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5759 backward is half the speed of walking forward. */
5761 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5764 const STRLEN forw = target - s;
5765 STRLEN backw = end - target;
5767 if (forw < 2 * backw) {
5768 return utf8_length(s, target);
5771 while (end > target) {
5773 while (UTF8_IS_CONTINUATION(*end)) {
5782 =for apidoc sv_pos_b2u
5784 Converts the value pointed to by offsetp from a count of bytes from the
5785 start of the string, to a count of the equivalent number of UTF-8 chars.
5786 Handles magic and type coercion.
5792 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5793 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5798 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5801 const STRLEN byte = *offsetp;
5802 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5811 s = (const U8*)SvPV_const(sv, blen);
5814 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5818 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5819 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5821 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5822 if (cache[1] == byte) {
5823 /* An exact match. */
5824 *offsetp = cache[0];
5827 if (cache[3] == byte) {
5828 /* An exact match. */
5829 *offsetp = cache[2];
5833 if (cache[1] < byte) {
5834 /* We already know part of the way. */
5835 if (mg->mg_len != -1) {
5836 /* Actually, we know the end too. */
5838 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5839 s + blen, mg->mg_len - cache[0]);
5841 len = cache[0] + utf8_length(s + cache[1], send);
5844 else if (cache[3] < byte) {
5845 /* We're between the two cached pairs, so we do the calculation
5846 offset by the byte/utf-8 positions for the earlier pair,
5847 then add the utf-8 characters from the string start to
5849 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5850 s + cache[1], cache[0] - cache[2])
5854 else { /* cache[3] > byte */
5855 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5859 ASSERT_UTF8_CACHE(cache);
5861 } else if (mg->mg_len != -1) {
5862 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5866 if (!found || PL_utf8cache < 0) {
5867 const STRLEN real_len = utf8_length(s, send);
5869 if (found && PL_utf8cache < 0) {
5870 if (len != real_len) {
5871 /* Need to turn the assertions off otherwise we may recurse
5872 infinitely while printing error messages. */
5873 SAVEI8(PL_utf8cache);
5875 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5876 " real %"UVuf" for %"SVf,
5877 (UV) len, (UV) real_len, (void*)sv);
5884 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5890 Returns a boolean indicating whether the strings in the two SVs are
5891 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5892 coerce its args to strings if necessary.
5898 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5907 SV* svrecode = NULL;
5914 /* if pv1 and pv2 are the same, second SvPV_const call may
5915 * invalidate pv1, so we may need to make a copy */
5916 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5917 pv1 = SvPV_const(sv1, cur1);
5918 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5919 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5921 pv1 = SvPV_const(sv1, cur1);
5929 pv2 = SvPV_const(sv2, cur2);
5931 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5932 /* Differing utf8ness.
5933 * Do not UTF8size the comparands as a side-effect. */
5936 svrecode = newSVpvn(pv2, cur2);
5937 sv_recode_to_utf8(svrecode, PL_encoding);
5938 pv2 = SvPV_const(svrecode, cur2);
5941 svrecode = newSVpvn(pv1, cur1);
5942 sv_recode_to_utf8(svrecode, PL_encoding);
5943 pv1 = SvPV_const(svrecode, cur1);
5945 /* Now both are in UTF-8. */
5947 SvREFCNT_dec(svrecode);
5952 bool is_utf8 = TRUE;
5955 /* sv1 is the UTF-8 one,
5956 * if is equal it must be downgrade-able */
5957 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5963 /* sv2 is the UTF-8 one,
5964 * if is equal it must be downgrade-able */
5965 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5971 /* Downgrade not possible - cannot be eq */
5979 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5981 SvREFCNT_dec(svrecode);
5991 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5992 string in C<sv1> is less than, equal to, or greater than the string in
5993 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5994 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6000 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6004 const char *pv1, *pv2;
6007 SV *svrecode = NULL;
6014 pv1 = SvPV_const(sv1, cur1);
6021 pv2 = SvPV_const(sv2, cur2);
6023 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6024 /* Differing utf8ness.
6025 * Do not UTF8size the comparands as a side-effect. */
6028 svrecode = newSVpvn(pv2, cur2);
6029 sv_recode_to_utf8(svrecode, PL_encoding);
6030 pv2 = SvPV_const(svrecode, cur2);
6033 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6038 svrecode = newSVpvn(pv1, cur1);
6039 sv_recode_to_utf8(svrecode, PL_encoding);
6040 pv1 = SvPV_const(svrecode, cur1);
6043 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6049 cmp = cur2 ? -1 : 0;
6053 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6056 cmp = retval < 0 ? -1 : 1;
6057 } else if (cur1 == cur2) {
6060 cmp = cur1 < cur2 ? -1 : 1;
6064 SvREFCNT_dec(svrecode);
6072 =for apidoc sv_cmp_locale
6074 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6075 'use bytes' aware, handles get magic, and will coerce its args to strings
6076 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6082 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6085 #ifdef USE_LOCALE_COLLATE
6091 if (PL_collation_standard)
6095 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6097 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6099 if (!pv1 || !len1) {
6110 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6113 return retval < 0 ? -1 : 1;
6116 * When the result of collation is equality, that doesn't mean
6117 * that there are no differences -- some locales exclude some
6118 * characters from consideration. So to avoid false equalities,
6119 * we use the raw string as a tiebreaker.
6125 #endif /* USE_LOCALE_COLLATE */
6127 return sv_cmp(sv1, sv2);
6131 #ifdef USE_LOCALE_COLLATE
6134 =for apidoc sv_collxfrm
6136 Add Collate Transform magic to an SV if it doesn't already have it.
6138 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6139 scalar data of the variable, but transformed to such a format that a normal
6140 memory comparison can be used to compare the data according to the locale
6147 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6152 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6153 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6159 Safefree(mg->mg_ptr);
6160 s = SvPV_const(sv, len);
6161 if ((xf = mem_collxfrm(s, len, &xlen))) {
6162 if (SvREADONLY(sv)) {
6165 return xf + sizeof(PL_collation_ix);
6168 #ifdef PERL_OLD_COPY_ON_WRITE
6170 sv_force_normal_flags(sv, 0);
6172 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6186 if (mg && mg->mg_ptr) {
6188 return mg->mg_ptr + sizeof(PL_collation_ix);
6196 #endif /* USE_LOCALE_COLLATE */
6201 Get a line from the filehandle and store it into the SV, optionally
6202 appending to the currently-stored string.
6208 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6213 register STDCHAR rslast;
6214 register STDCHAR *bp;
6219 if (SvTHINKFIRST(sv))
6220 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6221 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6223 However, perlbench says it's slower, because the existing swipe code
6224 is faster than copy on write.
6225 Swings and roundabouts. */
6226 SvUPGRADE(sv, SVt_PV);
6231 if (PerlIO_isutf8(fp)) {
6233 sv_utf8_upgrade_nomg(sv);
6234 sv_pos_u2b(sv,&append,0);
6236 } else if (SvUTF8(sv)) {
6237 SV * const tsv = newSV(0);
6238 sv_gets(tsv, fp, 0);
6239 sv_utf8_upgrade_nomg(tsv);
6240 SvCUR_set(sv,append);
6243 goto return_string_or_null;
6248 if (PerlIO_isutf8(fp))
6251 if (IN_PERL_COMPILETIME) {
6252 /* we always read code in line mode */
6256 else if (RsSNARF(PL_rs)) {
6257 /* If it is a regular disk file use size from stat() as estimate
6258 of amount we are going to read -- may result in mallocing
6259 more memory than we really need if the layers below reduce
6260 the size we read (e.g. CRLF or a gzip layer).
6263 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6264 const Off_t offset = PerlIO_tell(fp);
6265 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6266 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6272 else if (RsRECORD(PL_rs)) {
6277 /* Grab the size of the record we're getting */
6278 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6279 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6282 /* VMS wants read instead of fread, because fread doesn't respect */
6283 /* RMS record boundaries. This is not necessarily a good thing to be */
6284 /* doing, but we've got no other real choice - except avoid stdio
6285 as implementation - perhaps write a :vms layer ?
6287 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6289 bytesread = PerlIO_read(fp, buffer, recsize);
6293 SvCUR_set(sv, bytesread += append);
6294 buffer[bytesread] = '\0';
6295 goto return_string_or_null;
6297 else if (RsPARA(PL_rs)) {
6303 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6304 if (PerlIO_isutf8(fp)) {
6305 rsptr = SvPVutf8(PL_rs, rslen);
6308 if (SvUTF8(PL_rs)) {
6309 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6310 Perl_croak(aTHX_ "Wide character in $/");
6313 rsptr = SvPV_const(PL_rs, rslen);
6317 rslast = rslen ? rsptr[rslen - 1] : '\0';
6319 if (rspara) { /* have to do this both before and after */
6320 do { /* to make sure file boundaries work right */
6323 i = PerlIO_getc(fp);
6327 PerlIO_ungetc(fp,i);
6333 /* See if we know enough about I/O mechanism to cheat it ! */
6335 /* This used to be #ifdef test - it is made run-time test for ease
6336 of abstracting out stdio interface. One call should be cheap
6337 enough here - and may even be a macro allowing compile
6341 if (PerlIO_fast_gets(fp)) {
6344 * We're going to steal some values from the stdio struct
6345 * and put EVERYTHING in the innermost loop into registers.
6347 register STDCHAR *ptr;
6351 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6352 /* An ungetc()d char is handled separately from the regular
6353 * buffer, so we getc() it back out and stuff it in the buffer.
6355 i = PerlIO_getc(fp);
6356 if (i == EOF) return 0;
6357 *(--((*fp)->_ptr)) = (unsigned char) i;
6361 /* Here is some breathtakingly efficient cheating */
6363 cnt = PerlIO_get_cnt(fp); /* get count into register */
6364 /* make sure we have the room */
6365 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6366 /* Not room for all of it
6367 if we are looking for a separator and room for some
6369 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6370 /* just process what we have room for */
6371 shortbuffered = cnt - SvLEN(sv) + append + 1;
6372 cnt -= shortbuffered;
6376 /* remember that cnt can be negative */
6377 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6382 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6383 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6384 DEBUG_P(PerlIO_printf(Perl_debug_log,
6385 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
6387 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6388 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6389 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6394 while (cnt > 0) { /* this | eat */
6396 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6397 goto thats_all_folks; /* screams | sed :-) */
6401 Copy(ptr, bp, cnt, char); /* this | eat */
6402 bp += cnt; /* screams | dust */
6403 ptr += cnt; /* louder | sed :-) */
6408 if (shortbuffered) { /* oh well, must extend */
6409 cnt = shortbuffered;
6411 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6413 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6414 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6418 DEBUG_P(PerlIO_printf(Perl_debug_log,
6419 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6420 PTR2UV(ptr),(long)cnt));
6421 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6423 DEBUG_P(PerlIO_printf(Perl_debug_log,
6424 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6425 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6426 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6428 /* This used to call 'filbuf' in stdio form, but as that behaves like
6429 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6430 another abstraction. */
6431 i = PerlIO_getc(fp); /* get more characters */
6433 DEBUG_P(PerlIO_printf(Perl_debug_log,
6434 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6435 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6436 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6438 cnt = PerlIO_get_cnt(fp);
6439 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6440 DEBUG_P(PerlIO_printf(Perl_debug_log,
6441 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6443 if (i == EOF) /* all done for ever? */
6444 goto thats_really_all_folks;
6446 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6448 SvGROW(sv, bpx + cnt + 2);
6449 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6451 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6453 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6454 goto thats_all_folks;
6458 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6459 memNE((char*)bp - rslen, rsptr, rslen))
6460 goto screamer; /* go back to the fray */
6461 thats_really_all_folks:
6463 cnt += shortbuffered;
6464 DEBUG_P(PerlIO_printf(Perl_debug_log,
6465 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6466 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6467 DEBUG_P(PerlIO_printf(Perl_debug_log,
6468 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6469 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6470 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6472 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: done, len=%ld, string=|%.*s|\n",
6475 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6479 /*The big, slow, and stupid way. */
6480 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6481 STDCHAR *buf = NULL;
6482 Newx(buf, 8192, STDCHAR);
6490 register const STDCHAR * const bpe = buf + sizeof(buf);
6492 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6493 ; /* keep reading */
6497 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6498 /* Accomodate broken VAXC compiler, which applies U8 cast to
6499 * both args of ?: operator, causing EOF to change into 255
6502 i = (U8)buf[cnt - 1];
6508 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6510 sv_catpvn(sv, (char *) buf, cnt);
6512 sv_setpvn(sv, (char *) buf, cnt);
6514 if (i != EOF && /* joy */
6516 SvCUR(sv) < rslen ||
6517 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6521 * If we're reading from a TTY and we get a short read,
6522 * indicating that the user hit his EOF character, we need
6523 * to notice it now, because if we try to read from the TTY
6524 * again, the EOF condition will disappear.
6526 * The comparison of cnt to sizeof(buf) is an optimization
6527 * that prevents unnecessary calls to feof().
6531 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6535 #ifdef USE_HEAP_INSTEAD_OF_STACK
6540 if (rspara) { /* have to do this both before and after */
6541 while (i != EOF) { /* to make sure file boundaries work right */
6542 i = PerlIO_getc(fp);
6544 PerlIO_ungetc(fp,i);
6550 return_string_or_null:
6551 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6557 Auto-increment of the value in the SV, doing string to numeric conversion
6558 if necessary. Handles 'get' magic.
6564 Perl_sv_inc(pTHX_ register SV *sv)
6573 if (SvTHINKFIRST(sv)) {
6575 sv_force_normal_flags(sv, 0);
6576 if (SvREADONLY(sv)) {
6577 if (IN_PERL_RUNTIME)
6578 Perl_croak(aTHX_ PL_no_modify);
6582 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6584 i = PTR2IV(SvRV(sv));
6589 flags = SvFLAGS(sv);
6590 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6591 /* It's (privately or publicly) a float, but not tested as an
6592 integer, so test it to see. */
6594 flags = SvFLAGS(sv);
6596 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6597 /* It's publicly an integer, or privately an integer-not-float */
6598 #ifdef PERL_PRESERVE_IVUV
6602 if (SvUVX(sv) == UV_MAX)
6603 sv_setnv(sv, UV_MAX_P1);
6605 (void)SvIOK_only_UV(sv);
6606 SvUV_set(sv, SvUVX(sv) + 1);
6608 if (SvIVX(sv) == IV_MAX)
6609 sv_setuv(sv, (UV)IV_MAX + 1);
6611 (void)SvIOK_only(sv);
6612 SvIV_set(sv, SvIVX(sv) + 1);
6617 if (flags & SVp_NOK) {
6618 (void)SvNOK_only(sv);
6619 SvNV_set(sv, SvNVX(sv) + 1.0);
6623 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6624 if ((flags & SVTYPEMASK) < SVt_PVIV)
6625 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6626 (void)SvIOK_only(sv);
6631 while (isALPHA(*d)) d++;
6632 while (isDIGIT(*d)) d++;
6634 #ifdef PERL_PRESERVE_IVUV
6635 /* Got to punt this as an integer if needs be, but we don't issue
6636 warnings. Probably ought to make the sv_iv_please() that does
6637 the conversion if possible, and silently. */
6638 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6639 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6640 /* Need to try really hard to see if it's an integer.
6641 9.22337203685478e+18 is an integer.
6642 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6643 so $a="9.22337203685478e+18"; $a+0; $a++
6644 needs to be the same as $a="9.22337203685478e+18"; $a++
6651 /* sv_2iv *should* have made this an NV */
6652 if (flags & SVp_NOK) {
6653 (void)SvNOK_only(sv);
6654 SvNV_set(sv, SvNVX(sv) + 1.0);
6657 /* I don't think we can get here. Maybe I should assert this
6658 And if we do get here I suspect that sv_setnv will croak. NWC
6660 #if defined(USE_LONG_DOUBLE)
6661 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",
6662 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6664 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6665 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6668 #endif /* PERL_PRESERVE_IVUV */
6669 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6673 while (d >= SvPVX_const(sv)) {
6681 /* MKS: The original code here died if letters weren't consecutive.
6682 * at least it didn't have to worry about non-C locales. The
6683 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6684 * arranged in order (although not consecutively) and that only
6685 * [A-Za-z] are accepted by isALPHA in the C locale.
6687 if (*d != 'z' && *d != 'Z') {
6688 do { ++*d; } while (!isALPHA(*d));
6691 *(d--) -= 'z' - 'a';
6696 *(d--) -= 'z' - 'a' + 1;
6700 /* oh,oh, the number grew */
6701 SvGROW(sv, SvCUR(sv) + 2);
6702 SvCUR_set(sv, SvCUR(sv) + 1);
6703 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6714 Auto-decrement of the value in the SV, doing string to numeric conversion
6715 if necessary. Handles 'get' magic.
6721 Perl_sv_dec(pTHX_ register SV *sv)
6729 if (SvTHINKFIRST(sv)) {
6731 sv_force_normal_flags(sv, 0);
6732 if (SvREADONLY(sv)) {
6733 if (IN_PERL_RUNTIME)
6734 Perl_croak(aTHX_ PL_no_modify);
6738 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6740 i = PTR2IV(SvRV(sv));
6745 /* Unlike sv_inc we don't have to worry about string-never-numbers
6746 and keeping them magic. But we mustn't warn on punting */
6747 flags = SvFLAGS(sv);
6748 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6749 /* It's publicly an integer, or privately an integer-not-float */
6750 #ifdef PERL_PRESERVE_IVUV
6754 if (SvUVX(sv) == 0) {
6755 (void)SvIOK_only(sv);
6759 (void)SvIOK_only_UV(sv);
6760 SvUV_set(sv, SvUVX(sv) - 1);
6763 if (SvIVX(sv) == IV_MIN)
6764 sv_setnv(sv, (NV)IV_MIN - 1.0);
6766 (void)SvIOK_only(sv);
6767 SvIV_set(sv, SvIVX(sv) - 1);
6772 if (flags & SVp_NOK) {
6773 SvNV_set(sv, SvNVX(sv) - 1.0);
6774 (void)SvNOK_only(sv);
6777 if (!(flags & SVp_POK)) {
6778 if ((flags & SVTYPEMASK) < SVt_PVIV)
6779 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6781 (void)SvIOK_only(sv);
6784 #ifdef PERL_PRESERVE_IVUV
6786 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6787 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6788 /* Need to try really hard to see if it's an integer.
6789 9.22337203685478e+18 is an integer.
6790 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6791 so $a="9.22337203685478e+18"; $a+0; $a--
6792 needs to be the same as $a="9.22337203685478e+18"; $a--
6799 /* sv_2iv *should* have made this an NV */
6800 if (flags & SVp_NOK) {
6801 (void)SvNOK_only(sv);
6802 SvNV_set(sv, SvNVX(sv) - 1.0);
6805 /* I don't think we can get here. Maybe I should assert this
6806 And if we do get here I suspect that sv_setnv will croak. NWC
6808 #if defined(USE_LONG_DOUBLE)
6809 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",
6810 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6812 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6813 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6817 #endif /* PERL_PRESERVE_IVUV */
6818 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6822 =for apidoc sv_mortalcopy
6824 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6825 The new SV is marked as mortal. It will be destroyed "soon", either by an
6826 explicit call to FREETMPS, or by an implicit call at places such as
6827 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6832 /* Make a string that will exist for the duration of the expression
6833 * evaluation. Actually, it may have to last longer than that, but
6834 * hopefully we won't free it until it has been assigned to a
6835 * permanent location. */
6838 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6844 sv_setsv(sv,oldstr);
6846 PL_tmps_stack[++PL_tmps_ix] = sv;
6852 =for apidoc sv_newmortal
6854 Creates a new null SV which is mortal. The reference count of the SV is
6855 set to 1. It will be destroyed "soon", either by an explicit call to
6856 FREETMPS, or by an implicit call at places such as statement boundaries.
6857 See also C<sv_mortalcopy> and C<sv_2mortal>.
6863 Perl_sv_newmortal(pTHX)
6869 SvFLAGS(sv) = SVs_TEMP;
6871 PL_tmps_stack[++PL_tmps_ix] = sv;
6876 =for apidoc sv_2mortal
6878 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6879 by an explicit call to FREETMPS, or by an implicit call at places such as
6880 statement boundaries. SvTEMP() is turned on which means that the SV's
6881 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6882 and C<sv_mortalcopy>.
6888 Perl_sv_2mortal(pTHX_ register SV *sv)
6893 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6896 PL_tmps_stack[++PL_tmps_ix] = sv;
6904 Creates a new SV and copies a string into it. The reference count for the
6905 SV is set to 1. If C<len> is zero, Perl will compute the length using
6906 strlen(). For efficiency, consider using C<newSVpvn> instead.
6912 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6918 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6923 =for apidoc newSVpvn
6925 Creates a new SV and copies a string into it. The reference count for the
6926 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6927 string. You are responsible for ensuring that the source string is at least
6928 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6934 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6940 sv_setpvn(sv,s,len);
6946 =for apidoc newSVhek
6948 Creates a new SV from the hash key structure. It will generate scalars that
6949 point to the shared string table where possible. Returns a new (undefined)
6950 SV if the hek is NULL.
6956 Perl_newSVhek(pTHX_ const HEK *hek)
6966 if (HEK_LEN(hek) == HEf_SVKEY) {
6967 return newSVsv(*(SV**)HEK_KEY(hek));
6969 const int flags = HEK_FLAGS(hek);
6970 if (flags & HVhek_WASUTF8) {
6972 Andreas would like keys he put in as utf8 to come back as utf8
6974 STRLEN utf8_len = HEK_LEN(hek);
6975 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6976 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6979 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6981 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6982 /* We don't have a pointer to the hv, so we have to replicate the
6983 flag into every HEK. This hv is using custom a hasing
6984 algorithm. Hence we can't return a shared string scalar, as
6985 that would contain the (wrong) hash value, and might get passed
6986 into an hv routine with a regular hash.
6987 Similarly, a hash that isn't using shared hash keys has to have
6988 the flag in every key so that we know not to try to call
6989 share_hek_kek on it. */
6991 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6996 /* This will be overwhelminly the most common case. */
6998 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6999 more efficient than sharepvn(). */
7003 sv_upgrade(sv, SVt_PV);
7004 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7005 SvCUR_set(sv, HEK_LEN(hek));
7018 =for apidoc newSVpvn_share
7020 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7021 table. If the string does not already exist in the table, it is created
7022 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7023 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7024 otherwise the hash is computed. The idea here is that as the string table
7025 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7026 hash lookup will avoid string compare.
7032 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7036 bool is_utf8 = FALSE;
7037 const char *const orig_src = src;
7040 STRLEN tmplen = -len;
7042 /* See the note in hv.c:hv_fetch() --jhi */
7043 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7047 PERL_HASH(hash, src, len);
7049 sv_upgrade(sv, SVt_PV);
7050 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7058 if (src != orig_src)
7064 #if defined(PERL_IMPLICIT_CONTEXT)
7066 /* pTHX_ magic can't cope with varargs, so this is a no-context
7067 * version of the main function, (which may itself be aliased to us).
7068 * Don't access this version directly.
7072 Perl_newSVpvf_nocontext(const char* pat, ...)
7077 va_start(args, pat);
7078 sv = vnewSVpvf(pat, &args);
7085 =for apidoc newSVpvf
7087 Creates a new SV and initializes it with the string formatted like
7094 Perl_newSVpvf(pTHX_ const char* pat, ...)
7098 va_start(args, pat);
7099 sv = vnewSVpvf(pat, &args);
7104 /* backend for newSVpvf() and newSVpvf_nocontext() */
7107 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7112 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7119 Creates a new SV and copies a floating point value into it.
7120 The reference count for the SV is set to 1.
7126 Perl_newSVnv(pTHX_ NV n)
7139 Creates a new SV and copies an integer into it. The reference count for the
7146 Perl_newSViv(pTHX_ IV i)
7159 Creates a new SV and copies an unsigned integer into it.
7160 The reference count for the SV is set to 1.
7166 Perl_newSVuv(pTHX_ UV u)
7177 =for apidoc newRV_noinc
7179 Creates an RV wrapper for an SV. The reference count for the original
7180 SV is B<not> incremented.
7186 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7192 sv_upgrade(sv, SVt_RV);
7194 SvRV_set(sv, tmpRef);
7199 /* newRV_inc is the official function name to use now.
7200 * newRV_inc is in fact #defined to newRV in sv.h
7204 Perl_newRV(pTHX_ SV *sv)
7207 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7213 Creates a new SV which is an exact duplicate of the original SV.
7220 Perl_newSVsv(pTHX_ register SV *old)
7227 if (SvTYPE(old) == SVTYPEMASK) {
7228 if (ckWARN_d(WARN_INTERNAL))
7229 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7233 /* SV_GMAGIC is the default for sv_setv()
7234 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7235 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7236 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7241 =for apidoc sv_reset
7243 Underlying implementation for the C<reset> Perl function.
7244 Note that the perl-level function is vaguely deprecated.
7250 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7253 char todo[PERL_UCHAR_MAX+1];
7258 if (!*s) { /* reset ?? searches */
7259 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7261 PMOP *pm = (PMOP *) mg->mg_obj;
7263 pm->op_pmdynflags &= ~PMdf_USED;
7270 /* reset variables */
7272 if (!HvARRAY(stash))
7275 Zero(todo, 256, char);
7278 I32 i = (unsigned char)*s;
7282 max = (unsigned char)*s++;
7283 for ( ; i <= max; i++) {
7286 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7288 for (entry = HvARRAY(stash)[i];
7290 entry = HeNEXT(entry))
7295 if (!todo[(U8)*HeKEY(entry)])
7297 gv = (GV*)HeVAL(entry);
7300 if (SvTHINKFIRST(sv)) {
7301 if (!SvREADONLY(sv) && SvROK(sv))
7303 /* XXX Is this continue a bug? Why should THINKFIRST
7304 exempt us from resetting arrays and hashes? */
7308 if (SvTYPE(sv) >= SVt_PV) {
7310 if (SvPVX_const(sv) != NULL)
7318 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7320 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7323 # if defined(USE_ENVIRON_ARRAY)
7326 # endif /* USE_ENVIRON_ARRAY */
7337 Using various gambits, try to get an IO from an SV: the IO slot if its a
7338 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7339 named after the PV if we're a string.
7345 Perl_sv_2io(pTHX_ SV *sv)
7350 switch (SvTYPE(sv)) {
7358 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7362 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7364 return sv_2io(SvRV(sv));
7365 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7371 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7380 Using various gambits, try to get a CV from an SV; in addition, try if
7381 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7382 The flags in C<lref> are passed to sv_fetchsv.
7388 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7399 switch (SvTYPE(sv)) {
7418 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7419 tryAMAGICunDEREF(to_cv);
7422 if (SvTYPE(sv) == SVt_PVCV) {
7431 Perl_croak(aTHX_ "Not a subroutine reference");
7436 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7442 /* Some flags to gv_fetchsv mean don't really create the GV */
7443 if (SvTYPE(gv) != SVt_PVGV) {
7449 if (lref && !GvCVu(gv)) {
7453 gv_efullname3(tmpsv, gv, NULL);
7454 /* XXX this is probably not what they think they're getting.
7455 * It has the same effect as "sub name;", i.e. just a forward
7457 newSUB(start_subparse(FALSE, 0),
7458 newSVOP(OP_CONST, 0, tmpsv),
7462 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7472 Returns true if the SV has a true value by Perl's rules.
7473 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7474 instead use an in-line version.
7480 Perl_sv_true(pTHX_ register SV *sv)
7485 register const XPV* const tXpv = (XPV*)SvANY(sv);
7487 (tXpv->xpv_cur > 1 ||
7488 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7495 return SvIVX(sv) != 0;
7498 return SvNVX(sv) != 0.0;
7500 return sv_2bool(sv);
7506 =for apidoc sv_pvn_force
7508 Get a sensible string out of the SV somehow.
7509 A private implementation of the C<SvPV_force> macro for compilers which
7510 can't cope with complex macro expressions. Always use the macro instead.
7512 =for apidoc sv_pvn_force_flags
7514 Get a sensible string out of the SV somehow.
7515 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7516 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7517 implemented in terms of this function.
7518 You normally want to use the various wrapper macros instead: see
7519 C<SvPV_force> and C<SvPV_force_nomg>
7525 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7528 if (SvTHINKFIRST(sv) && !SvROK(sv))
7529 sv_force_normal_flags(sv, 0);
7539 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7540 const char * const ref = sv_reftype(sv,0);
7542 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7543 ref, OP_NAME(PL_op));
7545 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7547 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7548 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7550 s = sv_2pv_flags(sv, &len, flags);
7554 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7557 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7558 SvGROW(sv, len + 1);
7559 Move(s,SvPVX(sv),len,char);
7564 SvPOK_on(sv); /* validate pointer */
7566 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7567 PTR2UV(sv),SvPVX_const(sv)));
7570 return SvPVX_mutable(sv);
7574 =for apidoc sv_pvbyten_force
7576 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7582 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7584 sv_pvn_force(sv,lp);
7585 sv_utf8_downgrade(sv,0);
7591 =for apidoc sv_pvutf8n_force
7593 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7599 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7601 sv_pvn_force(sv,lp);
7602 sv_utf8_upgrade(sv);
7608 =for apidoc sv_reftype
7610 Returns a string describing what the SV is a reference to.
7616 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7618 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7619 inside return suggests a const propagation bug in g++. */
7620 if (ob && SvOBJECT(sv)) {
7621 char * const name = HvNAME_get(SvSTASH(sv));
7622 return name ? name : (char *) "__ANON__";
7625 switch (SvTYPE(sv)) {
7642 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7643 /* tied lvalues should appear to be
7644 * scalars for backwards compatitbility */
7645 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7646 ? "SCALAR" : "LVALUE");
7647 case SVt_PVAV: return "ARRAY";
7648 case SVt_PVHV: return "HASH";
7649 case SVt_PVCV: return "CODE";
7650 case SVt_PVGV: return "GLOB";
7651 case SVt_PVFM: return "FORMAT";
7652 case SVt_PVIO: return "IO";
7653 default: return "UNKNOWN";
7659 =for apidoc sv_isobject
7661 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7662 object. If the SV is not an RV, or if the object is not blessed, then this
7669 Perl_sv_isobject(pTHX_ SV *sv)
7685 Returns a boolean indicating whether the SV is blessed into the specified
7686 class. This does not check for subtypes; use C<sv_derived_from> to verify
7687 an inheritance relationship.
7693 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7704 hvname = HvNAME_get(SvSTASH(sv));
7708 return strEQ(hvname, name);
7714 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7715 it will be upgraded to one. If C<classname> is non-null then the new SV will
7716 be blessed in the specified package. The new SV is returned and its
7717 reference count is 1.
7723 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7730 SV_CHECK_THINKFIRST_COW_DROP(rv);
7733 if (SvTYPE(rv) >= SVt_PVMG) {
7734 const U32 refcnt = SvREFCNT(rv);
7738 SvREFCNT(rv) = refcnt;
7740 sv_upgrade(rv, SVt_RV);
7741 } else if (SvROK(rv)) {
7742 SvREFCNT_dec(SvRV(rv));
7743 } else if (SvTYPE(rv) < SVt_RV)
7744 sv_upgrade(rv, SVt_RV);
7745 else if (SvTYPE(rv) > SVt_RV) {
7756 HV* const stash = gv_stashpv(classname, TRUE);
7757 (void)sv_bless(rv, stash);
7763 =for apidoc sv_setref_pv
7765 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7766 argument will be upgraded to an RV. That RV will be modified to point to
7767 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7768 into the SV. The C<classname> argument indicates the package for the
7769 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7770 will have a reference count of 1, and the RV will be returned.
7772 Do not use with other Perl types such as HV, AV, SV, CV, because those
7773 objects will become corrupted by the pointer copy process.
7775 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7781 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7785 sv_setsv(rv, &PL_sv_undef);
7789 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7794 =for apidoc sv_setref_iv
7796 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7797 argument will be upgraded to an RV. That RV will be modified to point to
7798 the new SV. The C<classname> argument indicates the package for the
7799 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7800 will have a reference count of 1, and the RV will be returned.
7806 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7808 sv_setiv(newSVrv(rv,classname), iv);
7813 =for apidoc sv_setref_uv
7815 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7816 argument will be upgraded to an RV. That RV will be modified to point to
7817 the new SV. The C<classname> argument indicates the package for the
7818 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7819 will have a reference count of 1, and the RV will be returned.
7825 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7827 sv_setuv(newSVrv(rv,classname), uv);
7832 =for apidoc sv_setref_nv
7834 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7835 argument will be upgraded to an RV. That RV will be modified to point to
7836 the new SV. The C<classname> argument indicates the package for the
7837 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7838 will have a reference count of 1, and the RV will be returned.
7844 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7846 sv_setnv(newSVrv(rv,classname), nv);
7851 =for apidoc sv_setref_pvn
7853 Copies a string into a new SV, optionally blessing the SV. The length of the
7854 string must be specified with C<n>. The C<rv> argument will be upgraded to
7855 an RV. That RV will be modified to point to the new SV. The C<classname>
7856 argument indicates the package for the blessing. Set C<classname> to
7857 C<NULL> to avoid the blessing. The new SV will have a reference count
7858 of 1, and the RV will be returned.
7860 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7866 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7868 sv_setpvn(newSVrv(rv,classname), pv, n);
7873 =for apidoc sv_bless
7875 Blesses an SV into a specified package. The SV must be an RV. The package
7876 must be designated by its stash (see C<gv_stashpv()>). The reference count
7877 of the SV is unaffected.
7883 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7888 Perl_croak(aTHX_ "Can't bless non-reference value");
7890 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7891 if (SvREADONLY(tmpRef))
7892 Perl_croak(aTHX_ PL_no_modify);
7893 if (SvOBJECT(tmpRef)) {
7894 if (SvTYPE(tmpRef) != SVt_PVIO)
7896 SvREFCNT_dec(SvSTASH(tmpRef));
7899 SvOBJECT_on(tmpRef);
7900 if (SvTYPE(tmpRef) != SVt_PVIO)
7902 SvUPGRADE(tmpRef, SVt_PVMG);
7903 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7910 if(SvSMAGICAL(tmpRef))
7911 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7919 /* Downgrades a PVGV to a PVMG.
7923 S_sv_unglob(pTHX_ SV *sv)
7927 SV * const temp = sv_newmortal();
7929 assert(SvTYPE(sv) == SVt_PVGV);
7931 gv_efullname3(temp, (GV *) sv, "*");
7937 sv_del_backref((SV*)GvSTASH(sv), sv);
7941 if (GvNAME_HEK(sv)) {
7942 unshare_hek(GvNAME_HEK(sv));
7946 /* need to keep SvANY(sv) in the right arena */
7947 xpvmg = new_XPVMG();
7948 StructCopy(SvANY(sv), xpvmg, XPVMG);
7949 del_XPVGV(SvANY(sv));
7952 SvFLAGS(sv) &= ~SVTYPEMASK;
7953 SvFLAGS(sv) |= SVt_PVMG;
7955 /* Intentionally not calling any local SET magic, as this isn't so much a
7956 set operation as merely an internal storage change. */
7957 sv_setsv_flags(sv, temp, 0);
7961 =for apidoc sv_unref_flags
7963 Unsets the RV status of the SV, and decrements the reference count of
7964 whatever was being referenced by the RV. This can almost be thought of
7965 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7966 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7967 (otherwise the decrementing is conditional on the reference count being
7968 different from one or the reference being a readonly SV).
7975 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7977 SV* const target = SvRV(ref);
7979 if (SvWEAKREF(ref)) {
7980 sv_del_backref(target, ref);
7982 SvRV_set(ref, NULL);
7985 SvRV_set(ref, NULL);
7987 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7988 assigned to as BEGIN {$a = \"Foo"} will fail. */
7989 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7990 SvREFCNT_dec(target);
7991 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7992 sv_2mortal(target); /* Schedule for freeing later */
7996 =for apidoc sv_untaint
7998 Untaint an SV. Use C<SvTAINTED_off> instead.
8003 Perl_sv_untaint(pTHX_ SV *sv)
8005 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8006 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8013 =for apidoc sv_tainted
8015 Test an SV for taintedness. Use C<SvTAINTED> instead.
8020 Perl_sv_tainted(pTHX_ SV *sv)
8022 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8023 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8024 if (mg && (mg->mg_len & 1) )
8031 =for apidoc sv_setpviv
8033 Copies an integer into the given SV, also updating its string value.
8034 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8040 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8042 char buf[TYPE_CHARS(UV)];
8044 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8046 sv_setpvn(sv, ptr, ebuf - ptr);
8050 =for apidoc sv_setpviv_mg
8052 Like C<sv_setpviv>, but also handles 'set' magic.
8058 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8064 #if defined(PERL_IMPLICIT_CONTEXT)
8066 /* pTHX_ magic can't cope with varargs, so this is a no-context
8067 * version of the main function, (which may itself be aliased to us).
8068 * Don't access this version directly.
8072 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8076 va_start(args, pat);
8077 sv_vsetpvf(sv, pat, &args);
8081 /* pTHX_ magic can't cope with varargs, so this is a no-context
8082 * version of the main function, (which may itself be aliased to us).
8083 * Don't access this version directly.
8087 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8091 va_start(args, pat);
8092 sv_vsetpvf_mg(sv, pat, &args);
8098 =for apidoc sv_setpvf
8100 Works like C<sv_catpvf> but copies the text into the SV instead of
8101 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8107 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8110 va_start(args, pat);
8111 sv_vsetpvf(sv, pat, &args);
8116 =for apidoc sv_vsetpvf
8118 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8119 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8121 Usually used via its frontend C<sv_setpvf>.
8127 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8129 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8133 =for apidoc sv_setpvf_mg
8135 Like C<sv_setpvf>, but also handles 'set' magic.
8141 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8144 va_start(args, pat);
8145 sv_vsetpvf_mg(sv, pat, &args);
8150 =for apidoc sv_vsetpvf_mg
8152 Like C<sv_vsetpvf>, but also handles 'set' magic.
8154 Usually used via its frontend C<sv_setpvf_mg>.
8160 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8162 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8166 #if defined(PERL_IMPLICIT_CONTEXT)
8168 /* pTHX_ magic can't cope with varargs, so this is a no-context
8169 * version of the main function, (which may itself be aliased to us).
8170 * Don't access this version directly.
8174 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8178 va_start(args, pat);
8179 sv_vcatpvf(sv, pat, &args);
8183 /* pTHX_ magic can't cope with varargs, so this is a no-context
8184 * version of the main function, (which may itself be aliased to us).
8185 * Don't access this version directly.
8189 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8193 va_start(args, pat);
8194 sv_vcatpvf_mg(sv, pat, &args);
8200 =for apidoc sv_catpvf
8202 Processes its arguments like C<sprintf> and appends the formatted
8203 output to an SV. If the appended data contains "wide" characters
8204 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8205 and characters >255 formatted with %c), the original SV might get
8206 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8207 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8208 valid UTF-8; if the original SV was bytes, the pattern should be too.
8213 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8216 va_start(args, pat);
8217 sv_vcatpvf(sv, pat, &args);
8222 =for apidoc sv_vcatpvf
8224 Processes its arguments like C<vsprintf> and appends the formatted output
8225 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8227 Usually used via its frontend C<sv_catpvf>.
8233 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8235 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8239 =for apidoc sv_catpvf_mg
8241 Like C<sv_catpvf>, but also handles 'set' magic.
8247 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8250 va_start(args, pat);
8251 sv_vcatpvf_mg(sv, pat, &args);
8256 =for apidoc sv_vcatpvf_mg
8258 Like C<sv_vcatpvf>, but also handles 'set' magic.
8260 Usually used via its frontend C<sv_catpvf_mg>.
8266 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8268 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8273 =for apidoc sv_vsetpvfn
8275 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8278 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8284 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8286 sv_setpvn(sv, "", 0);
8287 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8291 S_expect_number(pTHX_ char** pattern)
8295 switch (**pattern) {
8296 case '1': case '2': case '3':
8297 case '4': case '5': case '6':
8298 case '7': case '8': case '9':
8299 var = *(*pattern)++ - '0';
8300 while (isDIGIT(**pattern)) {
8301 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8303 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8311 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8313 const int neg = nv < 0;
8322 if (uv & 1 && uv == nv)
8323 uv--; /* Round to even */
8325 const unsigned dig = uv % 10;
8338 =for apidoc sv_vcatpvfn
8340 Processes its arguments like C<vsprintf> and appends the formatted output
8341 to an SV. Uses an array of SVs if the C style variable argument list is
8342 missing (NULL). When running with taint checks enabled, indicates via
8343 C<maybe_tainted> if results are untrustworthy (often due to the use of
8346 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8352 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8353 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8354 vec_utf8 = DO_UTF8(vecsv);
8356 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8359 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8367 static const char nullstr[] = "(null)";
8369 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8370 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8372 /* Times 4: a decimal digit takes more than 3 binary digits.
8373 * NV_DIG: mantissa takes than many decimal digits.
8374 * Plus 32: Playing safe. */
8375 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8376 /* large enough for "%#.#f" --chip */
8377 /* what about long double NVs? --jhi */
8379 PERL_UNUSED_ARG(maybe_tainted);
8381 /* no matter what, this is a string now */
8382 (void)SvPV_force(sv, origlen);
8384 /* special-case "", "%s", and "%-p" (SVf - see below) */
8387 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8389 const char * const s = va_arg(*args, char*);
8390 sv_catpv(sv, s ? s : nullstr);
8392 else if (svix < svmax) {
8393 sv_catsv(sv, *svargs);
8397 if (args && patlen == 3 && pat[0] == '%' &&
8398 pat[1] == '-' && pat[2] == 'p') {
8399 argsv = va_arg(*args, SV*);
8400 sv_catsv(sv, argsv);
8404 #ifndef USE_LONG_DOUBLE
8405 /* special-case "%.<number>[gf]" */
8406 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8407 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8408 unsigned digits = 0;
8412 while (*pp >= '0' && *pp <= '9')
8413 digits = 10 * digits + (*pp++ - '0');
8414 if (pp - pat == (int)patlen - 1) {
8422 /* Add check for digits != 0 because it seems that some
8423 gconverts are buggy in this case, and we don't yet have
8424 a Configure test for this. */
8425 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8426 /* 0, point, slack */
8427 Gconvert(nv, (int)digits, 0, ebuf);
8429 if (*ebuf) /* May return an empty string for digits==0 */
8432 } else if (!digits) {
8435 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8436 sv_catpvn(sv, p, l);
8442 #endif /* !USE_LONG_DOUBLE */
8444 if (!args && svix < svmax && DO_UTF8(*svargs))
8447 patend = (char*)pat + patlen;
8448 for (p = (char*)pat; p < patend; p = q) {
8451 bool vectorize = FALSE;
8452 bool vectorarg = FALSE;
8453 bool vec_utf8 = FALSE;
8459 bool has_precis = FALSE;
8461 const I32 osvix = svix;
8462 bool is_utf8 = FALSE; /* is this item utf8? */
8463 #ifdef HAS_LDBL_SPRINTF_BUG
8464 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8465 with sfio - Allen <allens@cpan.org> */
8466 bool fix_ldbl_sprintf_bug = FALSE;
8470 U8 utf8buf[UTF8_MAXBYTES+1];
8471 STRLEN esignlen = 0;
8473 const char *eptr = NULL;
8476 const U8 *vecstr = NULL;
8483 /* we need a long double target in case HAS_LONG_DOUBLE but
8486 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8494 const char *dotstr = ".";
8495 STRLEN dotstrlen = 1;
8496 I32 efix = 0; /* explicit format parameter index */
8497 I32 ewix = 0; /* explicit width index */
8498 I32 epix = 0; /* explicit precision index */
8499 I32 evix = 0; /* explicit vector index */
8500 bool asterisk = FALSE;
8502 /* echo everything up to the next format specification */
8503 for (q = p; q < patend && *q != '%'; ++q) ;
8505 if (has_utf8 && !pat_utf8)
8506 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8508 sv_catpvn(sv, p, q - p);
8515 We allow format specification elements in this order:
8516 \d+\$ explicit format parameter index
8518 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8519 0 flag (as above): repeated to allow "v02"
8520 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8521 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8523 [%bcdefginopsuxDFOUX] format (mandatory)
8528 As of perl5.9.3, printf format checking is on by default.
8529 Internally, perl uses %p formats to provide an escape to
8530 some extended formatting. This block deals with those
8531 extensions: if it does not match, (char*)q is reset and
8532 the normal format processing code is used.
8534 Currently defined extensions are:
8535 %p include pointer address (standard)
8536 %-p (SVf) include an SV (previously %_)
8537 %-<num>p include an SV with precision <num>
8538 %1p (VDf) include a v-string (as %vd)
8539 %<num>p reserved for future extensions
8541 Robin Barker 2005-07-14
8548 n = expect_number(&q);
8555 argsv = va_arg(*args, SV*);
8556 eptr = SvPVx_const(argsv, elen);
8562 else if (n == vdNUMBER) { /* VDf */
8569 if (ckWARN_d(WARN_INTERNAL))
8570 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8571 "internal %%<num>p might conflict with future printf extensions");
8577 if ( (width = expect_number(&q)) ) {
8592 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8621 if ( (ewix = expect_number(&q)) )
8630 if ((vectorarg = asterisk)) {
8643 width = expect_number(&q);
8649 vecsv = va_arg(*args, SV*);
8651 vecsv = (evix > 0 && evix <= svmax)
8652 ? svargs[evix-1] : &PL_sv_undef;
8654 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8656 dotstr = SvPV_const(vecsv, dotstrlen);
8657 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8658 bad with tied or overloaded values that return UTF8. */
8661 else if (has_utf8) {
8662 vecsv = sv_mortalcopy(vecsv);
8663 sv_utf8_upgrade(vecsv);
8664 dotstr = SvPV_const(vecsv, dotstrlen);
8671 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8672 vecsv = svargs[efix ? efix-1 : svix++];
8673 vecstr = (U8*)SvPV_const(vecsv,veclen);
8674 vec_utf8 = DO_UTF8(vecsv);
8676 /* if this is a version object, we need to convert
8677 * back into v-string notation and then let the
8678 * vectorize happen normally
8680 if (sv_derived_from(vecsv, "version")) {
8681 char *version = savesvpv(vecsv);
8682 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8683 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8684 "vector argument not supported with alpha versions");
8687 vecsv = sv_newmortal();
8688 /* scan_vstring is expected to be called during
8689 * tokenization, so we need to fake up the end
8690 * of the buffer for it
8692 PL_bufend = version + veclen;
8693 scan_vstring(version, vecsv);
8694 vecstr = (U8*)SvPV_const(vecsv, veclen);
8695 vec_utf8 = DO_UTF8(vecsv);
8707 i = va_arg(*args, int);
8709 i = (ewix ? ewix <= svmax : svix < svmax) ?
8710 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8712 width = (i < 0) ? -i : i;
8722 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8724 /* XXX: todo, support specified precision parameter */
8728 i = va_arg(*args, int);
8730 i = (ewix ? ewix <= svmax : svix < svmax)
8731 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8733 has_precis = !(i < 0);
8738 precis = precis * 10 + (*q++ - '0');
8747 case 'I': /* Ix, I32x, and I64x */
8749 if (q[1] == '6' && q[2] == '4') {
8755 if (q[1] == '3' && q[2] == '2') {
8765 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8776 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8777 if (*(q + 1) == 'l') { /* lld, llf */
8803 if (!vectorize && !args) {
8805 const I32 i = efix-1;
8806 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8808 argsv = (svix >= 0 && svix < svmax)
8809 ? svargs[svix++] : &PL_sv_undef;
8820 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8822 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8824 eptr = (char*)utf8buf;
8825 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8839 eptr = va_arg(*args, char*);
8841 #ifdef MACOS_TRADITIONAL
8842 /* On MacOS, %#s format is used for Pascal strings */
8847 elen = strlen(eptr);
8849 eptr = (char *)nullstr;
8850 elen = sizeof nullstr - 1;
8854 eptr = SvPVx_const(argsv, elen);
8855 if (DO_UTF8(argsv)) {
8856 I32 old_precis = precis;
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 if (has_precis && precis < elen)
8864 width += precis - old_precis;
8866 width += elen - sv_len_utf8(argsv);
8873 if (has_precis && elen > precis)
8880 if (alt || vectorize)
8882 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8903 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8912 esignbuf[esignlen++] = plus;
8916 case 'h': iv = (short)va_arg(*args, int); break;
8917 case 'l': iv = va_arg(*args, long); break;
8918 case 'V': iv = va_arg(*args, IV); break;
8919 default: iv = va_arg(*args, int); break;
8921 case 'q': iv = va_arg(*args, Quad_t); break;
8926 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8928 case 'h': iv = (short)tiv; break;
8929 case 'l': iv = (long)tiv; break;
8931 default: iv = tiv; break;
8933 case 'q': iv = (Quad_t)tiv; break;
8937 if ( !vectorize ) /* we already set uv above */
8942 esignbuf[esignlen++] = plus;
8946 esignbuf[esignlen++] = '-';
8990 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9001 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9002 case 'l': uv = va_arg(*args, unsigned long); break;
9003 case 'V': uv = va_arg(*args, UV); break;
9004 default: uv = va_arg(*args, unsigned); break;
9006 case 'q': uv = va_arg(*args, Uquad_t); break;
9011 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9013 case 'h': uv = (unsigned short)tuv; break;
9014 case 'l': uv = (unsigned long)tuv; break;
9016 default: uv = tuv; break;
9018 case 'q': uv = (Uquad_t)tuv; break;
9025 char *ptr = ebuf + sizeof ebuf;
9026 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9032 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9038 esignbuf[esignlen++] = '0';
9039 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9047 if (alt && *ptr != '0')
9056 esignbuf[esignlen++] = '0';
9057 esignbuf[esignlen++] = c;
9060 default: /* it had better be ten or less */
9064 } while (uv /= base);
9067 elen = (ebuf + sizeof ebuf) - ptr;
9071 zeros = precis - elen;
9072 else if (precis == 0 && elen == 1 && *eptr == '0'
9073 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9076 /* a precision nullifies the 0 flag. */
9083 /* FLOATING POINT */
9086 c = 'f'; /* maybe %F isn't supported here */
9094 /* This is evil, but floating point is even more evil */
9096 /* for SV-style calling, we can only get NV
9097 for C-style calling, we assume %f is double;
9098 for simplicity we allow any of %Lf, %llf, %qf for long double
9102 #if defined(USE_LONG_DOUBLE)
9106 /* [perl #20339] - we should accept and ignore %lf rather than die */
9110 #if defined(USE_LONG_DOUBLE)
9111 intsize = args ? 0 : 'q';
9115 #if defined(HAS_LONG_DOUBLE)
9124 /* now we need (long double) if intsize == 'q', else (double) */
9126 #if LONG_DOUBLESIZE > DOUBLESIZE
9128 va_arg(*args, long double) :
9129 va_arg(*args, double)
9131 va_arg(*args, double)
9136 if (c != 'e' && c != 'E') {
9138 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9139 will cast our (long double) to (double) */
9140 (void)Perl_frexp(nv, &i);
9141 if (i == PERL_INT_MIN)
9142 Perl_die(aTHX_ "panic: frexp");
9144 need = BIT_DIGITS(i);
9146 need += has_precis ? precis : 6; /* known default */
9151 #ifdef HAS_LDBL_SPRINTF_BUG
9152 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9153 with sfio - Allen <allens@cpan.org> */
9156 # define MY_DBL_MAX DBL_MAX
9157 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9158 # if DOUBLESIZE >= 8
9159 # define MY_DBL_MAX 1.7976931348623157E+308L
9161 # define MY_DBL_MAX 3.40282347E+38L
9165 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9166 # define MY_DBL_MAX_BUG 1L
9168 # define MY_DBL_MAX_BUG MY_DBL_MAX
9172 # define MY_DBL_MIN DBL_MIN
9173 # else /* XXX guessing! -Allen */
9174 # if DOUBLESIZE >= 8
9175 # define MY_DBL_MIN 2.2250738585072014E-308L
9177 # define MY_DBL_MIN 1.17549435E-38L
9181 if ((intsize == 'q') && (c == 'f') &&
9182 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9184 /* it's going to be short enough that
9185 * long double precision is not needed */
9187 if ((nv <= 0L) && (nv >= -0L))
9188 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9190 /* would use Perl_fp_class as a double-check but not
9191 * functional on IRIX - see perl.h comments */
9193 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9194 /* It's within the range that a double can represent */
9195 #if defined(DBL_MAX) && !defined(DBL_MIN)
9196 if ((nv >= ((long double)1/DBL_MAX)) ||
9197 (nv <= (-(long double)1/DBL_MAX)))
9199 fix_ldbl_sprintf_bug = TRUE;
9202 if (fix_ldbl_sprintf_bug == TRUE) {
9212 # undef MY_DBL_MAX_BUG
9215 #endif /* HAS_LDBL_SPRINTF_BUG */
9217 need += 20; /* fudge factor */
9218 if (PL_efloatsize < need) {
9219 Safefree(PL_efloatbuf);
9220 PL_efloatsize = need + 20; /* more fudge */
9221 Newx(PL_efloatbuf, PL_efloatsize, char);
9222 PL_efloatbuf[0] = '\0';
9225 if ( !(width || left || plus || alt) && fill != '0'
9226 && has_precis && intsize != 'q' ) { /* Shortcuts */
9227 /* See earlier comment about buggy Gconvert when digits,
9229 if ( c == 'g' && precis) {
9230 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9231 /* May return an empty string for digits==0 */
9232 if (*PL_efloatbuf) {
9233 elen = strlen(PL_efloatbuf);
9234 goto float_converted;
9236 } else if ( c == 'f' && !precis) {
9237 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9242 char *ptr = ebuf + sizeof ebuf;
9245 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9246 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9247 if (intsize == 'q') {
9248 /* Copy the one or more characters in a long double
9249 * format before the 'base' ([efgEFG]) character to
9250 * the format string. */
9251 static char const prifldbl[] = PERL_PRIfldbl;
9252 char const *p = prifldbl + sizeof(prifldbl) - 3;
9253 while (p >= prifldbl) { *--ptr = *p--; }
9258 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9263 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9275 /* No taint. Otherwise we are in the strange situation
9276 * where printf() taints but print($float) doesn't.
9278 #if defined(HAS_LONG_DOUBLE)
9279 elen = ((intsize == 'q')
9280 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9281 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9283 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9287 eptr = PL_efloatbuf;
9295 i = SvCUR(sv) - origlen;
9298 case 'h': *(va_arg(*args, short*)) = i; break;
9299 default: *(va_arg(*args, int*)) = i; break;
9300 case 'l': *(va_arg(*args, long*)) = i; break;
9301 case 'V': *(va_arg(*args, IV*)) = i; break;
9303 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9308 sv_setuv_mg(argsv, (UV)i);
9309 continue; /* not "break" */
9316 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9317 && ckWARN(WARN_PRINTF))
9319 SV * const msg = sv_newmortal();
9320 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9321 (PL_op->op_type == OP_PRTF) ? "" : "s");
9324 Perl_sv_catpvf(aTHX_ msg,
9325 "\"%%%c\"", c & 0xFF);
9327 Perl_sv_catpvf(aTHX_ msg,
9328 "\"%%\\%03"UVof"\"",
9331 sv_catpvs(msg, "end of string");
9332 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9335 /* output mangled stuff ... */
9341 /* ... right here, because formatting flags should not apply */
9342 SvGROW(sv, SvCUR(sv) + elen + 1);
9344 Copy(eptr, p, elen, char);
9347 SvCUR_set(sv, p - SvPVX_const(sv));
9349 continue; /* not "break" */
9352 if (is_utf8 != has_utf8) {
9355 sv_utf8_upgrade(sv);
9358 const STRLEN old_elen = elen;
9359 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9360 sv_utf8_upgrade(nsv);
9361 eptr = SvPVX_const(nsv);
9364 if (width) { /* fudge width (can't fudge elen) */
9365 width += elen - old_elen;
9371 have = esignlen + zeros + elen;
9373 Perl_croak_nocontext(PL_memory_wrap);
9375 need = (have > width ? have : width);
9378 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9379 Perl_croak_nocontext(PL_memory_wrap);
9380 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9382 if (esignlen && fill == '0') {
9384 for (i = 0; i < (int)esignlen; i++)
9388 memset(p, fill, gap);
9391 if (esignlen && fill != '0') {
9393 for (i = 0; i < (int)esignlen; i++)
9398 for (i = zeros; i; i--)
9402 Copy(eptr, p, elen, char);
9406 memset(p, ' ', gap);
9411 Copy(dotstr, p, dotstrlen, char);
9415 vectorize = FALSE; /* done iterating over vecstr */
9422 SvCUR_set(sv, p - SvPVX_const(sv));
9430 /* =========================================================================
9432 =head1 Cloning an interpreter
9434 All the macros and functions in this section are for the private use of
9435 the main function, perl_clone().
9437 The foo_dup() functions make an exact copy of an existing foo thinngy.
9438 During the course of a cloning, a hash table is used to map old addresses
9439 to new addresses. The table is created and manipulated with the
9440 ptr_table_* functions.
9444 ============================================================================*/
9447 #if defined(USE_ITHREADS)
9449 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9450 #ifndef GpREFCNT_inc
9451 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9455 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9456 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9457 If this changes, please unmerge ss_dup. */
9458 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9459 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9460 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9461 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9463 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9465 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9466 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9467 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9468 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9469 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9470 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9471 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9474 /* duplicate a file handle */
9477 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9481 PERL_UNUSED_ARG(type);
9484 return (PerlIO*)NULL;
9486 /* look for it in the table first */
9487 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9491 /* create anew and remember what it is */
9492 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9493 ptr_table_store(PL_ptr_table, fp, ret);
9497 /* duplicate a directory handle */
9500 Perl_dirp_dup(pTHX_ DIR *dp)
9502 PERL_UNUSED_CONTEXT;
9509 /* duplicate a typeglob */
9512 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9518 /* look for it in the table first */
9519 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9523 /* create anew and remember what it is */
9525 ptr_table_store(PL_ptr_table, gp, ret);
9528 ret->gp_refcnt = 0; /* must be before any other dups! */
9529 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9530 ret->gp_io = io_dup_inc(gp->gp_io, param);
9531 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9532 ret->gp_av = av_dup_inc(gp->gp_av, param);
9533 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9534 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9535 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9536 ret->gp_cvgen = gp->gp_cvgen;
9537 ret->gp_line = gp->gp_line;
9538 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9542 /* duplicate a chain of magic */
9545 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9547 MAGIC *mgprev = (MAGIC*)NULL;
9550 return (MAGIC*)NULL;
9551 /* look for it in the table first */
9552 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9556 for (; mg; mg = mg->mg_moremagic) {
9558 Newxz(nmg, 1, MAGIC);
9560 mgprev->mg_moremagic = nmg;
9563 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9564 nmg->mg_private = mg->mg_private;
9565 nmg->mg_type = mg->mg_type;
9566 nmg->mg_flags = mg->mg_flags;
9567 if (mg->mg_type == PERL_MAGIC_qr) {
9568 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9570 else if(mg->mg_type == PERL_MAGIC_backref) {
9571 /* The backref AV has its reference count deliberately bumped by
9573 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9575 else if (mg->mg_type == PERL_MAGIC_symtab) {
9576 nmg->mg_obj = mg->mg_obj;
9579 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9580 ? sv_dup_inc(mg->mg_obj, param)
9581 : sv_dup(mg->mg_obj, param);
9583 nmg->mg_len = mg->mg_len;
9584 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9585 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9586 if (mg->mg_len > 0) {
9587 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9588 if (mg->mg_type == PERL_MAGIC_overload_table &&
9589 AMT_AMAGIC((AMT*)mg->mg_ptr))
9591 const AMT * const amtp = (AMT*)mg->mg_ptr;
9592 AMT * const namtp = (AMT*)nmg->mg_ptr;
9594 for (i = 1; i < NofAMmeth; i++) {
9595 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9599 else if (mg->mg_len == HEf_SVKEY)
9600 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9602 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9603 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9610 /* create a new pointer-mapping table */
9613 Perl_ptr_table_new(pTHX)
9616 PERL_UNUSED_CONTEXT;
9618 Newxz(tbl, 1, PTR_TBL_t);
9621 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9625 #define PTR_TABLE_HASH(ptr) \
9626 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9629 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9630 following define) and at call to new_body_inline made below in
9631 Perl_ptr_table_store()
9634 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9636 /* map an existing pointer using a table */
9638 STATIC PTR_TBL_ENT_t *
9639 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9640 PTR_TBL_ENT_t *tblent;
9641 const UV hash = PTR_TABLE_HASH(sv);
9643 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9644 for (; tblent; tblent = tblent->next) {
9645 if (tblent->oldval == sv)
9652 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9654 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9655 PERL_UNUSED_CONTEXT;
9656 return tblent ? tblent->newval : NULL;
9659 /* add a new entry to a pointer-mapping table */
9662 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9664 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9665 PERL_UNUSED_CONTEXT;
9668 tblent->newval = newsv;
9670 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9672 new_body_inline(tblent, PTE_SVSLOT);
9674 tblent->oldval = oldsv;
9675 tblent->newval = newsv;
9676 tblent->next = tbl->tbl_ary[entry];
9677 tbl->tbl_ary[entry] = tblent;
9679 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9680 ptr_table_split(tbl);
9684 /* double the hash bucket size of an existing ptr table */
9687 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9689 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9690 const UV oldsize = tbl->tbl_max + 1;
9691 UV newsize = oldsize * 2;
9693 PERL_UNUSED_CONTEXT;
9695 Renew(ary, newsize, PTR_TBL_ENT_t*);
9696 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9697 tbl->tbl_max = --newsize;
9699 for (i=0; i < oldsize; i++, ary++) {
9700 PTR_TBL_ENT_t **curentp, **entp, *ent;
9703 curentp = ary + oldsize;
9704 for (entp = ary, ent = *ary; ent; ent = *entp) {
9705 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9707 ent->next = *curentp;
9717 /* remove all the entries from a ptr table */
9720 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9722 if (tbl && tbl->tbl_items) {
9723 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9724 UV riter = tbl->tbl_max;
9727 PTR_TBL_ENT_t *entry = array[riter];
9730 PTR_TBL_ENT_t * const oentry = entry;
9731 entry = entry->next;
9740 /* clear and free a ptr table */
9743 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9748 ptr_table_clear(tbl);
9749 Safefree(tbl->tbl_ary);
9755 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9758 SvRV_set(dstr, SvWEAKREF(sstr)
9759 ? sv_dup(SvRV(sstr), param)
9760 : sv_dup_inc(SvRV(sstr), param));
9763 else if (SvPVX_const(sstr)) {
9764 /* Has something there */
9766 /* Normal PV - clone whole allocated space */
9767 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9768 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9769 /* Not that normal - actually sstr is copy on write.
9770 But we are a true, independant SV, so: */
9771 SvREADONLY_off(dstr);
9776 /* Special case - not normally malloced for some reason */
9777 if (isGV_with_GP(sstr)) {
9778 /* Don't need to do anything here. */
9780 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9781 /* A "shared" PV - clone it as "shared" PV */
9783 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9787 /* Some other special case - random pointer */
9788 SvPV_set(dstr, SvPVX(sstr));
9794 if (SvTYPE(dstr) == SVt_RV)
9795 SvRV_set(dstr, NULL);
9797 SvPV_set(dstr, NULL);
9801 /* duplicate an SV of any type (including AV, HV etc) */
9804 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9809 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9811 /* look for it in the table first */
9812 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9816 if(param->flags & CLONEf_JOIN_IN) {
9817 /** We are joining here so we don't want do clone
9818 something that is bad **/
9819 if (SvTYPE(sstr) == SVt_PVHV) {
9820 const char * const hvname = HvNAME_get(sstr);
9822 /** don't clone stashes if they already exist **/
9823 return (SV*)gv_stashpv(hvname,0);
9827 /* create anew and remember what it is */
9830 #ifdef DEBUG_LEAKING_SCALARS
9831 dstr->sv_debug_optype = sstr->sv_debug_optype;
9832 dstr->sv_debug_line = sstr->sv_debug_line;
9833 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9834 dstr->sv_debug_cloned = 1;
9835 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9838 ptr_table_store(PL_ptr_table, sstr, dstr);
9841 SvFLAGS(dstr) = SvFLAGS(sstr);
9842 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9843 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9846 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9847 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9848 PL_watch_pvx, SvPVX_const(sstr));
9851 /* don't clone objects whose class has asked us not to */
9852 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9853 SvFLAGS(dstr) &= ~SVTYPEMASK;
9858 switch (SvTYPE(sstr)) {
9863 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9864 SvIV_set(dstr, SvIVX(sstr));
9867 SvANY(dstr) = new_XNV();
9868 SvNV_set(dstr, SvNVX(sstr));
9871 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9872 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9876 /* These are all the types that need complex bodies allocating. */
9878 const svtype sv_type = SvTYPE(sstr);
9879 const struct body_details *const sv_type_details
9880 = bodies_by_type + sv_type;
9884 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9888 if (GvUNIQUE((GV*)sstr)) {
9889 NOOP; /* Do sharing here, and fall through */
9902 assert(sv_type_details->body_size);
9903 if (sv_type_details->arena) {
9904 new_body_inline(new_body, sv_type);
9906 = (void*)((char*)new_body - sv_type_details->offset);
9908 new_body = new_NOARENA(sv_type_details);
9912 SvANY(dstr) = new_body;
9915 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9916 ((char*)SvANY(dstr)) + sv_type_details->offset,
9917 sv_type_details->copy, char);
9919 Copy(((char*)SvANY(sstr)),
9920 ((char*)SvANY(dstr)),
9921 sv_type_details->body_size + sv_type_details->offset, char);
9924 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9925 && !isGV_with_GP(dstr))
9926 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9928 /* The Copy above means that all the source (unduplicated) pointers
9929 are now in the destination. We can check the flags and the
9930 pointers in either, but it's possible that there's less cache
9931 missing by always going for the destination.
9932 FIXME - instrument and check that assumption */
9933 if (sv_type >= SVt_PVMG) {
9934 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
9935 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
9936 } else if (SvMAGIC(dstr))
9937 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9939 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9942 /* The cast silences a GCC warning about unhandled types. */
9943 switch ((int)sv_type) {
9955 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9956 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9957 LvTARG(dstr) = dstr;
9958 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9959 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9961 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9964 if (GvNAME_HEK(dstr))
9965 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9967 /* Don't call sv_add_backref here as it's going to be created
9968 as part of the magic cloning of the symbol table. */
9969 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9970 if(isGV_with_GP(sstr)) {
9971 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9972 at the point of this comment. */
9973 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9974 (void)GpREFCNT_inc(GvGP(dstr));
9976 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9979 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9980 if (IoOFP(dstr) == IoIFP(sstr))
9981 IoOFP(dstr) = IoIFP(dstr);
9983 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9984 /* PL_rsfp_filters entries have fake IoDIRP() */
9985 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9986 /* I have no idea why fake dirp (rsfps)
9987 should be treated differently but otherwise
9988 we end up with leaks -- sky*/
9989 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9990 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9991 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9993 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9994 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9995 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9997 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10000 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10003 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10004 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10005 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10008 if (AvARRAY((AV*)sstr)) {
10009 SV **dst_ary, **src_ary;
10010 SSize_t items = AvFILLp((AV*)sstr) + 1;
10012 src_ary = AvARRAY((AV*)sstr);
10013 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10014 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10015 AvARRAY((AV*)dstr) = dst_ary;
10016 AvALLOC((AV*)dstr) = dst_ary;
10017 if (AvREAL((AV*)sstr)) {
10018 while (items-- > 0)
10019 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10022 while (items-- > 0)
10023 *dst_ary++ = sv_dup(*src_ary++, param);
10025 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10026 while (items-- > 0) {
10027 *dst_ary++ = &PL_sv_undef;
10031 AvARRAY((AV*)dstr) = NULL;
10032 AvALLOC((AV*)dstr) = (SV**)NULL;
10036 if (HvARRAY((HV*)sstr)) {
10038 const bool sharekeys = !!HvSHAREKEYS(sstr);
10039 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10040 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10042 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10043 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10045 HvARRAY(dstr) = (HE**)darray;
10046 while (i <= sxhv->xhv_max) {
10047 const HE * const source = HvARRAY(sstr)[i];
10048 HvARRAY(dstr)[i] = source
10049 ? he_dup(source, sharekeys, param) : 0;
10054 const struct xpvhv_aux * const saux = HvAUX(sstr);
10055 struct xpvhv_aux * const daux = HvAUX(dstr);
10056 /* This flag isn't copied. */
10057 /* SvOOK_on(hv) attacks the IV flags. */
10058 SvFLAGS(dstr) |= SVf_OOK;
10060 hvname = saux->xhv_name;
10061 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10063 daux->xhv_riter = saux->xhv_riter;
10064 daux->xhv_eiter = saux->xhv_eiter
10065 ? he_dup(saux->xhv_eiter,
10066 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10067 daux->xhv_backreferences =
10068 saux->xhv_backreferences
10069 ? (AV*) SvREFCNT_inc(
10070 sv_dup((SV*)saux->xhv_backreferences, param))
10072 /* Record stashes for possible cloning in Perl_clone(). */
10074 av_push(param->stashes, dstr);
10078 HvARRAY((HV*)dstr) = NULL;
10081 if (!(param->flags & CLONEf_COPY_STACKS)) {
10085 /* NOTE: not refcounted */
10086 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10088 if (!CvISXSUB(dstr))
10089 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10091 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10092 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10093 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10094 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10096 /* don't dup if copying back - CvGV isn't refcounted, so the
10097 * duped GV may never be freed. A bit of a hack! DAPM */
10098 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10099 NULL : gv_dup(CvGV(dstr), param) ;
10100 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10102 CvWEAKOUTSIDE(sstr)
10103 ? cv_dup( CvOUTSIDE(dstr), param)
10104 : cv_dup_inc(CvOUTSIDE(dstr), param);
10105 if (!CvISXSUB(dstr))
10106 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10112 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10118 /* duplicate a context */
10121 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10123 PERL_CONTEXT *ncxs;
10126 return (PERL_CONTEXT*)NULL;
10128 /* look for it in the table first */
10129 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10133 /* create anew and remember what it is */
10134 Newxz(ncxs, max + 1, PERL_CONTEXT);
10135 ptr_table_store(PL_ptr_table, cxs, ncxs);
10138 PERL_CONTEXT * const cx = &cxs[ix];
10139 PERL_CONTEXT * const ncx = &ncxs[ix];
10140 ncx->cx_type = cx->cx_type;
10141 if (CxTYPE(cx) == CXt_SUBST) {
10142 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10145 ncx->blk_oldsp = cx->blk_oldsp;
10146 ncx->blk_oldcop = cx->blk_oldcop;
10147 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10148 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10149 ncx->blk_oldpm = cx->blk_oldpm;
10150 ncx->blk_gimme = cx->blk_gimme;
10151 switch (CxTYPE(cx)) {
10153 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10154 ? cv_dup_inc(cx->blk_sub.cv, param)
10155 : cv_dup(cx->blk_sub.cv,param));
10156 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10157 ? av_dup_inc(cx->blk_sub.argarray, param)
10159 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10160 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10161 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10162 ncx->blk_sub.lval = cx->blk_sub.lval;
10163 ncx->blk_sub.retop = cx->blk_sub.retop;
10164 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10165 cx->blk_sub.oldcomppad);
10168 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10169 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10170 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10171 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10172 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10173 ncx->blk_eval.retop = cx->blk_eval.retop;
10176 ncx->blk_loop.label = cx->blk_loop.label;
10177 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10178 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10179 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10180 ? cx->blk_loop.iterdata
10181 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10182 ncx->blk_loop.oldcomppad
10183 = (PAD*)ptr_table_fetch(PL_ptr_table,
10184 cx->blk_loop.oldcomppad);
10185 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10186 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10187 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10188 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10189 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10192 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10193 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10194 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10195 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10196 ncx->blk_sub.retop = cx->blk_sub.retop;
10208 /* duplicate a stack info structure */
10211 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10216 return (PERL_SI*)NULL;
10218 /* look for it in the table first */
10219 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10223 /* create anew and remember what it is */
10224 Newxz(nsi, 1, PERL_SI);
10225 ptr_table_store(PL_ptr_table, si, nsi);
10227 nsi->si_stack = av_dup_inc(si->si_stack, param);
10228 nsi->si_cxix = si->si_cxix;
10229 nsi->si_cxmax = si->si_cxmax;
10230 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10231 nsi->si_type = si->si_type;
10232 nsi->si_prev = si_dup(si->si_prev, param);
10233 nsi->si_next = si_dup(si->si_next, param);
10234 nsi->si_markoff = si->si_markoff;
10239 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10240 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10241 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10242 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10243 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10244 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10245 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10246 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10247 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10248 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10249 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10250 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10251 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10252 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10255 #define pv_dup_inc(p) SAVEPV(p)
10256 #define pv_dup(p) SAVEPV(p)
10257 #define svp_dup_inc(p,pp) any_dup(p,pp)
10259 /* map any object to the new equivent - either something in the
10260 * ptr table, or something in the interpreter structure
10264 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10269 return (void*)NULL;
10271 /* look for it in the table first */
10272 ret = ptr_table_fetch(PL_ptr_table, v);
10276 /* see if it is part of the interpreter structure */
10277 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10278 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10286 /* duplicate the save stack */
10289 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10291 ANY * const ss = proto_perl->Tsavestack;
10292 const I32 max = proto_perl->Tsavestack_max;
10293 I32 ix = proto_perl->Tsavestack_ix;
10306 void (*dptr) (void*);
10307 void (*dxptr) (pTHX_ void*);
10309 Newxz(nss, max, ANY);
10312 const I32 type = POPINT(ss,ix);
10313 TOPINT(nss,ix) = type;
10315 case SAVEt_HELEM: /* hash element */
10316 sv = (SV*)POPPTR(ss,ix);
10317 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10319 case SAVEt_ITEM: /* normal string */
10320 case SAVEt_SV: /* scalar reference */
10321 sv = (SV*)POPPTR(ss,ix);
10322 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10325 case SAVEt_MORTALIZESV:
10326 sv = (SV*)POPPTR(ss,ix);
10327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10329 case SAVEt_SHARED_PVREF: /* char* in shared space */
10330 c = (char*)POPPTR(ss,ix);
10331 TOPPTR(nss,ix) = savesharedpv(c);
10332 ptr = POPPTR(ss,ix);
10333 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10335 case SAVEt_GENERIC_SVREF: /* generic sv */
10336 case SAVEt_SVREF: /* scalar reference */
10337 sv = (SV*)POPPTR(ss,ix);
10338 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10339 ptr = POPPTR(ss,ix);
10340 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10342 case SAVEt_HV: /* hash reference */
10343 case SAVEt_AV: /* array reference */
10344 sv = (SV*) POPPTR(ss,ix);
10345 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10347 case SAVEt_COMPPAD:
10349 sv = (SV*) POPPTR(ss,ix);
10350 TOPPTR(nss,ix) = sv_dup(sv, param);
10352 case SAVEt_INT: /* int reference */
10353 ptr = POPPTR(ss,ix);
10354 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10355 intval = (int)POPINT(ss,ix);
10356 TOPINT(nss,ix) = intval;
10358 case SAVEt_LONG: /* long reference */
10359 ptr = POPPTR(ss,ix);
10360 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10362 case SAVEt_CLEARSV:
10363 longval = (long)POPLONG(ss,ix);
10364 TOPLONG(nss,ix) = longval;
10366 case SAVEt_I32: /* I32 reference */
10367 case SAVEt_I16: /* I16 reference */
10368 case SAVEt_I8: /* I8 reference */
10369 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10370 ptr = POPPTR(ss,ix);
10371 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10373 TOPINT(nss,ix) = i;
10375 case SAVEt_IV: /* IV reference */
10376 ptr = POPPTR(ss,ix);
10377 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10379 TOPIV(nss,ix) = iv;
10381 case SAVEt_HPTR: /* HV* reference */
10382 case SAVEt_APTR: /* AV* reference */
10383 case SAVEt_SPTR: /* SV* reference */
10384 ptr = POPPTR(ss,ix);
10385 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10386 sv = (SV*)POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = sv_dup(sv, param);
10389 case SAVEt_VPTR: /* random* reference */
10390 ptr = POPPTR(ss,ix);
10391 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10392 ptr = POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10395 case SAVEt_GENERIC_PVREF: /* generic char* */
10396 case SAVEt_PPTR: /* char* reference */
10397 ptr = POPPTR(ss,ix);
10398 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10399 c = (char*)POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = pv_dup(c);
10402 case SAVEt_GP: /* scalar reference */
10403 gp = (GP*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10405 (void)GpREFCNT_inc(gp);
10406 gv = (GV*)POPPTR(ss,ix);
10407 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10410 ptr = POPPTR(ss,ix);
10411 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10412 /* these are assumed to be refcounted properly */
10414 switch (((OP*)ptr)->op_type) {
10416 case OP_LEAVESUBLV:
10420 case OP_LEAVEWRITE:
10421 TOPPTR(nss,ix) = ptr;
10428 TOPPTR(nss,ix) = NULL;
10433 TOPPTR(nss,ix) = NULL;
10436 c = (char*)POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = pv_dup_inc(c);
10440 hv = (HV*)POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10442 c = (char*)POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = pv_dup_inc(c);
10445 case SAVEt_STACK_POS: /* Position on Perl stack */
10447 TOPINT(nss,ix) = i;
10449 case SAVEt_DESTRUCTOR:
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10452 dptr = POPDPTR(ss,ix);
10453 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10454 any_dup(FPTR2DPTR(void *, dptr),
10457 case SAVEt_DESTRUCTOR_X:
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10460 dxptr = POPDXPTR(ss,ix);
10461 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10462 any_dup(FPTR2DPTR(void *, dxptr),
10465 case SAVEt_REGCONTEXT:
10468 TOPINT(nss,ix) = i;
10471 case SAVEt_AELEM: /* array element */
10472 sv = (SV*)POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10475 TOPINT(nss,ix) = i;
10476 av = (AV*)POPPTR(ss,ix);
10477 TOPPTR(nss,ix) = av_dup_inc(av, param);
10480 ptr = POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = ptr;
10485 TOPINT(nss,ix) = i;
10486 ptr = POPPTR(ss,ix);
10489 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10490 HINTS_REFCNT_UNLOCK;
10492 TOPPTR(nss,ix) = ptr;
10493 if (i & HINT_LOCALIZE_HH) {
10494 hv = (HV*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10499 longval = (long)POPLONG(ss,ix);
10500 TOPLONG(nss,ix) = longval;
10501 ptr = POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10503 sv = (SV*)POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = sv_dup(sv, param);
10507 ptr = POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10509 longval = (long)POPBOOL(ss,ix);
10510 TOPBOOL(nss,ix) = (bool)longval;
10512 case SAVEt_SET_SVFLAGS:
10514 TOPINT(nss,ix) = i;
10516 TOPINT(nss,ix) = i;
10517 sv = (SV*)POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = sv_dup(sv, param);
10520 case SAVEt_RE_STATE:
10522 const struct re_save_state *const old_state
10523 = (struct re_save_state *)
10524 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10525 struct re_save_state *const new_state
10526 = (struct re_save_state *)
10527 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10529 Copy(old_state, new_state, 1, struct re_save_state);
10530 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10532 new_state->re_state_bostr
10533 = pv_dup(old_state->re_state_bostr);
10534 new_state->re_state_reginput
10535 = pv_dup(old_state->re_state_reginput);
10536 new_state->re_state_regeol
10537 = pv_dup(old_state->re_state_regeol);
10538 new_state->re_state_regstartp
10539 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10540 new_state->re_state_regendp
10541 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10542 new_state->re_state_reglastparen
10543 = (U32*) any_dup(old_state->re_state_reglastparen,
10545 new_state->re_state_reglastcloseparen
10546 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10548 /* XXX This just has to be broken. The old save_re_context
10549 code did SAVEGENERICPV(PL_reg_start_tmp);
10550 PL_reg_start_tmp is char **.
10551 Look above to what the dup code does for
10552 SAVEt_GENERIC_PVREF
10553 It can never have worked.
10554 So this is merely a faithful copy of the exiting bug: */
10555 new_state->re_state_reg_start_tmp
10556 = (char **) pv_dup((char *)
10557 old_state->re_state_reg_start_tmp);
10558 /* I assume that it only ever "worked" because no-one called
10559 (pseudo)fork while the regexp engine had re-entered itself.
10561 #ifdef PERL_OLD_COPY_ON_WRITE
10562 new_state->re_state_nrs
10563 = sv_dup(old_state->re_state_nrs, param);
10565 new_state->re_state_reg_magic
10566 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10568 new_state->re_state_reg_oldcurpm
10569 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10571 new_state->re_state_reg_curpm
10572 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10574 new_state->re_state_reg_oldsaved
10575 = pv_dup(old_state->re_state_reg_oldsaved);
10576 new_state->re_state_reg_poscache
10577 = pv_dup(old_state->re_state_reg_poscache);
10578 new_state->re_state_reg_starttry
10579 = pv_dup(old_state->re_state_reg_starttry);
10582 case SAVEt_COMPILE_WARNINGS:
10583 ptr = POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10588 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10596 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10597 * flag to the result. This is done for each stash before cloning starts,
10598 * so we know which stashes want their objects cloned */
10601 do_mark_cloneable_stash(pTHX_ SV *sv)
10603 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10605 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10606 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10607 if (cloner && GvCV(cloner)) {
10614 XPUSHs(sv_2mortal(newSVhek(hvname)));
10616 call_sv((SV*)GvCV(cloner), G_SCALAR);
10623 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10631 =for apidoc perl_clone
10633 Create and return a new interpreter by cloning the current one.
10635 perl_clone takes these flags as parameters:
10637 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10638 without it we only clone the data and zero the stacks,
10639 with it we copy the stacks and the new perl interpreter is
10640 ready to run at the exact same point as the previous one.
10641 The pseudo-fork code uses COPY_STACKS while the
10642 threads->new doesn't.
10644 CLONEf_KEEP_PTR_TABLE
10645 perl_clone keeps a ptr_table with the pointer of the old
10646 variable as a key and the new variable as a value,
10647 this allows it to check if something has been cloned and not
10648 clone it again but rather just use the value and increase the
10649 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10650 the ptr_table using the function
10651 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10652 reason to keep it around is if you want to dup some of your own
10653 variable who are outside the graph perl scans, example of this
10654 code is in threads.xs create
10657 This is a win32 thing, it is ignored on unix, it tells perls
10658 win32host code (which is c++) to clone itself, this is needed on
10659 win32 if you want to run two threads at the same time,
10660 if you just want to do some stuff in a separate perl interpreter
10661 and then throw it away and return to the original one,
10662 you don't need to do anything.
10667 /* XXX the above needs expanding by someone who actually understands it ! */
10668 EXTERN_C PerlInterpreter *
10669 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10672 perl_clone(PerlInterpreter *proto_perl, UV flags)
10675 #ifdef PERL_IMPLICIT_SYS
10677 /* perlhost.h so we need to call into it
10678 to clone the host, CPerlHost should have a c interface, sky */
10680 if (flags & CLONEf_CLONE_HOST) {
10681 return perl_clone_host(proto_perl,flags);
10683 return perl_clone_using(proto_perl, flags,
10685 proto_perl->IMemShared,
10686 proto_perl->IMemParse,
10688 proto_perl->IStdIO,
10692 proto_perl->IProc);
10696 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10697 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10698 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10699 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10700 struct IPerlDir* ipD, struct IPerlSock* ipS,
10701 struct IPerlProc* ipP)
10703 /* XXX many of the string copies here can be optimized if they're
10704 * constants; they need to be allocated as common memory and just
10705 * their pointers copied. */
10708 CLONE_PARAMS clone_params;
10709 CLONE_PARAMS* const param = &clone_params;
10711 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10712 /* for each stash, determine whether its objects should be cloned */
10713 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10714 PERL_SET_THX(my_perl);
10717 PoisonNew(my_perl, 1, PerlInterpreter);
10723 PL_savestack_ix = 0;
10724 PL_savestack_max = -1;
10725 PL_sig_pending = 0;
10726 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10727 # else /* !DEBUGGING */
10728 Zero(my_perl, 1, PerlInterpreter);
10729 # endif /* DEBUGGING */
10731 /* host pointers */
10733 PL_MemShared = ipMS;
10734 PL_MemParse = ipMP;
10741 #else /* !PERL_IMPLICIT_SYS */
10743 CLONE_PARAMS clone_params;
10744 CLONE_PARAMS* param = &clone_params;
10745 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10746 /* for each stash, determine whether its objects should be cloned */
10747 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10748 PERL_SET_THX(my_perl);
10751 PoisonNew(my_perl, 1, PerlInterpreter);
10757 PL_savestack_ix = 0;
10758 PL_savestack_max = -1;
10759 PL_sig_pending = 0;
10760 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10761 # else /* !DEBUGGING */
10762 Zero(my_perl, 1, PerlInterpreter);
10763 # endif /* DEBUGGING */
10764 #endif /* PERL_IMPLICIT_SYS */
10765 param->flags = flags;
10766 param->proto_perl = proto_perl;
10768 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10770 PL_body_arenas = NULL;
10771 Zero(&PL_body_roots, 1, PL_body_roots);
10773 PL_nice_chunk = NULL;
10774 PL_nice_chunk_size = 0;
10776 PL_sv_objcount = 0;
10778 PL_sv_arenaroot = NULL;
10780 PL_debug = proto_perl->Idebug;
10782 PL_hash_seed = proto_perl->Ihash_seed;
10783 PL_rehash_seed = proto_perl->Irehash_seed;
10785 #ifdef USE_REENTRANT_API
10786 /* XXX: things like -Dm will segfault here in perlio, but doing
10787 * PERL_SET_CONTEXT(proto_perl);
10788 * breaks too many other things
10790 Perl_reentrant_init(aTHX);
10793 /* create SV map for pointer relocation */
10794 PL_ptr_table = ptr_table_new();
10796 /* initialize these special pointers as early as possible */
10797 SvANY(&PL_sv_undef) = NULL;
10798 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10799 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10800 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10802 SvANY(&PL_sv_no) = new_XPVNV();
10803 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10804 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10805 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10806 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10807 SvCUR_set(&PL_sv_no, 0);
10808 SvLEN_set(&PL_sv_no, 1);
10809 SvIV_set(&PL_sv_no, 0);
10810 SvNV_set(&PL_sv_no, 0);
10811 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10813 SvANY(&PL_sv_yes) = new_XPVNV();
10814 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10815 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10816 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10817 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10818 SvCUR_set(&PL_sv_yes, 1);
10819 SvLEN_set(&PL_sv_yes, 2);
10820 SvIV_set(&PL_sv_yes, 1);
10821 SvNV_set(&PL_sv_yes, 1);
10822 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10824 /* create (a non-shared!) shared string table */
10825 PL_strtab = newHV();
10826 HvSHAREKEYS_off(PL_strtab);
10827 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10828 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10830 PL_compiling = proto_perl->Icompiling;
10832 /* These two PVs will be free'd special way so must set them same way op.c does */
10833 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10834 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10836 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10837 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10839 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10840 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10841 if (PL_compiling.cop_hints_hash) {
10843 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10844 HINTS_REFCNT_UNLOCK;
10846 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10848 /* pseudo environmental stuff */
10849 PL_origargc = proto_perl->Iorigargc;
10850 PL_origargv = proto_perl->Iorigargv;
10852 param->stashes = newAV(); /* Setup array of objects to call clone on */
10854 /* Set tainting stuff before PerlIO_debug can possibly get called */
10855 PL_tainting = proto_perl->Itainting;
10856 PL_taint_warn = proto_perl->Itaint_warn;
10858 #ifdef PERLIO_LAYERS
10859 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10860 PerlIO_clone(aTHX_ proto_perl, param);
10863 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10864 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10865 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10866 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10867 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10868 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10871 PL_minus_c = proto_perl->Iminus_c;
10872 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10873 PL_localpatches = proto_perl->Ilocalpatches;
10874 PL_splitstr = proto_perl->Isplitstr;
10875 PL_preprocess = proto_perl->Ipreprocess;
10876 PL_minus_n = proto_perl->Iminus_n;
10877 PL_minus_p = proto_perl->Iminus_p;
10878 PL_minus_l = proto_perl->Iminus_l;
10879 PL_minus_a = proto_perl->Iminus_a;
10880 PL_minus_E = proto_perl->Iminus_E;
10881 PL_minus_F = proto_perl->Iminus_F;
10882 PL_doswitches = proto_perl->Idoswitches;
10883 PL_dowarn = proto_perl->Idowarn;
10884 PL_doextract = proto_perl->Idoextract;
10885 PL_sawampersand = proto_perl->Isawampersand;
10886 PL_unsafe = proto_perl->Iunsafe;
10887 PL_inplace = SAVEPV(proto_perl->Iinplace);
10888 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10889 PL_perldb = proto_perl->Iperldb;
10890 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10891 PL_exit_flags = proto_perl->Iexit_flags;
10893 /* magical thingies */
10894 /* XXX time(&PL_basetime) when asked for? */
10895 PL_basetime = proto_perl->Ibasetime;
10896 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10898 PL_maxsysfd = proto_perl->Imaxsysfd;
10899 PL_statusvalue = proto_perl->Istatusvalue;
10901 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10903 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10905 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10907 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10908 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10909 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10912 /* RE engine related */
10913 Zero(&PL_reg_state, 1, struct re_save_state);
10914 PL_reginterp_cnt = 0;
10915 PL_regmatch_slab = NULL;
10917 /* Clone the regex array */
10918 PL_regex_padav = newAV();
10920 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10921 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10923 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10924 for(i = 1; i <= len; i++) {
10925 const SV * const regex = regexen[i];
10928 ? sv_dup_inc(regex, param)
10930 newSViv(PTR2IV(CALLREGDUPE(
10931 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10933 av_push(PL_regex_padav, sv);
10936 PL_regex_pad = AvARRAY(PL_regex_padav);
10938 /* shortcuts to various I/O objects */
10939 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10940 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10941 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10942 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10943 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10944 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10946 /* shortcuts to regexp stuff */
10947 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10949 /* shortcuts to misc objects */
10950 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10952 /* shortcuts to debugging objects */
10953 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10954 PL_DBline = gv_dup(proto_perl->IDBline, param);
10955 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10956 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10957 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10958 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10959 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10960 PL_lineary = av_dup(proto_perl->Ilineary, param);
10961 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10963 /* symbol tables */
10964 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10965 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10966 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10967 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10968 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10970 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10971 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10972 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10973 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
10974 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
10975 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10976 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10977 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10979 PL_sub_generation = proto_perl->Isub_generation;
10981 /* funky return mechanisms */
10982 PL_forkprocess = proto_perl->Iforkprocess;
10984 /* subprocess state */
10985 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10987 /* internal state */
10988 PL_maxo = proto_perl->Imaxo;
10989 if (proto_perl->Iop_mask)
10990 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10993 /* PL_asserting = proto_perl->Iasserting; */
10995 /* current interpreter roots */
10996 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10998 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11000 PL_main_start = proto_perl->Imain_start;
11001 PL_eval_root = proto_perl->Ieval_root;
11002 PL_eval_start = proto_perl->Ieval_start;
11004 /* runtime control stuff */
11005 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11006 PL_copline = proto_perl->Icopline;
11008 PL_filemode = proto_perl->Ifilemode;
11009 PL_lastfd = proto_perl->Ilastfd;
11010 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11013 PL_gensym = proto_perl->Igensym;
11014 PL_preambled = proto_perl->Ipreambled;
11015 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11016 PL_laststatval = proto_perl->Ilaststatval;
11017 PL_laststype = proto_perl->Ilaststype;
11020 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11022 /* interpreter atexit processing */
11023 PL_exitlistlen = proto_perl->Iexitlistlen;
11024 if (PL_exitlistlen) {
11025 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11026 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11029 PL_exitlist = (PerlExitListEntry*)NULL;
11031 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11032 if (PL_my_cxt_size) {
11033 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11034 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11037 PL_my_cxt_list = (void**)NULL;
11038 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11039 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11040 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11042 PL_profiledata = NULL;
11043 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11044 /* PL_rsfp_filters entries have fake IoDIRP() */
11045 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11047 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11049 PAD_CLONE_VARS(proto_perl, param);
11051 #ifdef HAVE_INTERP_INTERN
11052 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11055 /* more statics moved here */
11056 PL_generation = proto_perl->Igeneration;
11057 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11059 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11060 PL_in_clean_all = proto_perl->Iin_clean_all;
11062 PL_uid = proto_perl->Iuid;
11063 PL_euid = proto_perl->Ieuid;
11064 PL_gid = proto_perl->Igid;
11065 PL_egid = proto_perl->Iegid;
11066 PL_nomemok = proto_perl->Inomemok;
11067 PL_an = proto_perl->Ian;
11068 PL_evalseq = proto_perl->Ievalseq;
11069 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11070 PL_origalen = proto_perl->Iorigalen;
11071 #ifdef PERL_USES_PL_PIDSTATUS
11072 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11074 PL_osname = SAVEPV(proto_perl->Iosname);
11075 PL_sighandlerp = proto_perl->Isighandlerp;
11077 PL_runops = proto_perl->Irunops;
11079 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11082 PL_cshlen = proto_perl->Icshlen;
11083 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11086 PL_lex_state = proto_perl->Ilex_state;
11087 PL_lex_defer = proto_perl->Ilex_defer;
11088 PL_lex_expect = proto_perl->Ilex_expect;
11089 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11090 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11091 PL_lex_starts = proto_perl->Ilex_starts;
11092 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11093 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11094 PL_lex_op = proto_perl->Ilex_op;
11095 PL_lex_inpat = proto_perl->Ilex_inpat;
11096 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11097 PL_lex_brackets = proto_perl->Ilex_brackets;
11098 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11099 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11100 PL_lex_casemods = proto_perl->Ilex_casemods;
11101 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11102 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11105 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11106 PL_lasttoke = proto_perl->Ilasttoke;
11107 PL_realtokenstart = proto_perl->Irealtokenstart;
11108 PL_faketokens = proto_perl->Ifaketokens;
11109 PL_thismad = proto_perl->Ithismad;
11110 PL_thistoken = proto_perl->Ithistoken;
11111 PL_thisopen = proto_perl->Ithisopen;
11112 PL_thisstuff = proto_perl->Ithisstuff;
11113 PL_thisclose = proto_perl->Ithisclose;
11114 PL_thiswhite = proto_perl->Ithiswhite;
11115 PL_nextwhite = proto_perl->Inextwhite;
11116 PL_skipwhite = proto_perl->Iskipwhite;
11117 PL_endwhite = proto_perl->Iendwhite;
11118 PL_curforce = proto_perl->Icurforce;
11120 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11121 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11122 PL_nexttoke = proto_perl->Inexttoke;
11125 /* XXX This is probably masking the deeper issue of why
11126 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11127 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11128 * (A little debugging with a watchpoint on it may help.)
11130 if (SvANY(proto_perl->Ilinestr)) {
11131 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11132 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11133 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11134 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11135 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11136 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11137 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11138 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11139 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11142 PL_linestr = newSV(79);
11143 sv_upgrade(PL_linestr,SVt_PVIV);
11144 sv_setpvn(PL_linestr,"",0);
11145 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11147 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11148 PL_pending_ident = proto_perl->Ipending_ident;
11149 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11151 PL_expect = proto_perl->Iexpect;
11153 PL_multi_start = proto_perl->Imulti_start;
11154 PL_multi_end = proto_perl->Imulti_end;
11155 PL_multi_open = proto_perl->Imulti_open;
11156 PL_multi_close = proto_perl->Imulti_close;
11158 PL_error_count = proto_perl->Ierror_count;
11159 PL_subline = proto_perl->Isubline;
11160 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11162 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11163 if (SvANY(proto_perl->Ilinestr)) {
11164 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11165 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11166 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11167 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11168 PL_last_lop_op = proto_perl->Ilast_lop_op;
11171 PL_last_uni = SvPVX(PL_linestr);
11172 PL_last_lop = SvPVX(PL_linestr);
11173 PL_last_lop_op = 0;
11175 PL_in_my = proto_perl->Iin_my;
11176 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11178 PL_cryptseen = proto_perl->Icryptseen;
11181 PL_hints = proto_perl->Ihints;
11183 PL_amagic_generation = proto_perl->Iamagic_generation;
11185 #ifdef USE_LOCALE_COLLATE
11186 PL_collation_ix = proto_perl->Icollation_ix;
11187 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11188 PL_collation_standard = proto_perl->Icollation_standard;
11189 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11190 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11191 #endif /* USE_LOCALE_COLLATE */
11193 #ifdef USE_LOCALE_NUMERIC
11194 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11195 PL_numeric_standard = proto_perl->Inumeric_standard;
11196 PL_numeric_local = proto_perl->Inumeric_local;
11197 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11198 #endif /* !USE_LOCALE_NUMERIC */
11200 /* utf8 character classes */
11201 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11202 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11203 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11204 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11205 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11206 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11207 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11208 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11209 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11210 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11211 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11212 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11213 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11214 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11215 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11216 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11217 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11218 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11219 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11220 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11222 /* Did the locale setup indicate UTF-8? */
11223 PL_utf8locale = proto_perl->Iutf8locale;
11224 /* Unicode features (see perlrun/-C) */
11225 PL_unicode = proto_perl->Iunicode;
11227 /* Pre-5.8 signals control */
11228 PL_signals = proto_perl->Isignals;
11230 /* times() ticks per second */
11231 PL_clocktick = proto_perl->Iclocktick;
11233 /* Recursion stopper for PerlIO_find_layer */
11234 PL_in_load_module = proto_perl->Iin_load_module;
11236 /* sort() routine */
11237 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11239 /* Not really needed/useful since the reenrant_retint is "volatile",
11240 * but do it for consistency's sake. */
11241 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11243 /* Hooks to shared SVs and locks. */
11244 PL_sharehook = proto_perl->Isharehook;
11245 PL_lockhook = proto_perl->Ilockhook;
11246 PL_unlockhook = proto_perl->Iunlockhook;
11247 PL_threadhook = proto_perl->Ithreadhook;
11249 PL_runops_std = proto_perl->Irunops_std;
11250 PL_runops_dbg = proto_perl->Irunops_dbg;
11252 #ifdef THREADS_HAVE_PIDS
11253 PL_ppid = proto_perl->Ippid;
11257 PL_last_swash_hv = NULL; /* reinits on demand */
11258 PL_last_swash_klen = 0;
11259 PL_last_swash_key[0]= '\0';
11260 PL_last_swash_tmps = (U8*)NULL;
11261 PL_last_swash_slen = 0;
11263 PL_glob_index = proto_perl->Iglob_index;
11264 PL_srand_called = proto_perl->Isrand_called;
11265 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11266 PL_bitcount = NULL; /* reinits on demand */
11268 if (proto_perl->Ipsig_pend) {
11269 Newxz(PL_psig_pend, SIG_SIZE, int);
11272 PL_psig_pend = (int*)NULL;
11275 if (proto_perl->Ipsig_ptr) {
11276 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11277 Newxz(PL_psig_name, SIG_SIZE, SV*);
11278 for (i = 1; i < SIG_SIZE; i++) {
11279 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11280 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11284 PL_psig_ptr = (SV**)NULL;
11285 PL_psig_name = (SV**)NULL;
11288 /* thrdvar.h stuff */
11290 if (flags & CLONEf_COPY_STACKS) {
11291 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11292 PL_tmps_ix = proto_perl->Ttmps_ix;
11293 PL_tmps_max = proto_perl->Ttmps_max;
11294 PL_tmps_floor = proto_perl->Ttmps_floor;
11295 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11297 while (i <= PL_tmps_ix) {
11298 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11302 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11303 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11304 Newxz(PL_markstack, i, I32);
11305 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11306 - proto_perl->Tmarkstack);
11307 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11308 - proto_perl->Tmarkstack);
11309 Copy(proto_perl->Tmarkstack, PL_markstack,
11310 PL_markstack_ptr - PL_markstack + 1, I32);
11312 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11313 * NOTE: unlike the others! */
11314 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11315 PL_scopestack_max = proto_perl->Tscopestack_max;
11316 Newxz(PL_scopestack, PL_scopestack_max, I32);
11317 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11319 /* NOTE: si_dup() looks at PL_markstack */
11320 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11322 /* PL_curstack = PL_curstackinfo->si_stack; */
11323 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11324 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11326 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11327 PL_stack_base = AvARRAY(PL_curstack);
11328 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11329 - proto_perl->Tstack_base);
11330 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11332 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11333 * NOTE: unlike the others! */
11334 PL_savestack_ix = proto_perl->Tsavestack_ix;
11335 PL_savestack_max = proto_perl->Tsavestack_max;
11336 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11337 PL_savestack = ss_dup(proto_perl, param);
11341 ENTER; /* perl_destruct() wants to LEAVE; */
11343 /* although we're not duplicating the tmps stack, we should still
11344 * add entries for any SVs on the tmps stack that got cloned by a
11345 * non-refcount means (eg a temp in @_); otherwise they will be
11348 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11349 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11350 proto_perl->Ttmps_stack[i]);
11351 if (nsv && !SvREFCNT(nsv)) {
11353 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11358 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11359 PL_top_env = &PL_start_env;
11361 PL_op = proto_perl->Top;
11364 PL_Xpv = (XPV*)NULL;
11365 PL_na = proto_perl->Tna;
11367 PL_statbuf = proto_perl->Tstatbuf;
11368 PL_statcache = proto_perl->Tstatcache;
11369 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11370 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11372 PL_timesbuf = proto_perl->Ttimesbuf;
11375 PL_tainted = proto_perl->Ttainted;
11376 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11377 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11378 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11379 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11380 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11381 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11382 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11383 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11384 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11386 PL_restartop = proto_perl->Trestartop;
11387 PL_in_eval = proto_perl->Tin_eval;
11388 PL_delaymagic = proto_perl->Tdelaymagic;
11389 PL_dirty = proto_perl->Tdirty;
11390 PL_localizing = proto_perl->Tlocalizing;
11392 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11393 PL_hv_fetch_ent_mh = NULL;
11394 PL_modcount = proto_perl->Tmodcount;
11395 PL_lastgotoprobe = NULL;
11396 PL_dumpindent = proto_perl->Tdumpindent;
11398 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11399 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11400 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11401 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11402 PL_efloatbuf = NULL; /* reinits on demand */
11403 PL_efloatsize = 0; /* reinits on demand */
11407 PL_screamfirst = NULL;
11408 PL_screamnext = NULL;
11409 PL_maxscream = -1; /* reinits on demand */
11410 PL_lastscream = NULL;
11412 PL_watchaddr = NULL;
11415 PL_regdummy = proto_perl->Tregdummy;
11416 PL_colorset = 0; /* reinits PL_colors[] */
11417 /*PL_colors[6] = {0,0,0,0,0,0};*/
11421 /* Pluggable optimizer */
11422 PL_peepp = proto_perl->Tpeepp;
11424 PL_stashcache = newHV();
11426 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11427 ptr_table_free(PL_ptr_table);
11428 PL_ptr_table = NULL;
11431 /* Call the ->CLONE method, if it exists, for each of the stashes
11432 identified by sv_dup() above.
11434 while(av_len(param->stashes) != -1) {
11435 HV* const stash = (HV*) av_shift(param->stashes);
11436 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11437 if (cloner && GvCV(cloner)) {
11442 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11444 call_sv((SV*)GvCV(cloner), G_DISCARD);
11450 SvREFCNT_dec(param->stashes);
11452 /* orphaned? eg threads->new inside BEGIN or use */
11453 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11454 SvREFCNT_inc_simple_void(PL_compcv);
11455 SAVEFREESV(PL_compcv);
11461 #endif /* USE_ITHREADS */
11464 =head1 Unicode Support
11466 =for apidoc sv_recode_to_utf8
11468 The encoding is assumed to be an Encode object, on entry the PV
11469 of the sv is assumed to be octets in that encoding, and the sv
11470 will be converted into Unicode (and UTF-8).
11472 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11473 is not a reference, nothing is done to the sv. If the encoding is not
11474 an C<Encode::XS> Encoding object, bad things will happen.
11475 (See F<lib/encoding.pm> and L<Encode>).
11477 The PV of the sv is returned.
11482 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11485 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11499 Passing sv_yes is wrong - it needs to be or'ed set of constants
11500 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11501 remove converted chars from source.
11503 Both will default the value - let them.
11505 XPUSHs(&PL_sv_yes);
11508 call_method("decode", G_SCALAR);
11512 s = SvPV_const(uni, len);
11513 if (s != SvPVX_const(sv)) {
11514 SvGROW(sv, len + 1);
11515 Move(s, SvPVX(sv), len + 1, char);
11516 SvCUR_set(sv, len);
11523 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11527 =for apidoc sv_cat_decode
11529 The encoding is assumed to be an Encode object, the PV of the ssv is
11530 assumed to be octets in that encoding and decoding the input starts
11531 from the position which (PV + *offset) pointed to. The dsv will be
11532 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11533 when the string tstr appears in decoding output or the input ends on
11534 the PV of the ssv. The value which the offset points will be modified
11535 to the last input position on the ssv.
11537 Returns TRUE if the terminator was found, else returns FALSE.
11542 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11543 SV *ssv, int *offset, char *tstr, int tlen)
11547 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11558 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11559 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11561 call_method("cat_decode", G_SCALAR);
11563 ret = SvTRUE(TOPs);
11564 *offset = SvIV(offsv);
11570 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11575 /* ---------------------------------------------------------------------
11577 * support functions for report_uninit()
11580 /* the maxiumum size of array or hash where we will scan looking
11581 * for the undefined element that triggered the warning */
11583 #define FUV_MAX_SEARCH_SIZE 1000
11585 /* Look for an entry in the hash whose value has the same SV as val;
11586 * If so, return a mortal copy of the key. */
11589 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11592 register HE **array;
11595 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11596 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11599 array = HvARRAY(hv);
11601 for (i=HvMAX(hv); i>0; i--) {
11602 register HE *entry;
11603 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11604 if (HeVAL(entry) != val)
11606 if ( HeVAL(entry) == &PL_sv_undef ||
11607 HeVAL(entry) == &PL_sv_placeholder)
11611 if (HeKLEN(entry) == HEf_SVKEY)
11612 return sv_mortalcopy(HeKEY_sv(entry));
11613 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11619 /* Look for an entry in the array whose value has the same SV as val;
11620 * If so, return the index, otherwise return -1. */
11623 S_find_array_subscript(pTHX_ AV *av, SV* val)
11626 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11627 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11630 if (val != &PL_sv_undef) {
11631 SV ** const svp = AvARRAY(av);
11634 for (i=AvFILLp(av); i>=0; i--)
11641 /* S_varname(): return the name of a variable, optionally with a subscript.
11642 * If gv is non-zero, use the name of that global, along with gvtype (one
11643 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11644 * targ. Depending on the value of the subscript_type flag, return:
11647 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11648 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11649 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11650 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11653 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11654 SV* keyname, I32 aindex, int subscript_type)
11657 SV * const name = sv_newmortal();
11660 buffer[0] = gvtype;
11663 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11665 gv_fullname4(name, gv, buffer, 0);
11667 if ((unsigned int)SvPVX(name)[1] <= 26) {
11669 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11671 /* Swap the 1 unprintable control character for the 2 byte pretty
11672 version - ie substr($name, 1, 1) = $buffer; */
11673 sv_insert(name, 1, 1, buffer, 2);
11678 CV * const cv = find_runcv(&unused);
11682 if (!cv || !CvPADLIST(cv))
11684 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11685 sv = *av_fetch(av, targ, FALSE);
11686 /* SvLEN in a pad name is not to be trusted */
11687 sv_setpv(name, SvPV_nolen_const(sv));
11690 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11691 SV * const sv = newSV(0);
11692 *SvPVX(name) = '$';
11693 Perl_sv_catpvf(aTHX_ name, "{%s}",
11694 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11697 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11698 *SvPVX(name) = '$';
11699 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11701 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11702 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11709 =for apidoc find_uninit_var
11711 Find the name of the undefined variable (if any) that caused the operator o
11712 to issue a "Use of uninitialized value" warning.
11713 If match is true, only return a name if it's value matches uninit_sv.
11714 So roughly speaking, if a unary operator (such as OP_COS) generates a
11715 warning, then following the direct child of the op may yield an
11716 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11717 other hand, with OP_ADD there are two branches to follow, so we only print
11718 the variable name if we get an exact match.
11720 The name is returned as a mortal SV.
11722 Assumes that PL_op is the op that originally triggered the error, and that
11723 PL_comppad/PL_curpad points to the currently executing pad.
11729 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11737 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11738 uninit_sv == &PL_sv_placeholder)))
11741 switch (obase->op_type) {
11748 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11749 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11752 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11754 if (pad) { /* @lex, %lex */
11755 sv = PAD_SVl(obase->op_targ);
11759 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11760 /* @global, %global */
11761 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11764 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11766 else /* @{expr}, %{expr} */
11767 return find_uninit_var(cUNOPx(obase)->op_first,
11771 /* attempt to find a match within the aggregate */
11773 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11775 subscript_type = FUV_SUBSCRIPT_HASH;
11778 index = find_array_subscript((AV*)sv, uninit_sv);
11780 subscript_type = FUV_SUBSCRIPT_ARRAY;
11783 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11786 return varname(gv, hash ? '%' : '@', obase->op_targ,
11787 keysv, index, subscript_type);
11791 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11793 return varname(NULL, '$', obase->op_targ,
11794 NULL, 0, FUV_SUBSCRIPT_NONE);
11797 gv = cGVOPx_gv(obase);
11798 if (!gv || (match && GvSV(gv) != uninit_sv))
11800 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11803 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11806 av = (AV*)PAD_SV(obase->op_targ);
11807 if (!av || SvRMAGICAL(av))
11809 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11810 if (!svp || *svp != uninit_sv)
11813 return varname(NULL, '$', obase->op_targ,
11814 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11817 gv = cGVOPx_gv(obase);
11823 if (!av || SvRMAGICAL(av))
11825 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11826 if (!svp || *svp != uninit_sv)
11829 return varname(gv, '$', 0,
11830 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11835 o = cUNOPx(obase)->op_first;
11836 if (!o || o->op_type != OP_NULL ||
11837 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11839 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11843 if (PL_op == obase)
11844 /* $a[uninit_expr] or $h{uninit_expr} */
11845 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11848 o = cBINOPx(obase)->op_first;
11849 kid = cBINOPx(obase)->op_last;
11851 /* get the av or hv, and optionally the gv */
11853 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11854 sv = PAD_SV(o->op_targ);
11856 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11857 && cUNOPo->op_first->op_type == OP_GV)
11859 gv = cGVOPx_gv(cUNOPo->op_first);
11862 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11867 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11868 /* index is constant */
11872 if (obase->op_type == OP_HELEM) {
11873 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11874 if (!he || HeVAL(he) != uninit_sv)
11878 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11879 if (!svp || *svp != uninit_sv)
11883 if (obase->op_type == OP_HELEM)
11884 return varname(gv, '%', o->op_targ,
11885 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11887 return varname(gv, '@', o->op_targ, NULL,
11888 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11891 /* index is an expression;
11892 * attempt to find a match within the aggregate */
11893 if (obase->op_type == OP_HELEM) {
11894 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11896 return varname(gv, '%', o->op_targ,
11897 keysv, 0, FUV_SUBSCRIPT_HASH);
11900 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11902 return varname(gv, '@', o->op_targ,
11903 NULL, index, FUV_SUBSCRIPT_ARRAY);
11908 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11910 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11915 /* only examine RHS */
11916 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11919 o = cUNOPx(obase)->op_first;
11920 if (o->op_type == OP_PUSHMARK)
11923 if (!o->op_sibling) {
11924 /* one-arg version of open is highly magical */
11926 if (o->op_type == OP_GV) { /* open FOO; */
11928 if (match && GvSV(gv) != uninit_sv)
11930 return varname(gv, '$', 0,
11931 NULL, 0, FUV_SUBSCRIPT_NONE);
11933 /* other possibilities not handled are:
11934 * open $x; or open my $x; should return '${*$x}'
11935 * open expr; should return '$'.expr ideally
11941 /* ops where $_ may be an implicit arg */
11945 if ( !(obase->op_flags & OPf_STACKED)) {
11946 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11947 ? PAD_SVl(obase->op_targ)
11950 sv = sv_newmortal();
11951 sv_setpvn(sv, "$_", 2);
11959 /* skip filehandle as it can't produce 'undef' warning */
11960 o = cUNOPx(obase)->op_first;
11961 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11962 o = o->op_sibling->op_sibling;
11969 match = 1; /* XS or custom code could trigger random warnings */
11974 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11975 return sv_2mortal(newSVpvs("${$/}"));
11980 if (!(obase->op_flags & OPf_KIDS))
11982 o = cUNOPx(obase)->op_first;
11988 /* if all except one arg are constant, or have no side-effects,
11989 * or are optimized away, then it's unambiguous */
11991 for (kid=o; kid; kid = kid->op_sibling) {
11993 const OPCODE type = kid->op_type;
11994 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11995 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11996 || (type == OP_PUSHMARK)
12000 if (o2) { /* more than one found */
12007 return find_uninit_var(o2, uninit_sv, match);
12009 /* scan all args */
12011 sv = find_uninit_var(o, uninit_sv, 1);
12023 =for apidoc report_uninit
12025 Print appropriate "Use of uninitialized variable" warning
12031 Perl_report_uninit(pTHX_ SV* uninit_sv)
12035 SV* varname = NULL;
12037 varname = find_uninit_var(PL_op, uninit_sv,0);
12039 sv_insert(varname, 0, 0, " ", 1);
12041 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12042 varname ? SvPV_nolen_const(varname) : "",
12043 " in ", OP_DESC(PL_op));
12046 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12052 * c-indentation-style: bsd
12053 * c-basic-offset: 4
12054 * indent-tabs-mode: t
12057 * ex: set ts=8 sts=4 sw=4 noet: