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)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1603 (void)SvNOK_only(sv); /* validate number */
1608 =for apidoc sv_setnv_mg
1610 Like C<sv_setnv>, but also handles 'set' magic.
1616 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1622 /* Print an "isn't numeric" warning, using a cleaned-up,
1623 * printable version of the offending string
1627 S_not_a_number(pTHX_ SV *sv)
1635 dsv = sv_2mortal(newSVpvs(""));
1636 pv = sv_uni_display(dsv, sv, 10, 0);
1639 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1640 /* each *s can expand to 4 chars + "...\0",
1641 i.e. need room for 8 chars */
1643 const char *s = SvPVX_const(sv);
1644 const char * const end = s + SvCUR(sv);
1645 for ( ; s < end && d < limit; s++ ) {
1647 if (ch & 128 && !isPRINT_LC(ch)) {
1656 else if (ch == '\r') {
1660 else if (ch == '\f') {
1664 else if (ch == '\\') {
1668 else if (ch == '\0') {
1672 else if (isPRINT_LC(ch))
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric in %s", pv,
1693 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1694 "Argument \"%s\" isn't numeric", pv);
1698 =for apidoc looks_like_number
1700 Test if the content of an SV looks like a number (or is a number).
1701 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1702 non-numeric warning), even if your atof() doesn't grok them.
1708 Perl_looks_like_number(pTHX_ SV *sv)
1710 register const char *sbegin;
1714 sbegin = SvPVX_const(sv);
1717 else if (SvPOKp(sv))
1718 sbegin = SvPV_const(sv, len);
1720 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1721 return grok_number(sbegin, len, NULL);
1725 S_glob_2number(pTHX_ GV * const gv)
1727 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1728 SV *const buffer = sv_newmortal();
1730 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1733 gv_efullname3(buffer, gv, "*");
1734 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1746 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1748 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1749 SV *const buffer = sv_newmortal();
1751 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1754 gv_efullname3(buffer, gv, "*");
1755 SvFLAGS(gv) |= wasfake;
1757 assert(SvPOK(buffer));
1759 *len = SvCUR(buffer);
1761 return SvPVX(buffer);
1764 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1765 until proven guilty, assume that things are not that bad... */
1770 As 64 bit platforms often have an NV that doesn't preserve all bits of
1771 an IV (an assumption perl has been based on to date) it becomes necessary
1772 to remove the assumption that the NV always carries enough precision to
1773 recreate the IV whenever needed, and that the NV is the canonical form.
1774 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1775 precision as a side effect of conversion (which would lead to insanity
1776 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1777 1) to distinguish between IV/UV/NV slots that have cached a valid
1778 conversion where precision was lost and IV/UV/NV slots that have a
1779 valid conversion which has lost no precision
1780 2) to ensure that if a numeric conversion to one form is requested that
1781 would lose precision, the precise conversion (or differently
1782 imprecise conversion) is also performed and cached, to prevent
1783 requests for different numeric formats on the same SV causing
1784 lossy conversion chains. (lossless conversion chains are perfectly
1789 SvIOKp is true if the IV slot contains a valid value
1790 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1791 SvNOKp is true if the NV slot contains a valid value
1792 SvNOK is true only if the NV value is accurate
1795 while converting from PV to NV, check to see if converting that NV to an
1796 IV(or UV) would lose accuracy over a direct conversion from PV to
1797 IV(or UV). If it would, cache both conversions, return NV, but mark
1798 SV as IOK NOKp (ie not NOK).
1800 While converting from PV to IV, check to see if converting that IV to an
1801 NV would lose accuracy over a direct conversion from PV to NV. If it
1802 would, cache both conversions, flag similarly.
1804 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1805 correctly because if IV & NV were set NV *always* overruled.
1806 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1807 changes - now IV and NV together means that the two are interchangeable:
1808 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1810 The benefit of this is that operations such as pp_add know that if
1811 SvIOK is true for both left and right operands, then integer addition
1812 can be used instead of floating point (for cases where the result won't
1813 overflow). Before, floating point was always used, which could lead to
1814 loss of precision compared with integer addition.
1816 * making IV and NV equal status should make maths accurate on 64 bit
1818 * may speed up maths somewhat if pp_add and friends start to use
1819 integers when possible instead of fp. (Hopefully the overhead in
1820 looking for SvIOK and checking for overflow will not outweigh the
1821 fp to integer speedup)
1822 * will slow down integer operations (callers of SvIV) on "inaccurate"
1823 values, as the change from SvIOK to SvIOKp will cause a call into
1824 sv_2iv each time rather than a macro access direct to the IV slot
1825 * should speed up number->string conversion on integers as IV is
1826 favoured when IV and NV are equally accurate
1828 ####################################################################
1829 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1830 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1831 On the other hand, SvUOK is true iff UV.
1832 ####################################################################
1834 Your mileage will vary depending your CPU's relative fp to integer
1838 #ifndef NV_PRESERVES_UV
1839 # define IS_NUMBER_UNDERFLOW_IV 1
1840 # define IS_NUMBER_UNDERFLOW_UV 2
1841 # define IS_NUMBER_IV_AND_UV 2
1842 # define IS_NUMBER_OVERFLOW_IV 4
1843 # define IS_NUMBER_OVERFLOW_UV 5
1845 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1847 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1849 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1852 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1853 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));
1854 if (SvNVX(sv) < (NV)IV_MIN) {
1855 (void)SvIOKp_on(sv);
1857 SvIV_set(sv, IV_MIN);
1858 return IS_NUMBER_UNDERFLOW_IV;
1860 if (SvNVX(sv) > (NV)UV_MAX) {
1861 (void)SvIOKp_on(sv);
1864 SvUV_set(sv, UV_MAX);
1865 return IS_NUMBER_OVERFLOW_UV;
1867 (void)SvIOKp_on(sv);
1869 /* Can't use strtol etc to convert this string. (See truth table in
1871 if (SvNVX(sv) <= (UV)IV_MAX) {
1872 SvIV_set(sv, I_V(SvNVX(sv)));
1873 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1874 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1876 /* Integer is imprecise. NOK, IOKp */
1878 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1881 SvUV_set(sv, U_V(SvNVX(sv)));
1882 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1883 if (SvUVX(sv) == UV_MAX) {
1884 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1885 possibly be preserved by NV. Hence, it must be overflow.
1887 return IS_NUMBER_OVERFLOW_UV;
1889 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1891 /* Integer is imprecise. NOK, IOKp */
1893 return IS_NUMBER_OVERFLOW_IV;
1895 #endif /* !NV_PRESERVES_UV*/
1898 S_sv_2iuv_common(pTHX_ SV *sv) {
1901 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1902 * without also getting a cached IV/UV from it at the same time
1903 * (ie PV->NV conversion should detect loss of accuracy and cache
1904 * IV or UV at same time to avoid this. */
1905 /* IV-over-UV optimisation - choose to cache IV if possible */
1907 if (SvTYPE(sv) == SVt_NV)
1908 sv_upgrade(sv, SVt_PVNV);
1910 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1911 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1912 certainly cast into the IV range at IV_MAX, whereas the correct
1913 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1915 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1916 if (Perl_isnan(SvNVX(sv))) {
1922 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1923 SvIV_set(sv, I_V(SvNVX(sv)));
1924 if (SvNVX(sv) == (NV) SvIVX(sv)
1925 #ifndef NV_PRESERVES_UV
1926 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1927 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1928 /* Don't flag it as "accurately an integer" if the number
1929 came from a (by definition imprecise) NV operation, and
1930 we're outside the range of NV integer precision */
1933 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1934 DEBUG_c(PerlIO_printf(Perl_debug_log,
1935 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1941 /* IV not precise. No need to convert from PV, as NV
1942 conversion would already have cached IV if it detected
1943 that PV->IV would be better than PV->NV->IV
1944 flags already correct - don't set public IOK. */
1945 DEBUG_c(PerlIO_printf(Perl_debug_log,
1946 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1951 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1952 but the cast (NV)IV_MIN rounds to a the value less (more
1953 negative) than IV_MIN which happens to be equal to SvNVX ??
1954 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1955 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1956 (NV)UVX == NVX are both true, but the values differ. :-(
1957 Hopefully for 2s complement IV_MIN is something like
1958 0x8000000000000000 which will be exact. NWC */
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1963 (SvNVX(sv) == (NV) SvUVX(sv))
1964 #ifndef NV_PRESERVES_UV
1965 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1966 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1967 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1968 /* Don't flag it as "accurately an integer" if the number
1969 came from a (by definition imprecise) NV operation, and
1970 we're outside the range of NV integer precision */
1975 DEBUG_c(PerlIO_printf(Perl_debug_log,
1976 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1982 else if (SvPOKp(sv) && SvLEN(sv)) {
1984 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1985 /* We want to avoid a possible problem when we cache an IV/ a UV which
1986 may be later translated to an NV, and the resulting NV is not
1987 the same as the direct translation of the initial string
1988 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1989 be careful to ensure that the value with the .456 is around if the
1990 NV value is requested in the future).
1992 This means that if we cache such an IV/a UV, we need to cache the
1993 NV as well. Moreover, we trade speed for space, and do not
1994 cache the NV if we are sure it's not needed.
1997 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1998 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1999 == IS_NUMBER_IN_UV) {
2000 /* It's definitely an integer, only upgrade to PVIV */
2001 if (SvTYPE(sv) < SVt_PVIV)
2002 sv_upgrade(sv, SVt_PVIV);
2004 } else if (SvTYPE(sv) < SVt_PVNV)
2005 sv_upgrade(sv, SVt_PVNV);
2007 /* If NVs preserve UVs then we only use the UV value if we know that
2008 we aren't going to call atof() below. If NVs don't preserve UVs
2009 then the value returned may have more precision than atof() will
2010 return, even though value isn't perfectly accurate. */
2011 if ((numtype & (IS_NUMBER_IN_UV
2012 #ifdef NV_PRESERVES_UV
2015 )) == IS_NUMBER_IN_UV) {
2016 /* This won't turn off the public IOK flag if it was set above */
2017 (void)SvIOKp_on(sv);
2019 if (!(numtype & IS_NUMBER_NEG)) {
2021 if (value <= (UV)IV_MAX) {
2022 SvIV_set(sv, (IV)value);
2024 /* it didn't overflow, and it was positive. */
2025 SvUV_set(sv, value);
2029 /* 2s complement assumption */
2030 if (value <= (UV)IV_MIN) {
2031 SvIV_set(sv, -(IV)value);
2033 /* Too negative for an IV. This is a double upgrade, but
2034 I'm assuming it will be rare. */
2035 if (SvTYPE(sv) < SVt_PVNV)
2036 sv_upgrade(sv, SVt_PVNV);
2040 SvNV_set(sv, -(NV)value);
2041 SvIV_set(sv, IV_MIN);
2045 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2046 will be in the previous block to set the IV slot, and the next
2047 block to set the NV slot. So no else here. */
2049 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2050 != IS_NUMBER_IN_UV) {
2051 /* It wasn't an (integer that doesn't overflow the UV). */
2052 SvNV_set(sv, Atof(SvPVX_const(sv)));
2054 if (! numtype && ckWARN(WARN_NUMERIC))
2057 #if defined(USE_LONG_DOUBLE)
2058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2059 PTR2UV(sv), SvNVX(sv)));
2061 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2062 PTR2UV(sv), SvNVX(sv)));
2065 #ifdef NV_PRESERVES_UV
2066 (void)SvIOKp_on(sv);
2068 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2069 SvIV_set(sv, I_V(SvNVX(sv)));
2070 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2073 NOOP; /* Integer is imprecise. NOK, IOKp */
2075 /* UV will not work better than IV */
2077 if (SvNVX(sv) > (NV)UV_MAX) {
2079 /* Integer is inaccurate. NOK, IOKp, is UV */
2080 SvUV_set(sv, UV_MAX);
2082 SvUV_set(sv, U_V(SvNVX(sv)));
2083 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2084 NV preservse UV so can do correct comparison. */
2085 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2088 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2093 #else /* NV_PRESERVES_UV */
2094 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2095 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2096 /* The IV/UV slot will have been set from value returned by
2097 grok_number above. The NV slot has just been set using
2100 assert (SvIOKp(sv));
2102 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2103 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2104 /* Small enough to preserve all bits. */
2105 (void)SvIOKp_on(sv);
2107 SvIV_set(sv, I_V(SvNVX(sv)));
2108 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2110 /* Assumption: first non-preserved integer is < IV_MAX,
2111 this NV is in the preserved range, therefore: */
2112 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2114 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);
2118 0 0 already failed to read UV.
2119 0 1 already failed to read UV.
2120 1 0 you won't get here in this case. IV/UV
2121 slot set, public IOK, Atof() unneeded.
2122 1 1 already read UV.
2123 so there's no point in sv_2iuv_non_preserve() attempting
2124 to use atol, strtol, strtoul etc. */
2125 sv_2iuv_non_preserve (sv, numtype);
2128 #endif /* NV_PRESERVES_UV */
2132 if (isGV_with_GP(sv))
2133 return glob_2number((GV *)sv);
2135 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2136 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2139 if (SvTYPE(sv) < SVt_IV)
2140 /* Typically the caller expects that sv_any is not NULL now. */
2141 sv_upgrade(sv, SVt_IV);
2142 /* Return 0 from the caller. */
2149 =for apidoc sv_2iv_flags
2151 Return the integer value of an SV, doing any necessary string
2152 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2153 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2159 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2164 if (SvGMAGICAL(sv)) {
2165 if (flags & SV_GMAGIC)
2170 return I_V(SvNVX(sv));
2172 if (SvPOKp(sv) && SvLEN(sv)) {
2175 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2177 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2178 == IS_NUMBER_IN_UV) {
2179 /* It's definitely an integer */
2180 if (numtype & IS_NUMBER_NEG) {
2181 if (value < (UV)IV_MIN)
2184 if (value < (UV)IV_MAX)
2189 if (ckWARN(WARN_NUMERIC))
2192 return I_V(Atof(SvPVX_const(sv)));
2197 assert(SvTYPE(sv) >= SVt_PVMG);
2198 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2199 } else if (SvTHINKFIRST(sv)) {
2203 SV * const tmpstr=AMG_CALLun(sv,numer);
2204 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2205 return SvIV(tmpstr);
2208 return PTR2IV(SvRV(sv));
2211 sv_force_normal_flags(sv, 0);
2213 if (SvREADONLY(sv) && !SvOK(sv)) {
2214 if (ckWARN(WARN_UNINITIALIZED))
2220 if (S_sv_2iuv_common(aTHX_ sv))
2223 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2224 PTR2UV(sv),SvIVX(sv)));
2225 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2229 =for apidoc sv_2uv_flags
2231 Return the unsigned integer value of an SV, doing any necessary string
2232 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2233 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2239 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2244 if (SvGMAGICAL(sv)) {
2245 if (flags & SV_GMAGIC)
2250 return U_V(SvNVX(sv));
2251 if (SvPOKp(sv) && SvLEN(sv)) {
2254 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2256 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2257 == IS_NUMBER_IN_UV) {
2258 /* It's definitely an integer */
2259 if (!(numtype & IS_NUMBER_NEG))
2263 if (ckWARN(WARN_NUMERIC))
2266 return U_V(Atof(SvPVX_const(sv)));
2271 assert(SvTYPE(sv) >= SVt_PVMG);
2272 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2273 } else if (SvTHINKFIRST(sv)) {
2277 SV *const tmpstr = AMG_CALLun(sv,numer);
2278 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2279 return SvUV(tmpstr);
2282 return PTR2UV(SvRV(sv));
2285 sv_force_normal_flags(sv, 0);
2287 if (SvREADONLY(sv) && !SvOK(sv)) {
2288 if (ckWARN(WARN_UNINITIALIZED))
2294 if (S_sv_2iuv_common(aTHX_ sv))
2298 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2299 PTR2UV(sv),SvUVX(sv)));
2300 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2306 Return the num value of an SV, doing any necessary string or integer
2307 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2314 Perl_sv_2nv(pTHX_ register SV *sv)
2319 if (SvGMAGICAL(sv)) {
2323 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2324 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2325 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2327 return Atof(SvPVX_const(sv));
2331 return (NV)SvUVX(sv);
2333 return (NV)SvIVX(sv);
2338 assert(SvTYPE(sv) >= SVt_PVMG);
2339 /* This falls through to the report_uninit near the end of the
2341 } else if (SvTHINKFIRST(sv)) {
2345 SV *const tmpstr = AMG_CALLun(sv,numer);
2346 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2347 return SvNV(tmpstr);
2350 return PTR2NV(SvRV(sv));
2353 sv_force_normal_flags(sv, 0);
2355 if (SvREADONLY(sv) && !SvOK(sv)) {
2356 if (ckWARN(WARN_UNINITIALIZED))
2361 if (SvTYPE(sv) < SVt_NV) {
2362 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2363 sv_upgrade(sv, SVt_NV);
2364 #ifdef USE_LONG_DOUBLE
2366 STORE_NUMERIC_LOCAL_SET_STANDARD();
2367 PerlIO_printf(Perl_debug_log,
2368 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2369 PTR2UV(sv), SvNVX(sv));
2370 RESTORE_NUMERIC_LOCAL();
2374 STORE_NUMERIC_LOCAL_SET_STANDARD();
2375 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2376 PTR2UV(sv), SvNVX(sv));
2377 RESTORE_NUMERIC_LOCAL();
2381 else if (SvTYPE(sv) < SVt_PVNV)
2382 sv_upgrade(sv, SVt_PVNV);
2387 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2388 #ifdef NV_PRESERVES_UV
2391 /* Only set the public NV OK flag if this NV preserves the IV */
2392 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2393 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2394 : (SvIVX(sv) == I_V(SvNVX(sv))))
2400 else if (SvPOKp(sv) && SvLEN(sv)) {
2402 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2403 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2405 #ifdef NV_PRESERVES_UV
2406 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2407 == IS_NUMBER_IN_UV) {
2408 /* It's definitely an integer */
2409 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2411 SvNV_set(sv, Atof(SvPVX_const(sv)));
2414 SvNV_set(sv, Atof(SvPVX_const(sv)));
2415 /* Only set the public NV OK flag if this NV preserves the value in
2416 the PV at least as well as an IV/UV would.
2417 Not sure how to do this 100% reliably. */
2418 /* if that shift count is out of range then Configure's test is
2419 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2421 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2422 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2423 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2424 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2425 /* Can't use strtol etc to convert this string, so don't try.
2426 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2429 /* value has been set. It may not be precise. */
2430 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2431 /* 2s complement assumption for (UV)IV_MIN */
2432 SvNOK_on(sv); /* Integer is too negative. */
2437 if (numtype & IS_NUMBER_NEG) {
2438 SvIV_set(sv, -(IV)value);
2439 } else if (value <= (UV)IV_MAX) {
2440 SvIV_set(sv, (IV)value);
2442 SvUV_set(sv, value);
2446 if (numtype & IS_NUMBER_NOT_INT) {
2447 /* I believe that even if the original PV had decimals,
2448 they are lost beyond the limit of the FP precision.
2449 However, neither is canonical, so both only get p
2450 flags. NWC, 2000/11/25 */
2451 /* Both already have p flags, so do nothing */
2453 const NV nv = SvNVX(sv);
2454 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2455 if (SvIVX(sv) == I_V(nv)) {
2458 /* It had no "." so it must be integer. */
2462 /* between IV_MAX and NV(UV_MAX).
2463 Could be slightly > UV_MAX */
2465 if (numtype & IS_NUMBER_NOT_INT) {
2466 /* UV and NV both imprecise. */
2468 const UV nv_as_uv = U_V(nv);
2470 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2479 #endif /* NV_PRESERVES_UV */
2482 if (isGV_with_GP(sv)) {
2483 glob_2number((GV *)sv);
2487 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2489 assert (SvTYPE(sv) >= SVt_NV);
2490 /* Typically the caller expects that sv_any is not NULL now. */
2491 /* XXX Ilya implies that this is a bug in callers that assume this
2492 and ideally should be fixed. */
2495 #if defined(USE_LONG_DOUBLE)
2497 STORE_NUMERIC_LOCAL_SET_STANDARD();
2498 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2499 PTR2UV(sv), SvNVX(sv));
2500 RESTORE_NUMERIC_LOCAL();
2504 STORE_NUMERIC_LOCAL_SET_STANDARD();
2505 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2506 PTR2UV(sv), SvNVX(sv));
2507 RESTORE_NUMERIC_LOCAL();
2513 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2514 * UV as a string towards the end of buf, and return pointers to start and
2517 * We assume that buf is at least TYPE_CHARS(UV) long.
2521 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2523 char *ptr = buf + TYPE_CHARS(UV);
2524 char * const ebuf = ptr;
2537 *--ptr = '0' + (char)(uv % 10);
2545 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2546 * a regexp to its stringified form.
2550 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2552 const regexp * const re = (regexp *)mg->mg_obj;
2555 const char *fptr = "msix";
2560 bool need_newline = 0;
2561 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2563 while((ch = *fptr++)) {
2565 reflags[left++] = ch;
2568 reflags[right--] = ch;
2573 reflags[left] = '-';
2577 mg->mg_len = re->prelen + 4 + left;
2579 * If /x was used, we have to worry about a regex ending with a
2580 * comment later being embedded within another regex. If so, we don't
2581 * want this regex's "commentization" to leak out to the right part of
2582 * the enclosing regex, we must cap it with a newline.
2584 * So, if /x was used, we scan backwards from the end of the regex. If
2585 * we find a '#' before we find a newline, we need to add a newline
2586 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2587 * we don't need to add anything. -jfriedl
2589 if (PMf_EXTENDED & re->reganch) {
2590 const char *endptr = re->precomp + re->prelen;
2591 while (endptr >= re->precomp) {
2592 const char c = *(endptr--);
2594 break; /* don't need another */
2596 /* we end while in a comment, so we need a newline */
2597 mg->mg_len++; /* save space for it */
2598 need_newline = 1; /* note to add it */
2604 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2605 mg->mg_ptr[0] = '(';
2606 mg->mg_ptr[1] = '?';
2607 Copy(reflags, mg->mg_ptr+2, left, char);
2608 *(mg->mg_ptr+left+2) = ':';
2609 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2611 mg->mg_ptr[mg->mg_len - 2] = '\n';
2612 mg->mg_ptr[mg->mg_len - 1] = ')';
2613 mg->mg_ptr[mg->mg_len] = 0;
2615 PL_reginterp_cnt += re->program[0].next_off;
2617 if (re->reganch & ROPT_UTF8)
2627 =for apidoc sv_2pv_flags
2629 Returns a pointer to the string value of an SV, and sets *lp to its length.
2630 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2632 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2633 usually end up here too.
2639 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2649 if (SvGMAGICAL(sv)) {
2650 if (flags & SV_GMAGIC)
2655 if (flags & SV_MUTABLE_RETURN)
2656 return SvPVX_mutable(sv);
2657 if (flags & SV_CONST_RETURN)
2658 return (char *)SvPVX_const(sv);
2661 if (SvIOKp(sv) || SvNOKp(sv)) {
2662 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2667 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2668 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2670 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2677 #ifdef FIXNEGATIVEZERO
2678 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2684 SvUPGRADE(sv, SVt_PV);
2687 s = SvGROW_mutable(sv, len + 1);
2690 return (char*)memcpy(s, tbuf, len + 1);
2696 assert(SvTYPE(sv) >= SVt_PVMG);
2697 /* This falls through to the report_uninit near the end of the
2699 } else if (SvTHINKFIRST(sv)) {
2703 SV *const tmpstr = AMG_CALLun(sv,string);
2704 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2706 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2710 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2711 if (flags & SV_CONST_RETURN) {
2712 pv = (char *) SvPVX_const(tmpstr);
2714 pv = (flags & SV_MUTABLE_RETURN)
2715 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2718 *lp = SvCUR(tmpstr);
2720 pv = sv_2pv_flags(tmpstr, lp, flags);
2734 const SV *const referent = (SV*)SvRV(sv);
2738 retval = buffer = savepvn("NULLREF", len);
2739 } else if (SvTYPE(referent) == SVt_PVMG
2740 && ((SvFLAGS(referent) &
2741 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2742 == (SVs_OBJECT|SVs_SMG))
2743 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2744 return stringify_regexp(sv, mg, lp);
2746 const char *const typestr = sv_reftype(referent, 0);
2747 const STRLEN typelen = strlen(typestr);
2748 UV addr = PTR2UV(referent);
2749 const char *stashname = NULL;
2750 STRLEN stashnamelen = 0; /* hush, gcc */
2751 const char *buffer_end;
2753 if (SvOBJECT(referent)) {
2754 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2757 stashname = HEK_KEY(name);
2758 stashnamelen = HEK_LEN(name);
2760 if (HEK_UTF8(name)) {
2766 stashname = "__ANON__";
2769 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2770 + 2 * sizeof(UV) + 2 /* )\0 */;
2772 len = typelen + 3 /* (0x */
2773 + 2 * sizeof(UV) + 2 /* )\0 */;
2776 Newx(buffer, len, char);
2777 buffer_end = retval = buffer + len;
2779 /* Working backwards */
2783 *--retval = PL_hexdigit[addr & 15];
2784 } while (addr >>= 4);
2790 memcpy(retval, typestr, typelen);
2794 retval -= stashnamelen;
2795 memcpy(retval, stashname, stashnamelen);
2797 /* retval may not neccesarily have reached the start of the
2799 assert (retval >= buffer);
2801 len = buffer_end - retval - 1; /* -1 for that \0 */
2809 if (SvREADONLY(sv) && !SvOK(sv)) {
2810 if (ckWARN(WARN_UNINITIALIZED))
2817 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2818 /* I'm assuming that if both IV and NV are equally valid then
2819 converting the IV is going to be more efficient */
2820 const U32 isIOK = SvIOK(sv);
2821 const U32 isUIOK = SvIsUV(sv);
2822 char buf[TYPE_CHARS(UV)];
2825 if (SvTYPE(sv) < SVt_PVIV)
2826 sv_upgrade(sv, SVt_PVIV);
2827 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2828 /* inlined from sv_setpvn */
2829 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2830 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2831 SvCUR_set(sv, ebuf - ptr);
2841 else if (SvNOKp(sv)) {
2842 const int olderrno = errno;
2843 if (SvTYPE(sv) < SVt_PVNV)
2844 sv_upgrade(sv, SVt_PVNV);
2845 /* The +20 is pure guesswork. Configure test needed. --jhi */
2846 s = SvGROW_mutable(sv, NV_DIG + 20);
2847 /* some Xenix systems wipe out errno here */
2849 if (SvNVX(sv) == 0.0)
2850 my_strlcpy(s, "0", SvLEN(sv));
2854 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2857 #ifdef FIXNEGATIVEZERO
2858 if (*s == '-' && s[1] == '0' && !s[2])
2859 my_strlcpy(s, "0", SvLEN(s));
2868 if (isGV_with_GP(sv))
2869 return glob_2pv((GV *)sv, lp);
2871 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2875 if (SvTYPE(sv) < SVt_PV)
2876 /* Typically the caller expects that sv_any is not NULL now. */
2877 sv_upgrade(sv, SVt_PV);
2881 const STRLEN len = s - SvPVX_const(sv);
2887 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2888 PTR2UV(sv),SvPVX_const(sv)));
2889 if (flags & SV_CONST_RETURN)
2890 return (char *)SvPVX_const(sv);
2891 if (flags & SV_MUTABLE_RETURN)
2892 return SvPVX_mutable(sv);
2897 =for apidoc sv_copypv
2899 Copies a stringified representation of the source SV into the
2900 destination SV. Automatically performs any necessary mg_get and
2901 coercion of numeric values into strings. Guaranteed to preserve
2902 UTF-8 flag even from overloaded objects. Similar in nature to
2903 sv_2pv[_flags] but operates directly on an SV instead of just the
2904 string. Mostly uses sv_2pv_flags to do its work, except when that
2905 would lose the UTF-8'ness of the PV.
2911 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2914 const char * const s = SvPV_const(ssv,len);
2915 sv_setpvn(dsv,s,len);
2923 =for apidoc sv_2pvbyte
2925 Return a pointer to the byte-encoded representation of the SV, and set *lp
2926 to its length. May cause the SV to be downgraded from UTF-8 as a
2929 Usually accessed via the C<SvPVbyte> macro.
2935 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2937 sv_utf8_downgrade(sv,0);
2938 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2942 =for apidoc sv_2pvutf8
2944 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2945 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2947 Usually accessed via the C<SvPVutf8> macro.
2953 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2955 sv_utf8_upgrade(sv);
2956 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2961 =for apidoc sv_2bool
2963 This function is only called on magical items, and is only used by
2964 sv_true() or its macro equivalent.
2970 Perl_sv_2bool(pTHX_ register SV *sv)
2979 SV * const tmpsv = AMG_CALLun(sv,bool_);
2980 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2981 return (bool)SvTRUE(tmpsv);
2983 return SvRV(sv) != 0;
2986 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2988 (*sv->sv_u.svu_pv > '0' ||
2989 Xpvtmp->xpv_cur > 1 ||
2990 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2997 return SvIVX(sv) != 0;
3000 return SvNVX(sv) != 0.0;
3002 if (isGV_with_GP(sv))
3012 =for apidoc sv_utf8_upgrade
3014 Converts the PV of an SV to its UTF-8-encoded form.
3015 Forces the SV to string form if it is not already.
3016 Always sets the SvUTF8 flag to avoid future validity checks even
3017 if all the bytes have hibit clear.
3019 This is not as a general purpose byte encoding to Unicode interface:
3020 use the Encode extension for that.
3022 =for apidoc sv_utf8_upgrade_flags
3024 Converts the PV of an SV to its UTF-8-encoded form.
3025 Forces the SV to string form if it is not already.
3026 Always sets the SvUTF8 flag to avoid future validity checks even
3027 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3028 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3029 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3031 This is not as a general purpose byte encoding to Unicode interface:
3032 use the Encode extension for that.
3038 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3041 if (sv == &PL_sv_undef)
3045 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3046 (void) sv_2pv_flags(sv,&len, flags);
3050 (void) SvPV_force(sv,len);
3059 sv_force_normal_flags(sv, 0);
3062 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3063 sv_recode_to_utf8(sv, PL_encoding);
3064 else { /* Assume Latin-1/EBCDIC */
3065 /* This function could be much more efficient if we
3066 * had a FLAG in SVs to signal if there are any hibit
3067 * chars in the PV. Given that there isn't such a flag
3068 * make the loop as fast as possible. */
3069 const U8 * const s = (U8 *) SvPVX_const(sv);
3070 const U8 * const e = (U8 *) SvEND(sv);
3075 /* Check for hi bit */
3076 if (!NATIVE_IS_INVARIANT(ch)) {
3077 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3078 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3080 SvPV_free(sv); /* No longer using what was there before. */
3081 SvPV_set(sv, (char*)recoded);
3082 SvCUR_set(sv, len - 1);
3083 SvLEN_set(sv, len); /* No longer know the real size. */
3087 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3094 =for apidoc sv_utf8_downgrade
3096 Attempts to convert the PV of an SV from characters to bytes.
3097 If the PV contains a character beyond byte, this conversion will fail;
3098 in this case, either returns false or, if C<fail_ok> is not
3101 This is not as a general purpose Unicode to byte encoding interface:
3102 use the Encode extension for that.
3108 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3111 if (SvPOKp(sv) && SvUTF8(sv)) {
3117 sv_force_normal_flags(sv, 0);
3119 s = (U8 *) SvPV(sv, len);
3120 if (!utf8_to_bytes(s, &len)) {
3125 Perl_croak(aTHX_ "Wide character in %s",
3128 Perl_croak(aTHX_ "Wide character");
3139 =for apidoc sv_utf8_encode
3141 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3142 flag off so that it looks like octets again.
3148 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3151 sv_force_normal_flags(sv, 0);
3153 if (SvREADONLY(sv)) {
3154 Perl_croak(aTHX_ PL_no_modify);
3156 (void) sv_utf8_upgrade(sv);
3161 =for apidoc sv_utf8_decode
3163 If the PV of the SV is an octet sequence in UTF-8
3164 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3165 so that it looks like a character. If the PV contains only single-byte
3166 characters, the C<SvUTF8> flag stays being off.
3167 Scans PV for validity and returns false if the PV is invalid UTF-8.
3173 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3179 /* The octets may have got themselves encoded - get them back as
3182 if (!sv_utf8_downgrade(sv, TRUE))
3185 /* it is actually just a matter of turning the utf8 flag on, but
3186 * we want to make sure everything inside is valid utf8 first.
3188 c = (const U8 *) SvPVX_const(sv);
3189 if (!is_utf8_string(c, SvCUR(sv)+1))
3191 e = (const U8 *) SvEND(sv);
3194 if (!UTF8_IS_INVARIANT(ch)) {
3204 =for apidoc sv_setsv
3206 Copies the contents of the source SV C<ssv> into the destination SV
3207 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3208 function if the source SV needs to be reused. Does not handle 'set' magic.
3209 Loosely speaking, it performs a copy-by-value, obliterating any previous
3210 content of the destination.
3212 You probably want to use one of the assortment of wrappers, such as
3213 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3214 C<SvSetMagicSV_nosteal>.
3216 =for apidoc sv_setsv_flags
3218 Copies the contents of the source SV C<ssv> into the destination SV
3219 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3220 function if the source SV needs to be reused. Does not handle 'set' magic.
3221 Loosely speaking, it performs a copy-by-value, obliterating any previous
3222 content of the destination.
3223 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3224 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3225 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3226 and C<sv_setsv_nomg> are implemented in terms of this function.
3228 You probably want to use one of the assortment of wrappers, such as
3229 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3230 C<SvSetMagicSV_nosteal>.
3232 This is the primary function for copying scalars, and most other
3233 copy-ish functions and macros use this underneath.
3239 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3241 if (dtype != SVt_PVGV) {
3242 const char * const name = GvNAME(sstr);
3243 const STRLEN len = GvNAMELEN(sstr);
3244 /* don't upgrade SVt_PVLV: it can hold a glob */
3245 if (dtype != SVt_PVLV) {
3246 if (dtype >= SVt_PV) {
3252 sv_upgrade(dstr, SVt_PVGV);
3253 (void)SvOK_off(dstr);
3256 GvSTASH(dstr) = GvSTASH(sstr);
3258 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3259 gv_name_set((GV *)dstr, name, len, GV_ADD);
3260 SvFAKE_on(dstr); /* can coerce to non-glob */
3263 #ifdef GV_UNIQUE_CHECK
3264 if (GvUNIQUE((GV*)dstr)) {
3265 Perl_croak(aTHX_ PL_no_modify);
3271 (void)SvOK_off(dstr);
3273 GvINTRO_off(dstr); /* one-shot flag */
3274 GvGP(dstr) = gp_ref(GvGP(sstr));
3275 if (SvTAINTED(sstr))
3277 if (GvIMPORTED(dstr) != GVf_IMPORTED
3278 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3280 GvIMPORTED_on(dstr);
3287 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3288 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3290 const int intro = GvINTRO(dstr);
3293 const U32 stype = SvTYPE(sref);
3296 #ifdef GV_UNIQUE_CHECK
3297 if (GvUNIQUE((GV*)dstr)) {
3298 Perl_croak(aTHX_ PL_no_modify);
3303 GvINTRO_off(dstr); /* one-shot flag */
3304 GvLINE(dstr) = CopLINE(PL_curcop);
3305 GvEGV(dstr) = (GV*)dstr;
3310 location = (SV **) &GvCV(dstr);
3311 import_flag = GVf_IMPORTED_CV;
3314 location = (SV **) &GvHV(dstr);
3315 import_flag = GVf_IMPORTED_HV;
3318 location = (SV **) &GvAV(dstr);
3319 import_flag = GVf_IMPORTED_AV;
3322 location = (SV **) &GvIOp(dstr);
3325 location = (SV **) &GvFORM(dstr);
3327 location = &GvSV(dstr);
3328 import_flag = GVf_IMPORTED_SV;
3331 if (stype == SVt_PVCV) {
3332 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3333 SvREFCNT_dec(GvCV(dstr));
3335 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3336 PL_sub_generation++;
3339 SAVEGENERICSV(*location);
3343 if (stype == SVt_PVCV && *location != sref) {
3344 CV* const cv = (CV*)*location;
3346 if (!GvCVGEN((GV*)dstr) &&
3347 (CvROOT(cv) || CvXSUB(cv)))
3349 /* Redefining a sub - warning is mandatory if
3350 it was a const and its value changed. */
3351 if (CvCONST(cv) && CvCONST((CV*)sref)
3352 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3354 /* They are 2 constant subroutines generated from
3355 the same constant. This probably means that
3356 they are really the "same" proxy subroutine
3357 instantiated in 2 places. Most likely this is
3358 when a constant is exported twice. Don't warn.
3361 else if (ckWARN(WARN_REDEFINE)
3363 && (!CvCONST((CV*)sref)
3364 || sv_cmp(cv_const_sv(cv),
3365 cv_const_sv((CV*)sref))))) {
3366 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3369 ? "Constant subroutine %s::%s redefined"
3370 : "Subroutine %s::%s redefined"),
3371 HvNAME_get(GvSTASH((GV*)dstr)),
3372 GvENAME((GV*)dstr));
3376 cv_ckproto_len(cv, (GV*)dstr,
3377 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3378 SvPOK(sref) ? SvCUR(sref) : 0);
3380 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3381 GvASSUMECV_on(dstr);
3382 PL_sub_generation++;
3385 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3386 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3387 GvFLAGS(dstr) |= import_flag;
3392 if (SvTAINTED(sstr))
3398 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3401 register U32 sflags;
3403 register svtype stype;
3408 if (SvIS_FREED(dstr)) {
3409 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3410 " to a freed scalar %p", sstr, dstr);
3412 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3414 sstr = &PL_sv_undef;
3415 if (SvIS_FREED(sstr)) {
3416 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3419 stype = SvTYPE(sstr);
3420 dtype = SvTYPE(dstr);
3425 /* need to nuke the magic */
3427 SvRMAGICAL_off(dstr);
3430 /* There's a lot of redundancy below but we're going for speed here */
3435 if (dtype != SVt_PVGV) {
3436 (void)SvOK_off(dstr);
3444 sv_upgrade(dstr, SVt_IV);
3449 sv_upgrade(dstr, SVt_PVIV);
3452 (void)SvIOK_only(dstr);
3453 SvIV_set(dstr, SvIVX(sstr));
3456 /* SvTAINTED can only be true if the SV has taint magic, which in
3457 turn means that the SV type is PVMG (or greater). This is the
3458 case statement for SVt_IV, so this cannot be true (whatever gcov
3460 assert(!SvTAINTED(sstr));
3470 sv_upgrade(dstr, SVt_NV);
3475 sv_upgrade(dstr, SVt_PVNV);
3478 SvNV_set(dstr, SvNVX(sstr));
3479 (void)SvNOK_only(dstr);
3480 /* SvTAINTED can only be true if the SV has taint magic, which in
3481 turn means that the SV type is PVMG (or greater). This is the
3482 case statement for SVt_NV, so this cannot be true (whatever gcov
3484 assert(!SvTAINTED(sstr));
3491 sv_upgrade(dstr, SVt_RV);
3494 #ifdef PERL_OLD_COPY_ON_WRITE
3495 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3496 if (dtype < SVt_PVIV)
3497 sv_upgrade(dstr, SVt_PVIV);
3504 sv_upgrade(dstr, SVt_PV);
3507 if (dtype < SVt_PVIV)
3508 sv_upgrade(dstr, SVt_PVIV);
3511 if (dtype < SVt_PVNV)
3512 sv_upgrade(dstr, SVt_PVNV);
3516 const char * const type = sv_reftype(sstr,0);
3518 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3520 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3525 if (dtype <= SVt_PVGV) {
3526 glob_assign_glob(dstr, sstr, dtype);
3534 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3536 if (SvTYPE(sstr) != stype) {
3537 stype = SvTYPE(sstr);
3538 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3539 glob_assign_glob(dstr, sstr, dtype);
3544 if (stype == SVt_PVLV)
3545 SvUPGRADE(dstr, SVt_PVNV);
3547 SvUPGRADE(dstr, (svtype)stype);
3550 /* dstr may have been upgraded. */
3551 dtype = SvTYPE(dstr);
3552 sflags = SvFLAGS(sstr);
3554 if (sflags & SVf_ROK) {
3555 if (dtype == SVt_PVGV &&
3556 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3559 if (GvIMPORTED(dstr) != GVf_IMPORTED
3560 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3562 GvIMPORTED_on(dstr);
3567 glob_assign_glob(dstr, sstr, dtype);
3571 if (dtype >= SVt_PV) {
3572 if (dtype == SVt_PVGV) {
3573 glob_assign_ref(dstr, sstr);
3576 if (SvPVX_const(dstr)) {
3582 (void)SvOK_off(dstr);
3583 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3584 SvFLAGS(dstr) |= sflags & SVf_ROK;
3585 assert(!(sflags & SVp_NOK));
3586 assert(!(sflags & SVp_IOK));
3587 assert(!(sflags & SVf_NOK));
3588 assert(!(sflags & SVf_IOK));
3590 else if (dtype == SVt_PVGV) {
3591 if (!(sflags & SVf_OK)) {
3592 if (ckWARN(WARN_MISC))
3593 Perl_warner(aTHX_ packWARN(WARN_MISC),
3594 "Undefined value assigned to typeglob");
3597 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3598 if (dstr != (SV*)gv) {
3601 GvGP(dstr) = gp_ref(GvGP(gv));
3605 else if (sflags & SVp_POK) {
3609 * Check to see if we can just swipe the string. If so, it's a
3610 * possible small lose on short strings, but a big win on long ones.
3611 * It might even be a win on short strings if SvPVX_const(dstr)
3612 * has to be allocated and SvPVX_const(sstr) has to be freed.
3613 * Likewise if we can set up COW rather than doing an actual copy, we
3614 * drop to the else clause, as the swipe code and the COW setup code
3615 * have much in common.
3618 /* Whichever path we take through the next code, we want this true,
3619 and doing it now facilitates the COW check. */
3620 (void)SvPOK_only(dstr);
3623 /* If we're already COW then this clause is not true, and if COW
3624 is allowed then we drop down to the else and make dest COW
3625 with us. If caller hasn't said that we're allowed to COW
3626 shared hash keys then we don't do the COW setup, even if the
3627 source scalar is a shared hash key scalar. */
3628 (((flags & SV_COW_SHARED_HASH_KEYS)
3629 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3630 : 1 /* If making a COW copy is forbidden then the behaviour we
3631 desire is as if the source SV isn't actually already
3632 COW, even if it is. So we act as if the source flags
3633 are not COW, rather than actually testing them. */
3635 #ifndef PERL_OLD_COPY_ON_WRITE
3636 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3637 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3638 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3639 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3640 but in turn, it's somewhat dead code, never expected to go
3641 live, but more kept as a placeholder on how to do it better
3642 in a newer implementation. */
3643 /* If we are COW and dstr is a suitable target then we drop down
3644 into the else and make dest a COW of us. */
3645 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3650 (sflags & SVs_TEMP) && /* slated for free anyway? */
3651 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3652 (!(flags & SV_NOSTEAL)) &&
3653 /* and we're allowed to steal temps */
3654 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3655 SvLEN(sstr) && /* and really is a string */
3656 /* and won't be needed again, potentially */
3657 !(PL_op && PL_op->op_type == OP_AASSIGN))
3658 #ifdef PERL_OLD_COPY_ON_WRITE
3659 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3660 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3661 && SvTYPE(sstr) >= SVt_PVIV)
3664 /* Failed the swipe test, and it's not a shared hash key either.
3665 Have to copy the string. */
3666 STRLEN len = SvCUR(sstr);
3667 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3668 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3669 SvCUR_set(dstr, len);
3670 *SvEND(dstr) = '\0';
3672 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3674 /* Either it's a shared hash key, or it's suitable for
3675 copy-on-write or we can swipe the string. */
3677 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3681 #ifdef PERL_OLD_COPY_ON_WRITE
3683 /* I believe I should acquire a global SV mutex if
3684 it's a COW sv (not a shared hash key) to stop
3685 it going un copy-on-write.
3686 If the source SV has gone un copy on write between up there
3687 and down here, then (assert() that) it is of the correct
3688 form to make it copy on write again */
3689 if ((sflags & (SVf_FAKE | SVf_READONLY))
3690 != (SVf_FAKE | SVf_READONLY)) {
3691 SvREADONLY_on(sstr);
3693 /* Make the source SV into a loop of 1.
3694 (about to become 2) */
3695 SV_COW_NEXT_SV_SET(sstr, sstr);
3699 /* Initial code is common. */
3700 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3705 /* making another shared SV. */
3706 STRLEN cur = SvCUR(sstr);
3707 STRLEN len = SvLEN(sstr);
3708 #ifdef PERL_OLD_COPY_ON_WRITE
3710 assert (SvTYPE(dstr) >= SVt_PVIV);
3711 /* SvIsCOW_normal */
3712 /* splice us in between source and next-after-source. */
3713 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3714 SV_COW_NEXT_SV_SET(sstr, dstr);
3715 SvPV_set(dstr, SvPVX_mutable(sstr));
3719 /* SvIsCOW_shared_hash */
3720 DEBUG_C(PerlIO_printf(Perl_debug_log,
3721 "Copy on write: Sharing hash\n"));
3723 assert (SvTYPE(dstr) >= SVt_PV);
3725 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3727 SvLEN_set(dstr, len);
3728 SvCUR_set(dstr, cur);
3729 SvREADONLY_on(dstr);
3731 /* Relesase a global SV mutex. */
3734 { /* Passes the swipe test. */
3735 SvPV_set(dstr, SvPVX_mutable(sstr));
3736 SvLEN_set(dstr, SvLEN(sstr));
3737 SvCUR_set(dstr, SvCUR(sstr));
3740 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3741 SvPV_set(sstr, NULL);
3747 if (sflags & SVp_NOK) {
3748 SvNV_set(dstr, SvNVX(sstr));
3750 if (sflags & SVp_IOK) {
3751 SvRELEASE_IVX(dstr);
3752 SvIV_set(dstr, SvIVX(sstr));
3753 /* Must do this otherwise some other overloaded use of 0x80000000
3754 gets confused. I guess SVpbm_VALID */
3755 if (sflags & SVf_IVisUV)
3758 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3760 const MAGIC * const smg = SvVSTRING_mg(sstr);
3762 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3763 smg->mg_ptr, smg->mg_len);
3764 SvRMAGICAL_on(dstr);
3768 else if (sflags & (SVp_IOK|SVp_NOK)) {
3769 (void)SvOK_off(dstr);
3770 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3771 if (sflags & SVp_IOK) {
3772 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3773 SvIV_set(dstr, SvIVX(sstr));
3775 if (sflags & SVp_NOK) {
3776 SvNV_set(dstr, SvNVX(sstr));
3780 if (isGV_with_GP(sstr)) {
3781 /* This stringification rule for globs is spread in 3 places.
3782 This feels bad. FIXME. */
3783 const U32 wasfake = sflags & SVf_FAKE;
3785 /* FAKE globs can get coerced, so need to turn this off
3786 temporarily if it is on. */
3788 gv_efullname3(dstr, (GV *)sstr, "*");
3789 SvFLAGS(sstr) |= wasfake;
3792 (void)SvOK_off(dstr);
3794 if (SvTAINTED(sstr))
3799 =for apidoc sv_setsv_mg
3801 Like C<sv_setsv>, but also handles 'set' magic.
3807 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3809 sv_setsv(dstr,sstr);
3813 #ifdef PERL_OLD_COPY_ON_WRITE
3815 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3817 STRLEN cur = SvCUR(sstr);
3818 STRLEN len = SvLEN(sstr);
3819 register char *new_pv;
3822 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3830 if (SvTHINKFIRST(dstr))
3831 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3832 else if (SvPVX_const(dstr))
3833 Safefree(SvPVX_const(dstr));
3837 SvUPGRADE(dstr, SVt_PVIV);
3839 assert (SvPOK(sstr));
3840 assert (SvPOKp(sstr));
3841 assert (!SvIOK(sstr));
3842 assert (!SvIOKp(sstr));
3843 assert (!SvNOK(sstr));
3844 assert (!SvNOKp(sstr));
3846 if (SvIsCOW(sstr)) {
3848 if (SvLEN(sstr) == 0) {
3849 /* source is a COW shared hash key. */
3850 DEBUG_C(PerlIO_printf(Perl_debug_log,
3851 "Fast copy on write: Sharing hash\n"));
3852 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3855 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3857 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3858 SvUPGRADE(sstr, SVt_PVIV);
3859 SvREADONLY_on(sstr);
3861 DEBUG_C(PerlIO_printf(Perl_debug_log,
3862 "Fast copy on write: Converting sstr to COW\n"));
3863 SV_COW_NEXT_SV_SET(dstr, sstr);
3865 SV_COW_NEXT_SV_SET(sstr, dstr);
3866 new_pv = SvPVX_mutable(sstr);
3869 SvPV_set(dstr, new_pv);
3870 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3873 SvLEN_set(dstr, len);
3874 SvCUR_set(dstr, cur);
3883 =for apidoc sv_setpvn
3885 Copies a string into an SV. The C<len> parameter indicates the number of
3886 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3887 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3893 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3896 register char *dptr;
3898 SV_CHECK_THINKFIRST_COW_DROP(sv);
3904 /* len is STRLEN which is unsigned, need to copy to signed */
3907 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3909 SvUPGRADE(sv, SVt_PV);
3911 dptr = SvGROW(sv, len + 1);
3912 Move(ptr,dptr,len,char);
3915 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3920 =for apidoc sv_setpvn_mg
3922 Like C<sv_setpvn>, but also handles 'set' magic.
3928 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3930 sv_setpvn(sv,ptr,len);
3935 =for apidoc sv_setpv
3937 Copies a string into an SV. The string must be null-terminated. Does not
3938 handle 'set' magic. See C<sv_setpv_mg>.
3944 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3947 register STRLEN len;
3949 SV_CHECK_THINKFIRST_COW_DROP(sv);
3955 SvUPGRADE(sv, SVt_PV);
3957 SvGROW(sv, len + 1);
3958 Move(ptr,SvPVX(sv),len+1,char);
3960 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3965 =for apidoc sv_setpv_mg
3967 Like C<sv_setpv>, but also handles 'set' magic.
3973 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3980 =for apidoc sv_usepvn_flags
3982 Tells an SV to use C<ptr> to find its string value. Normally the
3983 string is stored inside the SV but sv_usepvn allows the SV to use an
3984 outside string. The C<ptr> should point to memory that was allocated
3985 by C<malloc>. The string length, C<len>, must be supplied. By default
3986 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3987 so that pointer should not be freed or used by the programmer after
3988 giving it to sv_usepvn, and neither should any pointers from "behind"
3989 that pointer (e.g. ptr + 1) be used.
3991 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3992 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3993 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3994 C<len>, and already meets the requirements for storing in C<SvPVX>)
4000 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4004 SV_CHECK_THINKFIRST_COW_DROP(sv);
4005 SvUPGRADE(sv, SVt_PV);
4008 if (flags & SV_SMAGIC)
4012 if (SvPVX_const(sv))
4016 if (flags & SV_HAS_TRAILING_NUL)
4017 assert(ptr[len] == '\0');
4020 allocate = (flags & SV_HAS_TRAILING_NUL)
4021 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4022 if (flags & SV_HAS_TRAILING_NUL) {
4023 /* It's long enough - do nothing.
4024 Specfically Perl_newCONSTSUB is relying on this. */
4027 /* Force a move to shake out bugs in callers. */
4028 char *new_ptr = (char*)safemalloc(allocate);
4029 Copy(ptr, new_ptr, len, char);
4030 PoisonFree(ptr,len,char);
4034 ptr = (char*) saferealloc (ptr, allocate);
4039 SvLEN_set(sv, allocate);
4040 if (!(flags & SV_HAS_TRAILING_NUL)) {
4043 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4045 if (flags & SV_SMAGIC)
4049 #ifdef PERL_OLD_COPY_ON_WRITE
4050 /* Need to do this *after* making the SV normal, as we need the buffer
4051 pointer to remain valid until after we've copied it. If we let go too early,
4052 another thread could invalidate it by unsharing last of the same hash key
4053 (which it can do by means other than releasing copy-on-write Svs)
4054 or by changing the other copy-on-write SVs in the loop. */
4056 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4058 if (len) { /* this SV was SvIsCOW_normal(sv) */
4059 /* we need to find the SV pointing to us. */
4060 SV *current = SV_COW_NEXT_SV(after);
4062 if (current == sv) {
4063 /* The SV we point to points back to us (there were only two of us
4065 Hence other SV is no longer copy on write either. */
4067 SvREADONLY_off(after);
4069 /* We need to follow the pointers around the loop. */
4071 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4074 /* don't loop forever if the structure is bust, and we have
4075 a pointer into a closed loop. */
4076 assert (current != after);
4077 assert (SvPVX_const(current) == pvx);
4079 /* Make the SV before us point to the SV after us. */
4080 SV_COW_NEXT_SV_SET(current, after);
4083 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4088 Perl_sv_release_IVX(pTHX_ register SV *sv)
4091 sv_force_normal_flags(sv, 0);
4097 =for apidoc sv_force_normal_flags
4099 Undo various types of fakery on an SV: if the PV is a shared string, make
4100 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4101 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4102 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4103 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4104 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4105 set to some other value.) In addition, the C<flags> parameter gets passed to
4106 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4107 with flags set to 0.
4113 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4116 #ifdef PERL_OLD_COPY_ON_WRITE
4117 if (SvREADONLY(sv)) {
4118 /* At this point I believe I should acquire a global SV mutex. */
4120 const char * const pvx = SvPVX_const(sv);
4121 const STRLEN len = SvLEN(sv);
4122 const STRLEN cur = SvCUR(sv);
4123 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4125 PerlIO_printf(Perl_debug_log,
4126 "Copy on write: Force normal %ld\n",
4132 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4135 if (flags & SV_COW_DROP_PV) {
4136 /* OK, so we don't need to copy our buffer. */
4139 SvGROW(sv, cur + 1);
4140 Move(pvx,SvPVX(sv),cur,char);
4144 sv_release_COW(sv, pvx, len, next);
4149 else if (IN_PERL_RUNTIME)
4150 Perl_croak(aTHX_ PL_no_modify);
4151 /* At this point I believe that I can drop the global SV mutex. */
4154 if (SvREADONLY(sv)) {
4156 const char * const pvx = SvPVX_const(sv);
4157 const STRLEN len = SvCUR(sv);
4162 SvGROW(sv, len + 1);
4163 Move(pvx,SvPVX(sv),len,char);
4165 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4167 else if (IN_PERL_RUNTIME)
4168 Perl_croak(aTHX_ PL_no_modify);
4172 sv_unref_flags(sv, flags);
4173 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4180 Efficient removal of characters from the beginning of the string buffer.
4181 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4182 the string buffer. The C<ptr> becomes the first character of the adjusted
4183 string. Uses the "OOK hack".
4184 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4185 refer to the same chunk of data.
4191 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4193 register STRLEN delta;
4194 if (!ptr || !SvPOKp(sv))
4196 delta = ptr - SvPVX_const(sv);
4197 SV_CHECK_THINKFIRST(sv);
4198 if (SvTYPE(sv) < SVt_PVIV)
4199 sv_upgrade(sv,SVt_PVIV);
4202 if (!SvLEN(sv)) { /* make copy of shared string */
4203 const char *pvx = SvPVX_const(sv);
4204 const STRLEN len = SvCUR(sv);
4205 SvGROW(sv, len + 1);
4206 Move(pvx,SvPVX(sv),len,char);
4210 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4211 and we do that anyway inside the SvNIOK_off
4213 SvFLAGS(sv) |= SVf_OOK;
4216 SvLEN_set(sv, SvLEN(sv) - delta);
4217 SvCUR_set(sv, SvCUR(sv) - delta);
4218 SvPV_set(sv, SvPVX(sv) + delta);
4219 SvIV_set(sv, SvIVX(sv) + delta);
4223 =for apidoc sv_catpvn
4225 Concatenates the string onto the end of the string which is in the SV. The
4226 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4227 status set, then the bytes appended should be valid UTF-8.
4228 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4230 =for apidoc sv_catpvn_flags
4232 Concatenates the string onto the end of the string which is in the SV. The
4233 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4234 status set, then the bytes appended should be valid UTF-8.
4235 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4236 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4237 in terms of this function.
4243 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4247 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4249 SvGROW(dsv, dlen + slen + 1);
4251 sstr = SvPVX_const(dsv);
4252 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4253 SvCUR_set(dsv, SvCUR(dsv) + slen);
4255 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4257 if (flags & SV_SMAGIC)
4262 =for apidoc sv_catsv
4264 Concatenates the string from SV C<ssv> onto the end of the string in
4265 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4266 not 'set' magic. See C<sv_catsv_mg>.
4268 =for apidoc sv_catsv_flags
4270 Concatenates the string from SV C<ssv> onto the end of the string in
4271 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4272 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4273 and C<sv_catsv_nomg> are implemented in terms of this function.
4278 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4283 const char *spv = SvPV_const(ssv, slen);
4285 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4286 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4287 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4288 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4289 dsv->sv_flags doesn't have that bit set.
4290 Andy Dougherty 12 Oct 2001
4292 const I32 sutf8 = DO_UTF8(ssv);
4295 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4297 dutf8 = DO_UTF8(dsv);
4299 if (dutf8 != sutf8) {
4301 /* Not modifying source SV, so taking a temporary copy. */
4302 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4304 sv_utf8_upgrade(csv);
4305 spv = SvPV_const(csv, slen);
4308 sv_utf8_upgrade_nomg(dsv);
4310 sv_catpvn_nomg(dsv, spv, slen);
4313 if (flags & SV_SMAGIC)
4318 =for apidoc sv_catpv
4320 Concatenates the string onto the end of the string which is in the SV.
4321 If the SV has the UTF-8 status set, then the bytes appended should be
4322 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4327 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4330 register STRLEN len;
4336 junk = SvPV_force(sv, tlen);
4338 SvGROW(sv, tlen + len + 1);
4340 ptr = SvPVX_const(sv);
4341 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4342 SvCUR_set(sv, SvCUR(sv) + len);
4343 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4348 =for apidoc sv_catpv_mg
4350 Like C<sv_catpv>, but also handles 'set' magic.
4356 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4365 Creates a new SV. A non-zero C<len> parameter indicates the number of
4366 bytes of preallocated string space the SV should have. An extra byte for a
4367 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4368 space is allocated.) The reference count for the new SV is set to 1.
4370 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4371 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4372 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4373 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4374 modules supporting older perls.
4380 Perl_newSV(pTHX_ STRLEN len)
4387 sv_upgrade(sv, SVt_PV);
4388 SvGROW(sv, len + 1);
4393 =for apidoc sv_magicext
4395 Adds magic to an SV, upgrading it if necessary. Applies the
4396 supplied vtable and returns a pointer to the magic added.
4398 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4399 In particular, you can add magic to SvREADONLY SVs, and add more than
4400 one instance of the same 'how'.
4402 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4403 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4404 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4405 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4407 (This is now used as a subroutine by C<sv_magic>.)
4412 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4413 const char* name, I32 namlen)
4418 if (SvTYPE(sv) < SVt_PVMG) {
4419 SvUPGRADE(sv, SVt_PVMG);
4421 Newxz(mg, 1, MAGIC);
4422 mg->mg_moremagic = SvMAGIC(sv);
4423 SvMAGIC_set(sv, mg);
4425 /* Sometimes a magic contains a reference loop, where the sv and
4426 object refer to each other. To prevent a reference loop that
4427 would prevent such objects being freed, we look for such loops
4428 and if we find one we avoid incrementing the object refcount.
4430 Note we cannot do this to avoid self-tie loops as intervening RV must
4431 have its REFCNT incremented to keep it in existence.
4434 if (!obj || obj == sv ||
4435 how == PERL_MAGIC_arylen ||
4436 how == PERL_MAGIC_qr ||
4437 how == PERL_MAGIC_symtab ||
4438 (SvTYPE(obj) == SVt_PVGV &&
4439 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4440 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4441 GvFORM(obj) == (CV*)sv)))
4446 mg->mg_obj = SvREFCNT_inc_simple(obj);
4447 mg->mg_flags |= MGf_REFCOUNTED;
4450 /* Normal self-ties simply pass a null object, and instead of
4451 using mg_obj directly, use the SvTIED_obj macro to produce a
4452 new RV as needed. For glob "self-ties", we are tieing the PVIO
4453 with an RV obj pointing to the glob containing the PVIO. In
4454 this case, to avoid a reference loop, we need to weaken the
4458 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4459 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4465 mg->mg_len = namlen;
4468 mg->mg_ptr = savepvn(name, namlen);
4469 else if (namlen == HEf_SVKEY)
4470 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4472 mg->mg_ptr = (char *) name;
4474 mg->mg_virtual = vtable;
4478 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4483 =for apidoc sv_magic
4485 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4486 then adds a new magic item of type C<how> to the head of the magic list.
4488 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4489 handling of the C<name> and C<namlen> arguments.
4491 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4492 to add more than one instance of the same 'how'.
4498 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4504 #ifdef PERL_OLD_COPY_ON_WRITE
4506 sv_force_normal_flags(sv, 0);
4508 if (SvREADONLY(sv)) {
4510 /* its okay to attach magic to shared strings; the subsequent
4511 * upgrade to PVMG will unshare the string */
4512 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4515 && how != PERL_MAGIC_regex_global
4516 && how != PERL_MAGIC_bm
4517 && how != PERL_MAGIC_fm
4518 && how != PERL_MAGIC_sv
4519 && how != PERL_MAGIC_backref
4522 Perl_croak(aTHX_ PL_no_modify);
4525 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4526 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4527 /* sv_magic() refuses to add a magic of the same 'how' as an
4530 if (how == PERL_MAGIC_taint) {
4532 /* Any scalar which already had taint magic on which someone
4533 (erroneously?) did SvIOK_on() or similar will now be
4534 incorrectly sporting public "OK" flags. */
4535 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4543 vtable = &PL_vtbl_sv;
4545 case PERL_MAGIC_overload:
4546 vtable = &PL_vtbl_amagic;
4548 case PERL_MAGIC_overload_elem:
4549 vtable = &PL_vtbl_amagicelem;
4551 case PERL_MAGIC_overload_table:
4552 vtable = &PL_vtbl_ovrld;
4555 vtable = &PL_vtbl_bm;
4557 case PERL_MAGIC_regdata:
4558 vtable = &PL_vtbl_regdata;
4560 case PERL_MAGIC_regdata_names:
4561 vtable = &PL_vtbl_regdata_names;
4563 case PERL_MAGIC_regdatum:
4564 vtable = &PL_vtbl_regdatum;
4566 case PERL_MAGIC_env:
4567 vtable = &PL_vtbl_env;
4570 vtable = &PL_vtbl_fm;
4572 case PERL_MAGIC_envelem:
4573 vtable = &PL_vtbl_envelem;
4575 case PERL_MAGIC_regex_global:
4576 vtable = &PL_vtbl_mglob;
4578 case PERL_MAGIC_isa:
4579 vtable = &PL_vtbl_isa;
4581 case PERL_MAGIC_isaelem:
4582 vtable = &PL_vtbl_isaelem;
4584 case PERL_MAGIC_nkeys:
4585 vtable = &PL_vtbl_nkeys;
4587 case PERL_MAGIC_dbfile:
4590 case PERL_MAGIC_dbline:
4591 vtable = &PL_vtbl_dbline;
4593 #ifdef USE_LOCALE_COLLATE
4594 case PERL_MAGIC_collxfrm:
4595 vtable = &PL_vtbl_collxfrm;
4597 #endif /* USE_LOCALE_COLLATE */
4598 case PERL_MAGIC_tied:
4599 vtable = &PL_vtbl_pack;
4601 case PERL_MAGIC_tiedelem:
4602 case PERL_MAGIC_tiedscalar:
4603 vtable = &PL_vtbl_packelem;
4606 vtable = &PL_vtbl_regexp;
4608 case PERL_MAGIC_hints:
4609 /* As this vtable is all NULL, we can reuse it. */
4610 case PERL_MAGIC_sig:
4611 vtable = &PL_vtbl_sig;
4613 case PERL_MAGIC_sigelem:
4614 vtable = &PL_vtbl_sigelem;
4616 case PERL_MAGIC_taint:
4617 vtable = &PL_vtbl_taint;
4619 case PERL_MAGIC_uvar:
4620 vtable = &PL_vtbl_uvar;
4622 case PERL_MAGIC_vec:
4623 vtable = &PL_vtbl_vec;
4625 case PERL_MAGIC_arylen_p:
4626 case PERL_MAGIC_rhash:
4627 case PERL_MAGIC_symtab:
4628 case PERL_MAGIC_vstring:
4631 case PERL_MAGIC_utf8:
4632 vtable = &PL_vtbl_utf8;
4634 case PERL_MAGIC_substr:
4635 vtable = &PL_vtbl_substr;
4637 case PERL_MAGIC_defelem:
4638 vtable = &PL_vtbl_defelem;
4640 case PERL_MAGIC_arylen:
4641 vtable = &PL_vtbl_arylen;
4643 case PERL_MAGIC_pos:
4644 vtable = &PL_vtbl_pos;
4646 case PERL_MAGIC_backref:
4647 vtable = &PL_vtbl_backref;
4649 case PERL_MAGIC_hintselem:
4650 vtable = &PL_vtbl_hintselem;
4652 case PERL_MAGIC_ext:
4653 /* Reserved for use by extensions not perl internals. */
4654 /* Useful for attaching extension internal data to perl vars. */
4655 /* Note that multiple extensions may clash if magical scalars */
4656 /* etc holding private data from one are passed to another. */
4660 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4663 /* Rest of work is done else where */
4664 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4667 case PERL_MAGIC_taint:
4670 case PERL_MAGIC_ext:
4671 case PERL_MAGIC_dbfile:
4678 =for apidoc sv_unmagic
4680 Removes all magic of type C<type> from an SV.
4686 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4690 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4692 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4693 for (mg = *mgp; mg; mg = *mgp) {
4694 if (mg->mg_type == type) {
4695 const MGVTBL* const vtbl = mg->mg_virtual;
4696 *mgp = mg->mg_moremagic;
4697 if (vtbl && vtbl->svt_free)
4698 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4699 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4701 Safefree(mg->mg_ptr);
4702 else if (mg->mg_len == HEf_SVKEY)
4703 SvREFCNT_dec((SV*)mg->mg_ptr);
4704 else if (mg->mg_type == PERL_MAGIC_utf8)
4705 Safefree(mg->mg_ptr);
4707 if (mg->mg_flags & MGf_REFCOUNTED)
4708 SvREFCNT_dec(mg->mg_obj);
4712 mgp = &mg->mg_moremagic;
4716 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4717 SvMAGIC_set(sv, NULL);
4724 =for apidoc sv_rvweaken
4726 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4727 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4728 push a back-reference to this RV onto the array of backreferences
4729 associated with that magic. If the RV is magical, set magic will be
4730 called after the RV is cleared.
4736 Perl_sv_rvweaken(pTHX_ SV *sv)
4739 if (!SvOK(sv)) /* let undefs pass */
4742 Perl_croak(aTHX_ "Can't weaken a nonreference");
4743 else if (SvWEAKREF(sv)) {
4744 if (ckWARN(WARN_MISC))
4745 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4749 Perl_sv_add_backref(aTHX_ tsv, sv);
4755 /* Give tsv backref magic if it hasn't already got it, then push a
4756 * back-reference to sv onto the array associated with the backref magic.
4760 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4765 if (SvTYPE(tsv) == SVt_PVHV) {
4766 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4770 /* There is no AV in the offical place - try a fixup. */
4771 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4774 /* Aha. They've got it stowed in magic. Bring it back. */
4775 av = (AV*)mg->mg_obj;
4776 /* Stop mg_free decreasing the refernce count. */
4778 /* Stop mg_free even calling the destructor, given that
4779 there's no AV to free up. */
4781 sv_unmagic(tsv, PERL_MAGIC_backref);
4785 SvREFCNT_inc_simple_void(av);
4790 const MAGIC *const mg
4791 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4793 av = (AV*)mg->mg_obj;
4797 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4798 /* av now has a refcnt of 2, which avoids it getting freed
4799 * before us during global cleanup. The extra ref is removed
4800 * by magic_killbackrefs() when tsv is being freed */
4803 if (AvFILLp(av) >= AvMAX(av)) {
4804 av_extend(av, AvFILLp(av)+1);
4806 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4809 /* delete a back-reference to ourselves from the backref magic associated
4810 * with the SV we point to.
4814 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4821 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4822 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4823 /* We mustn't attempt to "fix up" the hash here by moving the
4824 backreference array back to the hv_aux structure, as that is stored
4825 in the main HvARRAY(), and hfreentries assumes that no-one
4826 reallocates HvARRAY() while it is running. */
4829 const MAGIC *const mg
4830 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4832 av = (AV *)mg->mg_obj;
4835 if (PL_in_clean_all)
4837 Perl_croak(aTHX_ "panic: del_backref");
4844 /* We shouldn't be in here more than once, but for paranoia reasons lets
4846 for (i = AvFILLp(av); i >= 0; i--) {
4848 const SSize_t fill = AvFILLp(av);
4850 /* We weren't the last entry.
4851 An unordered list has this property that you can take the
4852 last element off the end to fill the hole, and it's still
4853 an unordered list :-)
4858 AvFILLp(av) = fill - 1;
4864 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4866 SV **svp = AvARRAY(av);
4868 PERL_UNUSED_ARG(sv);
4870 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4871 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4872 if (svp && !SvIS_FREED(av)) {
4873 SV *const *const last = svp + AvFILLp(av);
4875 while (svp <= last) {
4877 SV *const referrer = *svp;
4878 if (SvWEAKREF(referrer)) {
4879 /* XXX Should we check that it hasn't changed? */
4880 SvRV_set(referrer, 0);
4882 SvWEAKREF_off(referrer);
4883 SvSETMAGIC(referrer);
4884 } else if (SvTYPE(referrer) == SVt_PVGV ||
4885 SvTYPE(referrer) == SVt_PVLV) {
4886 /* You lookin' at me? */
4887 assert(GvSTASH(referrer));
4888 assert(GvSTASH(referrer) == (HV*)sv);
4889 GvSTASH(referrer) = 0;
4892 "panic: magic_killbackrefs (flags=%"UVxf")",
4893 (UV)SvFLAGS(referrer));
4901 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4906 =for apidoc sv_insert
4908 Inserts a string at the specified offset/length within the SV. Similar to
4909 the Perl substr() function.
4915 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4920 register char *midend;
4921 register char *bigend;
4927 Perl_croak(aTHX_ "Can't modify non-existent substring");
4928 SvPV_force(bigstr, curlen);
4929 (void)SvPOK_only_UTF8(bigstr);
4930 if (offset + len > curlen) {
4931 SvGROW(bigstr, offset+len+1);
4932 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4933 SvCUR_set(bigstr, offset+len);
4937 i = littlelen - len;
4938 if (i > 0) { /* string might grow */
4939 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4940 mid = big + offset + len;
4941 midend = bigend = big + SvCUR(bigstr);
4944 while (midend > mid) /* shove everything down */
4945 *--bigend = *--midend;
4946 Move(little,big+offset,littlelen,char);
4947 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4952 Move(little,SvPVX(bigstr)+offset,len,char);
4957 big = SvPVX(bigstr);
4960 bigend = big + SvCUR(bigstr);
4962 if (midend > bigend)
4963 Perl_croak(aTHX_ "panic: sv_insert");
4965 if (mid - big > bigend - midend) { /* faster to shorten from end */
4967 Move(little, mid, littlelen,char);
4970 i = bigend - midend;
4972 Move(midend, mid, i,char);
4976 SvCUR_set(bigstr, mid - big);
4978 else if ((i = mid - big)) { /* faster from front */
4979 midend -= littlelen;
4981 sv_chop(bigstr,midend-i);
4986 Move(little, mid, littlelen,char);
4988 else if (littlelen) {
4989 midend -= littlelen;
4990 sv_chop(bigstr,midend);
4991 Move(little,midend,littlelen,char);
4994 sv_chop(bigstr,midend);
5000 =for apidoc sv_replace
5002 Make the first argument a copy of the second, then delete the original.
5003 The target SV physically takes over ownership of the body of the source SV
5004 and inherits its flags; however, the target keeps any magic it owns,
5005 and any magic in the source is discarded.
5006 Note that this is a rather specialist SV copying operation; most of the
5007 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5013 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5016 const U32 refcnt = SvREFCNT(sv);
5017 SV_CHECK_THINKFIRST_COW_DROP(sv);
5018 if (SvREFCNT(nsv) != 1) {
5019 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5020 UVuf " != 1)", (UV) SvREFCNT(nsv));
5022 if (SvMAGICAL(sv)) {
5026 sv_upgrade(nsv, SVt_PVMG);
5027 SvMAGIC_set(nsv, SvMAGIC(sv));
5028 SvFLAGS(nsv) |= SvMAGICAL(sv);
5030 SvMAGIC_set(sv, NULL);
5034 assert(!SvREFCNT(sv));
5035 #ifdef DEBUG_LEAKING_SCALARS
5036 sv->sv_flags = nsv->sv_flags;
5037 sv->sv_any = nsv->sv_any;
5038 sv->sv_refcnt = nsv->sv_refcnt;
5039 sv->sv_u = nsv->sv_u;
5041 StructCopy(nsv,sv,SV);
5043 /* Currently could join these into one piece of pointer arithmetic, but
5044 it would be unclear. */
5045 if(SvTYPE(sv) == SVt_IV)
5047 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5048 else if (SvTYPE(sv) == SVt_RV) {
5049 SvANY(sv) = &sv->sv_u.svu_rv;
5053 #ifdef PERL_OLD_COPY_ON_WRITE
5054 if (SvIsCOW_normal(nsv)) {
5055 /* We need to follow the pointers around the loop to make the
5056 previous SV point to sv, rather than nsv. */
5059 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5062 assert(SvPVX_const(current) == SvPVX_const(nsv));
5064 /* Make the SV before us point to the SV after us. */
5066 PerlIO_printf(Perl_debug_log, "previous is\n");
5068 PerlIO_printf(Perl_debug_log,
5069 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5070 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5072 SV_COW_NEXT_SV_SET(current, sv);
5075 SvREFCNT(sv) = refcnt;
5076 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5082 =for apidoc sv_clear
5084 Clear an SV: call any destructors, free up any memory used by the body,
5085 and free the body itself. The SV's head is I<not> freed, although
5086 its type is set to all 1's so that it won't inadvertently be assumed
5087 to be live during global destruction etc.
5088 This function should only be called when REFCNT is zero. Most of the time
5089 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5096 Perl_sv_clear(pTHX_ register SV *sv)
5099 const U32 type = SvTYPE(sv);
5100 const struct body_details *const sv_type_details
5101 = bodies_by_type + type;
5104 assert(SvREFCNT(sv) == 0);
5106 if (type <= SVt_IV) {
5107 /* See the comment in sv.h about the collusion between this early
5108 return and the overloading of the NULL and IV slots in the size
5114 if (PL_defstash) { /* Still have a symbol table? */
5119 stash = SvSTASH(sv);
5120 destructor = StashHANDLER(stash,DESTROY);
5122 SV* const tmpref = newRV(sv);
5123 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5125 PUSHSTACKi(PERLSI_DESTROY);
5130 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5136 if(SvREFCNT(tmpref) < 2) {
5137 /* tmpref is not kept alive! */
5139 SvRV_set(tmpref, NULL);
5142 SvREFCNT_dec(tmpref);
5144 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5148 if (PL_in_clean_objs)
5149 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5151 /* DESTROY gave object new lease on life */
5157 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5158 SvOBJECT_off(sv); /* Curse the object. */
5159 if (type != SVt_PVIO)
5160 --PL_sv_objcount; /* XXX Might want something more general */
5163 if (type >= SVt_PVMG) {
5164 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5165 SvREFCNT_dec(OURSTASH(sv));
5166 } else if (SvMAGIC(sv))
5168 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5169 SvREFCNT_dec(SvSTASH(sv));
5174 IoIFP(sv) != PerlIO_stdin() &&
5175 IoIFP(sv) != PerlIO_stdout() &&
5176 IoIFP(sv) != PerlIO_stderr())
5178 io_close((IO*)sv, FALSE);
5180 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5181 PerlDir_close(IoDIRP(sv));
5182 IoDIRP(sv) = (DIR*)NULL;
5183 Safefree(IoTOP_NAME(sv));
5184 Safefree(IoFMT_NAME(sv));
5185 Safefree(IoBOTTOM_NAME(sv));
5194 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5201 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5202 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5203 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5204 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5206 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5207 SvREFCNT_dec(LvTARG(sv));
5211 if (GvNAME_HEK(sv)) {
5212 unshare_hek(GvNAME_HEK(sv));
5214 /* If we're in a stash, we don't own a reference to it. However it does
5215 have a back reference to us, which needs to be cleared. */
5217 sv_del_backref((SV*)GvSTASH(sv), sv);
5222 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5224 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5225 /* Don't even bother with turning off the OOK flag. */
5230 SV * const target = SvRV(sv);
5232 sv_del_backref(target, sv);
5234 SvREFCNT_dec(target);
5236 #ifdef PERL_OLD_COPY_ON_WRITE
5237 else if (SvPVX_const(sv)) {
5239 /* I believe I need to grab the global SV mutex here and
5240 then recheck the COW status. */
5242 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5245 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5246 SV_COW_NEXT_SV(sv));
5247 /* And drop it here. */
5249 } else if (SvLEN(sv)) {
5250 Safefree(SvPVX_const(sv));
5254 else if (SvPVX_const(sv) && SvLEN(sv))
5255 Safefree(SvPVX_mutable(sv));
5256 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5257 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5266 SvFLAGS(sv) &= SVf_BREAK;
5267 SvFLAGS(sv) |= SVTYPEMASK;
5269 if (sv_type_details->arena) {
5270 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5271 &PL_body_roots[type]);
5273 else if (sv_type_details->body_size) {
5274 my_safefree(SvANY(sv));
5279 =for apidoc sv_newref
5281 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5288 Perl_sv_newref(pTHX_ SV *sv)
5290 PERL_UNUSED_CONTEXT;
5299 Decrement an SV's reference count, and if it drops to zero, call
5300 C<sv_clear> to invoke destructors and free up any memory used by
5301 the body; finally, deallocate the SV's head itself.
5302 Normally called via a wrapper macro C<SvREFCNT_dec>.
5308 Perl_sv_free(pTHX_ SV *sv)
5313 if (SvREFCNT(sv) == 0) {
5314 if (SvFLAGS(sv) & SVf_BREAK)
5315 /* this SV's refcnt has been artificially decremented to
5316 * trigger cleanup */
5318 if (PL_in_clean_all) /* All is fair */
5320 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5321 /* make sure SvREFCNT(sv)==0 happens very seldom */
5322 SvREFCNT(sv) = (~(U32)0)/2;
5325 if (ckWARN_d(WARN_INTERNAL)) {
5326 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5327 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5328 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5329 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5330 Perl_dump_sv_child(aTHX_ sv);
5335 if (--(SvREFCNT(sv)) > 0)
5337 Perl_sv_free2(aTHX_ sv);
5341 Perl_sv_free2(pTHX_ SV *sv)
5346 if (ckWARN_d(WARN_DEBUGGING))
5347 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5348 "Attempt to free temp prematurely: SV 0x%"UVxf
5349 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5353 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5354 /* make sure SvREFCNT(sv)==0 happens very seldom */
5355 SvREFCNT(sv) = (~(U32)0)/2;
5366 Returns the length of the string in the SV. Handles magic and type
5367 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5373 Perl_sv_len(pTHX_ register SV *sv)
5381 len = mg_length(sv);
5383 (void)SvPV_const(sv, len);
5388 =for apidoc sv_len_utf8
5390 Returns the number of characters in the string in an SV, counting wide
5391 UTF-8 bytes as a single character. Handles magic and type coercion.
5397 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5398 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5399 * (Note that the mg_len is not the length of the mg_ptr field.
5400 * This allows the cache to store the character length of the string without
5401 * needing to malloc() extra storage to attach to the mg_ptr.)
5406 Perl_sv_len_utf8(pTHX_ register SV *sv)
5412 return mg_length(sv);
5416 const U8 *s = (U8*)SvPV_const(sv, len);
5420 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5422 if (mg && mg->mg_len != -1) {
5424 if (PL_utf8cache < 0) {
5425 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5427 /* Need to turn the assertions off otherwise we may
5428 recurse infinitely while printing error messages.
5430 SAVEI8(PL_utf8cache);
5432 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5433 " real %"UVuf" for %"SVf,
5434 (UV) ulen, (UV) real, (void*)sv);
5439 ulen = Perl_utf8_length(aTHX_ s, s + len);
5440 if (!SvREADONLY(sv)) {
5442 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5443 &PL_vtbl_utf8, 0, 0);
5451 return Perl_utf8_length(aTHX_ s, s + len);
5455 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5458 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5461 const U8 *s = start;
5463 while (s < send && uoffset--)
5466 /* This is the existing behaviour. Possibly it should be a croak, as
5467 it's actually a bounds error */
5473 /* Given the length of the string in both bytes and UTF-8 characters, decide
5474 whether to walk forwards or backwards to find the byte corresponding to
5475 the passed in UTF-8 offset. */
5477 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5478 STRLEN uoffset, STRLEN uend)
5480 STRLEN backw = uend - uoffset;
5481 if (uoffset < 2 * backw) {
5482 /* The assumption is that going forwards is twice the speed of going
5483 forward (that's where the 2 * backw comes from).
5484 (The real figure of course depends on the UTF-8 data.) */
5485 return sv_pos_u2b_forwards(start, send, uoffset);
5490 while (UTF8_IS_CONTINUATION(*send))
5493 return send - start;
5496 /* For the string representation of the given scalar, find the byte
5497 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5498 give another position in the string, *before* the sought offset, which
5499 (which is always true, as 0, 0 is a valid pair of positions), which should
5500 help reduce the amount of linear searching.
5501 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5502 will be used to reduce the amount of linear searching. The cache will be
5503 created if necessary, and the found value offered to it for update. */
5505 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5506 const U8 *const send, STRLEN uoffset,
5507 STRLEN uoffset0, STRLEN boffset0) {
5508 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5511 assert (uoffset >= uoffset0);
5513 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5514 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5515 if ((*mgp)->mg_ptr) {
5516 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5517 if (cache[0] == uoffset) {
5518 /* An exact match. */
5521 if (cache[2] == uoffset) {
5522 /* An exact match. */
5526 if (cache[0] < uoffset) {
5527 /* The cache already knows part of the way. */
5528 if (cache[0] > uoffset0) {
5529 /* The cache knows more than the passed in pair */
5530 uoffset0 = cache[0];
5531 boffset0 = cache[1];
5533 if ((*mgp)->mg_len != -1) {
5534 /* And we know the end too. */
5536 + sv_pos_u2b_midway(start + boffset0, send,
5538 (*mgp)->mg_len - uoffset0);
5541 + sv_pos_u2b_forwards(start + boffset0,
5542 send, uoffset - uoffset0);
5545 else if (cache[2] < uoffset) {
5546 /* We're between the two cache entries. */
5547 if (cache[2] > uoffset0) {
5548 /* and the cache knows more than the passed in pair */
5549 uoffset0 = cache[2];
5550 boffset0 = cache[3];
5554 + sv_pos_u2b_midway(start + boffset0,
5557 cache[0] - uoffset0);
5560 + sv_pos_u2b_midway(start + boffset0,
5563 cache[2] - uoffset0);
5567 else if ((*mgp)->mg_len != -1) {
5568 /* If we can take advantage of a passed in offset, do so. */
5569 /* In fact, offset0 is either 0, or less than offset, so don't
5570 need to worry about the other possibility. */
5572 + sv_pos_u2b_midway(start + boffset0, send,
5574 (*mgp)->mg_len - uoffset0);
5579 if (!found || PL_utf8cache < 0) {
5580 const STRLEN real_boffset
5581 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5582 send, uoffset - uoffset0);
5584 if (found && PL_utf8cache < 0) {
5585 if (real_boffset != boffset) {
5586 /* Need to turn the assertions off otherwise we may recurse
5587 infinitely while printing error messages. */
5588 SAVEI8(PL_utf8cache);
5590 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5591 " real %"UVuf" for %"SVf,
5592 (UV) boffset, (UV) real_boffset, (void*)sv);
5595 boffset = real_boffset;
5598 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5604 =for apidoc sv_pos_u2b
5606 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5607 the start of the string, to a count of the equivalent number of bytes; if
5608 lenp is non-zero, it does the same to lenp, but this time starting from
5609 the offset, rather than from the start of the string. Handles magic and
5616 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5617 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5618 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5623 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5631 start = (U8*)SvPV_const(sv, len);
5633 STRLEN uoffset = (STRLEN) *offsetp;
5634 const U8 * const send = start + len;
5636 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5639 *offsetp = (I32) boffset;
5642 /* Convert the relative offset to absolute. */
5643 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5644 const STRLEN boffset2
5645 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5646 uoffset, boffset) - boffset;
5660 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5661 byte length pairing. The (byte) length of the total SV is passed in too,
5662 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5663 may not have updated SvCUR, so we can't rely on reading it directly.
5665 The proffered utf8/byte length pairing isn't used if the cache already has
5666 two pairs, and swapping either for the proffered pair would increase the
5667 RMS of the intervals between known byte offsets.
5669 The cache itself consists of 4 STRLEN values
5670 0: larger UTF-8 offset
5671 1: corresponding byte offset
5672 2: smaller UTF-8 offset
5673 3: corresponding byte offset
5675 Unused cache pairs have the value 0, 0.
5676 Keeping the cache "backwards" means that the invariant of
5677 cache[0] >= cache[2] is maintained even with empty slots, which means that
5678 the code that uses it doesn't need to worry if only 1 entry has actually
5679 been set to non-zero. It also makes the "position beyond the end of the
5680 cache" logic much simpler, as the first slot is always the one to start
5684 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5692 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5694 (*mgp)->mg_len = -1;
5698 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5699 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5700 (*mgp)->mg_ptr = (char *) cache;
5704 if (PL_utf8cache < 0) {
5705 const U8 *start = (const U8 *) SvPVX_const(sv);
5706 const STRLEN realutf8 = utf8_length(start, start + byte);
5708 if (realutf8 != utf8) {
5709 /* Need to turn the assertions off otherwise we may recurse
5710 infinitely while printing error messages. */
5711 SAVEI8(PL_utf8cache);
5713 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5714 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5718 /* Cache is held with the later position first, to simplify the code
5719 that deals with unbounded ends. */
5721 ASSERT_UTF8_CACHE(cache);
5722 if (cache[1] == 0) {
5723 /* Cache is totally empty */
5726 } else if (cache[3] == 0) {
5727 if (byte > cache[1]) {
5728 /* New one is larger, so goes first. */
5729 cache[2] = cache[0];
5730 cache[3] = cache[1];
5738 #define THREEWAY_SQUARE(a,b,c,d) \
5739 ((float)((d) - (c))) * ((float)((d) - (c))) \
5740 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5741 + ((float)((b) - (a))) * ((float)((b) - (a)))
5743 /* Cache has 2 slots in use, and we know three potential pairs.
5744 Keep the two that give the lowest RMS distance. Do the
5745 calcualation in bytes simply because we always know the byte
5746 length. squareroot has the same ordering as the positive value,
5747 so don't bother with the actual square root. */
5748 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5749 if (byte > cache[1]) {
5750 /* New position is after the existing pair of pairs. */
5751 const float keep_earlier
5752 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5753 const float keep_later
5754 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5756 if (keep_later < keep_earlier) {
5757 if (keep_later < existing) {
5758 cache[2] = cache[0];
5759 cache[3] = cache[1];
5765 if (keep_earlier < existing) {
5771 else if (byte > cache[3]) {
5772 /* New position is between the existing pair of pairs. */
5773 const float keep_earlier
5774 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5775 const float keep_later
5776 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5778 if (keep_later < keep_earlier) {
5779 if (keep_later < existing) {
5785 if (keep_earlier < existing) {
5792 /* New position is before the existing pair of pairs. */
5793 const float keep_earlier
5794 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5795 const float keep_later
5796 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5798 if (keep_later < keep_earlier) {
5799 if (keep_later < existing) {
5805 if (keep_earlier < existing) {
5806 cache[0] = cache[2];
5807 cache[1] = cache[3];
5814 ASSERT_UTF8_CACHE(cache);
5817 /* We already know all of the way, now we may be able to walk back. The same
5818 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5819 backward is half the speed of walking forward. */
5821 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5824 const STRLEN forw = target - s;
5825 STRLEN backw = end - target;
5827 if (forw < 2 * backw) {
5828 return utf8_length(s, target);
5831 while (end > target) {
5833 while (UTF8_IS_CONTINUATION(*end)) {
5842 =for apidoc sv_pos_b2u
5844 Converts the value pointed to by offsetp from a count of bytes from the
5845 start of the string, to a count of the equivalent number of UTF-8 chars.
5846 Handles magic and type coercion.
5852 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5853 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5858 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5861 const STRLEN byte = *offsetp;
5862 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5871 s = (const U8*)SvPV_const(sv, blen);
5874 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5878 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5879 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5881 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5882 if (cache[1] == byte) {
5883 /* An exact match. */
5884 *offsetp = cache[0];
5887 if (cache[3] == byte) {
5888 /* An exact match. */
5889 *offsetp = cache[2];
5893 if (cache[1] < byte) {
5894 /* We already know part of the way. */
5895 if (mg->mg_len != -1) {
5896 /* Actually, we know the end too. */
5898 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5899 s + blen, mg->mg_len - cache[0]);
5901 len = cache[0] + utf8_length(s + cache[1], send);
5904 else if (cache[3] < byte) {
5905 /* We're between the two cached pairs, so we do the calculation
5906 offset by the byte/utf-8 positions for the earlier pair,
5907 then add the utf-8 characters from the string start to
5909 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5910 s + cache[1], cache[0] - cache[2])
5914 else { /* cache[3] > byte */
5915 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5919 ASSERT_UTF8_CACHE(cache);
5921 } else if (mg->mg_len != -1) {
5922 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5926 if (!found || PL_utf8cache < 0) {
5927 const STRLEN real_len = utf8_length(s, send);
5929 if (found && PL_utf8cache < 0) {
5930 if (len != real_len) {
5931 /* Need to turn the assertions off otherwise we may recurse
5932 infinitely while printing error messages. */
5933 SAVEI8(PL_utf8cache);
5935 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5936 " real %"UVuf" for %"SVf,
5937 (UV) len, (UV) real_len, (void*)sv);
5944 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5950 Returns a boolean indicating whether the strings in the two SVs are
5951 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5952 coerce its args to strings if necessary.
5958 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5967 SV* svrecode = NULL;
5974 /* if pv1 and pv2 are the same, second SvPV_const call may
5975 * invalidate pv1, so we may need to make a copy */
5976 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5977 pv1 = SvPV_const(sv1, cur1);
5978 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5979 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5981 pv1 = SvPV_const(sv1, cur1);
5989 pv2 = SvPV_const(sv2, cur2);
5991 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5992 /* Differing utf8ness.
5993 * Do not UTF8size the comparands as a side-effect. */
5996 svrecode = newSVpvn(pv2, cur2);
5997 sv_recode_to_utf8(svrecode, PL_encoding);
5998 pv2 = SvPV_const(svrecode, cur2);
6001 svrecode = newSVpvn(pv1, cur1);
6002 sv_recode_to_utf8(svrecode, PL_encoding);
6003 pv1 = SvPV_const(svrecode, cur1);
6005 /* Now both are in UTF-8. */
6007 SvREFCNT_dec(svrecode);
6012 bool is_utf8 = TRUE;
6015 /* sv1 is the UTF-8 one,
6016 * if is equal it must be downgrade-able */
6017 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6023 /* sv2 is the UTF-8 one,
6024 * if is equal it must be downgrade-able */
6025 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6031 /* Downgrade not possible - cannot be eq */
6039 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6041 SvREFCNT_dec(svrecode);
6051 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6052 string in C<sv1> is less than, equal to, or greater than the string in
6053 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6054 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6060 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6064 const char *pv1, *pv2;
6067 SV *svrecode = NULL;
6074 pv1 = SvPV_const(sv1, cur1);
6081 pv2 = SvPV_const(sv2, cur2);
6083 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6084 /* Differing utf8ness.
6085 * Do not UTF8size the comparands as a side-effect. */
6088 svrecode = newSVpvn(pv2, cur2);
6089 sv_recode_to_utf8(svrecode, PL_encoding);
6090 pv2 = SvPV_const(svrecode, cur2);
6093 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6098 svrecode = newSVpvn(pv1, cur1);
6099 sv_recode_to_utf8(svrecode, PL_encoding);
6100 pv1 = SvPV_const(svrecode, cur1);
6103 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6109 cmp = cur2 ? -1 : 0;
6113 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6116 cmp = retval < 0 ? -1 : 1;
6117 } else if (cur1 == cur2) {
6120 cmp = cur1 < cur2 ? -1 : 1;
6124 SvREFCNT_dec(svrecode);
6132 =for apidoc sv_cmp_locale
6134 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6135 'use bytes' aware, handles get magic, and will coerce its args to strings
6136 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6142 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6145 #ifdef USE_LOCALE_COLLATE
6151 if (PL_collation_standard)
6155 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6157 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6159 if (!pv1 || !len1) {
6170 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6173 return retval < 0 ? -1 : 1;
6176 * When the result of collation is equality, that doesn't mean
6177 * that there are no differences -- some locales exclude some
6178 * characters from consideration. So to avoid false equalities,
6179 * we use the raw string as a tiebreaker.
6185 #endif /* USE_LOCALE_COLLATE */
6187 return sv_cmp(sv1, sv2);
6191 #ifdef USE_LOCALE_COLLATE
6194 =for apidoc sv_collxfrm
6196 Add Collate Transform magic to an SV if it doesn't already have it.
6198 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6199 scalar data of the variable, but transformed to such a format that a normal
6200 memory comparison can be used to compare the data according to the locale
6207 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6212 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6213 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6219 Safefree(mg->mg_ptr);
6220 s = SvPV_const(sv, len);
6221 if ((xf = mem_collxfrm(s, len, &xlen))) {
6222 if (SvREADONLY(sv)) {
6225 return xf + sizeof(PL_collation_ix);
6228 #ifdef PERL_OLD_COPY_ON_WRITE
6230 sv_force_normal_flags(sv, 0);
6232 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6246 if (mg && mg->mg_ptr) {
6248 return mg->mg_ptr + sizeof(PL_collation_ix);
6256 #endif /* USE_LOCALE_COLLATE */
6261 Get a line from the filehandle and store it into the SV, optionally
6262 appending to the currently-stored string.
6268 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6273 register STDCHAR rslast;
6274 register STDCHAR *bp;
6279 if (SvTHINKFIRST(sv))
6280 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6281 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6283 However, perlbench says it's slower, because the existing swipe code
6284 is faster than copy on write.
6285 Swings and roundabouts. */
6286 SvUPGRADE(sv, SVt_PV);
6291 if (PerlIO_isutf8(fp)) {
6293 sv_utf8_upgrade_nomg(sv);
6294 sv_pos_u2b(sv,&append,0);
6296 } else if (SvUTF8(sv)) {
6297 SV * const tsv = newSV(0);
6298 sv_gets(tsv, fp, 0);
6299 sv_utf8_upgrade_nomg(tsv);
6300 SvCUR_set(sv,append);
6303 goto return_string_or_null;
6308 if (PerlIO_isutf8(fp))
6311 if (IN_PERL_COMPILETIME) {
6312 /* we always read code in line mode */
6316 else if (RsSNARF(PL_rs)) {
6317 /* If it is a regular disk file use size from stat() as estimate
6318 of amount we are going to read -- may result in mallocing
6319 more memory than we really need if the layers below reduce
6320 the size we read (e.g. CRLF or a gzip layer).
6323 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6324 const Off_t offset = PerlIO_tell(fp);
6325 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6326 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6332 else if (RsRECORD(PL_rs)) {
6337 /* Grab the size of the record we're getting */
6338 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6339 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6342 /* VMS wants read instead of fread, because fread doesn't respect */
6343 /* RMS record boundaries. This is not necessarily a good thing to be */
6344 /* doing, but we've got no other real choice - except avoid stdio
6345 as implementation - perhaps write a :vms layer ?
6347 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6349 bytesread = PerlIO_read(fp, buffer, recsize);
6353 SvCUR_set(sv, bytesread += append);
6354 buffer[bytesread] = '\0';
6355 goto return_string_or_null;
6357 else if (RsPARA(PL_rs)) {
6363 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6364 if (PerlIO_isutf8(fp)) {
6365 rsptr = SvPVutf8(PL_rs, rslen);
6368 if (SvUTF8(PL_rs)) {
6369 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6370 Perl_croak(aTHX_ "Wide character in $/");
6373 rsptr = SvPV_const(PL_rs, rslen);
6377 rslast = rslen ? rsptr[rslen - 1] : '\0';
6379 if (rspara) { /* have to do this both before and after */
6380 do { /* to make sure file boundaries work right */
6383 i = PerlIO_getc(fp);
6387 PerlIO_ungetc(fp,i);
6393 /* See if we know enough about I/O mechanism to cheat it ! */
6395 /* This used to be #ifdef test - it is made run-time test for ease
6396 of abstracting out stdio interface. One call should be cheap
6397 enough here - and may even be a macro allowing compile
6401 if (PerlIO_fast_gets(fp)) {
6404 * We're going to steal some values from the stdio struct
6405 * and put EVERYTHING in the innermost loop into registers.
6407 register STDCHAR *ptr;
6411 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6412 /* An ungetc()d char is handled separately from the regular
6413 * buffer, so we getc() it back out and stuff it in the buffer.
6415 i = PerlIO_getc(fp);
6416 if (i == EOF) return 0;
6417 *(--((*fp)->_ptr)) = (unsigned char) i;
6421 /* Here is some breathtakingly efficient cheating */
6423 cnt = PerlIO_get_cnt(fp); /* get count into register */
6424 /* make sure we have the room */
6425 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6426 /* Not room for all of it
6427 if we are looking for a separator and room for some
6429 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6430 /* just process what we have room for */
6431 shortbuffered = cnt - SvLEN(sv) + append + 1;
6432 cnt -= shortbuffered;
6436 /* remember that cnt can be negative */
6437 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6442 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6443 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6444 DEBUG_P(PerlIO_printf(Perl_debug_log,
6445 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6446 DEBUG_P(PerlIO_printf(Perl_debug_log,
6447 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6448 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6449 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6454 while (cnt > 0) { /* this | eat */
6456 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6457 goto thats_all_folks; /* screams | sed :-) */
6461 Copy(ptr, bp, cnt, char); /* this | eat */
6462 bp += cnt; /* screams | dust */
6463 ptr += cnt; /* louder | sed :-) */
6468 if (shortbuffered) { /* oh well, must extend */
6469 cnt = shortbuffered;
6471 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6473 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6474 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6478 DEBUG_P(PerlIO_printf(Perl_debug_log,
6479 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6480 PTR2UV(ptr),(long)cnt));
6481 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6485 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6486 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6488 /* This used to call 'filbuf' in stdio form, but as that behaves like
6489 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6490 another abstraction. */
6491 i = PerlIO_getc(fp); /* get more characters */
6493 DEBUG_P(PerlIO_printf(Perl_debug_log,
6494 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6495 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6496 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6498 cnt = PerlIO_get_cnt(fp);
6499 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6500 DEBUG_P(PerlIO_printf(Perl_debug_log,
6501 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6503 if (i == EOF) /* all done for ever? */
6504 goto thats_really_all_folks;
6506 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6508 SvGROW(sv, bpx + cnt + 2);
6509 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6511 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6513 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6514 goto thats_all_folks;
6518 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6519 memNE((char*)bp - rslen, rsptr, rslen))
6520 goto screamer; /* go back to the fray */
6521 thats_really_all_folks:
6523 cnt += shortbuffered;
6524 DEBUG_P(PerlIO_printf(Perl_debug_log,
6525 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6526 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6527 DEBUG_P(PerlIO_printf(Perl_debug_log,
6528 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6529 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6530 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6532 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6533 DEBUG_P(PerlIO_printf(Perl_debug_log,
6534 "Screamer: done, len=%ld, string=|%.*s|\n",
6535 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6539 /*The big, slow, and stupid way. */
6540 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6541 STDCHAR *buf = NULL;
6542 Newx(buf, 8192, STDCHAR);
6550 register const STDCHAR * const bpe = buf + sizeof(buf);
6552 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6553 ; /* keep reading */
6557 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6558 /* Accomodate broken VAXC compiler, which applies U8 cast to
6559 * both args of ?: operator, causing EOF to change into 255
6562 i = (U8)buf[cnt - 1];
6568 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6570 sv_catpvn(sv, (char *) buf, cnt);
6572 sv_setpvn(sv, (char *) buf, cnt);
6574 if (i != EOF && /* joy */
6576 SvCUR(sv) < rslen ||
6577 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6581 * If we're reading from a TTY and we get a short read,
6582 * indicating that the user hit his EOF character, we need
6583 * to notice it now, because if we try to read from the TTY
6584 * again, the EOF condition will disappear.
6586 * The comparison of cnt to sizeof(buf) is an optimization
6587 * that prevents unnecessary calls to feof().
6591 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6595 #ifdef USE_HEAP_INSTEAD_OF_STACK
6600 if (rspara) { /* have to do this both before and after */
6601 while (i != EOF) { /* to make sure file boundaries work right */
6602 i = PerlIO_getc(fp);
6604 PerlIO_ungetc(fp,i);
6610 return_string_or_null:
6611 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6617 Auto-increment of the value in the SV, doing string to numeric conversion
6618 if necessary. Handles 'get' magic.
6624 Perl_sv_inc(pTHX_ register SV *sv)
6633 if (SvTHINKFIRST(sv)) {
6635 sv_force_normal_flags(sv, 0);
6636 if (SvREADONLY(sv)) {
6637 if (IN_PERL_RUNTIME)
6638 Perl_croak(aTHX_ PL_no_modify);
6642 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6644 i = PTR2IV(SvRV(sv));
6649 flags = SvFLAGS(sv);
6650 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6651 /* It's (privately or publicly) a float, but not tested as an
6652 integer, so test it to see. */
6654 flags = SvFLAGS(sv);
6656 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6657 /* It's publicly an integer, or privately an integer-not-float */
6658 #ifdef PERL_PRESERVE_IVUV
6662 if (SvUVX(sv) == UV_MAX)
6663 sv_setnv(sv, UV_MAX_P1);
6665 (void)SvIOK_only_UV(sv);
6666 SvUV_set(sv, SvUVX(sv) + 1);
6668 if (SvIVX(sv) == IV_MAX)
6669 sv_setuv(sv, (UV)IV_MAX + 1);
6671 (void)SvIOK_only(sv);
6672 SvIV_set(sv, SvIVX(sv) + 1);
6677 if (flags & SVp_NOK) {
6678 (void)SvNOK_only(sv);
6679 SvNV_set(sv, SvNVX(sv) + 1.0);
6683 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6684 if ((flags & SVTYPEMASK) < SVt_PVIV)
6685 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6686 (void)SvIOK_only(sv);
6691 while (isALPHA(*d)) d++;
6692 while (isDIGIT(*d)) d++;
6694 #ifdef PERL_PRESERVE_IVUV
6695 /* Got to punt this as an integer if needs be, but we don't issue
6696 warnings. Probably ought to make the sv_iv_please() that does
6697 the conversion if possible, and silently. */
6698 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6699 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6700 /* Need to try really hard to see if it's an integer.
6701 9.22337203685478e+18 is an integer.
6702 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6703 so $a="9.22337203685478e+18"; $a+0; $a++
6704 needs to be the same as $a="9.22337203685478e+18"; $a++
6711 /* sv_2iv *should* have made this an NV */
6712 if (flags & SVp_NOK) {
6713 (void)SvNOK_only(sv);
6714 SvNV_set(sv, SvNVX(sv) + 1.0);
6717 /* I don't think we can get here. Maybe I should assert this
6718 And if we do get here I suspect that sv_setnv will croak. NWC
6720 #if defined(USE_LONG_DOUBLE)
6721 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",
6722 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6724 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6725 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6728 #endif /* PERL_PRESERVE_IVUV */
6729 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6733 while (d >= SvPVX_const(sv)) {
6741 /* MKS: The original code here died if letters weren't consecutive.
6742 * at least it didn't have to worry about non-C locales. The
6743 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6744 * arranged in order (although not consecutively) and that only
6745 * [A-Za-z] are accepted by isALPHA in the C locale.
6747 if (*d != 'z' && *d != 'Z') {
6748 do { ++*d; } while (!isALPHA(*d));
6751 *(d--) -= 'z' - 'a';
6756 *(d--) -= 'z' - 'a' + 1;
6760 /* oh,oh, the number grew */
6761 SvGROW(sv, SvCUR(sv) + 2);
6762 SvCUR_set(sv, SvCUR(sv) + 1);
6763 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6774 Auto-decrement of the value in the SV, doing string to numeric conversion
6775 if necessary. Handles 'get' magic.
6781 Perl_sv_dec(pTHX_ register SV *sv)
6789 if (SvTHINKFIRST(sv)) {
6791 sv_force_normal_flags(sv, 0);
6792 if (SvREADONLY(sv)) {
6793 if (IN_PERL_RUNTIME)
6794 Perl_croak(aTHX_ PL_no_modify);
6798 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6800 i = PTR2IV(SvRV(sv));
6805 /* Unlike sv_inc we don't have to worry about string-never-numbers
6806 and keeping them magic. But we mustn't warn on punting */
6807 flags = SvFLAGS(sv);
6808 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6809 /* It's publicly an integer, or privately an integer-not-float */
6810 #ifdef PERL_PRESERVE_IVUV
6814 if (SvUVX(sv) == 0) {
6815 (void)SvIOK_only(sv);
6819 (void)SvIOK_only_UV(sv);
6820 SvUV_set(sv, SvUVX(sv) - 1);
6823 if (SvIVX(sv) == IV_MIN)
6824 sv_setnv(sv, (NV)IV_MIN - 1.0);
6826 (void)SvIOK_only(sv);
6827 SvIV_set(sv, SvIVX(sv) - 1);
6832 if (flags & SVp_NOK) {
6833 SvNV_set(sv, SvNVX(sv) - 1.0);
6834 (void)SvNOK_only(sv);
6837 if (!(flags & SVp_POK)) {
6838 if ((flags & SVTYPEMASK) < SVt_PVIV)
6839 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6841 (void)SvIOK_only(sv);
6844 #ifdef PERL_PRESERVE_IVUV
6846 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6847 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6848 /* Need to try really hard to see if it's an integer.
6849 9.22337203685478e+18 is an integer.
6850 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6851 so $a="9.22337203685478e+18"; $a+0; $a--
6852 needs to be the same as $a="9.22337203685478e+18"; $a--
6859 /* sv_2iv *should* have made this an NV */
6860 if (flags & SVp_NOK) {
6861 (void)SvNOK_only(sv);
6862 SvNV_set(sv, SvNVX(sv) - 1.0);
6865 /* I don't think we can get here. Maybe I should assert this
6866 And if we do get here I suspect that sv_setnv will croak. NWC
6868 #if defined(USE_LONG_DOUBLE)
6869 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",
6870 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6872 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6873 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6877 #endif /* PERL_PRESERVE_IVUV */
6878 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6882 =for apidoc sv_mortalcopy
6884 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6885 The new SV is marked as mortal. It will be destroyed "soon", either by an
6886 explicit call to FREETMPS, or by an implicit call at places such as
6887 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6892 /* Make a string that will exist for the duration of the expression
6893 * evaluation. Actually, it may have to last longer than that, but
6894 * hopefully we won't free it until it has been assigned to a
6895 * permanent location. */
6898 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6904 sv_setsv(sv,oldstr);
6906 PL_tmps_stack[++PL_tmps_ix] = sv;
6912 =for apidoc sv_newmortal
6914 Creates a new null SV which is mortal. The reference count of the SV is
6915 set to 1. It will be destroyed "soon", either by an explicit call to
6916 FREETMPS, or by an implicit call at places such as statement boundaries.
6917 See also C<sv_mortalcopy> and C<sv_2mortal>.
6923 Perl_sv_newmortal(pTHX)
6929 SvFLAGS(sv) = SVs_TEMP;
6931 PL_tmps_stack[++PL_tmps_ix] = sv;
6936 =for apidoc sv_2mortal
6938 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6939 by an explicit call to FREETMPS, or by an implicit call at places such as
6940 statement boundaries. SvTEMP() is turned on which means that the SV's
6941 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6942 and C<sv_mortalcopy>.
6948 Perl_sv_2mortal(pTHX_ register SV *sv)
6953 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6956 PL_tmps_stack[++PL_tmps_ix] = sv;
6964 Creates a new SV and copies a string into it. The reference count for the
6965 SV is set to 1. If C<len> is zero, Perl will compute the length using
6966 strlen(). For efficiency, consider using C<newSVpvn> instead.
6972 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6978 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6983 =for apidoc newSVpvn
6985 Creates a new SV and copies a string into it. The reference count for the
6986 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6987 string. You are responsible for ensuring that the source string is at least
6988 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6994 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7000 sv_setpvn(sv,s,len);
7006 =for apidoc newSVhek
7008 Creates a new SV from the hash key structure. It will generate scalars that
7009 point to the shared string table where possible. Returns a new (undefined)
7010 SV if the hek is NULL.
7016 Perl_newSVhek(pTHX_ const HEK *hek)
7026 if (HEK_LEN(hek) == HEf_SVKEY) {
7027 return newSVsv(*(SV**)HEK_KEY(hek));
7029 const int flags = HEK_FLAGS(hek);
7030 if (flags & HVhek_WASUTF8) {
7032 Andreas would like keys he put in as utf8 to come back as utf8
7034 STRLEN utf8_len = HEK_LEN(hek);
7035 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7036 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7039 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7041 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7042 /* We don't have a pointer to the hv, so we have to replicate the
7043 flag into every HEK. This hv is using custom a hasing
7044 algorithm. Hence we can't return a shared string scalar, as
7045 that would contain the (wrong) hash value, and might get passed
7046 into an hv routine with a regular hash.
7047 Similarly, a hash that isn't using shared hash keys has to have
7048 the flag in every key so that we know not to try to call
7049 share_hek_kek on it. */
7051 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7056 /* This will be overwhelminly the most common case. */
7058 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7059 more efficient than sharepvn(). */
7063 sv_upgrade(sv, SVt_PV);
7064 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7065 SvCUR_set(sv, HEK_LEN(hek));
7078 =for apidoc newSVpvn_share
7080 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7081 table. If the string does not already exist in the table, it is created
7082 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7083 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7084 otherwise the hash is computed. The idea here is that as the string table
7085 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7086 hash lookup will avoid string compare.
7092 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7096 bool is_utf8 = FALSE;
7097 const char *const orig_src = src;
7100 STRLEN tmplen = -len;
7102 /* See the note in hv.c:hv_fetch() --jhi */
7103 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7107 PERL_HASH(hash, src, len);
7109 sv_upgrade(sv, SVt_PV);
7110 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7118 if (src != orig_src)
7124 #if defined(PERL_IMPLICIT_CONTEXT)
7126 /* pTHX_ magic can't cope with varargs, so this is a no-context
7127 * version of the main function, (which may itself be aliased to us).
7128 * Don't access this version directly.
7132 Perl_newSVpvf_nocontext(const char* pat, ...)
7137 va_start(args, pat);
7138 sv = vnewSVpvf(pat, &args);
7145 =for apidoc newSVpvf
7147 Creates a new SV and initializes it with the string formatted like
7154 Perl_newSVpvf(pTHX_ const char* pat, ...)
7158 va_start(args, pat);
7159 sv = vnewSVpvf(pat, &args);
7164 /* backend for newSVpvf() and newSVpvf_nocontext() */
7167 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7172 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7179 Creates a new SV and copies a floating point value into it.
7180 The reference count for the SV is set to 1.
7186 Perl_newSVnv(pTHX_ NV n)
7199 Creates a new SV and copies an integer into it. The reference count for the
7206 Perl_newSViv(pTHX_ IV i)
7219 Creates a new SV and copies an unsigned integer into it.
7220 The reference count for the SV is set to 1.
7226 Perl_newSVuv(pTHX_ UV u)
7237 =for apidoc newRV_noinc
7239 Creates an RV wrapper for an SV. The reference count for the original
7240 SV is B<not> incremented.
7246 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7252 sv_upgrade(sv, SVt_RV);
7254 SvRV_set(sv, tmpRef);
7259 /* newRV_inc is the official function name to use now.
7260 * newRV_inc is in fact #defined to newRV in sv.h
7264 Perl_newRV(pTHX_ SV *sv)
7267 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7273 Creates a new SV which is an exact duplicate of the original SV.
7280 Perl_newSVsv(pTHX_ register SV *old)
7287 if (SvTYPE(old) == SVTYPEMASK) {
7288 if (ckWARN_d(WARN_INTERNAL))
7289 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7293 /* SV_GMAGIC is the default for sv_setv()
7294 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7295 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7296 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7301 =for apidoc sv_reset
7303 Underlying implementation for the C<reset> Perl function.
7304 Note that the perl-level function is vaguely deprecated.
7310 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7313 char todo[PERL_UCHAR_MAX+1];
7318 if (!*s) { /* reset ?? searches */
7319 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7321 PMOP *pm = (PMOP *) mg->mg_obj;
7323 pm->op_pmdynflags &= ~PMdf_USED;
7330 /* reset variables */
7332 if (!HvARRAY(stash))
7335 Zero(todo, 256, char);
7338 I32 i = (unsigned char)*s;
7342 max = (unsigned char)*s++;
7343 for ( ; i <= max; i++) {
7346 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7348 for (entry = HvARRAY(stash)[i];
7350 entry = HeNEXT(entry))
7355 if (!todo[(U8)*HeKEY(entry)])
7357 gv = (GV*)HeVAL(entry);
7360 if (SvTHINKFIRST(sv)) {
7361 if (!SvREADONLY(sv) && SvROK(sv))
7363 /* XXX Is this continue a bug? Why should THINKFIRST
7364 exempt us from resetting arrays and hashes? */
7368 if (SvTYPE(sv) >= SVt_PV) {
7370 if (SvPVX_const(sv) != NULL)
7378 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7380 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7383 # if defined(USE_ENVIRON_ARRAY)
7386 # endif /* USE_ENVIRON_ARRAY */
7397 Using various gambits, try to get an IO from an SV: the IO slot if its a
7398 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7399 named after the PV if we're a string.
7405 Perl_sv_2io(pTHX_ SV *sv)
7410 switch (SvTYPE(sv)) {
7418 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7422 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7424 return sv_2io(SvRV(sv));
7425 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7431 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7440 Using various gambits, try to get a CV from an SV; in addition, try if
7441 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7442 The flags in C<lref> are passed to sv_fetchsv.
7448 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7459 switch (SvTYPE(sv)) {
7478 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7479 tryAMAGICunDEREF(to_cv);
7482 if (SvTYPE(sv) == SVt_PVCV) {
7491 Perl_croak(aTHX_ "Not a subroutine reference");
7496 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7502 /* Some flags to gv_fetchsv mean don't really create the GV */
7503 if (SvTYPE(gv) != SVt_PVGV) {
7509 if (lref && !GvCVu(gv)) {
7513 gv_efullname3(tmpsv, gv, NULL);
7514 /* XXX this is probably not what they think they're getting.
7515 * It has the same effect as "sub name;", i.e. just a forward
7517 newSUB(start_subparse(FALSE, 0),
7518 newSVOP(OP_CONST, 0, tmpsv),
7522 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7532 Returns true if the SV has a true value by Perl's rules.
7533 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7534 instead use an in-line version.
7540 Perl_sv_true(pTHX_ register SV *sv)
7545 register const XPV* const tXpv = (XPV*)SvANY(sv);
7547 (tXpv->xpv_cur > 1 ||
7548 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7555 return SvIVX(sv) != 0;
7558 return SvNVX(sv) != 0.0;
7560 return sv_2bool(sv);
7566 =for apidoc sv_pvn_force
7568 Get a sensible string out of the SV somehow.
7569 A private implementation of the C<SvPV_force> macro for compilers which
7570 can't cope with complex macro expressions. Always use the macro instead.
7572 =for apidoc sv_pvn_force_flags
7574 Get a sensible string out of the SV somehow.
7575 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7576 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7577 implemented in terms of this function.
7578 You normally want to use the various wrapper macros instead: see
7579 C<SvPV_force> and C<SvPV_force_nomg>
7585 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7588 if (SvTHINKFIRST(sv) && !SvROK(sv))
7589 sv_force_normal_flags(sv, 0);
7599 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7600 const char * const ref = sv_reftype(sv,0);
7602 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7603 ref, OP_NAME(PL_op));
7605 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7607 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7608 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7610 s = sv_2pv_flags(sv, &len, flags);
7614 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7617 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7618 SvGROW(sv, len + 1);
7619 Move(s,SvPVX(sv),len,char);
7624 SvPOK_on(sv); /* validate pointer */
7626 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7627 PTR2UV(sv),SvPVX_const(sv)));
7630 return SvPVX_mutable(sv);
7634 =for apidoc sv_pvbyten_force
7636 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7642 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7644 sv_pvn_force(sv,lp);
7645 sv_utf8_downgrade(sv,0);
7651 =for apidoc sv_pvutf8n_force
7653 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7659 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7661 sv_pvn_force(sv,lp);
7662 sv_utf8_upgrade(sv);
7668 =for apidoc sv_reftype
7670 Returns a string describing what the SV is a reference to.
7676 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7678 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7679 inside return suggests a const propagation bug in g++. */
7680 if (ob && SvOBJECT(sv)) {
7681 char * const name = HvNAME_get(SvSTASH(sv));
7682 return name ? name : (char *) "__ANON__";
7685 switch (SvTYPE(sv)) {
7702 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7703 /* tied lvalues should appear to be
7704 * scalars for backwards compatitbility */
7705 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7706 ? "SCALAR" : "LVALUE");
7707 case SVt_PVAV: return "ARRAY";
7708 case SVt_PVHV: return "HASH";
7709 case SVt_PVCV: return "CODE";
7710 case SVt_PVGV: return "GLOB";
7711 case SVt_PVFM: return "FORMAT";
7712 case SVt_PVIO: return "IO";
7713 default: return "UNKNOWN";
7719 =for apidoc sv_isobject
7721 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7722 object. If the SV is not an RV, or if the object is not blessed, then this
7729 Perl_sv_isobject(pTHX_ SV *sv)
7745 Returns a boolean indicating whether the SV is blessed into the specified
7746 class. This does not check for subtypes; use C<sv_derived_from> to verify
7747 an inheritance relationship.
7753 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7764 hvname = HvNAME_get(SvSTASH(sv));
7768 return strEQ(hvname, name);
7774 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7775 it will be upgraded to one. If C<classname> is non-null then the new SV will
7776 be blessed in the specified package. The new SV is returned and its
7777 reference count is 1.
7783 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7790 SV_CHECK_THINKFIRST_COW_DROP(rv);
7793 if (SvTYPE(rv) >= SVt_PVMG) {
7794 const U32 refcnt = SvREFCNT(rv);
7798 SvREFCNT(rv) = refcnt;
7800 sv_upgrade(rv, SVt_RV);
7801 } else if (SvROK(rv)) {
7802 SvREFCNT_dec(SvRV(rv));
7803 } else if (SvTYPE(rv) < SVt_RV)
7804 sv_upgrade(rv, SVt_RV);
7805 else if (SvTYPE(rv) > SVt_RV) {
7816 HV* const stash = gv_stashpv(classname, TRUE);
7817 (void)sv_bless(rv, stash);
7823 =for apidoc sv_setref_pv
7825 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7826 argument will be upgraded to an RV. That RV will be modified to point to
7827 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7828 into the SV. The C<classname> argument indicates the package for the
7829 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7830 will have a reference count of 1, and the RV will be returned.
7832 Do not use with other Perl types such as HV, AV, SV, CV, because those
7833 objects will become corrupted by the pointer copy process.
7835 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7841 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7845 sv_setsv(rv, &PL_sv_undef);
7849 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7854 =for apidoc sv_setref_iv
7856 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7857 argument will be upgraded to an RV. That RV will be modified to point to
7858 the new SV. The C<classname> argument indicates the package for the
7859 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7860 will have a reference count of 1, and the RV will be returned.
7866 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7868 sv_setiv(newSVrv(rv,classname), iv);
7873 =for apidoc sv_setref_uv
7875 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7876 argument will be upgraded to an RV. That RV will be modified to point to
7877 the new SV. The C<classname> argument indicates the package for the
7878 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7879 will have a reference count of 1, and the RV will be returned.
7885 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7887 sv_setuv(newSVrv(rv,classname), uv);
7892 =for apidoc sv_setref_nv
7894 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7895 argument will be upgraded to an RV. That RV will be modified to point to
7896 the new SV. The C<classname> argument indicates the package for the
7897 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7898 will have a reference count of 1, and the RV will be returned.
7904 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7906 sv_setnv(newSVrv(rv,classname), nv);
7911 =for apidoc sv_setref_pvn
7913 Copies a string into a new SV, optionally blessing the SV. The length of the
7914 string must be specified with C<n>. The C<rv> argument will be upgraded to
7915 an RV. That RV will be modified to point to the new SV. The C<classname>
7916 argument indicates the package for the blessing. Set C<classname> to
7917 C<NULL> to avoid the blessing. The new SV will have a reference count
7918 of 1, and the RV will be returned.
7920 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7926 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7928 sv_setpvn(newSVrv(rv,classname), pv, n);
7933 =for apidoc sv_bless
7935 Blesses an SV into a specified package. The SV must be an RV. The package
7936 must be designated by its stash (see C<gv_stashpv()>). The reference count
7937 of the SV is unaffected.
7943 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7948 Perl_croak(aTHX_ "Can't bless non-reference value");
7950 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7951 if (SvREADONLY(tmpRef))
7952 Perl_croak(aTHX_ PL_no_modify);
7953 if (SvOBJECT(tmpRef)) {
7954 if (SvTYPE(tmpRef) != SVt_PVIO)
7956 SvREFCNT_dec(SvSTASH(tmpRef));
7959 SvOBJECT_on(tmpRef);
7960 if (SvTYPE(tmpRef) != SVt_PVIO)
7962 SvUPGRADE(tmpRef, SVt_PVMG);
7963 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7970 if(SvSMAGICAL(tmpRef))
7971 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7979 /* Downgrades a PVGV to a PVMG.
7983 S_sv_unglob(pTHX_ SV *sv)
7987 SV * const temp = sv_newmortal();
7989 assert(SvTYPE(sv) == SVt_PVGV);
7991 gv_efullname3(temp, (GV *) sv, "*");
7997 sv_del_backref((SV*)GvSTASH(sv), sv);
8001 if (GvNAME_HEK(sv)) {
8002 unshare_hek(GvNAME_HEK(sv));
8006 /* need to keep SvANY(sv) in the right arena */
8007 xpvmg = new_XPVMG();
8008 StructCopy(SvANY(sv), xpvmg, XPVMG);
8009 del_XPVGV(SvANY(sv));
8012 SvFLAGS(sv) &= ~SVTYPEMASK;
8013 SvFLAGS(sv) |= SVt_PVMG;
8015 /* Intentionally not calling any local SET magic, as this isn't so much a
8016 set operation as merely an internal storage change. */
8017 sv_setsv_flags(sv, temp, 0);
8021 =for apidoc sv_unref_flags
8023 Unsets the RV status of the SV, and decrements the reference count of
8024 whatever was being referenced by the RV. This can almost be thought of
8025 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8026 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8027 (otherwise the decrementing is conditional on the reference count being
8028 different from one or the reference being a readonly SV).
8035 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8037 SV* const target = SvRV(ref);
8039 if (SvWEAKREF(ref)) {
8040 sv_del_backref(target, ref);
8042 SvRV_set(ref, NULL);
8045 SvRV_set(ref, NULL);
8047 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8048 assigned to as BEGIN {$a = \"Foo"} will fail. */
8049 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8050 SvREFCNT_dec(target);
8051 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8052 sv_2mortal(target); /* Schedule for freeing later */
8056 =for apidoc sv_untaint
8058 Untaint an SV. Use C<SvTAINTED_off> instead.
8063 Perl_sv_untaint(pTHX_ SV *sv)
8065 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8066 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8073 =for apidoc sv_tainted
8075 Test an SV for taintedness. Use C<SvTAINTED> instead.
8080 Perl_sv_tainted(pTHX_ SV *sv)
8082 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8083 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8084 if (mg && (mg->mg_len & 1) )
8091 =for apidoc sv_setpviv
8093 Copies an integer into the given SV, also updating its string value.
8094 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8100 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8102 char buf[TYPE_CHARS(UV)];
8104 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8106 sv_setpvn(sv, ptr, ebuf - ptr);
8110 =for apidoc sv_setpviv_mg
8112 Like C<sv_setpviv>, but also handles 'set' magic.
8118 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8124 #if defined(PERL_IMPLICIT_CONTEXT)
8126 /* pTHX_ magic can't cope with varargs, so this is a no-context
8127 * version of the main function, (which may itself be aliased to us).
8128 * Don't access this version directly.
8132 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8136 va_start(args, pat);
8137 sv_vsetpvf(sv, pat, &args);
8141 /* pTHX_ magic can't cope with varargs, so this is a no-context
8142 * version of the main function, (which may itself be aliased to us).
8143 * Don't access this version directly.
8147 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8151 va_start(args, pat);
8152 sv_vsetpvf_mg(sv, pat, &args);
8158 =for apidoc sv_setpvf
8160 Works like C<sv_catpvf> but copies the text into the SV instead of
8161 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8167 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8170 va_start(args, pat);
8171 sv_vsetpvf(sv, pat, &args);
8176 =for apidoc sv_vsetpvf
8178 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8179 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8181 Usually used via its frontend C<sv_setpvf>.
8187 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8189 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8193 =for apidoc sv_setpvf_mg
8195 Like C<sv_setpvf>, but also handles 'set' magic.
8201 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8204 va_start(args, pat);
8205 sv_vsetpvf_mg(sv, pat, &args);
8210 =for apidoc sv_vsetpvf_mg
8212 Like C<sv_vsetpvf>, but also handles 'set' magic.
8214 Usually used via its frontend C<sv_setpvf_mg>.
8220 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8222 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8226 #if defined(PERL_IMPLICIT_CONTEXT)
8228 /* pTHX_ magic can't cope with varargs, so this is a no-context
8229 * version of the main function, (which may itself be aliased to us).
8230 * Don't access this version directly.
8234 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8238 va_start(args, pat);
8239 sv_vcatpvf(sv, pat, &args);
8243 /* pTHX_ magic can't cope with varargs, so this is a no-context
8244 * version of the main function, (which may itself be aliased to us).
8245 * Don't access this version directly.
8249 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8253 va_start(args, pat);
8254 sv_vcatpvf_mg(sv, pat, &args);
8260 =for apidoc sv_catpvf
8262 Processes its arguments like C<sprintf> and appends the formatted
8263 output to an SV. If the appended data contains "wide" characters
8264 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8265 and characters >255 formatted with %c), the original SV might get
8266 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8267 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8268 valid UTF-8; if the original SV was bytes, the pattern should be too.
8273 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8276 va_start(args, pat);
8277 sv_vcatpvf(sv, pat, &args);
8282 =for apidoc sv_vcatpvf
8284 Processes its arguments like C<vsprintf> and appends the formatted output
8285 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8287 Usually used via its frontend C<sv_catpvf>.
8293 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8295 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8299 =for apidoc sv_catpvf_mg
8301 Like C<sv_catpvf>, but also handles 'set' magic.
8307 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8310 va_start(args, pat);
8311 sv_vcatpvf_mg(sv, pat, &args);
8316 =for apidoc sv_vcatpvf_mg
8318 Like C<sv_vcatpvf>, but also handles 'set' magic.
8320 Usually used via its frontend C<sv_catpvf_mg>.
8326 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8328 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8333 =for apidoc sv_vsetpvfn
8335 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8338 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8344 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8346 sv_setpvn(sv, "", 0);
8347 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8351 S_expect_number(pTHX_ char** pattern)
8355 switch (**pattern) {
8356 case '1': case '2': case '3':
8357 case '4': case '5': case '6':
8358 case '7': case '8': case '9':
8359 var = *(*pattern)++ - '0';
8360 while (isDIGIT(**pattern)) {
8361 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8363 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8371 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8373 const int neg = nv < 0;
8382 if (uv & 1 && uv == nv)
8383 uv--; /* Round to even */
8385 const unsigned dig = uv % 10;
8398 =for apidoc sv_vcatpvfn
8400 Processes its arguments like C<vsprintf> and appends the formatted output
8401 to an SV. Uses an array of SVs if the C style variable argument list is
8402 missing (NULL). When running with taint checks enabled, indicates via
8403 C<maybe_tainted> if results are untrustworthy (often due to the use of
8406 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8412 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8413 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8414 vec_utf8 = DO_UTF8(vecsv);
8416 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8419 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8427 static const char nullstr[] = "(null)";
8429 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8430 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8432 /* Times 4: a decimal digit takes more than 3 binary digits.
8433 * NV_DIG: mantissa takes than many decimal digits.
8434 * Plus 32: Playing safe. */
8435 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8436 /* large enough for "%#.#f" --chip */
8437 /* what about long double NVs? --jhi */
8439 PERL_UNUSED_ARG(maybe_tainted);
8441 /* no matter what, this is a string now */
8442 (void)SvPV_force(sv, origlen);
8444 /* special-case "", "%s", and "%-p" (SVf - see below) */
8447 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8449 const char * const s = va_arg(*args, char*);
8450 sv_catpv(sv, s ? s : nullstr);
8452 else if (svix < svmax) {
8453 sv_catsv(sv, *svargs);
8457 if (args && patlen == 3 && pat[0] == '%' &&
8458 pat[1] == '-' && pat[2] == 'p') {
8459 argsv = va_arg(*args, SV*);
8460 sv_catsv(sv, argsv);
8464 #ifndef USE_LONG_DOUBLE
8465 /* special-case "%.<number>[gf]" */
8466 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8467 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8468 unsigned digits = 0;
8472 while (*pp >= '0' && *pp <= '9')
8473 digits = 10 * digits + (*pp++ - '0');
8474 if (pp - pat == (int)patlen - 1) {
8482 /* Add check for digits != 0 because it seems that some
8483 gconverts are buggy in this case, and we don't yet have
8484 a Configure test for this. */
8485 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8486 /* 0, point, slack */
8487 Gconvert(nv, (int)digits, 0, ebuf);
8489 if (*ebuf) /* May return an empty string for digits==0 */
8492 } else if (!digits) {
8495 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8496 sv_catpvn(sv, p, l);
8502 #endif /* !USE_LONG_DOUBLE */
8504 if (!args && svix < svmax && DO_UTF8(*svargs))
8507 patend = (char*)pat + patlen;
8508 for (p = (char*)pat; p < patend; p = q) {
8511 bool vectorize = FALSE;
8512 bool vectorarg = FALSE;
8513 bool vec_utf8 = FALSE;
8519 bool has_precis = FALSE;
8521 const I32 osvix = svix;
8522 bool is_utf8 = FALSE; /* is this item utf8? */
8523 #ifdef HAS_LDBL_SPRINTF_BUG
8524 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8525 with sfio - Allen <allens@cpan.org> */
8526 bool fix_ldbl_sprintf_bug = FALSE;
8530 U8 utf8buf[UTF8_MAXBYTES+1];
8531 STRLEN esignlen = 0;
8533 const char *eptr = NULL;
8536 const U8 *vecstr = NULL;
8543 /* we need a long double target in case HAS_LONG_DOUBLE but
8546 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8554 const char *dotstr = ".";
8555 STRLEN dotstrlen = 1;
8556 I32 efix = 0; /* explicit format parameter index */
8557 I32 ewix = 0; /* explicit width index */
8558 I32 epix = 0; /* explicit precision index */
8559 I32 evix = 0; /* explicit vector index */
8560 bool asterisk = FALSE;
8562 /* echo everything up to the next format specification */
8563 for (q = p; q < patend && *q != '%'; ++q) ;
8565 if (has_utf8 && !pat_utf8)
8566 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8568 sv_catpvn(sv, p, q - p);
8575 We allow format specification elements in this order:
8576 \d+\$ explicit format parameter index
8578 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8579 0 flag (as above): repeated to allow "v02"
8580 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8581 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8583 [%bcdefginopsuxDFOUX] format (mandatory)
8588 As of perl5.9.3, printf format checking is on by default.
8589 Internally, perl uses %p formats to provide an escape to
8590 some extended formatting. This block deals with those
8591 extensions: if it does not match, (char*)q is reset and
8592 the normal format processing code is used.
8594 Currently defined extensions are:
8595 %p include pointer address (standard)
8596 %-p (SVf) include an SV (previously %_)
8597 %-<num>p include an SV with precision <num>
8598 %1p (VDf) include a v-string (as %vd)
8599 %<num>p reserved for future extensions
8601 Robin Barker 2005-07-14
8608 n = expect_number(&q);
8615 argsv = va_arg(*args, SV*);
8616 eptr = SvPVx_const(argsv, elen);
8622 else if (n == vdNUMBER) { /* VDf */
8629 if (ckWARN_d(WARN_INTERNAL))
8630 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8631 "internal %%<num>p might conflict with future printf extensions");
8637 if ( (width = expect_number(&q)) ) {
8652 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8681 if ( (ewix = expect_number(&q)) )
8690 if ((vectorarg = asterisk)) {
8703 width = expect_number(&q);
8709 vecsv = va_arg(*args, SV*);
8711 vecsv = (evix > 0 && evix <= svmax)
8712 ? svargs[evix-1] : &PL_sv_undef;
8714 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8716 dotstr = SvPV_const(vecsv, dotstrlen);
8717 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8718 bad with tied or overloaded values that return UTF8. */
8721 else if (has_utf8) {
8722 vecsv = sv_mortalcopy(vecsv);
8723 sv_utf8_upgrade(vecsv);
8724 dotstr = SvPV_const(vecsv, dotstrlen);
8731 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8732 vecsv = svargs[efix ? efix-1 : svix++];
8733 vecstr = (U8*)SvPV_const(vecsv,veclen);
8734 vec_utf8 = DO_UTF8(vecsv);
8736 /* if this is a version object, we need to convert
8737 * back into v-string notation and then let the
8738 * vectorize happen normally
8740 if (sv_derived_from(vecsv, "version")) {
8741 char *version = savesvpv(vecsv);
8742 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8743 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8744 "vector argument not supported with alpha versions");
8747 vecsv = sv_newmortal();
8748 /* scan_vstring is expected to be called during
8749 * tokenization, so we need to fake up the end
8750 * of the buffer for it
8752 PL_bufend = version + veclen;
8753 scan_vstring(version, vecsv);
8754 vecstr = (U8*)SvPV_const(vecsv, veclen);
8755 vec_utf8 = DO_UTF8(vecsv);
8767 i = va_arg(*args, int);
8769 i = (ewix ? ewix <= svmax : svix < svmax) ?
8770 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8772 width = (i < 0) ? -i : i;
8782 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8784 /* XXX: todo, support specified precision parameter */
8788 i = va_arg(*args, int);
8790 i = (ewix ? ewix <= svmax : svix < svmax)
8791 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8793 has_precis = !(i < 0);
8798 precis = precis * 10 + (*q++ - '0');
8807 case 'I': /* Ix, I32x, and I64x */
8809 if (q[1] == '6' && q[2] == '4') {
8815 if (q[1] == '3' && q[2] == '2') {
8825 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8836 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8837 if (*(q + 1) == 'l') { /* lld, llf */
8863 if (!vectorize && !args) {
8865 const I32 i = efix-1;
8866 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8868 argsv = (svix >= 0 && svix < svmax)
8869 ? svargs[svix++] : &PL_sv_undef;
8880 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8882 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8884 eptr = (char*)utf8buf;
8885 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8899 eptr = va_arg(*args, char*);
8901 #ifdef MACOS_TRADITIONAL
8902 /* On MacOS, %#s format is used for Pascal strings */
8907 elen = strlen(eptr);
8909 eptr = (char *)nullstr;
8910 elen = sizeof nullstr - 1;
8914 eptr = SvPVx_const(argsv, elen);
8915 if (DO_UTF8(argsv)) {
8916 I32 old_precis = precis;
8917 if (has_precis && precis < elen) {
8919 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8922 if (width) { /* fudge width (can't fudge elen) */
8923 if (has_precis && precis < elen)
8924 width += precis - old_precis;
8926 width += elen - sv_len_utf8(argsv);
8933 if (has_precis && elen > precis)
8940 if (alt || vectorize)
8942 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8963 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8972 esignbuf[esignlen++] = plus;
8976 case 'h': iv = (short)va_arg(*args, int); break;
8977 case 'l': iv = va_arg(*args, long); break;
8978 case 'V': iv = va_arg(*args, IV); break;
8979 default: iv = va_arg(*args, int); break;
8981 case 'q': iv = va_arg(*args, Quad_t); break;
8986 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8988 case 'h': iv = (short)tiv; break;
8989 case 'l': iv = (long)tiv; break;
8991 default: iv = tiv; break;
8993 case 'q': iv = (Quad_t)tiv; break;
8997 if ( !vectorize ) /* we already set uv above */
9002 esignbuf[esignlen++] = plus;
9006 esignbuf[esignlen++] = '-';
9050 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9061 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9062 case 'l': uv = va_arg(*args, unsigned long); break;
9063 case 'V': uv = va_arg(*args, UV); break;
9064 default: uv = va_arg(*args, unsigned); break;
9066 case 'q': uv = va_arg(*args, Uquad_t); break;
9071 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9073 case 'h': uv = (unsigned short)tuv; break;
9074 case 'l': uv = (unsigned long)tuv; break;
9076 default: uv = tuv; break;
9078 case 'q': uv = (Uquad_t)tuv; break;
9085 char *ptr = ebuf + sizeof ebuf;
9086 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9092 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9098 esignbuf[esignlen++] = '0';
9099 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9107 if (alt && *ptr != '0')
9116 esignbuf[esignlen++] = '0';
9117 esignbuf[esignlen++] = c;
9120 default: /* it had better be ten or less */
9124 } while (uv /= base);
9127 elen = (ebuf + sizeof ebuf) - ptr;
9131 zeros = precis - elen;
9132 else if (precis == 0 && elen == 1 && *eptr == '0'
9133 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9136 /* a precision nullifies the 0 flag. */
9143 /* FLOATING POINT */
9146 c = 'f'; /* maybe %F isn't supported here */
9154 /* This is evil, but floating point is even more evil */
9156 /* for SV-style calling, we can only get NV
9157 for C-style calling, we assume %f is double;
9158 for simplicity we allow any of %Lf, %llf, %qf for long double
9162 #if defined(USE_LONG_DOUBLE)
9166 /* [perl #20339] - we should accept and ignore %lf rather than die */
9170 #if defined(USE_LONG_DOUBLE)
9171 intsize = args ? 0 : 'q';
9175 #if defined(HAS_LONG_DOUBLE)
9184 /* now we need (long double) if intsize == 'q', else (double) */
9186 #if LONG_DOUBLESIZE > DOUBLESIZE
9188 va_arg(*args, long double) :
9189 va_arg(*args, double)
9191 va_arg(*args, double)
9196 if (c != 'e' && c != 'E') {
9198 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9199 will cast our (long double) to (double) */
9200 (void)Perl_frexp(nv, &i);
9201 if (i == PERL_INT_MIN)
9202 Perl_die(aTHX_ "panic: frexp");
9204 need = BIT_DIGITS(i);
9206 need += has_precis ? precis : 6; /* known default */
9211 #ifdef HAS_LDBL_SPRINTF_BUG
9212 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9213 with sfio - Allen <allens@cpan.org> */
9216 # define MY_DBL_MAX DBL_MAX
9217 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9218 # if DOUBLESIZE >= 8
9219 # define MY_DBL_MAX 1.7976931348623157E+308L
9221 # define MY_DBL_MAX 3.40282347E+38L
9225 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9226 # define MY_DBL_MAX_BUG 1L
9228 # define MY_DBL_MAX_BUG MY_DBL_MAX
9232 # define MY_DBL_MIN DBL_MIN
9233 # else /* XXX guessing! -Allen */
9234 # if DOUBLESIZE >= 8
9235 # define MY_DBL_MIN 2.2250738585072014E-308L
9237 # define MY_DBL_MIN 1.17549435E-38L
9241 if ((intsize == 'q') && (c == 'f') &&
9242 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9244 /* it's going to be short enough that
9245 * long double precision is not needed */
9247 if ((nv <= 0L) && (nv >= -0L))
9248 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9250 /* would use Perl_fp_class as a double-check but not
9251 * functional on IRIX - see perl.h comments */
9253 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9254 /* It's within the range that a double can represent */
9255 #if defined(DBL_MAX) && !defined(DBL_MIN)
9256 if ((nv >= ((long double)1/DBL_MAX)) ||
9257 (nv <= (-(long double)1/DBL_MAX)))
9259 fix_ldbl_sprintf_bug = TRUE;
9262 if (fix_ldbl_sprintf_bug == TRUE) {
9272 # undef MY_DBL_MAX_BUG
9275 #endif /* HAS_LDBL_SPRINTF_BUG */
9277 need += 20; /* fudge factor */
9278 if (PL_efloatsize < need) {
9279 Safefree(PL_efloatbuf);
9280 PL_efloatsize = need + 20; /* more fudge */
9281 Newx(PL_efloatbuf, PL_efloatsize, char);
9282 PL_efloatbuf[0] = '\0';
9285 if ( !(width || left || plus || alt) && fill != '0'
9286 && has_precis && intsize != 'q' ) { /* Shortcuts */
9287 /* See earlier comment about buggy Gconvert when digits,
9289 if ( c == 'g' && precis) {
9290 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9291 /* May return an empty string for digits==0 */
9292 if (*PL_efloatbuf) {
9293 elen = strlen(PL_efloatbuf);
9294 goto float_converted;
9296 } else if ( c == 'f' && !precis) {
9297 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9302 char *ptr = ebuf + sizeof ebuf;
9305 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9306 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9307 if (intsize == 'q') {
9308 /* Copy the one or more characters in a long double
9309 * format before the 'base' ([efgEFG]) character to
9310 * the format string. */
9311 static char const prifldbl[] = PERL_PRIfldbl;
9312 char const *p = prifldbl + sizeof(prifldbl) - 3;
9313 while (p >= prifldbl) { *--ptr = *p--; }
9318 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9323 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9335 /* No taint. Otherwise we are in the strange situation
9336 * where printf() taints but print($float) doesn't.
9338 #if defined(HAS_LONG_DOUBLE)
9339 elen = ((intsize == 'q')
9340 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9341 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9343 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9347 eptr = PL_efloatbuf;
9355 i = SvCUR(sv) - origlen;
9358 case 'h': *(va_arg(*args, short*)) = i; break;
9359 default: *(va_arg(*args, int*)) = i; break;
9360 case 'l': *(va_arg(*args, long*)) = i; break;
9361 case 'V': *(va_arg(*args, IV*)) = i; break;
9363 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9368 sv_setuv_mg(argsv, (UV)i);
9369 continue; /* not "break" */
9376 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9377 && ckWARN(WARN_PRINTF))
9379 SV * const msg = sv_newmortal();
9380 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9381 (PL_op->op_type == OP_PRTF) ? "" : "s");
9384 Perl_sv_catpvf(aTHX_ msg,
9385 "\"%%%c\"", c & 0xFF);
9387 Perl_sv_catpvf(aTHX_ msg,
9388 "\"%%\\%03"UVof"\"",
9391 sv_catpvs(msg, "end of string");
9392 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9395 /* output mangled stuff ... */
9401 /* ... right here, because formatting flags should not apply */
9402 SvGROW(sv, SvCUR(sv) + elen + 1);
9404 Copy(eptr, p, elen, char);
9407 SvCUR_set(sv, p - SvPVX_const(sv));
9409 continue; /* not "break" */
9412 if (is_utf8 != has_utf8) {
9415 sv_utf8_upgrade(sv);
9418 const STRLEN old_elen = elen;
9419 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9420 sv_utf8_upgrade(nsv);
9421 eptr = SvPVX_const(nsv);
9424 if (width) { /* fudge width (can't fudge elen) */
9425 width += elen - old_elen;
9431 have = esignlen + zeros + elen;
9433 Perl_croak_nocontext(PL_memory_wrap);
9435 need = (have > width ? have : width);
9438 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9439 Perl_croak_nocontext(PL_memory_wrap);
9440 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9442 if (esignlen && fill == '0') {
9444 for (i = 0; i < (int)esignlen; i++)
9448 memset(p, fill, gap);
9451 if (esignlen && fill != '0') {
9453 for (i = 0; i < (int)esignlen; i++)
9458 for (i = zeros; i; i--)
9462 Copy(eptr, p, elen, char);
9466 memset(p, ' ', gap);
9471 Copy(dotstr, p, dotstrlen, char);
9475 vectorize = FALSE; /* done iterating over vecstr */
9482 SvCUR_set(sv, p - SvPVX_const(sv));
9490 /* =========================================================================
9492 =head1 Cloning an interpreter
9494 All the macros and functions in this section are for the private use of
9495 the main function, perl_clone().
9497 The foo_dup() functions make an exact copy of an existing foo thinngy.
9498 During the course of a cloning, a hash table is used to map old addresses
9499 to new addresses. The table is created and manipulated with the
9500 ptr_table_* functions.
9504 ============================================================================*/
9507 #if defined(USE_ITHREADS)
9509 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9510 #ifndef GpREFCNT_inc
9511 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9515 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9516 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9517 If this changes, please unmerge ss_dup. */
9518 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9519 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9520 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9521 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9522 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9523 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9524 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9525 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9526 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9527 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9528 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9529 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9530 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9531 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9534 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9535 regcomp.c. AMS 20010712 */
9538 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9540 return CALLREGDUPE(r,param);
9543 /* duplicate a file handle */
9546 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9550 PERL_UNUSED_ARG(type);
9553 return (PerlIO*)NULL;
9555 /* look for it in the table first */
9556 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9560 /* create anew and remember what it is */
9561 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9562 ptr_table_store(PL_ptr_table, fp, ret);
9566 /* duplicate a directory handle */
9569 Perl_dirp_dup(pTHX_ DIR *dp)
9571 PERL_UNUSED_CONTEXT;
9578 /* duplicate a typeglob */
9581 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9587 /* look for it in the table first */
9588 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9592 /* create anew and remember what it is */
9594 ptr_table_store(PL_ptr_table, gp, ret);
9597 ret->gp_refcnt = 0; /* must be before any other dups! */
9598 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9599 ret->gp_io = io_dup_inc(gp->gp_io, param);
9600 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9601 ret->gp_av = av_dup_inc(gp->gp_av, param);
9602 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9603 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9604 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9605 ret->gp_cvgen = gp->gp_cvgen;
9606 ret->gp_line = gp->gp_line;
9607 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9611 /* duplicate a chain of magic */
9614 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9616 MAGIC *mgprev = (MAGIC*)NULL;
9619 return (MAGIC*)NULL;
9620 /* look for it in the table first */
9621 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9625 for (; mg; mg = mg->mg_moremagic) {
9627 Newxz(nmg, 1, MAGIC);
9629 mgprev->mg_moremagic = nmg;
9632 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9633 nmg->mg_private = mg->mg_private;
9634 nmg->mg_type = mg->mg_type;
9635 nmg->mg_flags = mg->mg_flags;
9636 if (mg->mg_type == PERL_MAGIC_qr) {
9637 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9639 else if(mg->mg_type == PERL_MAGIC_backref) {
9640 /* The backref AV has its reference count deliberately bumped by
9642 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9644 else if (mg->mg_type == PERL_MAGIC_symtab) {
9645 nmg->mg_obj = mg->mg_obj;
9648 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9649 ? sv_dup_inc(mg->mg_obj, param)
9650 : sv_dup(mg->mg_obj, param);
9652 nmg->mg_len = mg->mg_len;
9653 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9654 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9655 if (mg->mg_len > 0) {
9656 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9657 if (mg->mg_type == PERL_MAGIC_overload_table &&
9658 AMT_AMAGIC((AMT*)mg->mg_ptr))
9660 const AMT * const amtp = (AMT*)mg->mg_ptr;
9661 AMT * const namtp = (AMT*)nmg->mg_ptr;
9663 for (i = 1; i < NofAMmeth; i++) {
9664 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9668 else if (mg->mg_len == HEf_SVKEY)
9669 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9671 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9672 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9679 /* create a new pointer-mapping table */
9682 Perl_ptr_table_new(pTHX)
9685 PERL_UNUSED_CONTEXT;
9687 Newxz(tbl, 1, PTR_TBL_t);
9690 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9694 #define PTR_TABLE_HASH(ptr) \
9695 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9698 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9699 following define) and at call to new_body_inline made below in
9700 Perl_ptr_table_store()
9703 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9705 /* map an existing pointer using a table */
9707 STATIC PTR_TBL_ENT_t *
9708 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9709 PTR_TBL_ENT_t *tblent;
9710 const UV hash = PTR_TABLE_HASH(sv);
9712 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9713 for (; tblent; tblent = tblent->next) {
9714 if (tblent->oldval == sv)
9721 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9723 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9724 PERL_UNUSED_CONTEXT;
9725 return tblent ? tblent->newval : NULL;
9728 /* add a new entry to a pointer-mapping table */
9731 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9733 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9734 PERL_UNUSED_CONTEXT;
9737 tblent->newval = newsv;
9739 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9741 new_body_inline(tblent, PTE_SVSLOT);
9743 tblent->oldval = oldsv;
9744 tblent->newval = newsv;
9745 tblent->next = tbl->tbl_ary[entry];
9746 tbl->tbl_ary[entry] = tblent;
9748 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9749 ptr_table_split(tbl);
9753 /* double the hash bucket size of an existing ptr table */
9756 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9758 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9759 const UV oldsize = tbl->tbl_max + 1;
9760 UV newsize = oldsize * 2;
9762 PERL_UNUSED_CONTEXT;
9764 Renew(ary, newsize, PTR_TBL_ENT_t*);
9765 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9766 tbl->tbl_max = --newsize;
9768 for (i=0; i < oldsize; i++, ary++) {
9769 PTR_TBL_ENT_t **curentp, **entp, *ent;
9772 curentp = ary + oldsize;
9773 for (entp = ary, ent = *ary; ent; ent = *entp) {
9774 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9776 ent->next = *curentp;
9786 /* remove all the entries from a ptr table */
9789 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9791 if (tbl && tbl->tbl_items) {
9792 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9793 UV riter = tbl->tbl_max;
9796 PTR_TBL_ENT_t *entry = array[riter];
9799 PTR_TBL_ENT_t * const oentry = entry;
9800 entry = entry->next;
9809 /* clear and free a ptr table */
9812 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9817 ptr_table_clear(tbl);
9818 Safefree(tbl->tbl_ary);
9824 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9827 SvRV_set(dstr, SvWEAKREF(sstr)
9828 ? sv_dup(SvRV(sstr), param)
9829 : sv_dup_inc(SvRV(sstr), param));
9832 else if (SvPVX_const(sstr)) {
9833 /* Has something there */
9835 /* Normal PV - clone whole allocated space */
9836 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9837 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9838 /* Not that normal - actually sstr is copy on write.
9839 But we are a true, independant SV, so: */
9840 SvREADONLY_off(dstr);
9845 /* Special case - not normally malloced for some reason */
9846 if (isGV_with_GP(sstr)) {
9847 /* Don't need to do anything here. */
9849 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9850 /* A "shared" PV - clone it as "shared" PV */
9852 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9856 /* Some other special case - random pointer */
9857 SvPV_set(dstr, SvPVX(sstr));
9863 if (SvTYPE(dstr) == SVt_RV)
9864 SvRV_set(dstr, NULL);
9866 SvPV_set(dstr, NULL);
9870 /* duplicate an SV of any type (including AV, HV etc) */
9873 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9878 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9880 /* look for it in the table first */
9881 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9885 if(param->flags & CLONEf_JOIN_IN) {
9886 /** We are joining here so we don't want do clone
9887 something that is bad **/
9888 if (SvTYPE(sstr) == SVt_PVHV) {
9889 const char * const hvname = HvNAME_get(sstr);
9891 /** don't clone stashes if they already exist **/
9892 return (SV*)gv_stashpv(hvname,0);
9896 /* create anew and remember what it is */
9899 #ifdef DEBUG_LEAKING_SCALARS
9900 dstr->sv_debug_optype = sstr->sv_debug_optype;
9901 dstr->sv_debug_line = sstr->sv_debug_line;
9902 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9903 dstr->sv_debug_cloned = 1;
9904 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9907 ptr_table_store(PL_ptr_table, sstr, dstr);
9910 SvFLAGS(dstr) = SvFLAGS(sstr);
9911 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9912 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9915 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9916 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9917 PL_watch_pvx, SvPVX_const(sstr));
9920 /* don't clone objects whose class has asked us not to */
9921 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9922 SvFLAGS(dstr) &= ~SVTYPEMASK;
9927 switch (SvTYPE(sstr)) {
9932 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9933 SvIV_set(dstr, SvIVX(sstr));
9936 SvANY(dstr) = new_XNV();
9937 SvNV_set(dstr, SvNVX(sstr));
9940 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9941 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9945 /* These are all the types that need complex bodies allocating. */
9947 const svtype sv_type = SvTYPE(sstr);
9948 const struct body_details *const sv_type_details
9949 = bodies_by_type + sv_type;
9953 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9957 if (GvUNIQUE((GV*)sstr)) {
9958 NOOP; /* Do sharing here, and fall through */
9971 assert(sv_type_details->body_size);
9972 if (sv_type_details->arena) {
9973 new_body_inline(new_body, sv_type);
9975 = (void*)((char*)new_body - sv_type_details->offset);
9977 new_body = new_NOARENA(sv_type_details);
9981 SvANY(dstr) = new_body;
9984 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9985 ((char*)SvANY(dstr)) + sv_type_details->offset,
9986 sv_type_details->copy, char);
9988 Copy(((char*)SvANY(sstr)),
9989 ((char*)SvANY(dstr)),
9990 sv_type_details->body_size + sv_type_details->offset, char);
9993 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9994 && !isGV_with_GP(dstr))
9995 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9997 /* The Copy above means that all the source (unduplicated) pointers
9998 are now in the destination. We can check the flags and the
9999 pointers in either, but it's possible that there's less cache
10000 missing by always going for the destination.
10001 FIXME - instrument and check that assumption */
10002 if (sv_type >= SVt_PVMG) {
10003 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10004 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10005 } else if (SvMAGIC(dstr))
10006 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10008 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10011 /* The cast silences a GCC warning about unhandled types. */
10012 switch ((int)sv_type) {
10024 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10025 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10026 LvTARG(dstr) = dstr;
10027 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10028 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10030 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10033 if (GvNAME_HEK(dstr))
10034 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10036 /* Don't call sv_add_backref here as it's going to be created
10037 as part of the magic cloning of the symbol table. */
10038 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10039 if(isGV_with_GP(sstr)) {
10040 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10041 at the point of this comment. */
10042 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10043 (void)GpREFCNT_inc(GvGP(dstr));
10045 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10048 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10049 if (IoOFP(dstr) == IoIFP(sstr))
10050 IoOFP(dstr) = IoIFP(dstr);
10052 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10053 /* PL_rsfp_filters entries have fake IoDIRP() */
10054 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10055 /* I have no idea why fake dirp (rsfps)
10056 should be treated differently but otherwise
10057 we end up with leaks -- sky*/
10058 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10059 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10060 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10062 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10063 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10064 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10065 if (IoDIRP(dstr)) {
10066 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10069 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10072 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10073 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10074 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10077 if (AvARRAY((AV*)sstr)) {
10078 SV **dst_ary, **src_ary;
10079 SSize_t items = AvFILLp((AV*)sstr) + 1;
10081 src_ary = AvARRAY((AV*)sstr);
10082 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10083 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10084 AvARRAY((AV*)dstr) = dst_ary;
10085 AvALLOC((AV*)dstr) = dst_ary;
10086 if (AvREAL((AV*)sstr)) {
10087 while (items-- > 0)
10088 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10091 while (items-- > 0)
10092 *dst_ary++ = sv_dup(*src_ary++, param);
10094 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10095 while (items-- > 0) {
10096 *dst_ary++ = &PL_sv_undef;
10100 AvARRAY((AV*)dstr) = NULL;
10101 AvALLOC((AV*)dstr) = (SV**)NULL;
10105 if (HvARRAY((HV*)sstr)) {
10107 const bool sharekeys = !!HvSHAREKEYS(sstr);
10108 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10109 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10111 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10112 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10114 HvARRAY(dstr) = (HE**)darray;
10115 while (i <= sxhv->xhv_max) {
10116 const HE * const source = HvARRAY(sstr)[i];
10117 HvARRAY(dstr)[i] = source
10118 ? he_dup(source, sharekeys, param) : 0;
10123 const struct xpvhv_aux * const saux = HvAUX(sstr);
10124 struct xpvhv_aux * const daux = HvAUX(dstr);
10125 /* This flag isn't copied. */
10126 /* SvOOK_on(hv) attacks the IV flags. */
10127 SvFLAGS(dstr) |= SVf_OOK;
10129 hvname = saux->xhv_name;
10130 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10132 daux->xhv_riter = saux->xhv_riter;
10133 daux->xhv_eiter = saux->xhv_eiter
10134 ? he_dup(saux->xhv_eiter,
10135 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10136 daux->xhv_backreferences =
10137 saux->xhv_backreferences
10138 ? (AV*) SvREFCNT_inc(
10139 sv_dup((SV*)saux->xhv_backreferences, param))
10141 /* Record stashes for possible cloning in Perl_clone(). */
10143 av_push(param->stashes, dstr);
10147 HvARRAY((HV*)dstr) = NULL;
10150 if (!(param->flags & CLONEf_COPY_STACKS)) {
10154 /* NOTE: not refcounted */
10155 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10157 if (!CvISXSUB(dstr))
10158 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10160 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10161 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10162 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10163 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10165 /* don't dup if copying back - CvGV isn't refcounted, so the
10166 * duped GV may never be freed. A bit of a hack! DAPM */
10167 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10168 NULL : gv_dup(CvGV(dstr), param) ;
10169 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10171 CvWEAKOUTSIDE(sstr)
10172 ? cv_dup( CvOUTSIDE(dstr), param)
10173 : cv_dup_inc(CvOUTSIDE(dstr), param);
10174 if (!CvISXSUB(dstr))
10175 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10181 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10187 /* duplicate a context */
10190 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10192 PERL_CONTEXT *ncxs;
10195 return (PERL_CONTEXT*)NULL;
10197 /* look for it in the table first */
10198 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10202 /* create anew and remember what it is */
10203 Newxz(ncxs, max + 1, PERL_CONTEXT);
10204 ptr_table_store(PL_ptr_table, cxs, ncxs);
10207 PERL_CONTEXT * const cx = &cxs[ix];
10208 PERL_CONTEXT * const ncx = &ncxs[ix];
10209 ncx->cx_type = cx->cx_type;
10210 if (CxTYPE(cx) == CXt_SUBST) {
10211 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10214 ncx->blk_oldsp = cx->blk_oldsp;
10215 ncx->blk_oldcop = cx->blk_oldcop;
10216 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10217 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10218 ncx->blk_oldpm = cx->blk_oldpm;
10219 ncx->blk_gimme = cx->blk_gimme;
10220 switch (CxTYPE(cx)) {
10222 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10223 ? cv_dup_inc(cx->blk_sub.cv, param)
10224 : cv_dup(cx->blk_sub.cv,param));
10225 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10226 ? av_dup_inc(cx->blk_sub.argarray, param)
10228 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10229 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10230 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10231 ncx->blk_sub.lval = cx->blk_sub.lval;
10232 ncx->blk_sub.retop = cx->blk_sub.retop;
10233 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10234 cx->blk_sub.oldcomppad);
10237 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10238 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10239 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10240 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10241 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10242 ncx->blk_eval.retop = cx->blk_eval.retop;
10245 ncx->blk_loop.label = cx->blk_loop.label;
10246 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10247 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10248 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10249 ? cx->blk_loop.iterdata
10250 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10251 ncx->blk_loop.oldcomppad
10252 = (PAD*)ptr_table_fetch(PL_ptr_table,
10253 cx->blk_loop.oldcomppad);
10254 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10255 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10256 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10257 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10258 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10261 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10262 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10263 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10264 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10265 ncx->blk_sub.retop = cx->blk_sub.retop;
10277 /* duplicate a stack info structure */
10280 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10285 return (PERL_SI*)NULL;
10287 /* look for it in the table first */
10288 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10292 /* create anew and remember what it is */
10293 Newxz(nsi, 1, PERL_SI);
10294 ptr_table_store(PL_ptr_table, si, nsi);
10296 nsi->si_stack = av_dup_inc(si->si_stack, param);
10297 nsi->si_cxix = si->si_cxix;
10298 nsi->si_cxmax = si->si_cxmax;
10299 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10300 nsi->si_type = si->si_type;
10301 nsi->si_prev = si_dup(si->si_prev, param);
10302 nsi->si_next = si_dup(si->si_next, param);
10303 nsi->si_markoff = si->si_markoff;
10308 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10309 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10310 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10311 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10312 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10313 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10314 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10315 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10316 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10317 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10318 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10319 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10320 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10321 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10324 #define pv_dup_inc(p) SAVEPV(p)
10325 #define pv_dup(p) SAVEPV(p)
10326 #define svp_dup_inc(p,pp) any_dup(p,pp)
10328 /* map any object to the new equivent - either something in the
10329 * ptr table, or something in the interpreter structure
10333 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10338 return (void*)NULL;
10340 /* look for it in the table first */
10341 ret = ptr_table_fetch(PL_ptr_table, v);
10345 /* see if it is part of the interpreter structure */
10346 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10347 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10355 /* duplicate the save stack */
10358 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10360 ANY * const ss = proto_perl->Tsavestack;
10361 const I32 max = proto_perl->Tsavestack_max;
10362 I32 ix = proto_perl->Tsavestack_ix;
10375 void (*dptr) (void*);
10376 void (*dxptr) (pTHX_ void*);
10378 Newxz(nss, max, ANY);
10381 const I32 type = POPINT(ss,ix);
10382 TOPINT(nss,ix) = type;
10384 case SAVEt_HELEM: /* hash element */
10385 sv = (SV*)POPPTR(ss,ix);
10386 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10388 case SAVEt_ITEM: /* normal string */
10389 case SAVEt_SV: /* scalar reference */
10390 sv = (SV*)POPPTR(ss,ix);
10391 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10394 case SAVEt_MORTALIZESV:
10395 sv = (SV*)POPPTR(ss,ix);
10396 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10398 case SAVEt_SHARED_PVREF: /* char* in shared space */
10399 c = (char*)POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = savesharedpv(c);
10401 ptr = POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10404 case SAVEt_GENERIC_SVREF: /* generic sv */
10405 case SAVEt_SVREF: /* scalar reference */
10406 sv = (SV*)POPPTR(ss,ix);
10407 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10408 ptr = POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10411 case SAVEt_HV: /* hash reference */
10412 case SAVEt_AV: /* array reference */
10413 sv = (SV*) POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10416 case SAVEt_COMPPAD:
10418 sv = (SV*) POPPTR(ss,ix);
10419 TOPPTR(nss,ix) = sv_dup(sv, param);
10421 case SAVEt_INT: /* int reference */
10422 ptr = POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10424 intval = (int)POPINT(ss,ix);
10425 TOPINT(nss,ix) = intval;
10427 case SAVEt_LONG: /* long reference */
10428 ptr = POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10431 case SAVEt_CLEARSV:
10432 longval = (long)POPLONG(ss,ix);
10433 TOPLONG(nss,ix) = longval;
10435 case SAVEt_I32: /* I32 reference */
10436 case SAVEt_I16: /* I16 reference */
10437 case SAVEt_I8: /* I8 reference */
10438 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10439 ptr = POPPTR(ss,ix);
10440 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10442 TOPINT(nss,ix) = i;
10444 case SAVEt_IV: /* IV reference */
10445 ptr = POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10448 TOPIV(nss,ix) = iv;
10450 case SAVEt_HPTR: /* HV* reference */
10451 case SAVEt_APTR: /* AV* reference */
10452 case SAVEt_SPTR: /* SV* reference */
10453 ptr = POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10455 sv = (SV*)POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = sv_dup(sv, param);
10458 case SAVEt_VPTR: /* random* reference */
10459 ptr = POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 case SAVEt_GENERIC_PVREF: /* generic char* */
10465 case SAVEt_PPTR: /* char* reference */
10466 ptr = POPPTR(ss,ix);
10467 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10468 c = (char*)POPPTR(ss,ix);
10469 TOPPTR(nss,ix) = pv_dup(c);
10471 case SAVEt_GP: /* scalar reference */
10472 gp = (GP*)POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10474 (void)GpREFCNT_inc(gp);
10475 gv = (GV*)POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10479 ptr = POPPTR(ss,ix);
10480 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10481 /* these are assumed to be refcounted properly */
10483 switch (((OP*)ptr)->op_type) {
10485 case OP_LEAVESUBLV:
10489 case OP_LEAVEWRITE:
10490 TOPPTR(nss,ix) = ptr;
10495 TOPPTR(nss,ix) = NULL;
10500 TOPPTR(nss,ix) = NULL;
10503 c = (char*)POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = pv_dup_inc(c);
10507 hv = (HV*)POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10509 c = (char*)POPPTR(ss,ix);
10510 TOPPTR(nss,ix) = pv_dup_inc(c);
10512 case SAVEt_STACK_POS: /* Position on Perl stack */
10514 TOPINT(nss,ix) = i;
10516 case SAVEt_DESTRUCTOR:
10517 ptr = POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10519 dptr = POPDPTR(ss,ix);
10520 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10521 any_dup(FPTR2DPTR(void *, dptr),
10524 case SAVEt_DESTRUCTOR_X:
10525 ptr = POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10527 dxptr = POPDXPTR(ss,ix);
10528 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10529 any_dup(FPTR2DPTR(void *, dxptr),
10532 case SAVEt_REGCONTEXT:
10535 TOPINT(nss,ix) = i;
10538 case SAVEt_AELEM: /* array element */
10539 sv = (SV*)POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10542 TOPINT(nss,ix) = i;
10543 av = (AV*)POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = av_dup_inc(av, param);
10547 ptr = POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = ptr;
10552 TOPINT(nss,ix) = i;
10553 ptr = POPPTR(ss,ix);
10556 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10557 HINTS_REFCNT_UNLOCK;
10559 TOPPTR(nss,ix) = ptr;
10560 if (i & HINT_LOCALIZE_HH) {
10561 hv = (HV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10566 longval = (long)POPLONG(ss,ix);
10567 TOPLONG(nss,ix) = longval;
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10570 sv = (SV*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = sv_dup(sv, param);
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10576 longval = (long)POPBOOL(ss,ix);
10577 TOPBOOL(nss,ix) = (bool)longval;
10579 case SAVEt_SET_SVFLAGS:
10581 TOPINT(nss,ix) = i;
10583 TOPINT(nss,ix) = i;
10584 sv = (SV*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = sv_dup(sv, param);
10587 case SAVEt_RE_STATE:
10589 const struct re_save_state *const old_state
10590 = (struct re_save_state *)
10591 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10592 struct re_save_state *const new_state
10593 = (struct re_save_state *)
10594 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10596 Copy(old_state, new_state, 1, struct re_save_state);
10597 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10599 new_state->re_state_bostr
10600 = pv_dup(old_state->re_state_bostr);
10601 new_state->re_state_reginput
10602 = pv_dup(old_state->re_state_reginput);
10603 new_state->re_state_regeol
10604 = pv_dup(old_state->re_state_regeol);
10605 new_state->re_state_regstartp
10606 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10607 new_state->re_state_regendp
10608 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10609 new_state->re_state_reglastparen
10610 = (U32*) any_dup(old_state->re_state_reglastparen,
10612 new_state->re_state_reglastcloseparen
10613 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10615 /* XXX This just has to be broken. The old save_re_context
10616 code did SAVEGENERICPV(PL_reg_start_tmp);
10617 PL_reg_start_tmp is char **.
10618 Look above to what the dup code does for
10619 SAVEt_GENERIC_PVREF
10620 It can never have worked.
10621 So this is merely a faithful copy of the exiting bug: */
10622 new_state->re_state_reg_start_tmp
10623 = (char **) pv_dup((char *)
10624 old_state->re_state_reg_start_tmp);
10625 /* I assume that it only ever "worked" because no-one called
10626 (pseudo)fork while the regexp engine had re-entered itself.
10628 #ifdef PERL_OLD_COPY_ON_WRITE
10629 new_state->re_state_nrs
10630 = sv_dup(old_state->re_state_nrs, param);
10632 new_state->re_state_reg_magic
10633 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10635 new_state->re_state_reg_oldcurpm
10636 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10638 new_state->re_state_reg_curpm
10639 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10641 new_state->re_state_reg_oldsaved
10642 = pv_dup(old_state->re_state_reg_oldsaved);
10643 new_state->re_state_reg_poscache
10644 = pv_dup(old_state->re_state_reg_poscache);
10645 new_state->re_state_reg_starttry
10646 = pv_dup(old_state->re_state_reg_starttry);
10649 case SAVEt_COMPILE_WARNINGS:
10650 ptr = POPPTR(ss,ix);
10651 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10655 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10663 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10664 * flag to the result. This is done for each stash before cloning starts,
10665 * so we know which stashes want their objects cloned */
10668 do_mark_cloneable_stash(pTHX_ SV *sv)
10670 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10672 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10673 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10674 if (cloner && GvCV(cloner)) {
10681 XPUSHs(sv_2mortal(newSVhek(hvname)));
10683 call_sv((SV*)GvCV(cloner), G_SCALAR);
10690 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10698 =for apidoc perl_clone
10700 Create and return a new interpreter by cloning the current one.
10702 perl_clone takes these flags as parameters:
10704 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10705 without it we only clone the data and zero the stacks,
10706 with it we copy the stacks and the new perl interpreter is
10707 ready to run at the exact same point as the previous one.
10708 The pseudo-fork code uses COPY_STACKS while the
10709 threads->new doesn't.
10711 CLONEf_KEEP_PTR_TABLE
10712 perl_clone keeps a ptr_table with the pointer of the old
10713 variable as a key and the new variable as a value,
10714 this allows it to check if something has been cloned and not
10715 clone it again but rather just use the value and increase the
10716 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10717 the ptr_table using the function
10718 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10719 reason to keep it around is if you want to dup some of your own
10720 variable who are outside the graph perl scans, example of this
10721 code is in threads.xs create
10724 This is a win32 thing, it is ignored on unix, it tells perls
10725 win32host code (which is c++) to clone itself, this is needed on
10726 win32 if you want to run two threads at the same time,
10727 if you just want to do some stuff in a separate perl interpreter
10728 and then throw it away and return to the original one,
10729 you don't need to do anything.
10734 /* XXX the above needs expanding by someone who actually understands it ! */
10735 EXTERN_C PerlInterpreter *
10736 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10739 perl_clone(PerlInterpreter *proto_perl, UV flags)
10742 #ifdef PERL_IMPLICIT_SYS
10744 /* perlhost.h so we need to call into it
10745 to clone the host, CPerlHost should have a c interface, sky */
10747 if (flags & CLONEf_CLONE_HOST) {
10748 return perl_clone_host(proto_perl,flags);
10750 return perl_clone_using(proto_perl, flags,
10752 proto_perl->IMemShared,
10753 proto_perl->IMemParse,
10755 proto_perl->IStdIO,
10759 proto_perl->IProc);
10763 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10764 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10765 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10766 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10767 struct IPerlDir* ipD, struct IPerlSock* ipS,
10768 struct IPerlProc* ipP)
10770 /* XXX many of the string copies here can be optimized if they're
10771 * constants; they need to be allocated as common memory and just
10772 * their pointers copied. */
10775 CLONE_PARAMS clone_params;
10776 CLONE_PARAMS* const param = &clone_params;
10778 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10779 /* for each stash, determine whether its objects should be cloned */
10780 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10781 PERL_SET_THX(my_perl);
10784 PoisonNew(my_perl, 1, PerlInterpreter);
10790 PL_savestack_ix = 0;
10791 PL_savestack_max = -1;
10792 PL_sig_pending = 0;
10793 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10794 # else /* !DEBUGGING */
10795 Zero(my_perl, 1, PerlInterpreter);
10796 # endif /* DEBUGGING */
10798 /* host pointers */
10800 PL_MemShared = ipMS;
10801 PL_MemParse = ipMP;
10808 #else /* !PERL_IMPLICIT_SYS */
10810 CLONE_PARAMS clone_params;
10811 CLONE_PARAMS* param = &clone_params;
10812 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10813 /* for each stash, determine whether its objects should be cloned */
10814 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10815 PERL_SET_THX(my_perl);
10818 PoisonNew(my_perl, 1, PerlInterpreter);
10824 PL_savestack_ix = 0;
10825 PL_savestack_max = -1;
10826 PL_sig_pending = 0;
10827 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10828 # else /* !DEBUGGING */
10829 Zero(my_perl, 1, PerlInterpreter);
10830 # endif /* DEBUGGING */
10831 #endif /* PERL_IMPLICIT_SYS */
10832 param->flags = flags;
10833 param->proto_perl = proto_perl;
10835 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10837 PL_body_arenas = NULL;
10838 Zero(&PL_body_roots, 1, PL_body_roots);
10840 PL_nice_chunk = NULL;
10841 PL_nice_chunk_size = 0;
10843 PL_sv_objcount = 0;
10845 PL_sv_arenaroot = NULL;
10847 PL_debug = proto_perl->Idebug;
10849 PL_hash_seed = proto_perl->Ihash_seed;
10850 PL_rehash_seed = proto_perl->Irehash_seed;
10852 #ifdef USE_REENTRANT_API
10853 /* XXX: things like -Dm will segfault here in perlio, but doing
10854 * PERL_SET_CONTEXT(proto_perl);
10855 * breaks too many other things
10857 Perl_reentrant_init(aTHX);
10860 /* create SV map for pointer relocation */
10861 PL_ptr_table = ptr_table_new();
10863 /* initialize these special pointers as early as possible */
10864 SvANY(&PL_sv_undef) = NULL;
10865 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10866 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10867 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10869 SvANY(&PL_sv_no) = new_XPVNV();
10870 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10871 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10872 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10873 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10874 SvCUR_set(&PL_sv_no, 0);
10875 SvLEN_set(&PL_sv_no, 1);
10876 SvIV_set(&PL_sv_no, 0);
10877 SvNV_set(&PL_sv_no, 0);
10878 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10880 SvANY(&PL_sv_yes) = new_XPVNV();
10881 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10882 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10883 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10884 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10885 SvCUR_set(&PL_sv_yes, 1);
10886 SvLEN_set(&PL_sv_yes, 2);
10887 SvIV_set(&PL_sv_yes, 1);
10888 SvNV_set(&PL_sv_yes, 1);
10889 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10891 /* create (a non-shared!) shared string table */
10892 PL_strtab = newHV();
10893 HvSHAREKEYS_off(PL_strtab);
10894 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10895 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10897 PL_compiling = proto_perl->Icompiling;
10899 /* These two PVs will be free'd special way so must set them same way op.c does */
10900 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10901 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10903 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10904 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10906 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10907 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10908 if (PL_compiling.cop_hints_hash) {
10910 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10911 HINTS_REFCNT_UNLOCK;
10913 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10915 /* pseudo environmental stuff */
10916 PL_origargc = proto_perl->Iorigargc;
10917 PL_origargv = proto_perl->Iorigargv;
10919 param->stashes = newAV(); /* Setup array of objects to call clone on */
10921 /* Set tainting stuff before PerlIO_debug can possibly get called */
10922 PL_tainting = proto_perl->Itainting;
10923 PL_taint_warn = proto_perl->Itaint_warn;
10925 #ifdef PERLIO_LAYERS
10926 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10927 PerlIO_clone(aTHX_ proto_perl, param);
10930 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10931 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10932 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10933 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10934 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10935 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10938 PL_minus_c = proto_perl->Iminus_c;
10939 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10940 PL_localpatches = proto_perl->Ilocalpatches;
10941 PL_splitstr = proto_perl->Isplitstr;
10942 PL_preprocess = proto_perl->Ipreprocess;
10943 PL_minus_n = proto_perl->Iminus_n;
10944 PL_minus_p = proto_perl->Iminus_p;
10945 PL_minus_l = proto_perl->Iminus_l;
10946 PL_minus_a = proto_perl->Iminus_a;
10947 PL_minus_E = proto_perl->Iminus_E;
10948 PL_minus_F = proto_perl->Iminus_F;
10949 PL_doswitches = proto_perl->Idoswitches;
10950 PL_dowarn = proto_perl->Idowarn;
10951 PL_doextract = proto_perl->Idoextract;
10952 PL_sawampersand = proto_perl->Isawampersand;
10953 PL_unsafe = proto_perl->Iunsafe;
10954 PL_inplace = SAVEPV(proto_perl->Iinplace);
10955 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10956 PL_perldb = proto_perl->Iperldb;
10957 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10958 PL_exit_flags = proto_perl->Iexit_flags;
10960 /* magical thingies */
10961 /* XXX time(&PL_basetime) when asked for? */
10962 PL_basetime = proto_perl->Ibasetime;
10963 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10965 PL_maxsysfd = proto_perl->Imaxsysfd;
10966 PL_statusvalue = proto_perl->Istatusvalue;
10968 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10970 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10972 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10974 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10975 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10976 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10979 /* RE engine related */
10980 Zero(&PL_reg_state, 1, struct re_save_state);
10981 PL_reginterp_cnt = 0;
10982 PL_regmatch_slab = NULL;
10984 /* Clone the regex array */
10985 PL_regex_padav = newAV();
10987 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10988 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10990 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10991 for(i = 1; i <= len; i++) {
10992 const SV * const regex = regexen[i];
10995 ? sv_dup_inc(regex, param)
10997 newSViv(PTR2IV(re_dup(
10998 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11000 av_push(PL_regex_padav, sv);
11003 PL_regex_pad = AvARRAY(PL_regex_padav);
11005 /* shortcuts to various I/O objects */
11006 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11007 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11008 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11009 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11010 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11011 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11013 /* shortcuts to regexp stuff */
11014 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11016 /* shortcuts to misc objects */
11017 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11019 /* shortcuts to debugging objects */
11020 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11021 PL_DBline = gv_dup(proto_perl->IDBline, param);
11022 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11023 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11024 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11025 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11026 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11027 PL_lineary = av_dup(proto_perl->Ilineary, param);
11028 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11030 /* symbol tables */
11031 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11032 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11033 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11034 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11035 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11037 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11038 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11039 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11040 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11041 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11042 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11043 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11044 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11046 PL_sub_generation = proto_perl->Isub_generation;
11048 /* funky return mechanisms */
11049 PL_forkprocess = proto_perl->Iforkprocess;
11051 /* subprocess state */
11052 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11054 /* internal state */
11055 PL_maxo = proto_perl->Imaxo;
11056 if (proto_perl->Iop_mask)
11057 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11060 /* PL_asserting = proto_perl->Iasserting; */
11062 /* current interpreter roots */
11063 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11064 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11065 PL_main_start = proto_perl->Imain_start;
11066 PL_eval_root = proto_perl->Ieval_root;
11067 PL_eval_start = proto_perl->Ieval_start;
11069 /* runtime control stuff */
11070 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11071 PL_copline = proto_perl->Icopline;
11073 PL_filemode = proto_perl->Ifilemode;
11074 PL_lastfd = proto_perl->Ilastfd;
11075 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11078 PL_gensym = proto_perl->Igensym;
11079 PL_preambled = proto_perl->Ipreambled;
11080 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11081 PL_laststatval = proto_perl->Ilaststatval;
11082 PL_laststype = proto_perl->Ilaststype;
11085 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11087 /* interpreter atexit processing */
11088 PL_exitlistlen = proto_perl->Iexitlistlen;
11089 if (PL_exitlistlen) {
11090 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11091 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11094 PL_exitlist = (PerlExitListEntry*)NULL;
11096 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11097 if (PL_my_cxt_size) {
11098 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11099 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11102 PL_my_cxt_list = (void**)NULL;
11103 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11104 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11105 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11107 PL_profiledata = NULL;
11108 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11109 /* PL_rsfp_filters entries have fake IoDIRP() */
11110 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11112 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11114 PAD_CLONE_VARS(proto_perl, param);
11116 #ifdef HAVE_INTERP_INTERN
11117 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11120 /* more statics moved here */
11121 PL_generation = proto_perl->Igeneration;
11122 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11124 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11125 PL_in_clean_all = proto_perl->Iin_clean_all;
11127 PL_uid = proto_perl->Iuid;
11128 PL_euid = proto_perl->Ieuid;
11129 PL_gid = proto_perl->Igid;
11130 PL_egid = proto_perl->Iegid;
11131 PL_nomemok = proto_perl->Inomemok;
11132 PL_an = proto_perl->Ian;
11133 PL_evalseq = proto_perl->Ievalseq;
11134 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11135 PL_origalen = proto_perl->Iorigalen;
11136 #ifdef PERL_USES_PL_PIDSTATUS
11137 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11139 PL_osname = SAVEPV(proto_perl->Iosname);
11140 PL_sighandlerp = proto_perl->Isighandlerp;
11142 PL_runops = proto_perl->Irunops;
11144 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11147 PL_cshlen = proto_perl->Icshlen;
11148 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11151 PL_lex_state = proto_perl->Ilex_state;
11152 PL_lex_defer = proto_perl->Ilex_defer;
11153 PL_lex_expect = proto_perl->Ilex_expect;
11154 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11155 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11156 PL_lex_starts = proto_perl->Ilex_starts;
11157 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11158 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11159 PL_lex_op = proto_perl->Ilex_op;
11160 PL_lex_inpat = proto_perl->Ilex_inpat;
11161 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11162 PL_lex_brackets = proto_perl->Ilex_brackets;
11163 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11164 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11165 PL_lex_casemods = proto_perl->Ilex_casemods;
11166 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11167 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11170 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11171 PL_lasttoke = proto_perl->Ilasttoke;
11172 PL_realtokenstart = proto_perl->Irealtokenstart;
11173 PL_faketokens = proto_perl->Ifaketokens;
11174 PL_thismad = proto_perl->Ithismad;
11175 PL_thistoken = proto_perl->Ithistoken;
11176 PL_thisopen = proto_perl->Ithisopen;
11177 PL_thisstuff = proto_perl->Ithisstuff;
11178 PL_thisclose = proto_perl->Ithisclose;
11179 PL_thiswhite = proto_perl->Ithiswhite;
11180 PL_nextwhite = proto_perl->Inextwhite;
11181 PL_skipwhite = proto_perl->Iskipwhite;
11182 PL_endwhite = proto_perl->Iendwhite;
11183 PL_curforce = proto_perl->Icurforce;
11185 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11186 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11187 PL_nexttoke = proto_perl->Inexttoke;
11190 /* XXX This is probably masking the deeper issue of why
11191 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11192 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11193 * (A little debugging with a watchpoint on it may help.)
11195 if (SvANY(proto_perl->Ilinestr)) {
11196 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11197 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11198 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11199 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11200 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11201 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11202 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11203 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11204 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11207 PL_linestr = newSV(79);
11208 sv_upgrade(PL_linestr,SVt_PVIV);
11209 sv_setpvn(PL_linestr,"",0);
11210 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11212 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11213 PL_pending_ident = proto_perl->Ipending_ident;
11214 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11216 PL_expect = proto_perl->Iexpect;
11218 PL_multi_start = proto_perl->Imulti_start;
11219 PL_multi_end = proto_perl->Imulti_end;
11220 PL_multi_open = proto_perl->Imulti_open;
11221 PL_multi_close = proto_perl->Imulti_close;
11223 PL_error_count = proto_perl->Ierror_count;
11224 PL_subline = proto_perl->Isubline;
11225 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11227 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11228 if (SvANY(proto_perl->Ilinestr)) {
11229 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11230 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11231 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11232 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11233 PL_last_lop_op = proto_perl->Ilast_lop_op;
11236 PL_last_uni = SvPVX(PL_linestr);
11237 PL_last_lop = SvPVX(PL_linestr);
11238 PL_last_lop_op = 0;
11240 PL_in_my = proto_perl->Iin_my;
11241 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11243 PL_cryptseen = proto_perl->Icryptseen;
11246 PL_hints = proto_perl->Ihints;
11248 PL_amagic_generation = proto_perl->Iamagic_generation;
11250 #ifdef USE_LOCALE_COLLATE
11251 PL_collation_ix = proto_perl->Icollation_ix;
11252 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11253 PL_collation_standard = proto_perl->Icollation_standard;
11254 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11255 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11256 #endif /* USE_LOCALE_COLLATE */
11258 #ifdef USE_LOCALE_NUMERIC
11259 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11260 PL_numeric_standard = proto_perl->Inumeric_standard;
11261 PL_numeric_local = proto_perl->Inumeric_local;
11262 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11263 #endif /* !USE_LOCALE_NUMERIC */
11265 /* utf8 character classes */
11266 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11267 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11268 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11269 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11270 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11271 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11272 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11273 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11274 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11275 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11276 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11277 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11278 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11279 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11280 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11281 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11282 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11283 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11284 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11285 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11287 /* Did the locale setup indicate UTF-8? */
11288 PL_utf8locale = proto_perl->Iutf8locale;
11289 /* Unicode features (see perlrun/-C) */
11290 PL_unicode = proto_perl->Iunicode;
11292 /* Pre-5.8 signals control */
11293 PL_signals = proto_perl->Isignals;
11295 /* times() ticks per second */
11296 PL_clocktick = proto_perl->Iclocktick;
11298 /* Recursion stopper for PerlIO_find_layer */
11299 PL_in_load_module = proto_perl->Iin_load_module;
11301 /* sort() routine */
11302 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11304 /* Not really needed/useful since the reenrant_retint is "volatile",
11305 * but do it for consistency's sake. */
11306 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11308 /* Hooks to shared SVs and locks. */
11309 PL_sharehook = proto_perl->Isharehook;
11310 PL_lockhook = proto_perl->Ilockhook;
11311 PL_unlockhook = proto_perl->Iunlockhook;
11312 PL_threadhook = proto_perl->Ithreadhook;
11314 PL_runops_std = proto_perl->Irunops_std;
11315 PL_runops_dbg = proto_perl->Irunops_dbg;
11317 #ifdef THREADS_HAVE_PIDS
11318 PL_ppid = proto_perl->Ippid;
11322 PL_last_swash_hv = NULL; /* reinits on demand */
11323 PL_last_swash_klen = 0;
11324 PL_last_swash_key[0]= '\0';
11325 PL_last_swash_tmps = (U8*)NULL;
11326 PL_last_swash_slen = 0;
11328 PL_glob_index = proto_perl->Iglob_index;
11329 PL_srand_called = proto_perl->Isrand_called;
11330 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11331 PL_bitcount = NULL; /* reinits on demand */
11333 if (proto_perl->Ipsig_pend) {
11334 Newxz(PL_psig_pend, SIG_SIZE, int);
11337 PL_psig_pend = (int*)NULL;
11340 if (proto_perl->Ipsig_ptr) {
11341 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11342 Newxz(PL_psig_name, SIG_SIZE, SV*);
11343 for (i = 1; i < SIG_SIZE; i++) {
11344 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11345 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11349 PL_psig_ptr = (SV**)NULL;
11350 PL_psig_name = (SV**)NULL;
11353 /* thrdvar.h stuff */
11355 if (flags & CLONEf_COPY_STACKS) {
11356 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11357 PL_tmps_ix = proto_perl->Ttmps_ix;
11358 PL_tmps_max = proto_perl->Ttmps_max;
11359 PL_tmps_floor = proto_perl->Ttmps_floor;
11360 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11362 while (i <= PL_tmps_ix) {
11363 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11367 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11368 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11369 Newxz(PL_markstack, i, I32);
11370 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11371 - proto_perl->Tmarkstack);
11372 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11373 - proto_perl->Tmarkstack);
11374 Copy(proto_perl->Tmarkstack, PL_markstack,
11375 PL_markstack_ptr - PL_markstack + 1, I32);
11377 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11378 * NOTE: unlike the others! */
11379 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11380 PL_scopestack_max = proto_perl->Tscopestack_max;
11381 Newxz(PL_scopestack, PL_scopestack_max, I32);
11382 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11384 /* NOTE: si_dup() looks at PL_markstack */
11385 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11387 /* PL_curstack = PL_curstackinfo->si_stack; */
11388 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11389 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11391 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11392 PL_stack_base = AvARRAY(PL_curstack);
11393 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11394 - proto_perl->Tstack_base);
11395 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11397 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11398 * NOTE: unlike the others! */
11399 PL_savestack_ix = proto_perl->Tsavestack_ix;
11400 PL_savestack_max = proto_perl->Tsavestack_max;
11401 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11402 PL_savestack = ss_dup(proto_perl, param);
11406 ENTER; /* perl_destruct() wants to LEAVE; */
11408 /* although we're not duplicating the tmps stack, we should still
11409 * add entries for any SVs on the tmps stack that got cloned by a
11410 * non-refcount means (eg a temp in @_); otherwise they will be
11413 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11414 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11415 proto_perl->Ttmps_stack[i]);
11416 if (nsv && !SvREFCNT(nsv)) {
11418 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11423 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11424 PL_top_env = &PL_start_env;
11426 PL_op = proto_perl->Top;
11429 PL_Xpv = (XPV*)NULL;
11430 PL_na = proto_perl->Tna;
11432 PL_statbuf = proto_perl->Tstatbuf;
11433 PL_statcache = proto_perl->Tstatcache;
11434 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11435 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11437 PL_timesbuf = proto_perl->Ttimesbuf;
11440 PL_tainted = proto_perl->Ttainted;
11441 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11442 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11443 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11444 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11445 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11446 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11447 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11448 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11449 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11451 PL_restartop = proto_perl->Trestartop;
11452 PL_in_eval = proto_perl->Tin_eval;
11453 PL_delaymagic = proto_perl->Tdelaymagic;
11454 PL_dirty = proto_perl->Tdirty;
11455 PL_localizing = proto_perl->Tlocalizing;
11457 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11458 PL_hv_fetch_ent_mh = NULL;
11459 PL_modcount = proto_perl->Tmodcount;
11460 PL_lastgotoprobe = NULL;
11461 PL_dumpindent = proto_perl->Tdumpindent;
11463 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11464 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11465 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11466 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11467 PL_efloatbuf = NULL; /* reinits on demand */
11468 PL_efloatsize = 0; /* reinits on demand */
11472 PL_screamfirst = NULL;
11473 PL_screamnext = NULL;
11474 PL_maxscream = -1; /* reinits on demand */
11475 PL_lastscream = NULL;
11477 PL_watchaddr = NULL;
11480 PL_regdummy = proto_perl->Tregdummy;
11481 PL_colorset = 0; /* reinits PL_colors[] */
11482 /*PL_colors[6] = {0,0,0,0,0,0};*/
11486 /* Pluggable optimizer */
11487 PL_peepp = proto_perl->Tpeepp;
11489 PL_stashcache = newHV();
11491 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11492 ptr_table_free(PL_ptr_table);
11493 PL_ptr_table = NULL;
11496 /* Call the ->CLONE method, if it exists, for each of the stashes
11497 identified by sv_dup() above.
11499 while(av_len(param->stashes) != -1) {
11500 HV* const stash = (HV*) av_shift(param->stashes);
11501 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11502 if (cloner && GvCV(cloner)) {
11507 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11509 call_sv((SV*)GvCV(cloner), G_DISCARD);
11515 SvREFCNT_dec(param->stashes);
11517 /* orphaned? eg threads->new inside BEGIN or use */
11518 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11519 SvREFCNT_inc_simple_void(PL_compcv);
11520 SAVEFREESV(PL_compcv);
11526 #endif /* USE_ITHREADS */
11529 =head1 Unicode Support
11531 =for apidoc sv_recode_to_utf8
11533 The encoding is assumed to be an Encode object, on entry the PV
11534 of the sv is assumed to be octets in that encoding, and the sv
11535 will be converted into Unicode (and UTF-8).
11537 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11538 is not a reference, nothing is done to the sv. If the encoding is not
11539 an C<Encode::XS> Encoding object, bad things will happen.
11540 (See F<lib/encoding.pm> and L<Encode>).
11542 The PV of the sv is returned.
11547 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11550 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11564 Passing sv_yes is wrong - it needs to be or'ed set of constants
11565 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11566 remove converted chars from source.
11568 Both will default the value - let them.
11570 XPUSHs(&PL_sv_yes);
11573 call_method("decode", G_SCALAR);
11577 s = SvPV_const(uni, len);
11578 if (s != SvPVX_const(sv)) {
11579 SvGROW(sv, len + 1);
11580 Move(s, SvPVX(sv), len + 1, char);
11581 SvCUR_set(sv, len);
11588 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11592 =for apidoc sv_cat_decode
11594 The encoding is assumed to be an Encode object, the PV of the ssv is
11595 assumed to be octets in that encoding and decoding the input starts
11596 from the position which (PV + *offset) pointed to. The dsv will be
11597 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11598 when the string tstr appears in decoding output or the input ends on
11599 the PV of the ssv. The value which the offset points will be modified
11600 to the last input position on the ssv.
11602 Returns TRUE if the terminator was found, else returns FALSE.
11607 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11608 SV *ssv, int *offset, char *tstr, int tlen)
11612 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11623 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11624 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11626 call_method("cat_decode", G_SCALAR);
11628 ret = SvTRUE(TOPs);
11629 *offset = SvIV(offsv);
11635 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11640 /* ---------------------------------------------------------------------
11642 * support functions for report_uninit()
11645 /* the maxiumum size of array or hash where we will scan looking
11646 * for the undefined element that triggered the warning */
11648 #define FUV_MAX_SEARCH_SIZE 1000
11650 /* Look for an entry in the hash whose value has the same SV as val;
11651 * If so, return a mortal copy of the key. */
11654 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11657 register HE **array;
11660 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11661 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11664 array = HvARRAY(hv);
11666 for (i=HvMAX(hv); i>0; i--) {
11667 register HE *entry;
11668 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11669 if (HeVAL(entry) != val)
11671 if ( HeVAL(entry) == &PL_sv_undef ||
11672 HeVAL(entry) == &PL_sv_placeholder)
11676 if (HeKLEN(entry) == HEf_SVKEY)
11677 return sv_mortalcopy(HeKEY_sv(entry));
11678 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11684 /* Look for an entry in the array whose value has the same SV as val;
11685 * If so, return the index, otherwise return -1. */
11688 S_find_array_subscript(pTHX_ AV *av, SV* val)
11691 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11692 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11695 if (val != &PL_sv_undef) {
11696 SV ** const svp = AvARRAY(av);
11699 for (i=AvFILLp(av); i>=0; i--)
11706 /* S_varname(): return the name of a variable, optionally with a subscript.
11707 * If gv is non-zero, use the name of that global, along with gvtype (one
11708 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11709 * targ. Depending on the value of the subscript_type flag, return:
11712 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11713 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11714 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11715 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11718 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11719 SV* keyname, I32 aindex, int subscript_type)
11722 SV * const name = sv_newmortal();
11725 buffer[0] = gvtype;
11728 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11730 gv_fullname4(name, gv, buffer, 0);
11732 if ((unsigned int)SvPVX(name)[1] <= 26) {
11734 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11736 /* Swap the 1 unprintable control character for the 2 byte pretty
11737 version - ie substr($name, 1, 1) = $buffer; */
11738 sv_insert(name, 1, 1, buffer, 2);
11743 CV * const cv = find_runcv(&unused);
11747 if (!cv || !CvPADLIST(cv))
11749 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11750 sv = *av_fetch(av, targ, FALSE);
11751 /* SvLEN in a pad name is not to be trusted */
11752 sv_setpv(name, SvPV_nolen_const(sv));
11755 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11756 SV * const sv = newSV(0);
11757 *SvPVX(name) = '$';
11758 Perl_sv_catpvf(aTHX_ name, "{%s}",
11759 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11762 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11763 *SvPVX(name) = '$';
11764 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11766 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11767 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11774 =for apidoc find_uninit_var
11776 Find the name of the undefined variable (if any) that caused the operator o
11777 to issue a "Use of uninitialized value" warning.
11778 If match is true, only return a name if it's value matches uninit_sv.
11779 So roughly speaking, if a unary operator (such as OP_COS) generates a
11780 warning, then following the direct child of the op may yield an
11781 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11782 other hand, with OP_ADD there are two branches to follow, so we only print
11783 the variable name if we get an exact match.
11785 The name is returned as a mortal SV.
11787 Assumes that PL_op is the op that originally triggered the error, and that
11788 PL_comppad/PL_curpad points to the currently executing pad.
11794 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11802 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11803 uninit_sv == &PL_sv_placeholder)))
11806 switch (obase->op_type) {
11813 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11814 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11817 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11819 if (pad) { /* @lex, %lex */
11820 sv = PAD_SVl(obase->op_targ);
11824 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11825 /* @global, %global */
11826 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11829 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11831 else /* @{expr}, %{expr} */
11832 return find_uninit_var(cUNOPx(obase)->op_first,
11836 /* attempt to find a match within the aggregate */
11838 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11840 subscript_type = FUV_SUBSCRIPT_HASH;
11843 index = find_array_subscript((AV*)sv, uninit_sv);
11845 subscript_type = FUV_SUBSCRIPT_ARRAY;
11848 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11851 return varname(gv, hash ? '%' : '@', obase->op_targ,
11852 keysv, index, subscript_type);
11856 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11858 return varname(NULL, '$', obase->op_targ,
11859 NULL, 0, FUV_SUBSCRIPT_NONE);
11862 gv = cGVOPx_gv(obase);
11863 if (!gv || (match && GvSV(gv) != uninit_sv))
11865 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11868 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11871 av = (AV*)PAD_SV(obase->op_targ);
11872 if (!av || SvRMAGICAL(av))
11874 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11875 if (!svp || *svp != uninit_sv)
11878 return varname(NULL, '$', obase->op_targ,
11879 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11882 gv = cGVOPx_gv(obase);
11888 if (!av || SvRMAGICAL(av))
11890 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11891 if (!svp || *svp != uninit_sv)
11894 return varname(gv, '$', 0,
11895 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11900 o = cUNOPx(obase)->op_first;
11901 if (!o || o->op_type != OP_NULL ||
11902 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11904 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11908 if (PL_op == obase)
11909 /* $a[uninit_expr] or $h{uninit_expr} */
11910 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11913 o = cBINOPx(obase)->op_first;
11914 kid = cBINOPx(obase)->op_last;
11916 /* get the av or hv, and optionally the gv */
11918 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11919 sv = PAD_SV(o->op_targ);
11921 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11922 && cUNOPo->op_first->op_type == OP_GV)
11924 gv = cGVOPx_gv(cUNOPo->op_first);
11927 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11932 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11933 /* index is constant */
11937 if (obase->op_type == OP_HELEM) {
11938 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11939 if (!he || HeVAL(he) != uninit_sv)
11943 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11944 if (!svp || *svp != uninit_sv)
11948 if (obase->op_type == OP_HELEM)
11949 return varname(gv, '%', o->op_targ,
11950 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11952 return varname(gv, '@', o->op_targ, NULL,
11953 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11956 /* index is an expression;
11957 * attempt to find a match within the aggregate */
11958 if (obase->op_type == OP_HELEM) {
11959 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11961 return varname(gv, '%', o->op_targ,
11962 keysv, 0, FUV_SUBSCRIPT_HASH);
11965 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11967 return varname(gv, '@', o->op_targ,
11968 NULL, index, FUV_SUBSCRIPT_ARRAY);
11973 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11975 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11980 /* only examine RHS */
11981 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11984 o = cUNOPx(obase)->op_first;
11985 if (o->op_type == OP_PUSHMARK)
11988 if (!o->op_sibling) {
11989 /* one-arg version of open is highly magical */
11991 if (o->op_type == OP_GV) { /* open FOO; */
11993 if (match && GvSV(gv) != uninit_sv)
11995 return varname(gv, '$', 0,
11996 NULL, 0, FUV_SUBSCRIPT_NONE);
11998 /* other possibilities not handled are:
11999 * open $x; or open my $x; should return '${*$x}'
12000 * open expr; should return '$'.expr ideally
12006 /* ops where $_ may be an implicit arg */
12010 if ( !(obase->op_flags & OPf_STACKED)) {
12011 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12012 ? PAD_SVl(obase->op_targ)
12015 sv = sv_newmortal();
12016 sv_setpvn(sv, "$_", 2);
12024 /* skip filehandle as it can't produce 'undef' warning */
12025 o = cUNOPx(obase)->op_first;
12026 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12027 o = o->op_sibling->op_sibling;
12034 match = 1; /* XS or custom code could trigger random warnings */
12039 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12040 return sv_2mortal(newSVpvs("${$/}"));
12045 if (!(obase->op_flags & OPf_KIDS))
12047 o = cUNOPx(obase)->op_first;
12053 /* if all except one arg are constant, or have no side-effects,
12054 * or are optimized away, then it's unambiguous */
12056 for (kid=o; kid; kid = kid->op_sibling) {
12058 const OPCODE type = kid->op_type;
12059 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12060 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12061 || (type == OP_PUSHMARK)
12065 if (o2) { /* more than one found */
12072 return find_uninit_var(o2, uninit_sv, match);
12074 /* scan all args */
12076 sv = find_uninit_var(o, uninit_sv, 1);
12088 =for apidoc report_uninit
12090 Print appropriate "Use of uninitialized variable" warning
12096 Perl_report_uninit(pTHX_ SV* uninit_sv)
12100 SV* varname = NULL;
12102 varname = find_uninit_var(PL_op, uninit_sv,0);
12104 sv_insert(varname, 0, 0, " ", 1);
12106 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12107 varname ? SvPV_nolen_const(varname) : "",
12108 " in ", OP_DESC(PL_op));
12111 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12117 * c-indentation-style: bsd
12118 * c-basic-offset: 4
12119 * indent-tabs-mode: t
12122 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob