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 = *((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 /* Could put this in the else clause below, as PVMG must have SvPVX
1281 0 already (the assertion above) */
1284 if (old_type >= SVt_PVMG) {
1285 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1286 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 /* XXX Is this still needed? Was it ever needed? Surely as there is
1293 no route from NV to PVIV, NOK can never be true */
1294 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = saferealloc(s, newlen);
1456 s = safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 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));
1855 if (SvNVX(sv) < (NV)IV_MIN) {
1856 (void)SvIOKp_on(sv);
1858 SvIV_set(sv, IV_MIN);
1859 return IS_NUMBER_UNDERFLOW_IV;
1861 if (SvNVX(sv) > (NV)UV_MAX) {
1862 (void)SvIOKp_on(sv);
1865 SvUV_set(sv, UV_MAX);
1866 return IS_NUMBER_OVERFLOW_UV;
1868 (void)SvIOKp_on(sv);
1870 /* Can't use strtol etc to convert this string. (See truth table in
1872 if (SvNVX(sv) <= (UV)IV_MAX) {
1873 SvIV_set(sv, I_V(SvNVX(sv)));
1874 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1875 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1877 /* Integer is imprecise. NOK, IOKp */
1879 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1882 SvUV_set(sv, U_V(SvNVX(sv)));
1883 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1884 if (SvUVX(sv) == UV_MAX) {
1885 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1886 possibly be preserved by NV. Hence, it must be overflow.
1888 return IS_NUMBER_OVERFLOW_UV;
1890 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1892 /* Integer is imprecise. NOK, IOKp */
1894 return IS_NUMBER_OVERFLOW_IV;
1896 #endif /* !NV_PRESERVES_UV*/
1899 S_sv_2iuv_common(pTHX_ SV *sv) {
1902 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1903 * without also getting a cached IV/UV from it at the same time
1904 * (ie PV->NV conversion should detect loss of accuracy and cache
1905 * IV or UV at same time to avoid this. */
1906 /* IV-over-UV optimisation - choose to cache IV if possible */
1908 if (SvTYPE(sv) == SVt_NV)
1909 sv_upgrade(sv, SVt_PVNV);
1911 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1912 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1913 certainly cast into the IV range at IV_MAX, whereas the correct
1914 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1916 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1917 if (Perl_isnan(SvNVX(sv))) {
1923 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1924 SvIV_set(sv, I_V(SvNVX(sv)));
1925 if (SvNVX(sv) == (NV) SvIVX(sv)
1926 #ifndef NV_PRESERVES_UV
1927 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1928 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1929 /* Don't flag it as "accurately an integer" if the number
1930 came from a (by definition imprecise) NV operation, and
1931 we're outside the range of NV integer precision */
1934 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1935 DEBUG_c(PerlIO_printf(Perl_debug_log,
1936 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1942 /* IV not precise. No need to convert from PV, as NV
1943 conversion would already have cached IV if it detected
1944 that PV->IV would be better than PV->NV->IV
1945 flags already correct - don't set public IOK. */
1946 DEBUG_c(PerlIO_printf(Perl_debug_log,
1947 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1952 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1953 but the cast (NV)IV_MIN rounds to a the value less (more
1954 negative) than IV_MIN which happens to be equal to SvNVX ??
1955 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1956 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1957 (NV)UVX == NVX are both true, but the values differ. :-(
1958 Hopefully for 2s complement IV_MIN is something like
1959 0x8000000000000000 which will be exact. NWC */
1962 SvUV_set(sv, U_V(SvNVX(sv)));
1964 (SvNVX(sv) == (NV) SvUVX(sv))
1965 #ifndef NV_PRESERVES_UV
1966 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1967 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1968 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1969 /* Don't flag it as "accurately an integer" if the number
1970 came from a (by definition imprecise) NV operation, and
1971 we're outside the range of NV integer precision */
1976 DEBUG_c(PerlIO_printf(Perl_debug_log,
1977 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1983 else if (SvPOKp(sv) && SvLEN(sv)) {
1985 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1986 /* We want to avoid a possible problem when we cache an IV/ a UV which
1987 may be later translated to an NV, and the resulting NV is not
1988 the same as the direct translation of the initial string
1989 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1990 be careful to ensure that the value with the .456 is around if the
1991 NV value is requested in the future).
1993 This means that if we cache such an IV/a UV, we need to cache the
1994 NV as well. Moreover, we trade speed for space, and do not
1995 cache the NV if we are sure it's not needed.
1998 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer, only upgrade to PVIV */
2002 if (SvTYPE(sv) < SVt_PVIV)
2003 sv_upgrade(sv, SVt_PVIV);
2005 } else if (SvTYPE(sv) < SVt_PVNV)
2006 sv_upgrade(sv, SVt_PVNV);
2008 /* If NVs preserve UVs then we only use the UV value if we know that
2009 we aren't going to call atof() below. If NVs don't preserve UVs
2010 then the value returned may have more precision than atof() will
2011 return, even though value isn't perfectly accurate. */
2012 if ((numtype & (IS_NUMBER_IN_UV
2013 #ifdef NV_PRESERVES_UV
2016 )) == IS_NUMBER_IN_UV) {
2017 /* This won't turn off the public IOK flag if it was set above */
2018 (void)SvIOKp_on(sv);
2020 if (!(numtype & IS_NUMBER_NEG)) {
2022 if (value <= (UV)IV_MAX) {
2023 SvIV_set(sv, (IV)value);
2025 /* it didn't overflow, and it was positive. */
2026 SvUV_set(sv, value);
2030 /* 2s complement assumption */
2031 if (value <= (UV)IV_MIN) {
2032 SvIV_set(sv, -(IV)value);
2034 /* Too negative for an IV. This is a double upgrade, but
2035 I'm assuming it will be rare. */
2036 if (SvTYPE(sv) < SVt_PVNV)
2037 sv_upgrade(sv, SVt_PVNV);
2041 SvNV_set(sv, -(NV)value);
2042 SvIV_set(sv, IV_MIN);
2046 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2047 will be in the previous block to set the IV slot, and the next
2048 block to set the NV slot. So no else here. */
2050 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2051 != IS_NUMBER_IN_UV) {
2052 /* It wasn't an (integer that doesn't overflow the UV). */
2053 SvNV_set(sv, Atof(SvPVX_const(sv)));
2055 if (! numtype && ckWARN(WARN_NUMERIC))
2058 #if defined(USE_LONG_DOUBLE)
2059 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2060 PTR2UV(sv), SvNVX(sv)));
2062 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2063 PTR2UV(sv), SvNVX(sv)));
2066 #ifdef NV_PRESERVES_UV
2067 (void)SvIOKp_on(sv);
2069 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2070 SvIV_set(sv, I_V(SvNVX(sv)));
2071 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2074 NOOP; /* Integer is imprecise. NOK, IOKp */
2076 /* UV will not work better than IV */
2078 if (SvNVX(sv) > (NV)UV_MAX) {
2080 /* Integer is inaccurate. NOK, IOKp, is UV */
2081 SvUV_set(sv, UV_MAX);
2083 SvUV_set(sv, U_V(SvNVX(sv)));
2084 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2085 NV preservse UV so can do correct comparison. */
2086 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2089 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2094 #else /* NV_PRESERVES_UV */
2095 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2096 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2097 /* The IV/UV slot will have been set from value returned by
2098 grok_number above. The NV slot has just been set using
2101 assert (SvIOKp(sv));
2103 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2104 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2105 /* Small enough to preserve all bits. */
2106 (void)SvIOKp_on(sv);
2108 SvIV_set(sv, I_V(SvNVX(sv)));
2109 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2111 /* Assumption: first non-preserved integer is < IV_MAX,
2112 this NV is in the preserved range, therefore: */
2113 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2115 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);
2119 0 0 already failed to read UV.
2120 0 1 already failed to read UV.
2121 1 0 you won't get here in this case. IV/UV
2122 slot set, public IOK, Atof() unneeded.
2123 1 1 already read UV.
2124 so there's no point in sv_2iuv_non_preserve() attempting
2125 to use atol, strtol, strtoul etc. */
2126 sv_2iuv_non_preserve (sv, numtype);
2129 #endif /* NV_PRESERVES_UV */
2133 if (isGV_with_GP(sv))
2134 return glob_2number((GV *)sv);
2136 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2137 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2140 if (SvTYPE(sv) < SVt_IV)
2141 /* Typically the caller expects that sv_any is not NULL now. */
2142 sv_upgrade(sv, SVt_IV);
2143 /* Return 0 from the caller. */
2150 =for apidoc sv_2iv_flags
2152 Return the integer value of an SV, doing any necessary string
2153 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2154 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2160 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2165 if (SvGMAGICAL(sv)) {
2166 if (flags & SV_GMAGIC)
2171 return I_V(SvNVX(sv));
2173 if (SvPOKp(sv) && SvLEN(sv)) {
2176 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2178 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2179 == IS_NUMBER_IN_UV) {
2180 /* It's definitely an integer */
2181 if (numtype & IS_NUMBER_NEG) {
2182 if (value < (UV)IV_MIN)
2185 if (value < (UV)IV_MAX)
2190 if (ckWARN(WARN_NUMERIC))
2193 return I_V(Atof(SvPVX_const(sv)));
2198 assert(SvTYPE(sv) >= SVt_PVMG);
2199 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2200 } else if (SvTHINKFIRST(sv)) {
2204 SV * const tmpstr=AMG_CALLun(sv,numer);
2205 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2206 return SvIV(tmpstr);
2209 return PTR2IV(SvRV(sv));
2212 sv_force_normal_flags(sv, 0);
2214 if (SvREADONLY(sv) && !SvOK(sv)) {
2215 if (ckWARN(WARN_UNINITIALIZED))
2221 if (S_sv_2iuv_common(aTHX_ sv))
2224 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2225 PTR2UV(sv),SvIVX(sv)));
2226 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2230 =for apidoc sv_2uv_flags
2232 Return the unsigned integer value of an SV, doing any necessary string
2233 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2234 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2240 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2245 if (SvGMAGICAL(sv)) {
2246 if (flags & SV_GMAGIC)
2251 return U_V(SvNVX(sv));
2252 if (SvPOKp(sv) && SvLEN(sv)) {
2255 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2257 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2258 == IS_NUMBER_IN_UV) {
2259 /* It's definitely an integer */
2260 if (!(numtype & IS_NUMBER_NEG))
2264 if (ckWARN(WARN_NUMERIC))
2267 return U_V(Atof(SvPVX_const(sv)));
2272 assert(SvTYPE(sv) >= SVt_PVMG);
2273 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2274 } else if (SvTHINKFIRST(sv)) {
2278 SV *const tmpstr = AMG_CALLun(sv,numer);
2279 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2280 return SvUV(tmpstr);
2283 return PTR2UV(SvRV(sv));
2286 sv_force_normal_flags(sv, 0);
2288 if (SvREADONLY(sv) && !SvOK(sv)) {
2289 if (ckWARN(WARN_UNINITIALIZED))
2295 if (S_sv_2iuv_common(aTHX_ sv))
2299 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2300 PTR2UV(sv),SvUVX(sv)));
2301 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2307 Return the num value of an SV, doing any necessary string or integer
2308 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2315 Perl_sv_2nv(pTHX_ register SV *sv)
2320 if (SvGMAGICAL(sv)) {
2324 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2325 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2326 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2328 return Atof(SvPVX_const(sv));
2332 return (NV)SvUVX(sv);
2334 return (NV)SvIVX(sv);
2339 assert(SvTYPE(sv) >= SVt_PVMG);
2340 /* This falls through to the report_uninit near the end of the
2342 } else if (SvTHINKFIRST(sv)) {
2346 SV *const tmpstr = AMG_CALLun(sv,numer);
2347 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2348 return SvNV(tmpstr);
2351 return PTR2NV(SvRV(sv));
2354 sv_force_normal_flags(sv, 0);
2356 if (SvREADONLY(sv) && !SvOK(sv)) {
2357 if (ckWARN(WARN_UNINITIALIZED))
2362 if (SvTYPE(sv) < SVt_NV) {
2363 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2364 sv_upgrade(sv, SVt_NV);
2365 #ifdef USE_LONG_DOUBLE
2367 STORE_NUMERIC_LOCAL_SET_STANDARD();
2368 PerlIO_printf(Perl_debug_log,
2369 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2370 PTR2UV(sv), SvNVX(sv));
2371 RESTORE_NUMERIC_LOCAL();
2375 STORE_NUMERIC_LOCAL_SET_STANDARD();
2376 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2377 PTR2UV(sv), SvNVX(sv));
2378 RESTORE_NUMERIC_LOCAL();
2382 else if (SvTYPE(sv) < SVt_PVNV)
2383 sv_upgrade(sv, SVt_PVNV);
2388 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2389 #ifdef NV_PRESERVES_UV
2392 /* Only set the public NV OK flag if this NV preserves the IV */
2393 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2394 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2395 : (SvIVX(sv) == I_V(SvNVX(sv))))
2401 else if (SvPOKp(sv) && SvLEN(sv)) {
2403 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2404 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2406 #ifdef NV_PRESERVES_UV
2407 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2408 == IS_NUMBER_IN_UV) {
2409 /* It's definitely an integer */
2410 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2412 SvNV_set(sv, Atof(SvPVX_const(sv)));
2415 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 /* Only set the public NV OK flag if this NV preserves the value in
2417 the PV at least as well as an IV/UV would.
2418 Not sure how to do this 100% reliably. */
2419 /* if that shift count is out of range then Configure's test is
2420 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2422 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2423 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2424 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2425 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2426 /* Can't use strtol etc to convert this string, so don't try.
2427 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2430 /* value has been set. It may not be precise. */
2431 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2432 /* 2s complement assumption for (UV)IV_MIN */
2433 SvNOK_on(sv); /* Integer is too negative. */
2438 if (numtype & IS_NUMBER_NEG) {
2439 SvIV_set(sv, -(IV)value);
2440 } else if (value <= (UV)IV_MAX) {
2441 SvIV_set(sv, (IV)value);
2443 SvUV_set(sv, value);
2447 if (numtype & IS_NUMBER_NOT_INT) {
2448 /* I believe that even if the original PV had decimals,
2449 they are lost beyond the limit of the FP precision.
2450 However, neither is canonical, so both only get p
2451 flags. NWC, 2000/11/25 */
2452 /* Both already have p flags, so do nothing */
2454 const NV nv = SvNVX(sv);
2455 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2456 if (SvIVX(sv) == I_V(nv)) {
2459 /* It had no "." so it must be integer. */
2463 /* between IV_MAX and NV(UV_MAX).
2464 Could be slightly > UV_MAX */
2466 if (numtype & IS_NUMBER_NOT_INT) {
2467 /* UV and NV both imprecise. */
2469 const UV nv_as_uv = U_V(nv);
2471 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2480 #endif /* NV_PRESERVES_UV */
2483 if (isGV_with_GP(sv)) {
2484 glob_2number((GV *)sv);
2488 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2490 assert (SvTYPE(sv) >= SVt_NV);
2491 /* Typically the caller expects that sv_any is not NULL now. */
2492 /* XXX Ilya implies that this is a bug in callers that assume this
2493 and ideally should be fixed. */
2496 #if defined(USE_LONG_DOUBLE)
2498 STORE_NUMERIC_LOCAL_SET_STANDARD();
2499 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2500 PTR2UV(sv), SvNVX(sv));
2501 RESTORE_NUMERIC_LOCAL();
2505 STORE_NUMERIC_LOCAL_SET_STANDARD();
2506 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2507 PTR2UV(sv), SvNVX(sv));
2508 RESTORE_NUMERIC_LOCAL();
2514 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2515 * UV as a string towards the end of buf, and return pointers to start and
2518 * We assume that buf is at least TYPE_CHARS(UV) long.
2522 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2524 char *ptr = buf + TYPE_CHARS(UV);
2525 char * const ebuf = ptr;
2538 *--ptr = '0' + (char)(uv % 10);
2546 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2547 * a regexp to its stringified form.
2551 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2553 const regexp * const re = (regexp *)mg->mg_obj;
2556 const char *fptr = "msix";
2561 bool need_newline = 0;
2562 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2564 while((ch = *fptr++)) {
2566 reflags[left++] = ch;
2569 reflags[right--] = ch;
2574 reflags[left] = '-';
2578 mg->mg_len = re->prelen + 4 + left;
2580 * If /x was used, we have to worry about a regex ending with a
2581 * comment later being embedded within another regex. If so, we don't
2582 * want this regex's "commentization" to leak out to the right part of
2583 * the enclosing regex, we must cap it with a newline.
2585 * So, if /x was used, we scan backwards from the end of the regex. If
2586 * we find a '#' before we find a newline, we need to add a newline
2587 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2588 * we don't need to add anything. -jfriedl
2590 if (PMf_EXTENDED & re->reganch) {
2591 const char *endptr = re->precomp + re->prelen;
2592 while (endptr >= re->precomp) {
2593 const char c = *(endptr--);
2595 break; /* don't need another */
2597 /* we end while in a comment, so we need a newline */
2598 mg->mg_len++; /* save space for it */
2599 need_newline = 1; /* note to add it */
2605 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2606 mg->mg_ptr[0] = '(';
2607 mg->mg_ptr[1] = '?';
2608 Copy(reflags, mg->mg_ptr+2, left, char);
2609 *(mg->mg_ptr+left+2) = ':';
2610 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2612 mg->mg_ptr[mg->mg_len - 2] = '\n';
2613 mg->mg_ptr[mg->mg_len - 1] = ')';
2614 mg->mg_ptr[mg->mg_len] = 0;
2616 PL_reginterp_cnt += re->program[0].next_off;
2618 if (re->reganch & ROPT_UTF8)
2628 =for apidoc sv_2pv_flags
2630 Returns a pointer to the string value of an SV, and sets *lp to its length.
2631 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2633 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2634 usually end up here too.
2640 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2650 if (SvGMAGICAL(sv)) {
2651 if (flags & SV_GMAGIC)
2656 if (flags & SV_MUTABLE_RETURN)
2657 return SvPVX_mutable(sv);
2658 if (flags & SV_CONST_RETURN)
2659 return (char *)SvPVX_const(sv);
2662 if (SvIOKp(sv) || SvNOKp(sv)) {
2663 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2668 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2669 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2671 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2678 #ifdef FIXNEGATIVEZERO
2679 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2685 SvUPGRADE(sv, SVt_PV);
2688 s = SvGROW_mutable(sv, len + 1);
2691 return memcpy(s, tbuf, len + 1);
2697 assert(SvTYPE(sv) >= SVt_PVMG);
2698 /* This falls through to the report_uninit near the end of the
2700 } else if (SvTHINKFIRST(sv)) {
2704 SV *const tmpstr = AMG_CALLun(sv,string);
2705 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2707 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2711 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2712 if (flags & SV_CONST_RETURN) {
2713 pv = (char *) SvPVX_const(tmpstr);
2715 pv = (flags & SV_MUTABLE_RETURN)
2716 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2719 *lp = SvCUR(tmpstr);
2721 pv = sv_2pv_flags(tmpstr, lp, flags);
2733 const SV *const referent = (SV*)SvRV(sv);
2736 tsv = sv_2mortal(newSVpvs("NULLREF"));
2737 } else if (SvTYPE(referent) == SVt_PVMG
2738 && ((SvFLAGS(referent) &
2739 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2740 == (SVs_OBJECT|SVs_SMG))
2741 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2742 return stringify_regexp(sv, mg, lp);
2744 const char *const typestr = sv_reftype(referent, 0);
2746 tsv = sv_newmortal();
2747 if (SvOBJECT(referent)) {
2748 const char *const name = HvNAME_get(SvSTASH(referent));
2749 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2750 name ? name : "__ANON__" , typestr,
2754 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2762 if (SvREADONLY(sv) && !SvOK(sv)) {
2763 if (ckWARN(WARN_UNINITIALIZED))
2770 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2771 /* I'm assuming that if both IV and NV are equally valid then
2772 converting the IV is going to be more efficient */
2773 const U32 isIOK = SvIOK(sv);
2774 const U32 isUIOK = SvIsUV(sv);
2775 char buf[TYPE_CHARS(UV)];
2778 if (SvTYPE(sv) < SVt_PVIV)
2779 sv_upgrade(sv, SVt_PVIV);
2780 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2781 /* inlined from sv_setpvn */
2782 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2783 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2784 SvCUR_set(sv, ebuf - ptr);
2794 else if (SvNOKp(sv)) {
2795 const int olderrno = errno;
2796 if (SvTYPE(sv) < SVt_PVNV)
2797 sv_upgrade(sv, SVt_PVNV);
2798 /* The +20 is pure guesswork. Configure test needed. --jhi */
2799 s = SvGROW_mutable(sv, NV_DIG + 20);
2800 /* some Xenix systems wipe out errno here */
2802 if (SvNVX(sv) == 0.0)
2803 my_strlcpy(s, "0", SvLEN(sv));
2807 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2810 #ifdef FIXNEGATIVEZERO
2811 if (*s == '-' && s[1] == '0' && !s[2])
2812 my_strlcpy(s, "0", SvLEN(s));
2821 if (isGV_with_GP(sv))
2822 return glob_2pv((GV *)sv, lp);
2824 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2828 if (SvTYPE(sv) < SVt_PV)
2829 /* Typically the caller expects that sv_any is not NULL now. */
2830 sv_upgrade(sv, SVt_PV);
2834 const STRLEN len = s - SvPVX_const(sv);
2840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2841 PTR2UV(sv),SvPVX_const(sv)));
2842 if (flags & SV_CONST_RETURN)
2843 return (char *)SvPVX_const(sv);
2844 if (flags & SV_MUTABLE_RETURN)
2845 return SvPVX_mutable(sv);
2850 =for apidoc sv_copypv
2852 Copies a stringified representation of the source SV into the
2853 destination SV. Automatically performs any necessary mg_get and
2854 coercion of numeric values into strings. Guaranteed to preserve
2855 UTF-8 flag even from overloaded objects. Similar in nature to
2856 sv_2pv[_flags] but operates directly on an SV instead of just the
2857 string. Mostly uses sv_2pv_flags to do its work, except when that
2858 would lose the UTF-8'ness of the PV.
2864 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2867 const char * const s = SvPV_const(ssv,len);
2868 sv_setpvn(dsv,s,len);
2876 =for apidoc sv_2pvbyte
2878 Return a pointer to the byte-encoded representation of the SV, and set *lp
2879 to its length. May cause the SV to be downgraded from UTF-8 as a
2882 Usually accessed via the C<SvPVbyte> macro.
2888 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2890 sv_utf8_downgrade(sv,0);
2891 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2895 =for apidoc sv_2pvutf8
2897 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2898 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2900 Usually accessed via the C<SvPVutf8> macro.
2906 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2908 sv_utf8_upgrade(sv);
2909 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2914 =for apidoc sv_2bool
2916 This function is only called on magical items, and is only used by
2917 sv_true() or its macro equivalent.
2923 Perl_sv_2bool(pTHX_ register SV *sv)
2932 SV * const tmpsv = AMG_CALLun(sv,bool_);
2933 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2934 return (bool)SvTRUE(tmpsv);
2936 return SvRV(sv) != 0;
2939 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2941 (*sv->sv_u.svu_pv > '0' ||
2942 Xpvtmp->xpv_cur > 1 ||
2943 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2950 return SvIVX(sv) != 0;
2953 return SvNVX(sv) != 0.0;
2955 if (isGV_with_GP(sv))
2965 =for apidoc sv_utf8_upgrade
2967 Converts the PV of an SV to its UTF-8-encoded form.
2968 Forces the SV to string form if it is not already.
2969 Always sets the SvUTF8 flag to avoid future validity checks even
2970 if all the bytes have hibit clear.
2972 This is not as a general purpose byte encoding to Unicode interface:
2973 use the Encode extension for that.
2975 =for apidoc sv_utf8_upgrade_flags
2977 Converts the PV of an SV to its UTF-8-encoded form.
2978 Forces the SV to string form if it is not already.
2979 Always sets the SvUTF8 flag to avoid future validity checks even
2980 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2981 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2982 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2984 This is not as a general purpose byte encoding to Unicode interface:
2985 use the Encode extension for that.
2991 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2994 if (sv == &PL_sv_undef)
2998 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2999 (void) sv_2pv_flags(sv,&len, flags);
3003 (void) SvPV_force(sv,len);
3012 sv_force_normal_flags(sv, 0);
3015 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3016 sv_recode_to_utf8(sv, PL_encoding);
3017 else { /* Assume Latin-1/EBCDIC */
3018 /* This function could be much more efficient if we
3019 * had a FLAG in SVs to signal if there are any hibit
3020 * chars in the PV. Given that there isn't such a flag
3021 * make the loop as fast as possible. */
3022 const U8 * const s = (U8 *) SvPVX_const(sv);
3023 const U8 * const e = (U8 *) SvEND(sv);
3028 /* Check for hi bit */
3029 if (!NATIVE_IS_INVARIANT(ch)) {
3030 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3031 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3033 SvPV_free(sv); /* No longer using what was there before. */
3034 SvPV_set(sv, (char*)recoded);
3035 SvCUR_set(sv, len - 1);
3036 SvLEN_set(sv, len); /* No longer know the real size. */
3040 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3047 =for apidoc sv_utf8_downgrade
3049 Attempts to convert the PV of an SV from characters to bytes.
3050 If the PV contains a character beyond byte, this conversion will fail;
3051 in this case, either returns false or, if C<fail_ok> is not
3054 This is not as a general purpose Unicode to byte encoding interface:
3055 use the Encode extension for that.
3061 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3064 if (SvPOKp(sv) && SvUTF8(sv)) {
3070 sv_force_normal_flags(sv, 0);
3072 s = (U8 *) SvPV(sv, len);
3073 if (!utf8_to_bytes(s, &len)) {
3078 Perl_croak(aTHX_ "Wide character in %s",
3081 Perl_croak(aTHX_ "Wide character");
3092 =for apidoc sv_utf8_encode
3094 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3095 flag off so that it looks like octets again.
3101 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3104 sv_force_normal_flags(sv, 0);
3106 if (SvREADONLY(sv)) {
3107 Perl_croak(aTHX_ PL_no_modify);
3109 (void) sv_utf8_upgrade(sv);
3114 =for apidoc sv_utf8_decode
3116 If the PV of the SV is an octet sequence in UTF-8
3117 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3118 so that it looks like a character. If the PV contains only single-byte
3119 characters, the C<SvUTF8> flag stays being off.
3120 Scans PV for validity and returns false if the PV is invalid UTF-8.
3126 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3132 /* The octets may have got themselves encoded - get them back as
3135 if (!sv_utf8_downgrade(sv, TRUE))
3138 /* it is actually just a matter of turning the utf8 flag on, but
3139 * we want to make sure everything inside is valid utf8 first.
3141 c = (const U8 *) SvPVX_const(sv);
3142 if (!is_utf8_string(c, SvCUR(sv)+1))
3144 e = (const U8 *) SvEND(sv);
3147 if (!UTF8_IS_INVARIANT(ch)) {
3157 =for apidoc sv_setsv
3159 Copies the contents of the source SV C<ssv> into the destination SV
3160 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3161 function if the source SV needs to be reused. Does not handle 'set' magic.
3162 Loosely speaking, it performs a copy-by-value, obliterating any previous
3163 content of the destination.
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3169 =for apidoc sv_setsv_flags
3171 Copies the contents of the source SV C<ssv> into the destination SV
3172 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3173 function if the source SV needs to be reused. Does not handle 'set' magic.
3174 Loosely speaking, it performs a copy-by-value, obliterating any previous
3175 content of the destination.
3176 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3177 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3178 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3179 and C<sv_setsv_nomg> are implemented in terms of this function.
3181 You probably want to use one of the assortment of wrappers, such as
3182 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3183 C<SvSetMagicSV_nosteal>.
3185 This is the primary function for copying scalars, and most other
3186 copy-ish functions and macros use this underneath.
3192 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3194 if (dtype != SVt_PVGV) {
3195 const char * const name = GvNAME(sstr);
3196 const STRLEN len = GvNAMELEN(sstr);
3197 /* don't upgrade SVt_PVLV: it can hold a glob */
3198 if (dtype != SVt_PVLV) {
3199 if (dtype >= SVt_PV) {
3205 sv_upgrade(dstr, SVt_PVGV);
3206 (void)SvOK_off(dstr);
3209 GvSTASH(dstr) = GvSTASH(sstr);
3211 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3212 gv_name_set((GV *)dstr, name, len, GV_ADD);
3213 SvFAKE_on(dstr); /* can coerce to non-glob */
3216 #ifdef GV_UNIQUE_CHECK
3217 if (GvUNIQUE((GV*)dstr)) {
3218 Perl_croak(aTHX_ PL_no_modify);
3224 (void)SvOK_off(dstr);
3226 GvINTRO_off(dstr); /* one-shot flag */
3227 GvGP(dstr) = gp_ref(GvGP(sstr));
3228 if (SvTAINTED(sstr))
3230 if (GvIMPORTED(dstr) != GVf_IMPORTED
3231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3233 GvIMPORTED_on(dstr);
3240 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3241 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3243 const int intro = GvINTRO(dstr);
3246 const U32 stype = SvTYPE(sref);
3249 #ifdef GV_UNIQUE_CHECK
3250 if (GvUNIQUE((GV*)dstr)) {
3251 Perl_croak(aTHX_ PL_no_modify);
3256 GvINTRO_off(dstr); /* one-shot flag */
3257 GvLINE(dstr) = CopLINE(PL_curcop);
3258 GvEGV(dstr) = (GV*)dstr;
3263 location = (SV **) &GvCV(dstr);
3264 import_flag = GVf_IMPORTED_CV;
3267 location = (SV **) &GvHV(dstr);
3268 import_flag = GVf_IMPORTED_HV;
3271 location = (SV **) &GvAV(dstr);
3272 import_flag = GVf_IMPORTED_AV;
3275 location = (SV **) &GvIOp(dstr);
3278 location = (SV **) &GvFORM(dstr);
3280 location = &GvSV(dstr);
3281 import_flag = GVf_IMPORTED_SV;
3284 if (stype == SVt_PVCV) {
3285 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3286 SvREFCNT_dec(GvCV(dstr));
3288 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3289 PL_sub_generation++;
3292 SAVEGENERICSV(*location);
3296 if (stype == SVt_PVCV && *location != sref) {
3297 CV* const cv = (CV*)*location;
3299 if (!GvCVGEN((GV*)dstr) &&
3300 (CvROOT(cv) || CvXSUB(cv)))
3302 /* Redefining a sub - warning is mandatory if
3303 it was a const and its value changed. */
3304 if (CvCONST(cv) && CvCONST((CV*)sref)
3305 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3307 /* They are 2 constant subroutines generated from
3308 the same constant. This probably means that
3309 they are really the "same" proxy subroutine
3310 instantiated in 2 places. Most likely this is
3311 when a constant is exported twice. Don't warn.
3314 else if (ckWARN(WARN_REDEFINE)
3316 && (!CvCONST((CV*)sref)
3317 || sv_cmp(cv_const_sv(cv),
3318 cv_const_sv((CV*)sref))))) {
3319 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3321 ? "Constant subroutine %s::%s redefined"
3322 : "Subroutine %s::%s redefined",
3323 HvNAME_get(GvSTASH((GV*)dstr)),
3324 GvENAME((GV*)dstr));
3328 cv_ckproto_len(cv, (GV*)dstr,
3329 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3330 SvPOK(sref) ? SvCUR(sref) : 0);
3332 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3333 GvASSUMECV_on(dstr);
3334 PL_sub_generation++;
3337 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3338 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3339 GvFLAGS(dstr) |= import_flag;
3344 if (SvTAINTED(sstr))
3350 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3353 register U32 sflags;
3355 register svtype stype;
3359 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3361 sstr = &PL_sv_undef;
3362 stype = SvTYPE(sstr);
3363 dtype = SvTYPE(dstr);
3368 /* need to nuke the magic */
3370 SvRMAGICAL_off(dstr);
3373 /* There's a lot of redundancy below but we're going for speed here */
3378 if (dtype != SVt_PVGV) {
3379 (void)SvOK_off(dstr);
3387 sv_upgrade(dstr, SVt_IV);
3392 sv_upgrade(dstr, SVt_PVIV);
3395 (void)SvIOK_only(dstr);
3396 SvIV_set(dstr, SvIVX(sstr));
3399 /* SvTAINTED can only be true if the SV has taint magic, which in
3400 turn means that the SV type is PVMG (or greater). This is the
3401 case statement for SVt_IV, so this cannot be true (whatever gcov
3403 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_NV);
3418 sv_upgrade(dstr, SVt_PVNV);
3421 SvNV_set(dstr, SvNVX(sstr));
3422 (void)SvNOK_only(dstr);
3423 /* SvTAINTED can only be true if the SV has taint magic, which in
3424 turn means that the SV type is PVMG (or greater). This is the
3425 case statement for SVt_NV, so this cannot be true (whatever gcov
3427 assert(!SvTAINTED(sstr));
3434 sv_upgrade(dstr, SVt_RV);
3437 #ifdef PERL_OLD_COPY_ON_WRITE
3438 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3439 if (dtype < SVt_PVIV)
3440 sv_upgrade(dstr, SVt_PVIV);
3447 sv_upgrade(dstr, SVt_PV);
3450 if (dtype < SVt_PVIV)
3451 sv_upgrade(dstr, SVt_PVIV);
3454 if (dtype < SVt_PVNV)
3455 sv_upgrade(dstr, SVt_PVNV);
3459 const char * const type = sv_reftype(sstr,0);
3461 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3463 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3468 if (dtype <= SVt_PVGV) {
3469 glob_assign_glob(dstr, sstr, dtype);
3477 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3479 if ((int)SvTYPE(sstr) != stype) {
3480 stype = SvTYPE(sstr);
3481 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3482 glob_assign_glob(dstr, sstr, dtype);
3487 if (stype == SVt_PVLV)
3488 SvUPGRADE(dstr, SVt_PVNV);
3490 SvUPGRADE(dstr, (svtype)stype);
3493 /* dstr may have been upgraded. */
3494 dtype = SvTYPE(dstr);
3495 sflags = SvFLAGS(sstr);
3497 if (sflags & SVf_ROK) {
3498 if (dtype == SVt_PVGV &&
3499 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3502 if (GvIMPORTED(dstr) != GVf_IMPORTED
3503 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3505 GvIMPORTED_on(dstr);
3510 glob_assign_glob(dstr, sstr, dtype);
3514 if (dtype >= SVt_PV) {
3515 if (dtype == SVt_PVGV) {
3516 glob_assign_ref(dstr, sstr);
3519 if (SvPVX_const(dstr)) {
3525 (void)SvOK_off(dstr);
3526 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3527 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3528 assert(!(sflags & SVp_NOK));
3529 assert(!(sflags & SVp_IOK));
3530 assert(!(sflags & SVf_NOK));
3531 assert(!(sflags & SVf_IOK));
3533 else if (dtype == SVt_PVGV) {
3534 if (!(sflags & SVf_OK)) {
3535 if (ckWARN(WARN_MISC))
3536 Perl_warner(aTHX_ packWARN(WARN_MISC),
3537 "Undefined value assigned to typeglob");
3540 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3541 if (dstr != (SV*)gv) {
3544 GvGP(dstr) = gp_ref(GvGP(gv));
3548 else if (sflags & SVp_POK) {
3552 * Check to see if we can just swipe the string. If so, it's a
3553 * possible small lose on short strings, but a big win on long ones.
3554 * It might even be a win on short strings if SvPVX_const(dstr)
3555 * has to be allocated and SvPVX_const(sstr) has to be freed.
3558 /* Whichever path we take through the next code, we want this true,
3559 and doing it now facilitates the COW check. */
3560 (void)SvPOK_only(dstr);
3563 /* We're not already COW */
3564 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3565 #ifndef PERL_OLD_COPY_ON_WRITE
3566 /* or we are, but dstr isn't a suitable target. */
3567 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3572 (sflags & SVs_TEMP) && /* slated for free anyway? */
3573 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3574 (!(flags & SV_NOSTEAL)) &&
3575 /* and we're allowed to steal temps */
3576 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3577 SvLEN(sstr) && /* and really is a string */
3578 /* and won't be needed again, potentially */
3579 !(PL_op && PL_op->op_type == OP_AASSIGN))
3580 #ifdef PERL_OLD_COPY_ON_WRITE
3581 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3582 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3583 && SvTYPE(sstr) >= SVt_PVIV)
3586 /* Failed the swipe test, and it's not a shared hash key either.
3587 Have to copy the string. */
3588 STRLEN len = SvCUR(sstr);
3589 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3590 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3591 SvCUR_set(dstr, len);
3592 *SvEND(dstr) = '\0';
3594 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3596 /* Either it's a shared hash key, or it's suitable for
3597 copy-on-write or we can swipe the string. */
3599 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3603 #ifdef PERL_OLD_COPY_ON_WRITE
3605 /* I believe I should acquire a global SV mutex if
3606 it's a COW sv (not a shared hash key) to stop
3607 it going un copy-on-write.
3608 If the source SV has gone un copy on write between up there
3609 and down here, then (assert() that) it is of the correct
3610 form to make it copy on write again */
3611 if ((sflags & (SVf_FAKE | SVf_READONLY))
3612 != (SVf_FAKE | SVf_READONLY)) {
3613 SvREADONLY_on(sstr);
3615 /* Make the source SV into a loop of 1.
3616 (about to become 2) */
3617 SV_COW_NEXT_SV_SET(sstr, sstr);
3621 /* Initial code is common. */
3622 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3627 /* making another shared SV. */
3628 STRLEN cur = SvCUR(sstr);
3629 STRLEN len = SvLEN(sstr);
3630 #ifdef PERL_OLD_COPY_ON_WRITE
3632 assert (SvTYPE(dstr) >= SVt_PVIV);
3633 /* SvIsCOW_normal */
3634 /* splice us in between source and next-after-source. */
3635 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3636 SV_COW_NEXT_SV_SET(sstr, dstr);
3637 SvPV_set(dstr, SvPVX_mutable(sstr));
3641 /* SvIsCOW_shared_hash */
3642 DEBUG_C(PerlIO_printf(Perl_debug_log,
3643 "Copy on write: Sharing hash\n"));
3645 assert (SvTYPE(dstr) >= SVt_PV);
3647 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3649 SvLEN_set(dstr, len);
3650 SvCUR_set(dstr, cur);
3651 SvREADONLY_on(dstr);
3653 /* Relesase a global SV mutex. */
3656 { /* Passes the swipe test. */
3657 SvPV_set(dstr, SvPVX_mutable(sstr));
3658 SvLEN_set(dstr, SvLEN(sstr));
3659 SvCUR_set(dstr, SvCUR(sstr));
3662 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3663 SvPV_set(sstr, NULL);
3669 if (sflags & SVp_NOK) {
3670 SvNV_set(dstr, SvNVX(sstr));
3672 if (sflags & SVp_IOK) {
3673 SvRELEASE_IVX(dstr);
3674 SvIV_set(dstr, SvIVX(sstr));
3675 /* Must do this otherwise some other overloaded use of 0x80000000
3676 gets confused. I guess SVpbm_VALID */
3677 if (sflags & SVf_IVisUV)
3680 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3683 const MAGIC * const smg = SvVSTRING_mg(sstr);
3685 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3686 smg->mg_ptr, smg->mg_len);
3687 SvRMAGICAL_on(dstr);
3691 else if (sflags & (SVp_IOK|SVp_NOK)) {
3692 (void)SvOK_off(dstr);
3693 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3695 if (sflags & SVp_IOK) {
3696 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3697 SvIV_set(dstr, SvIVX(sstr));
3699 if (sflags & SVp_NOK) {
3700 SvNV_set(dstr, SvNVX(sstr));
3704 if (isGV_with_GP(sstr)) {
3705 /* This stringification rule for globs is spread in 3 places.
3706 This feels bad. FIXME. */
3707 const U32 wasfake = sflags & SVf_FAKE;
3709 /* FAKE globs can get coerced, so need to turn this off
3710 temporarily if it is on. */
3712 gv_efullname3(dstr, (GV *)sstr, "*");
3713 SvFLAGS(sstr) |= wasfake;
3714 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3717 (void)SvOK_off(dstr);
3719 if (SvTAINTED(sstr))
3724 =for apidoc sv_setsv_mg
3726 Like C<sv_setsv>, but also handles 'set' magic.
3732 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3734 sv_setsv(dstr,sstr);
3738 #ifdef PERL_OLD_COPY_ON_WRITE
3740 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3742 STRLEN cur = SvCUR(sstr);
3743 STRLEN len = SvLEN(sstr);
3744 register char *new_pv;
3747 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3755 if (SvTHINKFIRST(dstr))
3756 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3757 else if (SvPVX_const(dstr))
3758 Safefree(SvPVX_const(dstr));
3762 SvUPGRADE(dstr, SVt_PVIV);
3764 assert (SvPOK(sstr));
3765 assert (SvPOKp(sstr));
3766 assert (!SvIOK(sstr));
3767 assert (!SvIOKp(sstr));
3768 assert (!SvNOK(sstr));
3769 assert (!SvNOKp(sstr));
3771 if (SvIsCOW(sstr)) {
3773 if (SvLEN(sstr) == 0) {
3774 /* source is a COW shared hash key. */
3775 DEBUG_C(PerlIO_printf(Perl_debug_log,
3776 "Fast copy on write: Sharing hash\n"));
3777 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3780 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3782 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3783 SvUPGRADE(sstr, SVt_PVIV);
3784 SvREADONLY_on(sstr);
3786 DEBUG_C(PerlIO_printf(Perl_debug_log,
3787 "Fast copy on write: Converting sstr to COW\n"));
3788 SV_COW_NEXT_SV_SET(dstr, sstr);
3790 SV_COW_NEXT_SV_SET(sstr, dstr);
3791 new_pv = SvPVX_mutable(sstr);
3794 SvPV_set(dstr, new_pv);
3795 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3798 SvLEN_set(dstr, len);
3799 SvCUR_set(dstr, cur);
3808 =for apidoc sv_setpvn
3810 Copies a string into an SV. The C<len> parameter indicates the number of
3811 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3812 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3818 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3821 register char *dptr;
3823 SV_CHECK_THINKFIRST_COW_DROP(sv);
3829 /* len is STRLEN which is unsigned, need to copy to signed */
3832 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3834 SvUPGRADE(sv, SVt_PV);
3836 dptr = SvGROW(sv, len + 1);
3837 Move(ptr,dptr,len,char);
3840 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3845 =for apidoc sv_setpvn_mg
3847 Like C<sv_setpvn>, but also handles 'set' magic.
3853 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3855 sv_setpvn(sv,ptr,len);
3860 =for apidoc sv_setpv
3862 Copies a string into an SV. The string must be null-terminated. Does not
3863 handle 'set' magic. See C<sv_setpv_mg>.
3869 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3872 register STRLEN len;
3874 SV_CHECK_THINKFIRST_COW_DROP(sv);
3880 SvUPGRADE(sv, SVt_PV);
3882 SvGROW(sv, len + 1);
3883 Move(ptr,SvPVX(sv),len+1,char);
3885 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3890 =for apidoc sv_setpv_mg
3892 Like C<sv_setpv>, but also handles 'set' magic.
3898 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3905 =for apidoc sv_usepvn_flags
3907 Tells an SV to use C<ptr> to find its string value. Normally the
3908 string is stored inside the SV but sv_usepvn allows the SV to use an
3909 outside string. The C<ptr> should point to memory that was allocated
3910 by C<malloc>. The string length, C<len>, must be supplied. By default
3911 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3912 so that pointer should not be freed or used by the programmer after
3913 giving it to sv_usepvn, and neither should any pointers from "behind"
3914 that pointer (e.g. ptr + 1) be used.
3916 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3917 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3918 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3919 C<len>, and already meets the requirements for storing in C<SvPVX>)
3925 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3929 SV_CHECK_THINKFIRST_COW_DROP(sv);
3930 SvUPGRADE(sv, SVt_PV);
3933 if (flags & SV_SMAGIC)
3937 if (SvPVX_const(sv))
3941 if (flags & SV_HAS_TRAILING_NUL)
3942 assert(ptr[len] == '\0');
3945 allocate = (flags & SV_HAS_TRAILING_NUL)
3946 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3947 if (flags & SV_HAS_TRAILING_NUL) {
3948 /* It's long enough - do nothing.
3949 Specfically Perl_newCONSTSUB is relying on this. */
3952 /* Force a move to shake out bugs in callers. */
3953 char *new_ptr = safemalloc(allocate);
3954 Copy(ptr, new_ptr, len, char);
3955 PoisonFree(ptr,len,char);
3959 ptr = saferealloc (ptr, allocate);
3964 SvLEN_set(sv, allocate);
3965 if (!(flags & SV_HAS_TRAILING_NUL)) {
3968 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3970 if (flags & SV_SMAGIC)
3974 #ifdef PERL_OLD_COPY_ON_WRITE
3975 /* Need to do this *after* making the SV normal, as we need the buffer
3976 pointer to remain valid until after we've copied it. If we let go too early,
3977 another thread could invalidate it by unsharing last of the same hash key
3978 (which it can do by means other than releasing copy-on-write Svs)
3979 or by changing the other copy-on-write SVs in the loop. */
3981 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3983 if (len) { /* this SV was SvIsCOW_normal(sv) */
3984 /* we need to find the SV pointing to us. */
3985 SV *current = SV_COW_NEXT_SV(after);
3987 if (current == sv) {
3988 /* The SV we point to points back to us (there were only two of us
3990 Hence other SV is no longer copy on write either. */
3992 SvREADONLY_off(after);
3994 /* We need to follow the pointers around the loop. */
3996 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3999 /* don't loop forever if the structure is bust, and we have
4000 a pointer into a closed loop. */
4001 assert (current != after);
4002 assert (SvPVX_const(current) == pvx);
4004 /* Make the SV before us point to the SV after us. */
4005 SV_COW_NEXT_SV_SET(current, after);
4008 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4013 Perl_sv_release_IVX(pTHX_ register SV *sv)
4016 sv_force_normal_flags(sv, 0);
4022 =for apidoc sv_force_normal_flags
4024 Undo various types of fakery on an SV: if the PV is a shared string, make
4025 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4026 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4027 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4028 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4029 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4030 set to some other value.) In addition, the C<flags> parameter gets passed to
4031 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4032 with flags set to 0.
4038 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4041 #ifdef PERL_OLD_COPY_ON_WRITE
4042 if (SvREADONLY(sv)) {
4043 /* At this point I believe I should acquire a global SV mutex. */
4045 const char * const pvx = SvPVX_const(sv);
4046 const STRLEN len = SvLEN(sv);
4047 const STRLEN cur = SvCUR(sv);
4048 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4050 PerlIO_printf(Perl_debug_log,
4051 "Copy on write: Force normal %ld\n",
4057 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4060 if (flags & SV_COW_DROP_PV) {
4061 /* OK, so we don't need to copy our buffer. */
4064 SvGROW(sv, cur + 1);
4065 Move(pvx,SvPVX(sv),cur,char);
4069 sv_release_COW(sv, pvx, len, next);
4074 else if (IN_PERL_RUNTIME)
4075 Perl_croak(aTHX_ PL_no_modify);
4076 /* At this point I believe that I can drop the global SV mutex. */
4079 if (SvREADONLY(sv)) {
4081 const char * const pvx = SvPVX_const(sv);
4082 const STRLEN len = SvCUR(sv);
4087 SvGROW(sv, len + 1);
4088 Move(pvx,SvPVX(sv),len,char);
4090 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4092 else if (IN_PERL_RUNTIME)
4093 Perl_croak(aTHX_ PL_no_modify);
4097 sv_unref_flags(sv, flags);
4098 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4105 Efficient removal of characters from the beginning of the string buffer.
4106 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4107 the string buffer. The C<ptr> becomes the first character of the adjusted
4108 string. Uses the "OOK hack".
4109 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4110 refer to the same chunk of data.
4116 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4118 register STRLEN delta;
4119 if (!ptr || !SvPOKp(sv))
4121 delta = ptr - SvPVX_const(sv);
4122 SV_CHECK_THINKFIRST(sv);
4123 if (SvTYPE(sv) < SVt_PVIV)
4124 sv_upgrade(sv,SVt_PVIV);
4127 if (!SvLEN(sv)) { /* make copy of shared string */
4128 const char *pvx = SvPVX_const(sv);
4129 const STRLEN len = SvCUR(sv);
4130 SvGROW(sv, len + 1);
4131 Move(pvx,SvPVX(sv),len,char);
4135 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4136 and we do that anyway inside the SvNIOK_off
4138 SvFLAGS(sv) |= SVf_OOK;
4141 SvLEN_set(sv, SvLEN(sv) - delta);
4142 SvCUR_set(sv, SvCUR(sv) - delta);
4143 SvPV_set(sv, SvPVX(sv) + delta);
4144 SvIV_set(sv, SvIVX(sv) + delta);
4148 =for apidoc sv_catpvn
4150 Concatenates the string onto the end of the string which is in the SV. The
4151 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4152 status set, then the bytes appended should be valid UTF-8.
4153 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4155 =for apidoc sv_catpvn_flags
4157 Concatenates the string onto the end of the string which is in the SV. The
4158 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4159 status set, then the bytes appended should be valid UTF-8.
4160 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4161 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4162 in terms of this function.
4168 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4172 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4174 SvGROW(dsv, dlen + slen + 1);
4176 sstr = SvPVX_const(dsv);
4177 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4178 SvCUR_set(dsv, SvCUR(dsv) + slen);
4180 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4182 if (flags & SV_SMAGIC)
4187 =for apidoc sv_catsv
4189 Concatenates the string from SV C<ssv> onto the end of the string in
4190 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4191 not 'set' magic. See C<sv_catsv_mg>.
4193 =for apidoc sv_catsv_flags
4195 Concatenates the string from SV C<ssv> onto the end of the string in
4196 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4197 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4198 and C<sv_catsv_nomg> are implemented in terms of this function.
4203 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4208 const char *spv = SvPV_const(ssv, slen);
4210 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4211 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4212 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4213 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4214 dsv->sv_flags doesn't have that bit set.
4215 Andy Dougherty 12 Oct 2001
4217 const I32 sutf8 = DO_UTF8(ssv);
4220 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4222 dutf8 = DO_UTF8(dsv);
4224 if (dutf8 != sutf8) {
4226 /* Not modifying source SV, so taking a temporary copy. */
4227 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4229 sv_utf8_upgrade(csv);
4230 spv = SvPV_const(csv, slen);
4233 sv_utf8_upgrade_nomg(dsv);
4235 sv_catpvn_nomg(dsv, spv, slen);
4238 if (flags & SV_SMAGIC)
4243 =for apidoc sv_catpv
4245 Concatenates the string onto the end of the string which is in the SV.
4246 If the SV has the UTF-8 status set, then the bytes appended should be
4247 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4252 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4255 register STRLEN len;
4261 junk = SvPV_force(sv, tlen);
4263 SvGROW(sv, tlen + len + 1);
4265 ptr = SvPVX_const(sv);
4266 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4267 SvCUR_set(sv, SvCUR(sv) + len);
4268 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4273 =for apidoc sv_catpv_mg
4275 Like C<sv_catpv>, but also handles 'set' magic.
4281 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4290 Creates a new SV. A non-zero C<len> parameter indicates the number of
4291 bytes of preallocated string space the SV should have. An extra byte for a
4292 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4293 space is allocated.) The reference count for the new SV is set to 1.
4295 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4296 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4297 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4298 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4299 modules supporting older perls.
4305 Perl_newSV(pTHX_ STRLEN len)
4312 sv_upgrade(sv, SVt_PV);
4313 SvGROW(sv, len + 1);
4318 =for apidoc sv_magicext
4320 Adds magic to an SV, upgrading it if necessary. Applies the
4321 supplied vtable and returns a pointer to the magic added.
4323 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4324 In particular, you can add magic to SvREADONLY SVs, and add more than
4325 one instance of the same 'how'.
4327 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4328 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4329 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4330 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4332 (This is now used as a subroutine by C<sv_magic>.)
4337 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4338 const char* name, I32 namlen)
4343 if (SvTYPE(sv) < SVt_PVMG) {
4344 SvUPGRADE(sv, SVt_PVMG);
4346 Newxz(mg, 1, MAGIC);
4347 mg->mg_moremagic = SvMAGIC(sv);
4348 SvMAGIC_set(sv, mg);
4350 /* Sometimes a magic contains a reference loop, where the sv and
4351 object refer to each other. To prevent a reference loop that
4352 would prevent such objects being freed, we look for such loops
4353 and if we find one we avoid incrementing the object refcount.
4355 Note we cannot do this to avoid self-tie loops as intervening RV must
4356 have its REFCNT incremented to keep it in existence.
4359 if (!obj || obj == sv ||
4360 how == PERL_MAGIC_arylen ||
4361 how == PERL_MAGIC_qr ||
4362 how == PERL_MAGIC_symtab ||
4363 (SvTYPE(obj) == SVt_PVGV &&
4364 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4365 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4366 GvFORM(obj) == (CV*)sv)))
4371 mg->mg_obj = SvREFCNT_inc_simple(obj);
4372 mg->mg_flags |= MGf_REFCOUNTED;
4375 /* Normal self-ties simply pass a null object, and instead of
4376 using mg_obj directly, use the SvTIED_obj macro to produce a
4377 new RV as needed. For glob "self-ties", we are tieing the PVIO
4378 with an RV obj pointing to the glob containing the PVIO. In
4379 this case, to avoid a reference loop, we need to weaken the
4383 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4384 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4390 mg->mg_len = namlen;
4393 mg->mg_ptr = savepvn(name, namlen);
4394 else if (namlen == HEf_SVKEY)
4395 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4397 mg->mg_ptr = (char *) name;
4399 mg->mg_virtual = vtable;
4403 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4408 =for apidoc sv_magic
4410 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4411 then adds a new magic item of type C<how> to the head of the magic list.
4413 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4414 handling of the C<name> and C<namlen> arguments.
4416 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4417 to add more than one instance of the same 'how'.
4423 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4429 #ifdef PERL_OLD_COPY_ON_WRITE
4431 sv_force_normal_flags(sv, 0);
4433 if (SvREADONLY(sv)) {
4435 /* its okay to attach magic to shared strings; the subsequent
4436 * upgrade to PVMG will unshare the string */
4437 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4440 && how != PERL_MAGIC_regex_global
4441 && how != PERL_MAGIC_bm
4442 && how != PERL_MAGIC_fm
4443 && how != PERL_MAGIC_sv
4444 && how != PERL_MAGIC_backref
4447 Perl_croak(aTHX_ PL_no_modify);
4450 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4451 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4452 /* sv_magic() refuses to add a magic of the same 'how' as an
4455 if (how == PERL_MAGIC_taint) {
4457 /* Any scalar which already had taint magic on which someone
4458 (erroneously?) did SvIOK_on() or similar will now be
4459 incorrectly sporting public "OK" flags. */
4460 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4468 vtable = &PL_vtbl_sv;
4470 case PERL_MAGIC_overload:
4471 vtable = &PL_vtbl_amagic;
4473 case PERL_MAGIC_overload_elem:
4474 vtable = &PL_vtbl_amagicelem;
4476 case PERL_MAGIC_overload_table:
4477 vtable = &PL_vtbl_ovrld;
4480 vtable = &PL_vtbl_bm;
4482 case PERL_MAGIC_regdata:
4483 vtable = &PL_vtbl_regdata;
4485 case PERL_MAGIC_regdatum:
4486 vtable = &PL_vtbl_regdatum;
4488 case PERL_MAGIC_env:
4489 vtable = &PL_vtbl_env;
4492 vtable = &PL_vtbl_fm;
4494 case PERL_MAGIC_envelem:
4495 vtable = &PL_vtbl_envelem;
4497 case PERL_MAGIC_regex_global:
4498 vtable = &PL_vtbl_mglob;
4500 case PERL_MAGIC_isa:
4501 vtable = &PL_vtbl_isa;
4503 case PERL_MAGIC_isaelem:
4504 vtable = &PL_vtbl_isaelem;
4506 case PERL_MAGIC_nkeys:
4507 vtable = &PL_vtbl_nkeys;
4509 case PERL_MAGIC_dbfile:
4512 case PERL_MAGIC_dbline:
4513 vtable = &PL_vtbl_dbline;
4515 #ifdef USE_LOCALE_COLLATE
4516 case PERL_MAGIC_collxfrm:
4517 vtable = &PL_vtbl_collxfrm;
4519 #endif /* USE_LOCALE_COLLATE */
4520 case PERL_MAGIC_tied:
4521 vtable = &PL_vtbl_pack;
4523 case PERL_MAGIC_tiedelem:
4524 case PERL_MAGIC_tiedscalar:
4525 vtable = &PL_vtbl_packelem;
4528 vtable = &PL_vtbl_regexp;
4530 case PERL_MAGIC_hints:
4531 /* As this vtable is all NULL, we can reuse it. */
4532 case PERL_MAGIC_sig:
4533 vtable = &PL_vtbl_sig;
4535 case PERL_MAGIC_sigelem:
4536 vtable = &PL_vtbl_sigelem;
4538 case PERL_MAGIC_taint:
4539 vtable = &PL_vtbl_taint;
4541 case PERL_MAGIC_uvar:
4542 vtable = &PL_vtbl_uvar;
4544 case PERL_MAGIC_vec:
4545 vtable = &PL_vtbl_vec;
4547 case PERL_MAGIC_arylen_p:
4548 case PERL_MAGIC_rhash:
4549 case PERL_MAGIC_symtab:
4550 case PERL_MAGIC_vstring:
4553 case PERL_MAGIC_utf8:
4554 vtable = &PL_vtbl_utf8;
4556 case PERL_MAGIC_substr:
4557 vtable = &PL_vtbl_substr;
4559 case PERL_MAGIC_defelem:
4560 vtable = &PL_vtbl_defelem;
4562 case PERL_MAGIC_arylen:
4563 vtable = &PL_vtbl_arylen;
4565 case PERL_MAGIC_pos:
4566 vtable = &PL_vtbl_pos;
4568 case PERL_MAGIC_backref:
4569 vtable = &PL_vtbl_backref;
4571 case PERL_MAGIC_hintselem:
4572 vtable = &PL_vtbl_hintselem;
4574 case PERL_MAGIC_ext:
4575 /* Reserved for use by extensions not perl internals. */
4576 /* Useful for attaching extension internal data to perl vars. */
4577 /* Note that multiple extensions may clash if magical scalars */
4578 /* etc holding private data from one are passed to another. */
4582 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4585 /* Rest of work is done else where */
4586 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4589 case PERL_MAGIC_taint:
4592 case PERL_MAGIC_ext:
4593 case PERL_MAGIC_dbfile:
4600 =for apidoc sv_unmagic
4602 Removes all magic of type C<type> from an SV.
4608 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4612 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4614 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4615 for (mg = *mgp; mg; mg = *mgp) {
4616 if (mg->mg_type == type) {
4617 const MGVTBL* const vtbl = mg->mg_virtual;
4618 *mgp = mg->mg_moremagic;
4619 if (vtbl && vtbl->svt_free)
4620 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4621 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4623 Safefree(mg->mg_ptr);
4624 else if (mg->mg_len == HEf_SVKEY)
4625 SvREFCNT_dec((SV*)mg->mg_ptr);
4626 else if (mg->mg_type == PERL_MAGIC_utf8)
4627 Safefree(mg->mg_ptr);
4629 if (mg->mg_flags & MGf_REFCOUNTED)
4630 SvREFCNT_dec(mg->mg_obj);
4634 mgp = &mg->mg_moremagic;
4638 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4639 SvMAGIC_set(sv, NULL);
4646 =for apidoc sv_rvweaken
4648 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4649 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4650 push a back-reference to this RV onto the array of backreferences
4651 associated with that magic. If the RV is magical, set magic will be
4652 called after the RV is cleared.
4658 Perl_sv_rvweaken(pTHX_ SV *sv)
4661 if (!SvOK(sv)) /* let undefs pass */
4664 Perl_croak(aTHX_ "Can't weaken a nonreference");
4665 else if (SvWEAKREF(sv)) {
4666 if (ckWARN(WARN_MISC))
4667 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4671 Perl_sv_add_backref(aTHX_ tsv, sv);
4677 /* Give tsv backref magic if it hasn't already got it, then push a
4678 * back-reference to sv onto the array associated with the backref magic.
4682 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4687 if (SvTYPE(tsv) == SVt_PVHV) {
4688 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4692 /* There is no AV in the offical place - try a fixup. */
4693 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4696 /* Aha. They've got it stowed in magic. Bring it back. */
4697 av = (AV*)mg->mg_obj;
4698 /* Stop mg_free decreasing the refernce count. */
4700 /* Stop mg_free even calling the destructor, given that
4701 there's no AV to free up. */
4703 sv_unmagic(tsv, PERL_MAGIC_backref);
4707 SvREFCNT_inc_simple_void(av);
4712 const MAGIC *const mg
4713 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4715 av = (AV*)mg->mg_obj;
4719 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4720 /* av now has a refcnt of 2, which avoids it getting freed
4721 * before us during global cleanup. The extra ref is removed
4722 * by magic_killbackrefs() when tsv is being freed */
4725 if (AvFILLp(av) >= AvMAX(av)) {
4726 av_extend(av, AvFILLp(av)+1);
4728 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4731 /* delete a back-reference to ourselves from the backref magic associated
4732 * with the SV we point to.
4736 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4743 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4744 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4745 /* We mustn't attempt to "fix up" the hash here by moving the
4746 backreference array back to the hv_aux structure, as that is stored
4747 in the main HvARRAY(), and hfreentries assumes that no-one
4748 reallocates HvARRAY() while it is running. */
4751 const MAGIC *const mg
4752 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4754 av = (AV *)mg->mg_obj;
4757 if (PL_in_clean_all)
4759 Perl_croak(aTHX_ "panic: del_backref");
4766 /* We shouldn't be in here more than once, but for paranoia reasons lets
4768 for (i = AvFILLp(av); i >= 0; i--) {
4770 const SSize_t fill = AvFILLp(av);
4772 /* We weren't the last entry.
4773 An unordered list has this property that you can take the
4774 last element off the end to fill the hole, and it's still
4775 an unordered list :-)
4780 AvFILLp(av) = fill - 1;
4786 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4788 SV **svp = AvARRAY(av);
4790 PERL_UNUSED_ARG(sv);
4792 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4793 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4794 if (svp && !SvIS_FREED(av)) {
4795 SV *const *const last = svp + AvFILLp(av);
4797 while (svp <= last) {
4799 SV *const referrer = *svp;
4800 if (SvWEAKREF(referrer)) {
4801 /* XXX Should we check that it hasn't changed? */
4802 SvRV_set(referrer, 0);
4804 SvWEAKREF_off(referrer);
4805 SvSETMAGIC(referrer);
4806 } else if (SvTYPE(referrer) == SVt_PVGV ||
4807 SvTYPE(referrer) == SVt_PVLV) {
4808 /* You lookin' at me? */
4809 assert(GvSTASH(referrer));
4810 assert(GvSTASH(referrer) == (HV*)sv);
4811 GvSTASH(referrer) = 0;
4814 "panic: magic_killbackrefs (flags=%"UVxf")",
4815 (UV)SvFLAGS(referrer));
4823 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4828 =for apidoc sv_insert
4830 Inserts a string at the specified offset/length within the SV. Similar to
4831 the Perl substr() function.
4837 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4842 register char *midend;
4843 register char *bigend;
4849 Perl_croak(aTHX_ "Can't modify non-existent substring");
4850 SvPV_force(bigstr, curlen);
4851 (void)SvPOK_only_UTF8(bigstr);
4852 if (offset + len > curlen) {
4853 SvGROW(bigstr, offset+len+1);
4854 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4855 SvCUR_set(bigstr, offset+len);
4859 i = littlelen - len;
4860 if (i > 0) { /* string might grow */
4861 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4862 mid = big + offset + len;
4863 midend = bigend = big + SvCUR(bigstr);
4866 while (midend > mid) /* shove everything down */
4867 *--bigend = *--midend;
4868 Move(little,big+offset,littlelen,char);
4869 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4874 Move(little,SvPVX(bigstr)+offset,len,char);
4879 big = SvPVX(bigstr);
4882 bigend = big + SvCUR(bigstr);
4884 if (midend > bigend)
4885 Perl_croak(aTHX_ "panic: sv_insert");
4887 if (mid - big > bigend - midend) { /* faster to shorten from end */
4889 Move(little, mid, littlelen,char);
4892 i = bigend - midend;
4894 Move(midend, mid, i,char);
4898 SvCUR_set(bigstr, mid - big);
4900 else if ((i = mid - big)) { /* faster from front */
4901 midend -= littlelen;
4903 sv_chop(bigstr,midend-i);
4908 Move(little, mid, littlelen,char);
4910 else if (littlelen) {
4911 midend -= littlelen;
4912 sv_chop(bigstr,midend);
4913 Move(little,midend,littlelen,char);
4916 sv_chop(bigstr,midend);
4922 =for apidoc sv_replace
4924 Make the first argument a copy of the second, then delete the original.
4925 The target SV physically takes over ownership of the body of the source SV
4926 and inherits its flags; however, the target keeps any magic it owns,
4927 and any magic in the source is discarded.
4928 Note that this is a rather specialist SV copying operation; most of the
4929 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4935 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4938 const U32 refcnt = SvREFCNT(sv);
4939 SV_CHECK_THINKFIRST_COW_DROP(sv);
4940 if (SvREFCNT(nsv) != 1) {
4941 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4942 UVuf " != 1)", (UV) SvREFCNT(nsv));
4944 if (SvMAGICAL(sv)) {
4948 sv_upgrade(nsv, SVt_PVMG);
4949 SvMAGIC_set(nsv, SvMAGIC(sv));
4950 SvFLAGS(nsv) |= SvMAGICAL(sv);
4952 SvMAGIC_set(sv, NULL);
4956 assert(!SvREFCNT(sv));
4957 #ifdef DEBUG_LEAKING_SCALARS
4958 sv->sv_flags = nsv->sv_flags;
4959 sv->sv_any = nsv->sv_any;
4960 sv->sv_refcnt = nsv->sv_refcnt;
4961 sv->sv_u = nsv->sv_u;
4963 StructCopy(nsv,sv,SV);
4965 /* Currently could join these into one piece of pointer arithmetic, but
4966 it would be unclear. */
4967 if(SvTYPE(sv) == SVt_IV)
4969 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4970 else if (SvTYPE(sv) == SVt_RV) {
4971 SvANY(sv) = &sv->sv_u.svu_rv;
4975 #ifdef PERL_OLD_COPY_ON_WRITE
4976 if (SvIsCOW_normal(nsv)) {
4977 /* We need to follow the pointers around the loop to make the
4978 previous SV point to sv, rather than nsv. */
4981 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4984 assert(SvPVX_const(current) == SvPVX_const(nsv));
4986 /* Make the SV before us point to the SV after us. */
4988 PerlIO_printf(Perl_debug_log, "previous is\n");
4990 PerlIO_printf(Perl_debug_log,
4991 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4992 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4994 SV_COW_NEXT_SV_SET(current, sv);
4997 SvREFCNT(sv) = refcnt;
4998 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5004 =for apidoc sv_clear
5006 Clear an SV: call any destructors, free up any memory used by the body,
5007 and free the body itself. The SV's head is I<not> freed, although
5008 its type is set to all 1's so that it won't inadvertently be assumed
5009 to be live during global destruction etc.
5010 This function should only be called when REFCNT is zero. Most of the time
5011 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5018 Perl_sv_clear(pTHX_ register SV *sv)
5021 const U32 type = SvTYPE(sv);
5022 const struct body_details *const sv_type_details
5023 = bodies_by_type + type;
5026 assert(SvREFCNT(sv) == 0);
5028 if (type <= SVt_IV) {
5029 /* See the comment in sv.h about the collusion between this early
5030 return and the overloading of the NULL and IV slots in the size
5036 if (PL_defstash) { /* Still have a symbol table? */
5041 stash = SvSTASH(sv);
5042 destructor = StashHANDLER(stash,DESTROY);
5044 SV* const tmpref = newRV(sv);
5045 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5047 PUSHSTACKi(PERLSI_DESTROY);
5052 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5058 if(SvREFCNT(tmpref) < 2) {
5059 /* tmpref is not kept alive! */
5061 SvRV_set(tmpref, NULL);
5064 SvREFCNT_dec(tmpref);
5066 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5070 if (PL_in_clean_objs)
5071 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5073 /* DESTROY gave object new lease on life */
5079 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5080 SvOBJECT_off(sv); /* Curse the object. */
5081 if (type != SVt_PVIO)
5082 --PL_sv_objcount; /* XXX Might want something more general */
5085 if (type >= SVt_PVMG) {
5086 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5087 SvREFCNT_dec(OURSTASH(sv));
5088 } else if (SvMAGIC(sv))
5090 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5091 SvREFCNT_dec(SvSTASH(sv));
5096 IoIFP(sv) != PerlIO_stdin() &&
5097 IoIFP(sv) != PerlIO_stdout() &&
5098 IoIFP(sv) != PerlIO_stderr())
5100 io_close((IO*)sv, FALSE);
5102 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5103 PerlDir_close(IoDIRP(sv));
5104 IoDIRP(sv) = (DIR*)NULL;
5105 Safefree(IoTOP_NAME(sv));
5106 Safefree(IoFMT_NAME(sv));
5107 Safefree(IoBOTTOM_NAME(sv));
5116 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5123 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5124 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5125 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5126 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5128 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5129 SvREFCNT_dec(LvTARG(sv));
5133 if (GvNAME_HEK(sv)) {
5134 unshare_hek(GvNAME_HEK(sv));
5136 /* If we're in a stash, we don't own a reference to it. However it does
5137 have a back reference to us, which needs to be cleared. */
5139 sv_del_backref((SV*)GvSTASH(sv), sv);
5144 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5146 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5147 /* Don't even bother with turning off the OOK flag. */
5152 SV * const target = SvRV(sv);
5154 sv_del_backref(target, sv);
5156 SvREFCNT_dec(target);
5158 #ifdef PERL_OLD_COPY_ON_WRITE
5159 else if (SvPVX_const(sv)) {
5161 /* I believe I need to grab the global SV mutex here and
5162 then recheck the COW status. */
5164 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5167 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5168 SV_COW_NEXT_SV(sv));
5169 /* And drop it here. */
5171 } else if (SvLEN(sv)) {
5172 Safefree(SvPVX_const(sv));
5176 else if (SvPVX_const(sv) && SvLEN(sv))
5177 Safefree(SvPVX_mutable(sv));
5178 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5179 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5188 SvFLAGS(sv) &= SVf_BREAK;
5189 SvFLAGS(sv) |= SVTYPEMASK;
5191 if (sv_type_details->arena) {
5192 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5193 &PL_body_roots[type]);
5195 else if (sv_type_details->body_size) {
5196 my_safefree(SvANY(sv));
5201 =for apidoc sv_newref
5203 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5210 Perl_sv_newref(pTHX_ SV *sv)
5212 PERL_UNUSED_CONTEXT;
5221 Decrement an SV's reference count, and if it drops to zero, call
5222 C<sv_clear> to invoke destructors and free up any memory used by
5223 the body; finally, deallocate the SV's head itself.
5224 Normally called via a wrapper macro C<SvREFCNT_dec>.
5230 Perl_sv_free(pTHX_ SV *sv)
5235 if (SvREFCNT(sv) == 0) {
5236 if (SvFLAGS(sv) & SVf_BREAK)
5237 /* this SV's refcnt has been artificially decremented to
5238 * trigger cleanup */
5240 if (PL_in_clean_all) /* All is fair */
5242 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5243 /* make sure SvREFCNT(sv)==0 happens very seldom */
5244 SvREFCNT(sv) = (~(U32)0)/2;
5247 if (ckWARN_d(WARN_INTERNAL)) {
5248 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5249 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5250 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5251 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5252 Perl_dump_sv_child(aTHX_ sv);
5257 if (--(SvREFCNT(sv)) > 0)
5259 Perl_sv_free2(aTHX_ sv);
5263 Perl_sv_free2(pTHX_ SV *sv)
5268 if (ckWARN_d(WARN_DEBUGGING))
5269 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5270 "Attempt to free temp prematurely: SV 0x%"UVxf
5271 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5275 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5276 /* make sure SvREFCNT(sv)==0 happens very seldom */
5277 SvREFCNT(sv) = (~(U32)0)/2;
5288 Returns the length of the string in the SV. Handles magic and type
5289 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5295 Perl_sv_len(pTHX_ register SV *sv)
5303 len = mg_length(sv);
5305 (void)SvPV_const(sv, len);
5310 =for apidoc sv_len_utf8
5312 Returns the number of characters in the string in an SV, counting wide
5313 UTF-8 bytes as a single character. Handles magic and type coercion.
5319 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5320 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5321 * (Note that the mg_len is not the length of the mg_ptr field.
5322 * This allows the cache to store the character length of the string without
5323 * needing to malloc() extra storage to attach to the mg_ptr.)
5328 Perl_sv_len_utf8(pTHX_ register SV *sv)
5334 return mg_length(sv);
5338 const U8 *s = (U8*)SvPV_const(sv, len);
5342 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5344 if (mg && mg->mg_len != -1) {
5346 if (PL_utf8cache < 0) {
5347 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5349 /* Need to turn the assertions off otherwise we may
5350 recurse infinitely while printing error messages.
5352 SAVEI8(PL_utf8cache);
5354 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5355 " real %"UVf" for %"SVf,
5356 (UV) ulen, (UV) real, (void*)sv);
5361 ulen = Perl_utf8_length(aTHX_ s, s + len);
5362 if (!SvREADONLY(sv)) {
5364 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5365 &PL_vtbl_utf8, 0, 0);
5373 return Perl_utf8_length(aTHX_ s, s + len);
5377 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5380 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5383 const U8 *s = start;
5385 while (s < send && uoffset--)
5388 /* This is the existing behaviour. Possibly it should be a croak, as
5389 it's actually a bounds error */
5395 /* Given the length of the string in both bytes and UTF-8 characters, decide
5396 whether to walk forwards or backwards to find the byte corresponding to
5397 the passed in UTF-8 offset. */
5399 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5400 STRLEN uoffset, STRLEN uend)
5402 STRLEN backw = uend - uoffset;
5403 if (uoffset < 2 * backw) {
5404 /* The assumption is that going forwards is twice the speed of going
5405 forward (that's where the 2 * backw comes from).
5406 (The real figure of course depends on the UTF-8 data.) */
5407 return sv_pos_u2b_forwards(start, send, uoffset);
5412 while (UTF8_IS_CONTINUATION(*send))
5415 return send - start;
5418 /* For the string representation of the given scalar, find the byte
5419 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5420 give another position in the string, *before* the sought offset, which
5421 (which is always true, as 0, 0 is a valid pair of positions), which should
5422 help reduce the amount of linear searching.
5423 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5424 will be used to reduce the amount of linear searching. The cache will be
5425 created if necessary, and the found value offered to it for update. */
5427 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5428 const U8 *const send, STRLEN uoffset,
5429 STRLEN uoffset0, STRLEN boffset0) {
5430 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5433 assert (uoffset >= uoffset0);
5435 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5436 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5437 if ((*mgp)->mg_ptr) {
5438 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5439 if (cache[0] == uoffset) {
5440 /* An exact match. */
5443 if (cache[2] == uoffset) {
5444 /* An exact match. */
5448 if (cache[0] < uoffset) {
5449 /* The cache already knows part of the way. */
5450 if (cache[0] > uoffset0) {
5451 /* The cache knows more than the passed in pair */
5452 uoffset0 = cache[0];
5453 boffset0 = cache[1];
5455 if ((*mgp)->mg_len != -1) {
5456 /* And we know the end too. */
5458 + sv_pos_u2b_midway(start + boffset0, send,
5460 (*mgp)->mg_len - uoffset0);
5463 + sv_pos_u2b_forwards(start + boffset0,
5464 send, uoffset - uoffset0);
5467 else if (cache[2] < uoffset) {
5468 /* We're between the two cache entries. */
5469 if (cache[2] > uoffset0) {
5470 /* and the cache knows more than the passed in pair */
5471 uoffset0 = cache[2];
5472 boffset0 = cache[3];
5476 + sv_pos_u2b_midway(start + boffset0,
5479 cache[0] - uoffset0);
5482 + sv_pos_u2b_midway(start + boffset0,
5485 cache[2] - uoffset0);
5489 else if ((*mgp)->mg_len != -1) {
5490 /* If we can take advantage of a passed in offset, do so. */
5491 /* In fact, offset0 is either 0, or less than offset, so don't
5492 need to worry about the other possibility. */
5494 + sv_pos_u2b_midway(start + boffset0, send,
5496 (*mgp)->mg_len - uoffset0);
5501 if (!found || PL_utf8cache < 0) {
5502 const STRLEN real_boffset
5503 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5504 send, uoffset - uoffset0);
5506 if (found && PL_utf8cache < 0) {
5507 if (real_boffset != boffset) {
5508 /* Need to turn the assertions off otherwise we may recurse
5509 infinitely while printing error messages. */
5510 SAVEI8(PL_utf8cache);
5512 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5513 " real %"UVf" for %"SVf,
5514 (UV) boffset, (UV) real_boffset, (void*)sv);
5517 boffset = real_boffset;
5520 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5526 =for apidoc sv_pos_u2b
5528 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5529 the start of the string, to a count of the equivalent number of bytes; if
5530 lenp is non-zero, it does the same to lenp, but this time starting from
5531 the offset, rather than from the start of the string. Handles magic and
5538 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5539 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5540 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5545 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5553 start = (U8*)SvPV_const(sv, len);
5555 STRLEN uoffset = (STRLEN) *offsetp;
5556 const U8 * const send = start + len;
5558 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5561 *offsetp = (I32) boffset;
5564 /* Convert the relative offset to absolute. */
5565 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5566 const STRLEN boffset2
5567 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5568 uoffset, boffset) - boffset;
5582 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5583 byte length pairing. The (byte) length of the total SV is passed in too,
5584 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5585 may not have updated SvCUR, so we can't rely on reading it directly.
5587 The proffered utf8/byte length pairing isn't used if the cache already has
5588 two pairs, and swapping either for the proffered pair would increase the
5589 RMS of the intervals between known byte offsets.
5591 The cache itself consists of 4 STRLEN values
5592 0: larger UTF-8 offset
5593 1: corresponding byte offset
5594 2: smaller UTF-8 offset
5595 3: corresponding byte offset
5597 Unused cache pairs have the value 0, 0.
5598 Keeping the cache "backwards" means that the invariant of
5599 cache[0] >= cache[2] is maintained even with empty slots, which means that
5600 the code that uses it doesn't need to worry if only 1 entry has actually
5601 been set to non-zero. It also makes the "position beyond the end of the
5602 cache" logic much simpler, as the first slot is always the one to start
5606 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5614 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5616 (*mgp)->mg_len = -1;
5620 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5621 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5622 (*mgp)->mg_ptr = (char *) cache;
5626 if (PL_utf8cache < 0) {
5627 const U8 *start = (const U8 *) SvPVX_const(sv);
5628 const U8 *const end = start + byte;
5629 STRLEN realutf8 = 0;
5631 while (start < end) {
5632 start += UTF8SKIP(start);
5636 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5637 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5638 doesn't? I don't know whether this difference was introduced with
5639 the caching code in 5.8.1. */
5641 if (realutf8 != utf8) {
5642 /* Need to turn the assertions off otherwise we may recurse
5643 infinitely while printing error messages. */
5644 SAVEI8(PL_utf8cache);
5646 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5647 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5651 /* Cache is held with the later position first, to simplify the code
5652 that deals with unbounded ends. */
5654 ASSERT_UTF8_CACHE(cache);
5655 if (cache[1] == 0) {
5656 /* Cache is totally empty */
5659 } else if (cache[3] == 0) {
5660 if (byte > cache[1]) {
5661 /* New one is larger, so goes first. */
5662 cache[2] = cache[0];
5663 cache[3] = cache[1];
5671 #define THREEWAY_SQUARE(a,b,c,d) \
5672 ((float)((d) - (c))) * ((float)((d) - (c))) \
5673 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5674 + ((float)((b) - (a))) * ((float)((b) - (a)))
5676 /* Cache has 2 slots in use, and we know three potential pairs.
5677 Keep the two that give the lowest RMS distance. Do the
5678 calcualation in bytes simply because we always know the byte
5679 length. squareroot has the same ordering as the positive value,
5680 so don't bother with the actual square root. */
5681 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5682 if (byte > cache[1]) {
5683 /* New position is after the existing pair of pairs. */
5684 const float keep_earlier
5685 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5686 const float keep_later
5687 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5689 if (keep_later < keep_earlier) {
5690 if (keep_later < existing) {
5691 cache[2] = cache[0];
5692 cache[3] = cache[1];
5698 if (keep_earlier < existing) {
5704 else if (byte > cache[3]) {
5705 /* New position is between the existing pair of pairs. */
5706 const float keep_earlier
5707 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5708 const float keep_later
5709 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5711 if (keep_later < keep_earlier) {
5712 if (keep_later < existing) {
5718 if (keep_earlier < existing) {
5725 /* New position is before the existing pair of pairs. */
5726 const float keep_earlier
5727 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5728 const float keep_later
5729 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5731 if (keep_later < keep_earlier) {
5732 if (keep_later < existing) {
5738 if (keep_earlier < existing) {
5739 cache[0] = cache[2];
5740 cache[1] = cache[3];
5747 ASSERT_UTF8_CACHE(cache);
5750 /* If we don't know the character offset of the end of a region, our only
5751 option is to walk forwards to the target byte offset. */
5753 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5756 while (s < target) {
5759 /* Call utf8n_to_uvchr() to validate the sequence
5760 * (unless a simple non-UTF character) */
5761 if (!UTF8_IS_INVARIANT(*s))
5762 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5773 /* We already know all of the way, now we may be able to walk back. The same
5774 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5775 backward is half the speed of walking forward. */
5777 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5780 const STRLEN forw = target - s;
5781 STRLEN backw = end - target;
5783 if (forw < 2 * backw) {
5784 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5787 while (end > target) {
5789 while (UTF8_IS_CONTINUATION(*end)) {
5798 =for apidoc sv_pos_b2u
5800 Converts the value pointed to by offsetp from a count of bytes from the
5801 start of the string, to a count of the equivalent number of UTF-8 chars.
5802 Handles magic and type coercion.
5808 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5809 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5814 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5817 const STRLEN byte = *offsetp;
5818 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5827 s = (const U8*)SvPV_const(sv, blen);
5830 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5834 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5835 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5837 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5838 if (cache[1] == byte) {
5839 /* An exact match. */
5840 *offsetp = cache[0];
5843 if (cache[3] == byte) {
5844 /* An exact match. */
5845 *offsetp = cache[2];
5849 if (cache[1] < byte) {
5850 /* We already know part of the way. */
5851 if (mg->mg_len != -1) {
5852 /* Actually, we know the end too. */
5854 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5855 s + blen, mg->mg_len - cache[0]);
5858 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5861 else if (cache[3] < byte) {
5862 /* We're between the two cached pairs, so we do the calculation
5863 offset by the byte/utf-8 positions for the earlier pair,
5864 then add the utf-8 characters from the string start to
5866 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5867 s + cache[1], cache[0] - cache[2])
5871 else { /* cache[3] > byte */
5872 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5876 ASSERT_UTF8_CACHE(cache);
5878 } else if (mg->mg_len != -1) {
5879 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5883 if (!found || PL_utf8cache < 0) {
5884 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5886 if (found && PL_utf8cache < 0) {
5887 if (len != real_len) {
5888 /* Need to turn the assertions off otherwise we may recurse
5889 infinitely while printing error messages. */
5890 SAVEI8(PL_utf8cache);
5892 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5893 " real %"UVf" for %"SVf,
5894 (UV) len, (UV) real_len, (void*)sv);
5901 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5907 Returns a boolean indicating whether the strings in the two SVs are
5908 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5909 coerce its args to strings if necessary.
5915 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5924 SV* svrecode = NULL;
5931 pv1 = SvPV_const(sv1, cur1);
5938 pv2 = SvPV_const(sv2, cur2);
5940 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5941 /* Differing utf8ness.
5942 * Do not UTF8size the comparands as a side-effect. */
5945 svrecode = newSVpvn(pv2, cur2);
5946 sv_recode_to_utf8(svrecode, PL_encoding);
5947 pv2 = SvPV_const(svrecode, cur2);
5950 svrecode = newSVpvn(pv1, cur1);
5951 sv_recode_to_utf8(svrecode, PL_encoding);
5952 pv1 = SvPV_const(svrecode, cur1);
5954 /* Now both are in UTF-8. */
5956 SvREFCNT_dec(svrecode);
5961 bool is_utf8 = TRUE;
5964 /* sv1 is the UTF-8 one,
5965 * if is equal it must be downgrade-able */
5966 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5972 /* sv2 is the UTF-8 one,
5973 * if is equal it must be downgrade-able */
5974 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5980 /* Downgrade not possible - cannot be eq */
5988 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5990 SvREFCNT_dec(svrecode);
6000 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6001 string in C<sv1> is less than, equal to, or greater than the string in
6002 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6003 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6009 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6013 const char *pv1, *pv2;
6016 SV *svrecode = NULL;
6023 pv1 = SvPV_const(sv1, cur1);
6030 pv2 = SvPV_const(sv2, cur2);
6032 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6033 /* Differing utf8ness.
6034 * Do not UTF8size the comparands as a side-effect. */
6037 svrecode = newSVpvn(pv2, cur2);
6038 sv_recode_to_utf8(svrecode, PL_encoding);
6039 pv2 = SvPV_const(svrecode, cur2);
6042 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6047 svrecode = newSVpvn(pv1, cur1);
6048 sv_recode_to_utf8(svrecode, PL_encoding);
6049 pv1 = SvPV_const(svrecode, cur1);
6052 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6058 cmp = cur2 ? -1 : 0;
6062 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6065 cmp = retval < 0 ? -1 : 1;
6066 } else if (cur1 == cur2) {
6069 cmp = cur1 < cur2 ? -1 : 1;
6073 SvREFCNT_dec(svrecode);
6081 =for apidoc sv_cmp_locale
6083 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6084 'use bytes' aware, handles get magic, and will coerce its args to strings
6085 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6091 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6094 #ifdef USE_LOCALE_COLLATE
6100 if (PL_collation_standard)
6104 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6106 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6108 if (!pv1 || !len1) {
6119 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6122 return retval < 0 ? -1 : 1;
6125 * When the result of collation is equality, that doesn't mean
6126 * that there are no differences -- some locales exclude some
6127 * characters from consideration. So to avoid false equalities,
6128 * we use the raw string as a tiebreaker.
6134 #endif /* USE_LOCALE_COLLATE */
6136 return sv_cmp(sv1, sv2);
6140 #ifdef USE_LOCALE_COLLATE
6143 =for apidoc sv_collxfrm
6145 Add Collate Transform magic to an SV if it doesn't already have it.
6147 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6148 scalar data of the variable, but transformed to such a format that a normal
6149 memory comparison can be used to compare the data according to the locale
6156 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6161 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6162 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6168 Safefree(mg->mg_ptr);
6169 s = SvPV_const(sv, len);
6170 if ((xf = mem_collxfrm(s, len, &xlen))) {
6171 if (SvREADONLY(sv)) {
6174 return xf + sizeof(PL_collation_ix);
6177 #ifdef PERL_OLD_COPY_ON_WRITE
6179 sv_force_normal_flags(sv, 0);
6181 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6195 if (mg && mg->mg_ptr) {
6197 return mg->mg_ptr + sizeof(PL_collation_ix);
6205 #endif /* USE_LOCALE_COLLATE */
6210 Get a line from the filehandle and store it into the SV, optionally
6211 appending to the currently-stored string.
6217 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6222 register STDCHAR rslast;
6223 register STDCHAR *bp;
6228 if (SvTHINKFIRST(sv))
6229 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6230 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6232 However, perlbench says it's slower, because the existing swipe code
6233 is faster than copy on write.
6234 Swings and roundabouts. */
6235 SvUPGRADE(sv, SVt_PV);
6240 if (PerlIO_isutf8(fp)) {
6242 sv_utf8_upgrade_nomg(sv);
6243 sv_pos_u2b(sv,&append,0);
6245 } else if (SvUTF8(sv)) {
6246 SV * const tsv = newSV(0);
6247 sv_gets(tsv, fp, 0);
6248 sv_utf8_upgrade_nomg(tsv);
6249 SvCUR_set(sv,append);
6252 goto return_string_or_null;
6257 if (PerlIO_isutf8(fp))
6260 if (IN_PERL_COMPILETIME) {
6261 /* we always read code in line mode */
6265 else if (RsSNARF(PL_rs)) {
6266 /* If it is a regular disk file use size from stat() as estimate
6267 of amount we are going to read -- may result in mallocing
6268 more memory than we really need if the layers below reduce
6269 the size we read (e.g. CRLF or a gzip layer).
6272 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6273 const Off_t offset = PerlIO_tell(fp);
6274 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6275 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6281 else if (RsRECORD(PL_rs)) {
6286 /* Grab the size of the record we're getting */
6287 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6288 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6291 /* VMS wants read instead of fread, because fread doesn't respect */
6292 /* RMS record boundaries. This is not necessarily a good thing to be */
6293 /* doing, but we've got no other real choice - except avoid stdio
6294 as implementation - perhaps write a :vms layer ?
6296 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6298 bytesread = PerlIO_read(fp, buffer, recsize);
6302 SvCUR_set(sv, bytesread += append);
6303 buffer[bytesread] = '\0';
6304 goto return_string_or_null;
6306 else if (RsPARA(PL_rs)) {
6312 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6313 if (PerlIO_isutf8(fp)) {
6314 rsptr = SvPVutf8(PL_rs, rslen);
6317 if (SvUTF8(PL_rs)) {
6318 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6319 Perl_croak(aTHX_ "Wide character in $/");
6322 rsptr = SvPV_const(PL_rs, rslen);
6326 rslast = rslen ? rsptr[rslen - 1] : '\0';
6328 if (rspara) { /* have to do this both before and after */
6329 do { /* to make sure file boundaries work right */
6332 i = PerlIO_getc(fp);
6336 PerlIO_ungetc(fp,i);
6342 /* See if we know enough about I/O mechanism to cheat it ! */
6344 /* This used to be #ifdef test - it is made run-time test for ease
6345 of abstracting out stdio interface. One call should be cheap
6346 enough here - and may even be a macro allowing compile
6350 if (PerlIO_fast_gets(fp)) {
6353 * We're going to steal some values from the stdio struct
6354 * and put EVERYTHING in the innermost loop into registers.
6356 register STDCHAR *ptr;
6360 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6361 /* An ungetc()d char is handled separately from the regular
6362 * buffer, so we getc() it back out and stuff it in the buffer.
6364 i = PerlIO_getc(fp);
6365 if (i == EOF) return 0;
6366 *(--((*fp)->_ptr)) = (unsigned char) i;
6370 /* Here is some breathtakingly efficient cheating */
6372 cnt = PerlIO_get_cnt(fp); /* get count into register */
6373 /* make sure we have the room */
6374 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6375 /* Not room for all of it
6376 if we are looking for a separator and room for some
6378 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6379 /* just process what we have room for */
6380 shortbuffered = cnt - SvLEN(sv) + append + 1;
6381 cnt -= shortbuffered;
6385 /* remember that cnt can be negative */
6386 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6391 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6392 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6393 DEBUG_P(PerlIO_printf(Perl_debug_log,
6394 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6395 DEBUG_P(PerlIO_printf(Perl_debug_log,
6396 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6397 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6398 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6403 while (cnt > 0) { /* this | eat */
6405 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6406 goto thats_all_folks; /* screams | sed :-) */
6410 Copy(ptr, bp, cnt, char); /* this | eat */
6411 bp += cnt; /* screams | dust */
6412 ptr += cnt; /* louder | sed :-) */
6417 if (shortbuffered) { /* oh well, must extend */
6418 cnt = shortbuffered;
6420 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6422 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6423 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6427 DEBUG_P(PerlIO_printf(Perl_debug_log,
6428 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6429 PTR2UV(ptr),(long)cnt));
6430 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6432 DEBUG_P(PerlIO_printf(Perl_debug_log,
6433 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6434 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6435 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6437 /* This used to call 'filbuf' in stdio form, but as that behaves like
6438 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6439 another abstraction. */
6440 i = PerlIO_getc(fp); /* get more characters */
6442 DEBUG_P(PerlIO_printf(Perl_debug_log,
6443 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6444 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6445 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6447 cnt = PerlIO_get_cnt(fp);
6448 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6449 DEBUG_P(PerlIO_printf(Perl_debug_log,
6450 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6452 if (i == EOF) /* all done for ever? */
6453 goto thats_really_all_folks;
6455 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6457 SvGROW(sv, bpx + cnt + 2);
6458 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6460 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6462 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6463 goto thats_all_folks;
6467 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6468 memNE((char*)bp - rslen, rsptr, rslen))
6469 goto screamer; /* go back to the fray */
6470 thats_really_all_folks:
6472 cnt += shortbuffered;
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6475 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6476 DEBUG_P(PerlIO_printf(Perl_debug_log,
6477 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6478 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6479 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6481 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6482 DEBUG_P(PerlIO_printf(Perl_debug_log,
6483 "Screamer: done, len=%ld, string=|%.*s|\n",
6484 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6488 /*The big, slow, and stupid way. */
6489 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6490 STDCHAR *buf = NULL;
6491 Newx(buf, 8192, STDCHAR);
6499 register const STDCHAR * const bpe = buf + sizeof(buf);
6501 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6502 ; /* keep reading */
6506 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6507 /* Accomodate broken VAXC compiler, which applies U8 cast to
6508 * both args of ?: operator, causing EOF to change into 255
6511 i = (U8)buf[cnt - 1];
6517 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6519 sv_catpvn(sv, (char *) buf, cnt);
6521 sv_setpvn(sv, (char *) buf, cnt);
6523 if (i != EOF && /* joy */
6525 SvCUR(sv) < rslen ||
6526 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6530 * If we're reading from a TTY and we get a short read,
6531 * indicating that the user hit his EOF character, we need
6532 * to notice it now, because if we try to read from the TTY
6533 * again, the EOF condition will disappear.
6535 * The comparison of cnt to sizeof(buf) is an optimization
6536 * that prevents unnecessary calls to feof().
6540 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6544 #ifdef USE_HEAP_INSTEAD_OF_STACK
6549 if (rspara) { /* have to do this both before and after */
6550 while (i != EOF) { /* to make sure file boundaries work right */
6551 i = PerlIO_getc(fp);
6553 PerlIO_ungetc(fp,i);
6559 return_string_or_null:
6560 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6566 Auto-increment of the value in the SV, doing string to numeric conversion
6567 if necessary. Handles 'get' magic.
6573 Perl_sv_inc(pTHX_ register SV *sv)
6582 if (SvTHINKFIRST(sv)) {
6584 sv_force_normal_flags(sv, 0);
6585 if (SvREADONLY(sv)) {
6586 if (IN_PERL_RUNTIME)
6587 Perl_croak(aTHX_ PL_no_modify);
6591 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6593 i = PTR2IV(SvRV(sv));
6598 flags = SvFLAGS(sv);
6599 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6600 /* It's (privately or publicly) a float, but not tested as an
6601 integer, so test it to see. */
6603 flags = SvFLAGS(sv);
6605 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6606 /* It's publicly an integer, or privately an integer-not-float */
6607 #ifdef PERL_PRESERVE_IVUV
6611 if (SvUVX(sv) == UV_MAX)
6612 sv_setnv(sv, UV_MAX_P1);
6614 (void)SvIOK_only_UV(sv);
6615 SvUV_set(sv, SvUVX(sv) + 1);
6617 if (SvIVX(sv) == IV_MAX)
6618 sv_setuv(sv, (UV)IV_MAX + 1);
6620 (void)SvIOK_only(sv);
6621 SvIV_set(sv, SvIVX(sv) + 1);
6626 if (flags & SVp_NOK) {
6627 (void)SvNOK_only(sv);
6628 SvNV_set(sv, SvNVX(sv) + 1.0);
6632 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6633 if ((flags & SVTYPEMASK) < SVt_PVIV)
6634 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6635 (void)SvIOK_only(sv);
6640 while (isALPHA(*d)) d++;
6641 while (isDIGIT(*d)) d++;
6643 #ifdef PERL_PRESERVE_IVUV
6644 /* Got to punt this as an integer if needs be, but we don't issue
6645 warnings. Probably ought to make the sv_iv_please() that does
6646 the conversion if possible, and silently. */
6647 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6648 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6649 /* Need to try really hard to see if it's an integer.
6650 9.22337203685478e+18 is an integer.
6651 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6652 so $a="9.22337203685478e+18"; $a+0; $a++
6653 needs to be the same as $a="9.22337203685478e+18"; $a++
6660 /* sv_2iv *should* have made this an NV */
6661 if (flags & SVp_NOK) {
6662 (void)SvNOK_only(sv);
6663 SvNV_set(sv, SvNVX(sv) + 1.0);
6666 /* I don't think we can get here. Maybe I should assert this
6667 And if we do get here I suspect that sv_setnv will croak. NWC
6669 #if defined(USE_LONG_DOUBLE)
6670 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",
6671 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6673 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6674 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6677 #endif /* PERL_PRESERVE_IVUV */
6678 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6682 while (d >= SvPVX_const(sv)) {
6690 /* MKS: The original code here died if letters weren't consecutive.
6691 * at least it didn't have to worry about non-C locales. The
6692 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6693 * arranged in order (although not consecutively) and that only
6694 * [A-Za-z] are accepted by isALPHA in the C locale.
6696 if (*d != 'z' && *d != 'Z') {
6697 do { ++*d; } while (!isALPHA(*d));
6700 *(d--) -= 'z' - 'a';
6705 *(d--) -= 'z' - 'a' + 1;
6709 /* oh,oh, the number grew */
6710 SvGROW(sv, SvCUR(sv) + 2);
6711 SvCUR_set(sv, SvCUR(sv) + 1);
6712 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6723 Auto-decrement of the value in the SV, doing string to numeric conversion
6724 if necessary. Handles 'get' magic.
6730 Perl_sv_dec(pTHX_ register SV *sv)
6738 if (SvTHINKFIRST(sv)) {
6740 sv_force_normal_flags(sv, 0);
6741 if (SvREADONLY(sv)) {
6742 if (IN_PERL_RUNTIME)
6743 Perl_croak(aTHX_ PL_no_modify);
6747 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6749 i = PTR2IV(SvRV(sv));
6754 /* Unlike sv_inc we don't have to worry about string-never-numbers
6755 and keeping them magic. But we mustn't warn on punting */
6756 flags = SvFLAGS(sv);
6757 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6758 /* It's publicly an integer, or privately an integer-not-float */
6759 #ifdef PERL_PRESERVE_IVUV
6763 if (SvUVX(sv) == 0) {
6764 (void)SvIOK_only(sv);
6768 (void)SvIOK_only_UV(sv);
6769 SvUV_set(sv, SvUVX(sv) - 1);
6772 if (SvIVX(sv) == IV_MIN)
6773 sv_setnv(sv, (NV)IV_MIN - 1.0);
6775 (void)SvIOK_only(sv);
6776 SvIV_set(sv, SvIVX(sv) - 1);
6781 if (flags & SVp_NOK) {
6782 SvNV_set(sv, SvNVX(sv) - 1.0);
6783 (void)SvNOK_only(sv);
6786 if (!(flags & SVp_POK)) {
6787 if ((flags & SVTYPEMASK) < SVt_PVIV)
6788 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6790 (void)SvIOK_only(sv);
6793 #ifdef PERL_PRESERVE_IVUV
6795 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6796 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6797 /* Need to try really hard to see if it's an integer.
6798 9.22337203685478e+18 is an integer.
6799 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6800 so $a="9.22337203685478e+18"; $a+0; $a--
6801 needs to be the same as $a="9.22337203685478e+18"; $a--
6808 /* sv_2iv *should* have made this an NV */
6809 if (flags & SVp_NOK) {
6810 (void)SvNOK_only(sv);
6811 SvNV_set(sv, SvNVX(sv) - 1.0);
6814 /* I don't think we can get here. Maybe I should assert this
6815 And if we do get here I suspect that sv_setnv will croak. NWC
6817 #if defined(USE_LONG_DOUBLE)
6818 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",
6819 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6821 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6822 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6826 #endif /* PERL_PRESERVE_IVUV */
6827 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6831 =for apidoc sv_mortalcopy
6833 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6834 The new SV is marked as mortal. It will be destroyed "soon", either by an
6835 explicit call to FREETMPS, or by an implicit call at places such as
6836 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6841 /* Make a string that will exist for the duration of the expression
6842 * evaluation. Actually, it may have to last longer than that, but
6843 * hopefully we won't free it until it has been assigned to a
6844 * permanent location. */
6847 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6853 sv_setsv(sv,oldstr);
6855 PL_tmps_stack[++PL_tmps_ix] = sv;
6861 =for apidoc sv_newmortal
6863 Creates a new null SV which is mortal. The reference count of the SV is
6864 set to 1. It will be destroyed "soon", either by an explicit call to
6865 FREETMPS, or by an implicit call at places such as statement boundaries.
6866 See also C<sv_mortalcopy> and C<sv_2mortal>.
6872 Perl_sv_newmortal(pTHX)
6878 SvFLAGS(sv) = SVs_TEMP;
6880 PL_tmps_stack[++PL_tmps_ix] = sv;
6885 =for apidoc sv_2mortal
6887 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6888 by an explicit call to FREETMPS, or by an implicit call at places such as
6889 statement boundaries. SvTEMP() is turned on which means that the SV's
6890 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6891 and C<sv_mortalcopy>.
6897 Perl_sv_2mortal(pTHX_ register SV *sv)
6902 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6905 PL_tmps_stack[++PL_tmps_ix] = sv;
6913 Creates a new SV and copies a string into it. The reference count for the
6914 SV is set to 1. If C<len> is zero, Perl will compute the length using
6915 strlen(). For efficiency, consider using C<newSVpvn> instead.
6921 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6927 sv_setpvn(sv,s,len ? len : strlen(s));
6932 =for apidoc newSVpvn
6934 Creates a new SV and copies a string into it. The reference count for the
6935 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6936 string. You are responsible for ensuring that the source string is at least
6937 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6943 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6949 sv_setpvn(sv,s,len);
6955 =for apidoc newSVhek
6957 Creates a new SV from the hash key structure. It will generate scalars that
6958 point to the shared string table where possible. Returns a new (undefined)
6959 SV if the hek is NULL.
6965 Perl_newSVhek(pTHX_ const HEK *hek)
6975 if (HEK_LEN(hek) == HEf_SVKEY) {
6976 return newSVsv(*(SV**)HEK_KEY(hek));
6978 const int flags = HEK_FLAGS(hek);
6979 if (flags & HVhek_WASUTF8) {
6981 Andreas would like keys he put in as utf8 to come back as utf8
6983 STRLEN utf8_len = HEK_LEN(hek);
6984 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6985 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6988 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6990 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6991 /* We don't have a pointer to the hv, so we have to replicate the
6992 flag into every HEK. This hv is using custom a hasing
6993 algorithm. Hence we can't return a shared string scalar, as
6994 that would contain the (wrong) hash value, and might get passed
6995 into an hv routine with a regular hash.
6996 Similarly, a hash that isn't using shared hash keys has to have
6997 the flag in every key so that we know not to try to call
6998 share_hek_kek on it. */
7000 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7005 /* This will be overwhelminly the most common case. */
7007 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7008 more efficient than sharepvn(). */
7012 sv_upgrade(sv, SVt_PV);
7013 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7014 SvCUR_set(sv, HEK_LEN(hek));
7027 =for apidoc newSVpvn_share
7029 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7030 table. If the string does not already exist in the table, it is created
7031 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7032 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7033 otherwise the hash is computed. The idea here is that as the string table
7034 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7035 hash lookup will avoid string compare.
7041 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7045 bool is_utf8 = FALSE;
7046 const char *const orig_src = src;
7049 STRLEN tmplen = -len;
7051 /* See the note in hv.c:hv_fetch() --jhi */
7052 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7056 PERL_HASH(hash, src, len);
7058 sv_upgrade(sv, SVt_PV);
7059 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7067 if (src != orig_src)
7073 #if defined(PERL_IMPLICIT_CONTEXT)
7075 /* pTHX_ magic can't cope with varargs, so this is a no-context
7076 * version of the main function, (which may itself be aliased to us).
7077 * Don't access this version directly.
7081 Perl_newSVpvf_nocontext(const char* pat, ...)
7086 va_start(args, pat);
7087 sv = vnewSVpvf(pat, &args);
7094 =for apidoc newSVpvf
7096 Creates a new SV and initializes it with the string formatted like
7103 Perl_newSVpvf(pTHX_ const char* pat, ...)
7107 va_start(args, pat);
7108 sv = vnewSVpvf(pat, &args);
7113 /* backend for newSVpvf() and newSVpvf_nocontext() */
7116 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7121 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7128 Creates a new SV and copies a floating point value into it.
7129 The reference count for the SV is set to 1.
7135 Perl_newSVnv(pTHX_ NV n)
7148 Creates a new SV and copies an integer into it. The reference count for the
7155 Perl_newSViv(pTHX_ IV i)
7168 Creates a new SV and copies an unsigned integer into it.
7169 The reference count for the SV is set to 1.
7175 Perl_newSVuv(pTHX_ UV u)
7186 =for apidoc newRV_noinc
7188 Creates an RV wrapper for an SV. The reference count for the original
7189 SV is B<not> incremented.
7195 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7201 sv_upgrade(sv, SVt_RV);
7203 SvRV_set(sv, tmpRef);
7208 /* newRV_inc is the official function name to use now.
7209 * newRV_inc is in fact #defined to newRV in sv.h
7213 Perl_newRV(pTHX_ SV *sv)
7216 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7222 Creates a new SV which is an exact duplicate of the original SV.
7229 Perl_newSVsv(pTHX_ register SV *old)
7236 if (SvTYPE(old) == SVTYPEMASK) {
7237 if (ckWARN_d(WARN_INTERNAL))
7238 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7242 /* SV_GMAGIC is the default for sv_setv()
7243 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7244 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7245 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7250 =for apidoc sv_reset
7252 Underlying implementation for the C<reset> Perl function.
7253 Note that the perl-level function is vaguely deprecated.
7259 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7262 char todo[PERL_UCHAR_MAX+1];
7267 if (!*s) { /* reset ?? searches */
7268 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7270 PMOP *pm = (PMOP *) mg->mg_obj;
7272 pm->op_pmdynflags &= ~PMdf_USED;
7279 /* reset variables */
7281 if (!HvARRAY(stash))
7284 Zero(todo, 256, char);
7287 I32 i = (unsigned char)*s;
7291 max = (unsigned char)*s++;
7292 for ( ; i <= max; i++) {
7295 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7297 for (entry = HvARRAY(stash)[i];
7299 entry = HeNEXT(entry))
7304 if (!todo[(U8)*HeKEY(entry)])
7306 gv = (GV*)HeVAL(entry);
7309 if (SvTHINKFIRST(sv)) {
7310 if (!SvREADONLY(sv) && SvROK(sv))
7312 /* XXX Is this continue a bug? Why should THINKFIRST
7313 exempt us from resetting arrays and hashes? */
7317 if (SvTYPE(sv) >= SVt_PV) {
7319 if (SvPVX_const(sv) != NULL)
7327 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7329 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7332 # if defined(USE_ENVIRON_ARRAY)
7335 # endif /* USE_ENVIRON_ARRAY */
7346 Using various gambits, try to get an IO from an SV: the IO slot if its a
7347 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7348 named after the PV if we're a string.
7354 Perl_sv_2io(pTHX_ SV *sv)
7359 switch (SvTYPE(sv)) {
7367 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7371 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7373 return sv_2io(SvRV(sv));
7374 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7380 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7389 Using various gambits, try to get a CV from an SV; in addition, try if
7390 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7391 The flags in C<lref> are passed to sv_fetchsv.
7397 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7408 switch (SvTYPE(sv)) {
7427 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7428 tryAMAGICunDEREF(to_cv);
7431 if (SvTYPE(sv) == SVt_PVCV) {
7440 Perl_croak(aTHX_ "Not a subroutine reference");
7445 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7451 /* Some flags to gv_fetchsv mean don't really create the GV */
7452 if (SvTYPE(gv) != SVt_PVGV) {
7458 if (lref && !GvCVu(gv)) {
7462 gv_efullname3(tmpsv, gv, NULL);
7463 /* XXX this is probably not what they think they're getting.
7464 * It has the same effect as "sub name;", i.e. just a forward
7466 newSUB(start_subparse(FALSE, 0),
7467 newSVOP(OP_CONST, 0, tmpsv),
7471 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7481 Returns true if the SV has a true value by Perl's rules.
7482 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7483 instead use an in-line version.
7489 Perl_sv_true(pTHX_ register SV *sv)
7494 register const XPV* const tXpv = (XPV*)SvANY(sv);
7496 (tXpv->xpv_cur > 1 ||
7497 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7504 return SvIVX(sv) != 0;
7507 return SvNVX(sv) != 0.0;
7509 return sv_2bool(sv);
7515 =for apidoc sv_pvn_force
7517 Get a sensible string out of the SV somehow.
7518 A private implementation of the C<SvPV_force> macro for compilers which
7519 can't cope with complex macro expressions. Always use the macro instead.
7521 =for apidoc sv_pvn_force_flags
7523 Get a sensible string out of the SV somehow.
7524 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7525 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7526 implemented in terms of this function.
7527 You normally want to use the various wrapper macros instead: see
7528 C<SvPV_force> and C<SvPV_force_nomg>
7534 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7537 if (SvTHINKFIRST(sv) && !SvROK(sv))
7538 sv_force_normal_flags(sv, 0);
7548 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7549 const char * const ref = sv_reftype(sv,0);
7551 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7552 ref, OP_NAME(PL_op));
7554 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7556 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7557 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7559 s = sv_2pv_flags(sv, &len, flags);
7563 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7566 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7567 SvGROW(sv, len + 1);
7568 Move(s,SvPVX(sv),len,char);
7573 SvPOK_on(sv); /* validate pointer */
7575 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7576 PTR2UV(sv),SvPVX_const(sv)));
7579 return SvPVX_mutable(sv);
7583 =for apidoc sv_pvbyten_force
7585 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7591 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7593 sv_pvn_force(sv,lp);
7594 sv_utf8_downgrade(sv,0);
7600 =for apidoc sv_pvutf8n_force
7602 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7608 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7610 sv_pvn_force(sv,lp);
7611 sv_utf8_upgrade(sv);
7617 =for apidoc sv_reftype
7619 Returns a string describing what the SV is a reference to.
7625 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7627 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7628 inside return suggests a const propagation bug in g++. */
7629 if (ob && SvOBJECT(sv)) {
7630 char * const name = HvNAME_get(SvSTASH(sv));
7631 return name ? name : (char *) "__ANON__";
7634 switch (SvTYPE(sv)) {
7651 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7652 /* tied lvalues should appear to be
7653 * scalars for backwards compatitbility */
7654 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7655 ? "SCALAR" : "LVALUE");
7656 case SVt_PVAV: return "ARRAY";
7657 case SVt_PVHV: return "HASH";
7658 case SVt_PVCV: return "CODE";
7659 case SVt_PVGV: return "GLOB";
7660 case SVt_PVFM: return "FORMAT";
7661 case SVt_PVIO: return "IO";
7662 default: return "UNKNOWN";
7668 =for apidoc sv_isobject
7670 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7671 object. If the SV is not an RV, or if the object is not blessed, then this
7678 Perl_sv_isobject(pTHX_ SV *sv)
7694 Returns a boolean indicating whether the SV is blessed into the specified
7695 class. This does not check for subtypes; use C<sv_derived_from> to verify
7696 an inheritance relationship.
7702 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7713 hvname = HvNAME_get(SvSTASH(sv));
7717 return strEQ(hvname, name);
7723 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7724 it will be upgraded to one. If C<classname> is non-null then the new SV will
7725 be blessed in the specified package. The new SV is returned and its
7726 reference count is 1.
7732 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7739 SV_CHECK_THINKFIRST_COW_DROP(rv);
7742 if (SvTYPE(rv) >= SVt_PVMG) {
7743 const U32 refcnt = SvREFCNT(rv);
7747 SvREFCNT(rv) = refcnt;
7749 sv_upgrade(rv, SVt_RV);
7750 } else if (SvROK(rv)) {
7751 SvREFCNT_dec(SvRV(rv));
7752 } else if (SvTYPE(rv) < SVt_RV)
7753 sv_upgrade(rv, SVt_RV);
7754 else if (SvTYPE(rv) > SVt_RV) {
7765 HV* const stash = gv_stashpv(classname, TRUE);
7766 (void)sv_bless(rv, stash);
7772 =for apidoc sv_setref_pv
7774 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7775 argument will be upgraded to an RV. That RV will be modified to point to
7776 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7777 into the SV. The C<classname> argument indicates the package for the
7778 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7779 will have a reference count of 1, and the RV will be returned.
7781 Do not use with other Perl types such as HV, AV, SV, CV, because those
7782 objects will become corrupted by the pointer copy process.
7784 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7790 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7794 sv_setsv(rv, &PL_sv_undef);
7798 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7803 =for apidoc sv_setref_iv
7805 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7806 argument will be upgraded to an RV. That RV will be modified to point to
7807 the new SV. The C<classname> argument indicates the package for the
7808 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7809 will have a reference count of 1, and the RV will be returned.
7815 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7817 sv_setiv(newSVrv(rv,classname), iv);
7822 =for apidoc sv_setref_uv
7824 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7825 argument will be upgraded to an RV. That RV will be modified to point to
7826 the new SV. The C<classname> argument indicates the package for the
7827 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7828 will have a reference count of 1, and the RV will be returned.
7834 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7836 sv_setuv(newSVrv(rv,classname), uv);
7841 =for apidoc sv_setref_nv
7843 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7844 argument will be upgraded to an RV. That RV will be modified to point to
7845 the new SV. The C<classname> argument indicates the package for the
7846 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7847 will have a reference count of 1, and the RV will be returned.
7853 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7855 sv_setnv(newSVrv(rv,classname), nv);
7860 =for apidoc sv_setref_pvn
7862 Copies a string into a new SV, optionally blessing the SV. The length of the
7863 string must be specified with C<n>. The C<rv> argument will be upgraded to
7864 an RV. That RV will be modified to point to the new SV. The C<classname>
7865 argument indicates the package for the blessing. Set C<classname> to
7866 C<NULL> to avoid the blessing. The new SV will have a reference count
7867 of 1, and the RV will be returned.
7869 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7875 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7877 sv_setpvn(newSVrv(rv,classname), pv, n);
7882 =for apidoc sv_bless
7884 Blesses an SV into a specified package. The SV must be an RV. The package
7885 must be designated by its stash (see C<gv_stashpv()>). The reference count
7886 of the SV is unaffected.
7892 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7897 Perl_croak(aTHX_ "Can't bless non-reference value");
7899 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7900 if (SvREADONLY(tmpRef))
7901 Perl_croak(aTHX_ PL_no_modify);
7902 if (SvOBJECT(tmpRef)) {
7903 if (SvTYPE(tmpRef) != SVt_PVIO)
7905 SvREFCNT_dec(SvSTASH(tmpRef));
7908 SvOBJECT_on(tmpRef);
7909 if (SvTYPE(tmpRef) != SVt_PVIO)
7911 SvUPGRADE(tmpRef, SVt_PVMG);
7912 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7919 if(SvSMAGICAL(tmpRef))
7920 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7928 /* Downgrades a PVGV to a PVMG.
7932 S_sv_unglob(pTHX_ SV *sv)
7936 SV * const temp = sv_newmortal();
7938 assert(SvTYPE(sv) == SVt_PVGV);
7940 gv_efullname3(temp, (GV *) sv, "*");
7946 sv_del_backref((SV*)GvSTASH(sv), sv);
7950 if (GvNAME_HEK(sv)) {
7951 unshare_hek(GvNAME_HEK(sv));
7955 /* need to keep SvANY(sv) in the right arena */
7956 xpvmg = new_XPVMG();
7957 StructCopy(SvANY(sv), xpvmg, XPVMG);
7958 del_XPVGV(SvANY(sv));
7961 SvFLAGS(sv) &= ~SVTYPEMASK;
7962 SvFLAGS(sv) |= SVt_PVMG;
7964 /* Intentionally not calling any local SET magic, as this isn't so much a
7965 set operation as merely an internal storage change. */
7966 sv_setsv_flags(sv, temp, 0);
7970 =for apidoc sv_unref_flags
7972 Unsets the RV status of the SV, and decrements the reference count of
7973 whatever was being referenced by the RV. This can almost be thought of
7974 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7975 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7976 (otherwise the decrementing is conditional on the reference count being
7977 different from one or the reference being a readonly SV).
7984 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7986 SV* const target = SvRV(ref);
7988 if (SvWEAKREF(ref)) {
7989 sv_del_backref(target, ref);
7991 SvRV_set(ref, NULL);
7994 SvRV_set(ref, NULL);
7996 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7997 assigned to as BEGIN {$a = \"Foo"} will fail. */
7998 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7999 SvREFCNT_dec(target);
8000 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8001 sv_2mortal(target); /* Schedule for freeing later */
8005 =for apidoc sv_untaint
8007 Untaint an SV. Use C<SvTAINTED_off> instead.
8012 Perl_sv_untaint(pTHX_ SV *sv)
8014 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8015 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8022 =for apidoc sv_tainted
8024 Test an SV for taintedness. Use C<SvTAINTED> instead.
8029 Perl_sv_tainted(pTHX_ SV *sv)
8031 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8032 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8033 if (mg && (mg->mg_len & 1) )
8040 =for apidoc sv_setpviv
8042 Copies an integer into the given SV, also updating its string value.
8043 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8049 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8051 char buf[TYPE_CHARS(UV)];
8053 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8055 sv_setpvn(sv, ptr, ebuf - ptr);
8059 =for apidoc sv_setpviv_mg
8061 Like C<sv_setpviv>, but also handles 'set' magic.
8067 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8073 #if defined(PERL_IMPLICIT_CONTEXT)
8075 /* pTHX_ magic can't cope with varargs, so this is a no-context
8076 * version of the main function, (which may itself be aliased to us).
8077 * Don't access this version directly.
8081 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8085 va_start(args, pat);
8086 sv_vsetpvf(sv, pat, &args);
8090 /* pTHX_ magic can't cope with varargs, so this is a no-context
8091 * version of the main function, (which may itself be aliased to us).
8092 * Don't access this version directly.
8096 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8100 va_start(args, pat);
8101 sv_vsetpvf_mg(sv, pat, &args);
8107 =for apidoc sv_setpvf
8109 Works like C<sv_catpvf> but copies the text into the SV instead of
8110 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8116 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8119 va_start(args, pat);
8120 sv_vsetpvf(sv, pat, &args);
8125 =for apidoc sv_vsetpvf
8127 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8128 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8130 Usually used via its frontend C<sv_setpvf>.
8136 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8138 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8142 =for apidoc sv_setpvf_mg
8144 Like C<sv_setpvf>, but also handles 'set' magic.
8150 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8153 va_start(args, pat);
8154 sv_vsetpvf_mg(sv, pat, &args);
8159 =for apidoc sv_vsetpvf_mg
8161 Like C<sv_vsetpvf>, but also handles 'set' magic.
8163 Usually used via its frontend C<sv_setpvf_mg>.
8169 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8171 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8175 #if defined(PERL_IMPLICIT_CONTEXT)
8177 /* pTHX_ magic can't cope with varargs, so this is a no-context
8178 * version of the main function, (which may itself be aliased to us).
8179 * Don't access this version directly.
8183 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8187 va_start(args, pat);
8188 sv_vcatpvf(sv, pat, &args);
8192 /* pTHX_ magic can't cope with varargs, so this is a no-context
8193 * version of the main function, (which may itself be aliased to us).
8194 * Don't access this version directly.
8198 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8202 va_start(args, pat);
8203 sv_vcatpvf_mg(sv, pat, &args);
8209 =for apidoc sv_catpvf
8211 Processes its arguments like C<sprintf> and appends the formatted
8212 output to an SV. If the appended data contains "wide" characters
8213 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8214 and characters >255 formatted with %c), the original SV might get
8215 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8216 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8217 valid UTF-8; if the original SV was bytes, the pattern should be too.
8222 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8225 va_start(args, pat);
8226 sv_vcatpvf(sv, pat, &args);
8231 =for apidoc sv_vcatpvf
8233 Processes its arguments like C<vsprintf> and appends the formatted output
8234 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8236 Usually used via its frontend C<sv_catpvf>.
8242 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8244 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8248 =for apidoc sv_catpvf_mg
8250 Like C<sv_catpvf>, but also handles 'set' magic.
8256 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8259 va_start(args, pat);
8260 sv_vcatpvf_mg(sv, pat, &args);
8265 =for apidoc sv_vcatpvf_mg
8267 Like C<sv_vcatpvf>, but also handles 'set' magic.
8269 Usually used via its frontend C<sv_catpvf_mg>.
8275 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8277 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8282 =for apidoc sv_vsetpvfn
8284 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8287 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8293 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8295 sv_setpvn(sv, "", 0);
8296 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8300 S_expect_number(pTHX_ char** pattern)
8304 switch (**pattern) {
8305 case '1': case '2': case '3':
8306 case '4': case '5': case '6':
8307 case '7': case '8': case '9':
8308 var = *(*pattern)++ - '0';
8309 while (isDIGIT(**pattern)) {
8310 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8312 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8320 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8322 const int neg = nv < 0;
8331 if (uv & 1 && uv == nv)
8332 uv--; /* Round to even */
8334 const unsigned dig = uv % 10;
8347 =for apidoc sv_vcatpvfn
8349 Processes its arguments like C<vsprintf> and appends the formatted output
8350 to an SV. Uses an array of SVs if the C style variable argument list is
8351 missing (NULL). When running with taint checks enabled, indicates via
8352 C<maybe_tainted> if results are untrustworthy (often due to the use of
8355 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8361 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8362 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8363 vec_utf8 = DO_UTF8(vecsv);
8365 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8368 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8376 static const char nullstr[] = "(null)";
8378 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8379 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8381 /* Times 4: a decimal digit takes more than 3 binary digits.
8382 * NV_DIG: mantissa takes than many decimal digits.
8383 * Plus 32: Playing safe. */
8384 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8385 /* large enough for "%#.#f" --chip */
8386 /* what about long double NVs? --jhi */
8388 PERL_UNUSED_ARG(maybe_tainted);
8390 /* no matter what, this is a string now */
8391 (void)SvPV_force(sv, origlen);
8393 /* special-case "", "%s", and "%-p" (SVf - see below) */
8396 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8398 const char * const s = va_arg(*args, char*);
8399 sv_catpv(sv, s ? s : nullstr);
8401 else if (svix < svmax) {
8402 sv_catsv(sv, *svargs);
8406 if (args && patlen == 3 && pat[0] == '%' &&
8407 pat[1] == '-' && pat[2] == 'p') {
8408 argsv = va_arg(*args, SV*);
8409 sv_catsv(sv, argsv);
8413 #ifndef USE_LONG_DOUBLE
8414 /* special-case "%.<number>[gf]" */
8415 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8416 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8417 unsigned digits = 0;
8421 while (*pp >= '0' && *pp <= '9')
8422 digits = 10 * digits + (*pp++ - '0');
8423 if (pp - pat == (int)patlen - 1) {
8431 /* Add check for digits != 0 because it seems that some
8432 gconverts are buggy in this case, and we don't yet have
8433 a Configure test for this. */
8434 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8435 /* 0, point, slack */
8436 Gconvert(nv, (int)digits, 0, ebuf);
8438 if (*ebuf) /* May return an empty string for digits==0 */
8441 } else if (!digits) {
8444 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8445 sv_catpvn(sv, p, l);
8451 #endif /* !USE_LONG_DOUBLE */
8453 if (!args && svix < svmax && DO_UTF8(*svargs))
8456 patend = (char*)pat + patlen;
8457 for (p = (char*)pat; p < patend; p = q) {
8460 bool vectorize = FALSE;
8461 bool vectorarg = FALSE;
8462 bool vec_utf8 = FALSE;
8468 bool has_precis = FALSE;
8470 const I32 osvix = svix;
8471 bool is_utf8 = FALSE; /* is this item utf8? */
8472 #ifdef HAS_LDBL_SPRINTF_BUG
8473 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8474 with sfio - Allen <allens@cpan.org> */
8475 bool fix_ldbl_sprintf_bug = FALSE;
8479 U8 utf8buf[UTF8_MAXBYTES+1];
8480 STRLEN esignlen = 0;
8482 const char *eptr = NULL;
8485 const U8 *vecstr = NULL;
8492 /* we need a long double target in case HAS_LONG_DOUBLE but
8495 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8503 const char *dotstr = ".";
8504 STRLEN dotstrlen = 1;
8505 I32 efix = 0; /* explicit format parameter index */
8506 I32 ewix = 0; /* explicit width index */
8507 I32 epix = 0; /* explicit precision index */
8508 I32 evix = 0; /* explicit vector index */
8509 bool asterisk = FALSE;
8511 /* echo everything up to the next format specification */
8512 for (q = p; q < patend && *q != '%'; ++q) ;
8514 if (has_utf8 && !pat_utf8)
8515 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8517 sv_catpvn(sv, p, q - p);
8524 We allow format specification elements in this order:
8525 \d+\$ explicit format parameter index
8527 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8528 0 flag (as above): repeated to allow "v02"
8529 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8530 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8532 [%bcdefginopsuxDFOUX] format (mandatory)
8537 As of perl5.9.3, printf format checking is on by default.
8538 Internally, perl uses %p formats to provide an escape to
8539 some extended formatting. This block deals with those
8540 extensions: if it does not match, (char*)q is reset and
8541 the normal format processing code is used.
8543 Currently defined extensions are:
8544 %p include pointer address (standard)
8545 %-p (SVf) include an SV (previously %_)
8546 %-<num>p include an SV with precision <num>
8547 %1p (VDf) include a v-string (as %vd)
8548 %<num>p reserved for future extensions
8550 Robin Barker 2005-07-14
8557 n = expect_number(&q);
8564 argsv = va_arg(*args, SV*);
8565 eptr = SvPVx_const(argsv, elen);
8571 else if (n == vdNUMBER) { /* VDf */
8578 if (ckWARN_d(WARN_INTERNAL))
8579 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8580 "internal %%<num>p might conflict with future printf extensions");
8586 if ( (width = expect_number(&q)) ) {
8627 if ( (ewix = expect_number(&q)) )
8636 if ((vectorarg = asterisk)) {
8649 width = expect_number(&q);
8655 vecsv = va_arg(*args, SV*);
8657 vecsv = (evix > 0 && evix <= svmax)
8658 ? svargs[evix-1] : &PL_sv_undef;
8660 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8662 dotstr = SvPV_const(vecsv, dotstrlen);
8663 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8664 bad with tied or overloaded values that return UTF8. */
8667 else if (has_utf8) {
8668 vecsv = sv_mortalcopy(vecsv);
8669 sv_utf8_upgrade(vecsv);
8670 dotstr = SvPV_const(vecsv, dotstrlen);
8677 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8678 vecsv = svargs[efix ? efix-1 : svix++];
8679 vecstr = (U8*)SvPV_const(vecsv,veclen);
8680 vec_utf8 = DO_UTF8(vecsv);
8682 /* if this is a version object, we need to convert
8683 * back into v-string notation and then let the
8684 * vectorize happen normally
8686 if (sv_derived_from(vecsv, "version")) {
8687 char *version = savesvpv(vecsv);
8688 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8689 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8690 "vector argument not supported with alpha versions");
8693 vecsv = sv_newmortal();
8694 /* scan_vstring is expected to be called during
8695 * tokenization, so we need to fake up the end
8696 * of the buffer for it
8698 PL_bufend = version + veclen;
8699 scan_vstring(version, vecsv);
8700 vecstr = (U8*)SvPV_const(vecsv, veclen);
8701 vec_utf8 = DO_UTF8(vecsv);
8713 i = va_arg(*args, int);
8715 i = (ewix ? ewix <= svmax : svix < svmax) ?
8716 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8718 width = (i < 0) ? -i : i;
8728 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8730 /* XXX: todo, support specified precision parameter */
8734 i = va_arg(*args, int);
8736 i = (ewix ? ewix <= svmax : svix < svmax)
8737 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8738 precis = (i < 0) ? 0 : i;
8743 precis = precis * 10 + (*q++ - '0');
8752 case 'I': /* Ix, I32x, and I64x */
8754 if (q[1] == '6' && q[2] == '4') {
8760 if (q[1] == '3' && q[2] == '2') {
8770 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8781 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8782 if (*(q + 1) == 'l') { /* lld, llf */
8808 if (!vectorize && !args) {
8810 const I32 i = efix-1;
8811 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8813 argsv = (svix >= 0 && svix < svmax)
8814 ? svargs[svix++] : &PL_sv_undef;
8825 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8827 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8829 eptr = (char*)utf8buf;
8830 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8844 eptr = va_arg(*args, char*);
8846 #ifdef MACOS_TRADITIONAL
8847 /* On MacOS, %#s format is used for Pascal strings */
8852 elen = strlen(eptr);
8854 eptr = (char *)nullstr;
8855 elen = sizeof nullstr - 1;
8859 eptr = SvPVx_const(argsv, elen);
8860 if (DO_UTF8(argsv)) {
8861 if (has_precis && precis < elen) {
8863 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8866 if (width) { /* fudge width (can't fudge elen) */
8867 width += elen - sv_len_utf8(argsv);
8874 if (has_precis && elen > precis)
8881 if (alt || vectorize)
8883 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8904 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8913 esignbuf[esignlen++] = plus;
8917 case 'h': iv = (short)va_arg(*args, int); break;
8918 case 'l': iv = va_arg(*args, long); break;
8919 case 'V': iv = va_arg(*args, IV); break;
8920 default: iv = va_arg(*args, int); break;
8922 case 'q': iv = va_arg(*args, Quad_t); break;
8927 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8929 case 'h': iv = (short)tiv; break;
8930 case 'l': iv = (long)tiv; break;
8932 default: iv = tiv; break;
8934 case 'q': iv = (Quad_t)tiv; break;
8938 if ( !vectorize ) /* we already set uv above */
8943 esignbuf[esignlen++] = plus;
8947 esignbuf[esignlen++] = '-';
8990 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9001 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9002 case 'l': uv = va_arg(*args, unsigned long); break;
9003 case 'V': uv = va_arg(*args, UV); break;
9004 default: uv = va_arg(*args, unsigned); break;
9006 case 'q': uv = va_arg(*args, Uquad_t); break;
9011 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9013 case 'h': uv = (unsigned short)tuv; break;
9014 case 'l': uv = (unsigned long)tuv; break;
9016 default: uv = tuv; break;
9018 case 'q': uv = (Uquad_t)tuv; break;
9025 char *ptr = ebuf + sizeof ebuf;
9026 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9032 p = (char*)((c == 'X')
9033 ? "0123456789ABCDEF" : "0123456789abcdef");
9039 esignbuf[esignlen++] = '0';
9040 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9048 if (alt && *ptr != '0')
9057 esignbuf[esignlen++] = '0';
9058 esignbuf[esignlen++] = 'b';
9061 default: /* it had better be ten or less */
9065 } while (uv /= base);
9068 elen = (ebuf + sizeof ebuf) - ptr;
9072 zeros = precis - elen;
9073 else if (precis == 0 && elen == 1 && *eptr == '0')
9079 /* FLOATING POINT */
9082 c = 'f'; /* maybe %F isn't supported here */
9090 /* This is evil, but floating point is even more evil */
9092 /* for SV-style calling, we can only get NV
9093 for C-style calling, we assume %f is double;
9094 for simplicity we allow any of %Lf, %llf, %qf for long double
9098 #if defined(USE_LONG_DOUBLE)
9102 /* [perl #20339] - we should accept and ignore %lf rather than die */
9106 #if defined(USE_LONG_DOUBLE)
9107 intsize = args ? 0 : 'q';
9111 #if defined(HAS_LONG_DOUBLE)
9120 /* now we need (long double) if intsize == 'q', else (double) */
9122 #if LONG_DOUBLESIZE > DOUBLESIZE
9124 va_arg(*args, long double) :
9125 va_arg(*args, double)
9127 va_arg(*args, double)
9132 if (c != 'e' && c != 'E') {
9134 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9135 will cast our (long double) to (double) */
9136 (void)Perl_frexp(nv, &i);
9137 if (i == PERL_INT_MIN)
9138 Perl_die(aTHX_ "panic: frexp");
9140 need = BIT_DIGITS(i);
9142 need += has_precis ? precis : 6; /* known default */
9147 #ifdef HAS_LDBL_SPRINTF_BUG
9148 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9149 with sfio - Allen <allens@cpan.org> */
9152 # define MY_DBL_MAX DBL_MAX
9153 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9154 # if DOUBLESIZE >= 8
9155 # define MY_DBL_MAX 1.7976931348623157E+308L
9157 # define MY_DBL_MAX 3.40282347E+38L
9161 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9162 # define MY_DBL_MAX_BUG 1L
9164 # define MY_DBL_MAX_BUG MY_DBL_MAX
9168 # define MY_DBL_MIN DBL_MIN
9169 # else /* XXX guessing! -Allen */
9170 # if DOUBLESIZE >= 8
9171 # define MY_DBL_MIN 2.2250738585072014E-308L
9173 # define MY_DBL_MIN 1.17549435E-38L
9177 if ((intsize == 'q') && (c == 'f') &&
9178 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9180 /* it's going to be short enough that
9181 * long double precision is not needed */
9183 if ((nv <= 0L) && (nv >= -0L))
9184 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9186 /* would use Perl_fp_class as a double-check but not
9187 * functional on IRIX - see perl.h comments */
9189 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9190 /* It's within the range that a double can represent */
9191 #if defined(DBL_MAX) && !defined(DBL_MIN)
9192 if ((nv >= ((long double)1/DBL_MAX)) ||
9193 (nv <= (-(long double)1/DBL_MAX)))
9195 fix_ldbl_sprintf_bug = TRUE;
9198 if (fix_ldbl_sprintf_bug == TRUE) {
9208 # undef MY_DBL_MAX_BUG
9211 #endif /* HAS_LDBL_SPRINTF_BUG */
9213 need += 20; /* fudge factor */
9214 if (PL_efloatsize < need) {
9215 Safefree(PL_efloatbuf);
9216 PL_efloatsize = need + 20; /* more fudge */
9217 Newx(PL_efloatbuf, PL_efloatsize, char);
9218 PL_efloatbuf[0] = '\0';
9221 if ( !(width || left || plus || alt) && fill != '0'
9222 && has_precis && intsize != 'q' ) { /* Shortcuts */
9223 /* See earlier comment about buggy Gconvert when digits,
9225 if ( c == 'g' && precis) {
9226 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9227 /* May return an empty string for digits==0 */
9228 if (*PL_efloatbuf) {
9229 elen = strlen(PL_efloatbuf);
9230 goto float_converted;
9232 } else if ( c == 'f' && !precis) {
9233 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9238 char *ptr = ebuf + sizeof ebuf;
9241 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9242 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9243 if (intsize == 'q') {
9244 /* Copy the one or more characters in a long double
9245 * format before the 'base' ([efgEFG]) character to
9246 * the format string. */
9247 static char const prifldbl[] = PERL_PRIfldbl;
9248 char const *p = prifldbl + sizeof(prifldbl) - 3;
9249 while (p >= prifldbl) { *--ptr = *p--; }
9254 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9259 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9271 /* No taint. Otherwise we are in the strange situation
9272 * where printf() taints but print($float) doesn't.
9274 #if defined(HAS_LONG_DOUBLE)
9275 elen = ((intsize == 'q')
9276 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9277 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9279 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9283 eptr = PL_efloatbuf;
9291 i = SvCUR(sv) - origlen;
9294 case 'h': *(va_arg(*args, short*)) = i; break;
9295 default: *(va_arg(*args, int*)) = i; break;
9296 case 'l': *(va_arg(*args, long*)) = i; break;
9297 case 'V': *(va_arg(*args, IV*)) = i; break;
9299 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9304 sv_setuv_mg(argsv, (UV)i);
9305 continue; /* not "break" */
9312 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9313 && ckWARN(WARN_PRINTF))
9315 SV * const msg = sv_newmortal();
9316 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9317 (PL_op->op_type == OP_PRTF) ? "" : "s");
9320 Perl_sv_catpvf(aTHX_ msg,
9321 "\"%%%c\"", c & 0xFF);
9323 Perl_sv_catpvf(aTHX_ msg,
9324 "\"%%\\%03"UVof"\"",
9327 sv_catpvs(msg, "end of string");
9328 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9331 /* output mangled stuff ... */
9337 /* ... right here, because formatting flags should not apply */
9338 SvGROW(sv, SvCUR(sv) + elen + 1);
9340 Copy(eptr, p, elen, char);
9343 SvCUR_set(sv, p - SvPVX_const(sv));
9345 continue; /* not "break" */
9348 if (is_utf8 != has_utf8) {
9351 sv_utf8_upgrade(sv);
9354 const STRLEN old_elen = elen;
9355 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9356 sv_utf8_upgrade(nsv);
9357 eptr = SvPVX_const(nsv);
9360 if (width) { /* fudge width (can't fudge elen) */
9361 width += elen - old_elen;
9367 have = esignlen + zeros + elen;
9369 Perl_croak_nocontext(PL_memory_wrap);
9371 need = (have > width ? have : width);
9374 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9375 Perl_croak_nocontext(PL_memory_wrap);
9376 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9378 if (esignlen && fill == '0') {
9380 for (i = 0; i < (int)esignlen; i++)
9384 memset(p, fill, gap);
9387 if (esignlen && fill != '0') {
9389 for (i = 0; i < (int)esignlen; i++)
9394 for (i = zeros; i; i--)
9398 Copy(eptr, p, elen, char);
9402 memset(p, ' ', gap);
9407 Copy(dotstr, p, dotstrlen, char);
9411 vectorize = FALSE; /* done iterating over vecstr */
9418 SvCUR_set(sv, p - SvPVX_const(sv));
9426 /* =========================================================================
9428 =head1 Cloning an interpreter
9430 All the macros and functions in this section are for the private use of
9431 the main function, perl_clone().
9433 The foo_dup() functions make an exact copy of an existing foo thinngy.
9434 During the course of a cloning, a hash table is used to map old addresses
9435 to new addresses. The table is created and manipulated with the
9436 ptr_table_* functions.
9440 ============================================================================*/
9443 #if defined(USE_ITHREADS)
9445 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9446 #ifndef GpREFCNT_inc
9447 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9451 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9452 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9453 please unmerge ss_dup. */
9454 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9455 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9456 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9457 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9459 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9461 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9463 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9465 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9466 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9467 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9470 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9471 regcomp.c. AMS 20010712 */
9474 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9479 struct reg_substr_datum *s;
9482 return (REGEXP *)NULL;
9484 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9487 len = r->offsets[0];
9488 npar = r->nparens+1;
9490 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9491 Copy(r->program, ret->program, len+1, regnode);
9493 Newx(ret->startp, npar, I32);
9494 Copy(r->startp, ret->startp, npar, I32);
9495 Newx(ret->endp, npar, I32);
9496 Copy(r->startp, ret->startp, npar, I32);
9498 Newx(ret->substrs, 1, struct reg_substr_data);
9499 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9500 s->min_offset = r->substrs->data[i].min_offset;
9501 s->max_offset = r->substrs->data[i].max_offset;
9502 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9503 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9506 ret->regstclass = NULL;
9509 const int count = r->data->count;
9512 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9513 char, struct reg_data);
9514 Newx(d->what, count, U8);
9517 for (i = 0; i < count; i++) {
9518 d->what[i] = r->data->what[i];
9519 switch (d->what[i]) {
9520 /* legal options are one of: sfpont
9521 see also regcomp.h and pregfree() */
9523 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9526 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9529 /* This is cheating. */
9530 Newx(d->data[i], 1, struct regnode_charclass_class);
9531 StructCopy(r->data->data[i], d->data[i],
9532 struct regnode_charclass_class);
9533 ret->regstclass = (regnode*)d->data[i];
9536 /* Compiled op trees are readonly, and can thus be
9537 shared without duplication. */
9539 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9543 d->data[i] = r->data->data[i];
9546 d->data[i] = r->data->data[i];
9548 ((reg_trie_data*)d->data[i])->refcount++;
9552 d->data[i] = r->data->data[i];
9554 ((reg_ac_data*)d->data[i])->refcount++;
9556 /* Trie stclasses are readonly and can thus be shared
9557 * without duplication. We free the stclass in pregfree
9558 * when the corresponding reg_ac_data struct is freed.
9560 ret->regstclass= r->regstclass;
9563 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9572 Newx(ret->offsets, 2*len+1, U32);
9573 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9575 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9576 ret->refcnt = r->refcnt;
9577 ret->minlen = r->minlen;
9578 ret->prelen = r->prelen;
9579 ret->nparens = r->nparens;
9580 ret->lastparen = r->lastparen;
9581 ret->lastcloseparen = r->lastcloseparen;
9582 ret->reganch = r->reganch;
9584 ret->sublen = r->sublen;
9586 if (RX_MATCH_COPIED(ret))
9587 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9590 #ifdef PERL_OLD_COPY_ON_WRITE
9591 ret->saved_copy = NULL;
9594 ptr_table_store(PL_ptr_table, r, ret);
9598 /* duplicate a file handle */
9601 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9605 PERL_UNUSED_ARG(type);
9608 return (PerlIO*)NULL;
9610 /* look for it in the table first */
9611 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9615 /* create anew and remember what it is */
9616 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9617 ptr_table_store(PL_ptr_table, fp, ret);
9621 /* duplicate a directory handle */
9624 Perl_dirp_dup(pTHX_ DIR *dp)
9626 PERL_UNUSED_CONTEXT;
9633 /* duplicate a typeglob */
9636 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9642 /* look for it in the table first */
9643 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9647 /* create anew and remember what it is */
9649 ptr_table_store(PL_ptr_table, gp, ret);
9652 ret->gp_refcnt = 0; /* must be before any other dups! */
9653 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9654 ret->gp_io = io_dup_inc(gp->gp_io, param);
9655 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9656 ret->gp_av = av_dup_inc(gp->gp_av, param);
9657 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9658 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9659 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9660 ret->gp_cvgen = gp->gp_cvgen;
9661 ret->gp_line = gp->gp_line;
9662 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9666 /* duplicate a chain of magic */
9669 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9671 MAGIC *mgprev = (MAGIC*)NULL;
9674 return (MAGIC*)NULL;
9675 /* look for it in the table first */
9676 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9680 for (; mg; mg = mg->mg_moremagic) {
9682 Newxz(nmg, 1, MAGIC);
9684 mgprev->mg_moremagic = nmg;
9687 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9688 nmg->mg_private = mg->mg_private;
9689 nmg->mg_type = mg->mg_type;
9690 nmg->mg_flags = mg->mg_flags;
9691 if (mg->mg_type == PERL_MAGIC_qr) {
9692 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9694 else if(mg->mg_type == PERL_MAGIC_backref) {
9695 /* The backref AV has its reference count deliberately bumped by
9697 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9699 else if (mg->mg_type == PERL_MAGIC_symtab) {
9700 nmg->mg_obj = mg->mg_obj;
9703 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9704 ? sv_dup_inc(mg->mg_obj, param)
9705 : sv_dup(mg->mg_obj, param);
9707 nmg->mg_len = mg->mg_len;
9708 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9709 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9710 if (mg->mg_len > 0) {
9711 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9712 if (mg->mg_type == PERL_MAGIC_overload_table &&
9713 AMT_AMAGIC((AMT*)mg->mg_ptr))
9715 const AMT * const amtp = (AMT*)mg->mg_ptr;
9716 AMT * const namtp = (AMT*)nmg->mg_ptr;
9718 for (i = 1; i < NofAMmeth; i++) {
9719 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9723 else if (mg->mg_len == HEf_SVKEY)
9724 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9726 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9727 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9734 /* create a new pointer-mapping table */
9737 Perl_ptr_table_new(pTHX)
9740 PERL_UNUSED_CONTEXT;
9742 Newxz(tbl, 1, PTR_TBL_t);
9745 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9749 #define PTR_TABLE_HASH(ptr) \
9750 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9753 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9754 following define) and at call to new_body_inline made below in
9755 Perl_ptr_table_store()
9758 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9760 /* map an existing pointer using a table */
9762 STATIC PTR_TBL_ENT_t *
9763 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9764 PTR_TBL_ENT_t *tblent;
9765 const UV hash = PTR_TABLE_HASH(sv);
9767 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9768 for (; tblent; tblent = tblent->next) {
9769 if (tblent->oldval == sv)
9776 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9778 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9779 PERL_UNUSED_CONTEXT;
9780 return tblent ? tblent->newval : NULL;
9783 /* add a new entry to a pointer-mapping table */
9786 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9788 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9789 PERL_UNUSED_CONTEXT;
9792 tblent->newval = newsv;
9794 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9796 new_body_inline(tblent, PTE_SVSLOT);
9798 tblent->oldval = oldsv;
9799 tblent->newval = newsv;
9800 tblent->next = tbl->tbl_ary[entry];
9801 tbl->tbl_ary[entry] = tblent;
9803 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9804 ptr_table_split(tbl);
9808 /* double the hash bucket size of an existing ptr table */
9811 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9813 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9814 const UV oldsize = tbl->tbl_max + 1;
9815 UV newsize = oldsize * 2;
9817 PERL_UNUSED_CONTEXT;
9819 Renew(ary, newsize, PTR_TBL_ENT_t*);
9820 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9821 tbl->tbl_max = --newsize;
9823 for (i=0; i < oldsize; i++, ary++) {
9824 PTR_TBL_ENT_t **curentp, **entp, *ent;
9827 curentp = ary + oldsize;
9828 for (entp = ary, ent = *ary; ent; ent = *entp) {
9829 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9831 ent->next = *curentp;
9841 /* remove all the entries from a ptr table */
9844 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9846 if (tbl && tbl->tbl_items) {
9847 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9848 UV riter = tbl->tbl_max;
9851 PTR_TBL_ENT_t *entry = array[riter];
9854 PTR_TBL_ENT_t * const oentry = entry;
9855 entry = entry->next;
9864 /* clear and free a ptr table */
9867 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9872 ptr_table_clear(tbl);
9873 Safefree(tbl->tbl_ary);
9879 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9882 SvRV_set(dstr, SvWEAKREF(sstr)
9883 ? sv_dup(SvRV(sstr), param)
9884 : sv_dup_inc(SvRV(sstr), param));
9887 else if (SvPVX_const(sstr)) {
9888 /* Has something there */
9890 /* Normal PV - clone whole allocated space */
9891 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9892 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9893 /* Not that normal - actually sstr is copy on write.
9894 But we are a true, independant SV, so: */
9895 SvREADONLY_off(dstr);
9900 /* Special case - not normally malloced for some reason */
9901 if (isGV_with_GP(sstr)) {
9902 /* Don't need to do anything here. */
9904 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9905 /* A "shared" PV - clone it as "shared" PV */
9907 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9911 /* Some other special case - random pointer */
9912 SvPV_set(dstr, SvPVX(sstr));
9918 if (SvTYPE(dstr) == SVt_RV)
9919 SvRV_set(dstr, NULL);
9921 SvPV_set(dstr, NULL);
9925 /* duplicate an SV of any type (including AV, HV etc) */
9928 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9933 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9935 /* look for it in the table first */
9936 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9940 if(param->flags & CLONEf_JOIN_IN) {
9941 /** We are joining here so we don't want do clone
9942 something that is bad **/
9943 if (SvTYPE(sstr) == SVt_PVHV) {
9944 const char * const hvname = HvNAME_get(sstr);
9946 /** don't clone stashes if they already exist **/
9947 return (SV*)gv_stashpv(hvname,0);
9951 /* create anew and remember what it is */
9954 #ifdef DEBUG_LEAKING_SCALARS
9955 dstr->sv_debug_optype = sstr->sv_debug_optype;
9956 dstr->sv_debug_line = sstr->sv_debug_line;
9957 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9958 dstr->sv_debug_cloned = 1;
9959 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9962 ptr_table_store(PL_ptr_table, sstr, dstr);
9965 SvFLAGS(dstr) = SvFLAGS(sstr);
9966 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9967 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9970 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9971 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9972 PL_watch_pvx, SvPVX_const(sstr));
9975 /* don't clone objects whose class has asked us not to */
9976 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9977 SvFLAGS(dstr) &= ~SVTYPEMASK;
9982 switch (SvTYPE(sstr)) {
9987 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9988 SvIV_set(dstr, SvIVX(sstr));
9991 SvANY(dstr) = new_XNV();
9992 SvNV_set(dstr, SvNVX(sstr));
9995 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9996 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10000 /* These are all the types that need complex bodies allocating. */
10002 const svtype sv_type = SvTYPE(sstr);
10003 const struct body_details *const sv_type_details
10004 = bodies_by_type + sv_type;
10008 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10012 if (GvUNIQUE((GV*)sstr)) {
10013 NOOP; /* Do sharing here, and fall through */
10026 assert(sv_type_details->body_size);
10027 if (sv_type_details->arena) {
10028 new_body_inline(new_body, sv_type);
10030 = (void*)((char*)new_body - sv_type_details->offset);
10032 new_body = new_NOARENA(sv_type_details);
10036 SvANY(dstr) = new_body;
10039 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10040 ((char*)SvANY(dstr)) + sv_type_details->offset,
10041 sv_type_details->copy, char);
10043 Copy(((char*)SvANY(sstr)),
10044 ((char*)SvANY(dstr)),
10045 sv_type_details->body_size + sv_type_details->offset, char);
10048 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10049 && !isGV_with_GP(dstr))
10050 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10052 /* The Copy above means that all the source (unduplicated) pointers
10053 are now in the destination. We can check the flags and the
10054 pointers in either, but it's possible that there's less cache
10055 missing by always going for the destination.
10056 FIXME - instrument and check that assumption */
10057 if (sv_type >= SVt_PVMG) {
10058 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10059 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10060 } else if (SvMAGIC(dstr))
10061 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10063 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10066 /* The cast silences a GCC warning about unhandled types. */
10067 switch ((int)sv_type) {
10079 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10080 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10081 LvTARG(dstr) = dstr;
10082 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10083 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10085 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10088 if (GvNAME_HEK(dstr))
10089 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10091 /* Don't call sv_add_backref here as it's going to be created
10092 as part of the magic cloning of the symbol table. */
10093 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10094 if(isGV_with_GP(sstr)) {
10095 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10096 at the point of this comment. */
10097 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10098 (void)GpREFCNT_inc(GvGP(dstr));
10100 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10103 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10104 if (IoOFP(dstr) == IoIFP(sstr))
10105 IoOFP(dstr) = IoIFP(dstr);
10107 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10108 /* PL_rsfp_filters entries have fake IoDIRP() */
10109 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10110 /* I have no idea why fake dirp (rsfps)
10111 should be treated differently but otherwise
10112 we end up with leaks -- sky*/
10113 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10114 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10115 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10117 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10118 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10119 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10120 if (IoDIRP(dstr)) {
10121 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10124 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10127 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10128 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10129 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10132 if (AvARRAY((AV*)sstr)) {
10133 SV **dst_ary, **src_ary;
10134 SSize_t items = AvFILLp((AV*)sstr) + 1;
10136 src_ary = AvARRAY((AV*)sstr);
10137 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10138 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10139 SvPV_set(dstr, (char*)dst_ary);
10140 AvALLOC((AV*)dstr) = dst_ary;
10141 if (AvREAL((AV*)sstr)) {
10142 while (items-- > 0)
10143 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10146 while (items-- > 0)
10147 *dst_ary++ = sv_dup(*src_ary++, param);
10149 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10150 while (items-- > 0) {
10151 *dst_ary++ = &PL_sv_undef;
10155 SvPV_set(dstr, NULL);
10156 AvALLOC((AV*)dstr) = (SV**)NULL;
10160 if (HvARRAY((HV*)sstr)) {
10162 const bool sharekeys = !!HvSHAREKEYS(sstr);
10163 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10164 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10166 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10167 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10169 HvARRAY(dstr) = (HE**)darray;
10170 while (i <= sxhv->xhv_max) {
10171 const HE * const source = HvARRAY(sstr)[i];
10172 HvARRAY(dstr)[i] = source
10173 ? he_dup(source, sharekeys, param) : 0;
10178 const struct xpvhv_aux * const saux = HvAUX(sstr);
10179 struct xpvhv_aux * const daux = HvAUX(dstr);
10180 /* This flag isn't copied. */
10181 /* SvOOK_on(hv) attacks the IV flags. */
10182 SvFLAGS(dstr) |= SVf_OOK;
10184 hvname = saux->xhv_name;
10185 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10187 daux->xhv_riter = saux->xhv_riter;
10188 daux->xhv_eiter = saux->xhv_eiter
10189 ? he_dup(saux->xhv_eiter,
10190 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10191 daux->xhv_backreferences =
10192 saux->xhv_backreferences
10193 ? (AV*) SvREFCNT_inc(
10194 sv_dup((SV*)saux->xhv_backreferences, param))
10196 /* Record stashes for possible cloning in Perl_clone(). */
10198 av_push(param->stashes, dstr);
10202 SvPV_set(dstr, NULL);
10205 if (!(param->flags & CLONEf_COPY_STACKS)) {
10209 /* NOTE: not refcounted */
10210 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10212 if (!CvISXSUB(dstr))
10213 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10215 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10216 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10217 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10218 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10220 /* don't dup if copying back - CvGV isn't refcounted, so the
10221 * duped GV may never be freed. A bit of a hack! DAPM */
10222 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10223 NULL : gv_dup(CvGV(dstr), param) ;
10224 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10226 CvWEAKOUTSIDE(sstr)
10227 ? cv_dup( CvOUTSIDE(dstr), param)
10228 : cv_dup_inc(CvOUTSIDE(dstr), param);
10229 if (!CvISXSUB(dstr))
10230 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10236 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10242 /* duplicate a context */
10245 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10247 PERL_CONTEXT *ncxs;
10250 return (PERL_CONTEXT*)NULL;
10252 /* look for it in the table first */
10253 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10257 /* create anew and remember what it is */
10258 Newxz(ncxs, max + 1, PERL_CONTEXT);
10259 ptr_table_store(PL_ptr_table, cxs, ncxs);
10262 PERL_CONTEXT * const cx = &cxs[ix];
10263 PERL_CONTEXT * const ncx = &ncxs[ix];
10264 ncx->cx_type = cx->cx_type;
10265 if (CxTYPE(cx) == CXt_SUBST) {
10266 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10269 ncx->blk_oldsp = cx->blk_oldsp;
10270 ncx->blk_oldcop = cx->blk_oldcop;
10271 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10272 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10273 ncx->blk_oldpm = cx->blk_oldpm;
10274 ncx->blk_gimme = cx->blk_gimme;
10275 switch (CxTYPE(cx)) {
10277 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10278 ? cv_dup_inc(cx->blk_sub.cv, param)
10279 : cv_dup(cx->blk_sub.cv,param));
10280 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10281 ? av_dup_inc(cx->blk_sub.argarray, param)
10283 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10284 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10285 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10286 ncx->blk_sub.lval = cx->blk_sub.lval;
10287 ncx->blk_sub.retop = cx->blk_sub.retop;
10288 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10289 cx->blk_sub.oldcomppad);
10292 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10293 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10294 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10295 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10296 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10297 ncx->blk_eval.retop = cx->blk_eval.retop;
10300 ncx->blk_loop.label = cx->blk_loop.label;
10301 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10302 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10303 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10304 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10305 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10306 ? cx->blk_loop.iterdata
10307 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10308 ncx->blk_loop.oldcomppad
10309 = (PAD*)ptr_table_fetch(PL_ptr_table,
10310 cx->blk_loop.oldcomppad);
10311 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10312 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10313 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10314 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10315 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10318 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10319 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10320 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10321 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10322 ncx->blk_sub.retop = cx->blk_sub.retop;
10334 /* duplicate a stack info structure */
10337 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10342 return (PERL_SI*)NULL;
10344 /* look for it in the table first */
10345 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10349 /* create anew and remember what it is */
10350 Newxz(nsi, 1, PERL_SI);
10351 ptr_table_store(PL_ptr_table, si, nsi);
10353 nsi->si_stack = av_dup_inc(si->si_stack, param);
10354 nsi->si_cxix = si->si_cxix;
10355 nsi->si_cxmax = si->si_cxmax;
10356 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10357 nsi->si_type = si->si_type;
10358 nsi->si_prev = si_dup(si->si_prev, param);
10359 nsi->si_next = si_dup(si->si_next, param);
10360 nsi->si_markoff = si->si_markoff;
10365 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10366 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10367 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10368 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10369 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10370 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10371 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10372 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10373 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10374 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10375 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10376 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10377 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10378 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10381 #define pv_dup_inc(p) SAVEPV(p)
10382 #define pv_dup(p) SAVEPV(p)
10383 #define svp_dup_inc(p,pp) any_dup(p,pp)
10385 /* map any object to the new equivent - either something in the
10386 * ptr table, or something in the interpreter structure
10390 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10395 return (void*)NULL;
10397 /* look for it in the table first */
10398 ret = ptr_table_fetch(PL_ptr_table, v);
10402 /* see if it is part of the interpreter structure */
10403 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10404 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10412 /* duplicate the save stack */
10415 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10417 ANY * const ss = proto_perl->Tsavestack;
10418 const I32 max = proto_perl->Tsavestack_max;
10419 I32 ix = proto_perl->Tsavestack_ix;
10431 void (*dptr) (void*);
10432 void (*dxptr) (pTHX_ void*);
10434 Newxz(nss, max, ANY);
10437 I32 i = POPINT(ss,ix);
10438 TOPINT(nss,ix) = i;
10440 case SAVEt_ITEM: /* normal string */
10441 case SAVEt_SV: /* scalar reference */
10442 sv = (SV*)POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10444 sv = (SV*)POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10447 case SAVEt_SHARED_PVREF: /* char* in shared space */
10448 c = (char*)POPPTR(ss,ix);
10449 TOPPTR(nss,ix) = savesharedpv(c);
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10453 case SAVEt_GENERIC_SVREF: /* generic sv */
10454 case SAVEt_SVREF: /* scalar reference */
10455 sv = (SV*)POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10457 ptr = POPPTR(ss,ix);
10458 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10460 case SAVEt_HV: /* hash reference */
10461 case SAVEt_AV: /* array reference */
10462 sv = POPPTR(ss,ix);
10463 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10464 gv = (GV*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = gv_dup(gv, param);
10467 case SAVEt_INT: /* int reference */
10468 ptr = POPPTR(ss,ix);
10469 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10470 intval = (int)POPINT(ss,ix);
10471 TOPINT(nss,ix) = intval;
10473 case SAVEt_LONG: /* long reference */
10474 ptr = POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10476 longval = (long)POPLONG(ss,ix);
10477 TOPLONG(nss,ix) = longval;
10479 case SAVEt_I32: /* I32 reference */
10480 case SAVEt_I16: /* I16 reference */
10481 case SAVEt_I8: /* I8 reference */
10482 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10483 ptr = POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 TOPINT(nss,ix) = i;
10488 case SAVEt_IV: /* IV reference */
10489 ptr = POPPTR(ss,ix);
10490 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10492 TOPIV(nss,ix) = iv;
10494 case SAVEt_HPTR: /* HV* reference */
10495 case SAVEt_APTR: /* AV* reference */
10496 case SAVEt_SPTR: /* SV* reference */
10497 ptr = POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10499 sv = (SV*)POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = sv_dup(sv, param);
10502 case SAVEt_VPTR: /* random* reference */
10503 ptr = POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10505 ptr = POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10508 case SAVEt_GENERIC_PVREF: /* generic char* */
10509 case SAVEt_PPTR: /* char* reference */
10510 ptr = POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10512 c = (char*)POPPTR(ss,ix);
10513 TOPPTR(nss,ix) = pv_dup(c);
10516 gv = (GV*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = gv_dup(gv, param);
10519 case SAVEt_GP: /* scalar reference */
10520 gp = (GP*)POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10522 (void)GpREFCNT_inc(gp);
10523 gv = (GV*)POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10525 c = (char*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = pv_dup(c);
10528 TOPIV(nss,ix) = iv;
10530 TOPIV(nss,ix) = iv;
10533 case SAVEt_MORTALIZESV:
10534 sv = (SV*)POPPTR(ss,ix);
10535 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10538 ptr = POPPTR(ss,ix);
10539 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10540 /* these are assumed to be refcounted properly */
10542 switch (((OP*)ptr)->op_type) {
10544 case OP_LEAVESUBLV:
10548 case OP_LEAVEWRITE:
10549 TOPPTR(nss,ix) = ptr;
10554 TOPPTR(nss,ix) = NULL;
10559 TOPPTR(nss,ix) = NULL;
10562 c = (char*)POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = pv_dup_inc(c);
10565 case SAVEt_CLEARSV:
10566 longval = POPLONG(ss,ix);
10567 TOPLONG(nss,ix) = longval;
10570 hv = (HV*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10572 c = (char*)POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = pv_dup_inc(c);
10575 TOPINT(nss,ix) = i;
10577 case SAVEt_DESTRUCTOR:
10578 ptr = POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10580 dptr = POPDPTR(ss,ix);
10581 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10582 any_dup(FPTR2DPTR(void *, dptr),
10585 case SAVEt_DESTRUCTOR_X:
10586 ptr = POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10588 dxptr = POPDXPTR(ss,ix);
10589 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10590 any_dup(FPTR2DPTR(void *, dxptr),
10593 case SAVEt_REGCONTEXT:
10596 TOPINT(nss,ix) = i;
10599 case SAVEt_STACK_POS: /* Position on Perl stack */
10601 TOPINT(nss,ix) = i;
10603 case SAVEt_AELEM: /* array element */
10604 sv = (SV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10607 TOPINT(nss,ix) = i;
10608 av = (AV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = av_dup_inc(av, param);
10611 case SAVEt_HELEM: /* hash element */
10612 sv = (SV*)POPPTR(ss,ix);
10613 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10614 sv = (SV*)POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10616 hv = (HV*)POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10620 ptr = POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = ptr;
10625 TOPINT(nss,ix) = i;
10626 ptr = POPPTR(ss,ix);
10629 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10630 HINTS_REFCNT_UNLOCK;
10632 TOPPTR(nss,ix) = ptr;
10633 if (i & HINT_LOCALIZE_HH) {
10634 hv = (HV*)POPPTR(ss,ix);
10635 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10638 case SAVEt_COMPPAD:
10639 av = (AV*)POPPTR(ss,ix);
10640 TOPPTR(nss,ix) = av_dup(av, param);
10643 longval = (long)POPLONG(ss,ix);
10644 TOPLONG(nss,ix) = longval;
10645 ptr = POPPTR(ss,ix);
10646 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10647 sv = (SV*)POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = sv_dup(sv, param);
10651 ptr = POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10653 longval = (long)POPBOOL(ss,ix);
10654 TOPBOOL(nss,ix) = (bool)longval;
10656 case SAVEt_SET_SVFLAGS:
10658 TOPINT(nss,ix) = i;
10660 TOPINT(nss,ix) = i;
10661 sv = (SV*)POPPTR(ss,ix);
10662 TOPPTR(nss,ix) = sv_dup(sv, param);
10664 case SAVEt_RE_STATE:
10666 const struct re_save_state *const old_state
10667 = (struct re_save_state *)
10668 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10669 struct re_save_state *const new_state
10670 = (struct re_save_state *)
10671 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10673 Copy(old_state, new_state, 1, struct re_save_state);
10674 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10676 new_state->re_state_bostr
10677 = pv_dup(old_state->re_state_bostr);
10678 new_state->re_state_reginput
10679 = pv_dup(old_state->re_state_reginput);
10680 new_state->re_state_regeol
10681 = pv_dup(old_state->re_state_regeol);
10682 new_state->re_state_regstartp
10683 = any_dup(old_state->re_state_regstartp, proto_perl);
10684 new_state->re_state_regendp
10685 = any_dup(old_state->re_state_regendp, proto_perl);
10686 new_state->re_state_reglastparen
10687 = any_dup(old_state->re_state_reglastparen, proto_perl);
10688 new_state->re_state_reglastcloseparen
10689 = any_dup(old_state->re_state_reglastcloseparen,
10691 /* XXX This just has to be broken. The old save_re_context
10692 code did SAVEGENERICPV(PL_reg_start_tmp);
10693 PL_reg_start_tmp is char **.
10694 Look above to what the dup code does for
10695 SAVEt_GENERIC_PVREF
10696 It can never have worked.
10697 So this is merely a faithful copy of the exiting bug: */
10698 new_state->re_state_reg_start_tmp
10699 = (char **) pv_dup((char *)
10700 old_state->re_state_reg_start_tmp);
10701 /* I assume that it only ever "worked" because no-one called
10702 (pseudo)fork while the regexp engine had re-entered itself.
10704 #ifdef PERL_OLD_COPY_ON_WRITE
10705 new_state->re_state_nrs
10706 = sv_dup(old_state->re_state_nrs, param);
10708 new_state->re_state_reg_magic
10709 = any_dup(old_state->re_state_reg_magic, proto_perl);
10710 new_state->re_state_reg_oldcurpm
10711 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10712 new_state->re_state_reg_curpm
10713 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10714 new_state->re_state_reg_oldsaved
10715 = pv_dup(old_state->re_state_reg_oldsaved);
10716 new_state->re_state_reg_poscache
10717 = pv_dup(old_state->re_state_reg_poscache);
10718 new_state->re_state_reg_starttry
10719 = pv_dup(old_state->re_state_reg_starttry);
10722 case SAVEt_COMPILE_WARNINGS:
10723 ptr = POPPTR(ss,ix);
10724 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10727 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10735 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10736 * flag to the result. This is done for each stash before cloning starts,
10737 * so we know which stashes want their objects cloned */
10740 do_mark_cloneable_stash(pTHX_ SV *sv)
10742 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10744 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10745 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10746 if (cloner && GvCV(cloner)) {
10753 XPUSHs(sv_2mortal(newSVhek(hvname)));
10755 call_sv((SV*)GvCV(cloner), G_SCALAR);
10762 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10770 =for apidoc perl_clone
10772 Create and return a new interpreter by cloning the current one.
10774 perl_clone takes these flags as parameters:
10776 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10777 without it we only clone the data and zero the stacks,
10778 with it we copy the stacks and the new perl interpreter is
10779 ready to run at the exact same point as the previous one.
10780 The pseudo-fork code uses COPY_STACKS while the
10781 threads->new doesn't.
10783 CLONEf_KEEP_PTR_TABLE
10784 perl_clone keeps a ptr_table with the pointer of the old
10785 variable as a key and the new variable as a value,
10786 this allows it to check if something has been cloned and not
10787 clone it again but rather just use the value and increase the
10788 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10789 the ptr_table using the function
10790 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10791 reason to keep it around is if you want to dup some of your own
10792 variable who are outside the graph perl scans, example of this
10793 code is in threads.xs create
10796 This is a win32 thing, it is ignored on unix, it tells perls
10797 win32host code (which is c++) to clone itself, this is needed on
10798 win32 if you want to run two threads at the same time,
10799 if you just want to do some stuff in a separate perl interpreter
10800 and then throw it away and return to the original one,
10801 you don't need to do anything.
10806 /* XXX the above needs expanding by someone who actually understands it ! */
10807 EXTERN_C PerlInterpreter *
10808 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10811 perl_clone(PerlInterpreter *proto_perl, UV flags)
10814 #ifdef PERL_IMPLICIT_SYS
10816 /* perlhost.h so we need to call into it
10817 to clone the host, CPerlHost should have a c interface, sky */
10819 if (flags & CLONEf_CLONE_HOST) {
10820 return perl_clone_host(proto_perl,flags);
10822 return perl_clone_using(proto_perl, flags,
10824 proto_perl->IMemShared,
10825 proto_perl->IMemParse,
10827 proto_perl->IStdIO,
10831 proto_perl->IProc);
10835 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10836 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10837 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10838 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10839 struct IPerlDir* ipD, struct IPerlSock* ipS,
10840 struct IPerlProc* ipP)
10842 /* XXX many of the string copies here can be optimized if they're
10843 * constants; they need to be allocated as common memory and just
10844 * their pointers copied. */
10847 CLONE_PARAMS clone_params;
10848 CLONE_PARAMS* const param = &clone_params;
10850 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10851 /* for each stash, determine whether its objects should be cloned */
10852 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10853 PERL_SET_THX(my_perl);
10856 PoisonNew(my_perl, 1, PerlInterpreter);
10862 PL_savestack_ix = 0;
10863 PL_savestack_max = -1;
10864 PL_sig_pending = 0;
10865 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10866 # else /* !DEBUGGING */
10867 Zero(my_perl, 1, PerlInterpreter);
10868 # endif /* DEBUGGING */
10870 /* host pointers */
10872 PL_MemShared = ipMS;
10873 PL_MemParse = ipMP;
10880 #else /* !PERL_IMPLICIT_SYS */
10882 CLONE_PARAMS clone_params;
10883 CLONE_PARAMS* param = &clone_params;
10884 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10885 /* for each stash, determine whether its objects should be cloned */
10886 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10887 PERL_SET_THX(my_perl);
10890 PoisonNew(my_perl, 1, PerlInterpreter);
10896 PL_savestack_ix = 0;
10897 PL_savestack_max = -1;
10898 PL_sig_pending = 0;
10899 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10900 # else /* !DEBUGGING */
10901 Zero(my_perl, 1, PerlInterpreter);
10902 # endif /* DEBUGGING */
10903 #endif /* PERL_IMPLICIT_SYS */
10904 param->flags = flags;
10905 param->proto_perl = proto_perl;
10907 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10909 PL_body_arenas = NULL;
10910 Zero(&PL_body_roots, 1, PL_body_roots);
10912 PL_nice_chunk = NULL;
10913 PL_nice_chunk_size = 0;
10915 PL_sv_objcount = 0;
10917 PL_sv_arenaroot = NULL;
10919 PL_debug = proto_perl->Idebug;
10921 PL_hash_seed = proto_perl->Ihash_seed;
10922 PL_rehash_seed = proto_perl->Irehash_seed;
10924 #ifdef USE_REENTRANT_API
10925 /* XXX: things like -Dm will segfault here in perlio, but doing
10926 * PERL_SET_CONTEXT(proto_perl);
10927 * breaks too many other things
10929 Perl_reentrant_init(aTHX);
10932 /* create SV map for pointer relocation */
10933 PL_ptr_table = ptr_table_new();
10935 /* initialize these special pointers as early as possible */
10936 SvANY(&PL_sv_undef) = NULL;
10937 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10938 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10939 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10941 SvANY(&PL_sv_no) = new_XPVNV();
10942 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10943 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10944 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10945 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10946 SvCUR_set(&PL_sv_no, 0);
10947 SvLEN_set(&PL_sv_no, 1);
10948 SvIV_set(&PL_sv_no, 0);
10949 SvNV_set(&PL_sv_no, 0);
10950 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10952 SvANY(&PL_sv_yes) = new_XPVNV();
10953 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10954 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10955 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10956 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10957 SvCUR_set(&PL_sv_yes, 1);
10958 SvLEN_set(&PL_sv_yes, 2);
10959 SvIV_set(&PL_sv_yes, 1);
10960 SvNV_set(&PL_sv_yes, 1);
10961 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10963 /* create (a non-shared!) shared string table */
10964 PL_strtab = newHV();
10965 HvSHAREKEYS_off(PL_strtab);
10966 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10967 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10969 PL_compiling = proto_perl->Icompiling;
10971 /* These two PVs will be free'd special way so must set them same way op.c does */
10972 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10973 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10975 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10976 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10978 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10979 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10980 if (PL_compiling.cop_hints_hash) {
10982 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10983 HINTS_REFCNT_UNLOCK;
10985 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10987 /* pseudo environmental stuff */
10988 PL_origargc = proto_perl->Iorigargc;
10989 PL_origargv = proto_perl->Iorigargv;
10991 param->stashes = newAV(); /* Setup array of objects to call clone on */
10993 /* Set tainting stuff before PerlIO_debug can possibly get called */
10994 PL_tainting = proto_perl->Itainting;
10995 PL_taint_warn = proto_perl->Itaint_warn;
10997 #ifdef PERLIO_LAYERS
10998 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10999 PerlIO_clone(aTHX_ proto_perl, param);
11002 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11003 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11004 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11005 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11006 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11007 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11010 PL_minus_c = proto_perl->Iminus_c;
11011 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11012 PL_localpatches = proto_perl->Ilocalpatches;
11013 PL_splitstr = proto_perl->Isplitstr;
11014 PL_preprocess = proto_perl->Ipreprocess;
11015 PL_minus_n = proto_perl->Iminus_n;
11016 PL_minus_p = proto_perl->Iminus_p;
11017 PL_minus_l = proto_perl->Iminus_l;
11018 PL_minus_a = proto_perl->Iminus_a;
11019 PL_minus_E = proto_perl->Iminus_E;
11020 PL_minus_F = proto_perl->Iminus_F;
11021 PL_doswitches = proto_perl->Idoswitches;
11022 PL_dowarn = proto_perl->Idowarn;
11023 PL_doextract = proto_perl->Idoextract;
11024 PL_sawampersand = proto_perl->Isawampersand;
11025 PL_unsafe = proto_perl->Iunsafe;
11026 PL_inplace = SAVEPV(proto_perl->Iinplace);
11027 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11028 PL_perldb = proto_perl->Iperldb;
11029 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11030 PL_exit_flags = proto_perl->Iexit_flags;
11032 /* magical thingies */
11033 /* XXX time(&PL_basetime) when asked for? */
11034 PL_basetime = proto_perl->Ibasetime;
11035 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11037 PL_maxsysfd = proto_perl->Imaxsysfd;
11038 PL_statusvalue = proto_perl->Istatusvalue;
11040 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11042 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11044 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11046 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11047 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11048 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11050 /* Clone the regex array */
11051 PL_regex_padav = newAV();
11053 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11054 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11056 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11057 for(i = 1; i <= len; i++) {
11058 const SV * const regex = regexen[i];
11061 ? sv_dup_inc(regex, param)
11063 newSViv(PTR2IV(re_dup(
11064 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11066 av_push(PL_regex_padav, sv);
11069 PL_regex_pad = AvARRAY(PL_regex_padav);
11071 /* shortcuts to various I/O objects */
11072 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11073 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11074 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11075 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11076 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11077 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11079 /* shortcuts to regexp stuff */
11080 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11082 /* shortcuts to misc objects */
11083 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11085 /* shortcuts to debugging objects */
11086 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11087 PL_DBline = gv_dup(proto_perl->IDBline, param);
11088 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11089 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11090 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11091 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11092 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11093 PL_lineary = av_dup(proto_perl->Ilineary, param);
11094 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11096 /* symbol tables */
11097 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11098 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11099 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11100 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11101 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11103 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11104 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11105 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11106 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11107 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11108 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11110 PL_sub_generation = proto_perl->Isub_generation;
11112 /* funky return mechanisms */
11113 PL_forkprocess = proto_perl->Iforkprocess;
11115 /* subprocess state */
11116 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11118 /* internal state */
11119 PL_maxo = proto_perl->Imaxo;
11120 if (proto_perl->Iop_mask)
11121 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11124 /* PL_asserting = proto_perl->Iasserting; */
11126 /* current interpreter roots */
11127 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11128 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11129 PL_main_start = proto_perl->Imain_start;
11130 PL_eval_root = proto_perl->Ieval_root;
11131 PL_eval_start = proto_perl->Ieval_start;
11133 /* runtime control stuff */
11134 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11135 PL_copline = proto_perl->Icopline;
11137 PL_filemode = proto_perl->Ifilemode;
11138 PL_lastfd = proto_perl->Ilastfd;
11139 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11142 PL_gensym = proto_perl->Igensym;
11143 PL_preambled = proto_perl->Ipreambled;
11144 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11145 PL_laststatval = proto_perl->Ilaststatval;
11146 PL_laststype = proto_perl->Ilaststype;
11149 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11151 /* interpreter atexit processing */
11152 PL_exitlistlen = proto_perl->Iexitlistlen;
11153 if (PL_exitlistlen) {
11154 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11155 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11158 PL_exitlist = (PerlExitListEntry*)NULL;
11160 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11161 if (PL_my_cxt_size) {
11162 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11163 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11166 PL_my_cxt_list = (void**)NULL;
11167 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11168 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11169 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11171 PL_profiledata = NULL;
11172 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11173 /* PL_rsfp_filters entries have fake IoDIRP() */
11174 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11176 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11178 PAD_CLONE_VARS(proto_perl, param);
11180 #ifdef HAVE_INTERP_INTERN
11181 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11184 /* more statics moved here */
11185 PL_generation = proto_perl->Igeneration;
11186 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11188 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11189 PL_in_clean_all = proto_perl->Iin_clean_all;
11191 PL_uid = proto_perl->Iuid;
11192 PL_euid = proto_perl->Ieuid;
11193 PL_gid = proto_perl->Igid;
11194 PL_egid = proto_perl->Iegid;
11195 PL_nomemok = proto_perl->Inomemok;
11196 PL_an = proto_perl->Ian;
11197 PL_evalseq = proto_perl->Ievalseq;
11198 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11199 PL_origalen = proto_perl->Iorigalen;
11200 #ifdef PERL_USES_PL_PIDSTATUS
11201 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11203 PL_osname = SAVEPV(proto_perl->Iosname);
11204 PL_sighandlerp = proto_perl->Isighandlerp;
11206 PL_runops = proto_perl->Irunops;
11208 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11211 PL_cshlen = proto_perl->Icshlen;
11212 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11215 PL_lex_state = proto_perl->Ilex_state;
11216 PL_lex_defer = proto_perl->Ilex_defer;
11217 PL_lex_expect = proto_perl->Ilex_expect;
11218 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11219 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11220 PL_lex_starts = proto_perl->Ilex_starts;
11221 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11222 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11223 PL_lex_op = proto_perl->Ilex_op;
11224 PL_lex_inpat = proto_perl->Ilex_inpat;
11225 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11226 PL_lex_brackets = proto_perl->Ilex_brackets;
11227 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11228 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11229 PL_lex_casemods = proto_perl->Ilex_casemods;
11230 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11231 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11234 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11235 PL_lasttoke = proto_perl->Ilasttoke;
11236 PL_realtokenstart = proto_perl->Irealtokenstart;
11237 PL_faketokens = proto_perl->Ifaketokens;
11238 PL_thismad = proto_perl->Ithismad;
11239 PL_thistoken = proto_perl->Ithistoken;
11240 PL_thisopen = proto_perl->Ithisopen;
11241 PL_thisstuff = proto_perl->Ithisstuff;
11242 PL_thisclose = proto_perl->Ithisclose;
11243 PL_thiswhite = proto_perl->Ithiswhite;
11244 PL_nextwhite = proto_perl->Inextwhite;
11245 PL_skipwhite = proto_perl->Iskipwhite;
11246 PL_endwhite = proto_perl->Iendwhite;
11247 PL_curforce = proto_perl->Icurforce;
11249 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11250 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11251 PL_nexttoke = proto_perl->Inexttoke;
11254 /* XXX This is probably masking the deeper issue of why
11255 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11256 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11257 * (A little debugging with a watchpoint on it may help.)
11259 if (SvANY(proto_perl->Ilinestr)) {
11260 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11261 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11262 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11263 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11264 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11265 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11266 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11267 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11268 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11271 PL_linestr = newSV(79);
11272 sv_upgrade(PL_linestr,SVt_PVIV);
11273 sv_setpvn(PL_linestr,"",0);
11274 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11276 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11277 PL_pending_ident = proto_perl->Ipending_ident;
11278 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11280 PL_expect = proto_perl->Iexpect;
11282 PL_multi_start = proto_perl->Imulti_start;
11283 PL_multi_end = proto_perl->Imulti_end;
11284 PL_multi_open = proto_perl->Imulti_open;
11285 PL_multi_close = proto_perl->Imulti_close;
11287 PL_error_count = proto_perl->Ierror_count;
11288 PL_subline = proto_perl->Isubline;
11289 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11291 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11292 if (SvANY(proto_perl->Ilinestr)) {
11293 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11294 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11295 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11296 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11297 PL_last_lop_op = proto_perl->Ilast_lop_op;
11300 PL_last_uni = SvPVX(PL_linestr);
11301 PL_last_lop = SvPVX(PL_linestr);
11302 PL_last_lop_op = 0;
11304 PL_in_my = proto_perl->Iin_my;
11305 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11307 PL_cryptseen = proto_perl->Icryptseen;
11310 PL_hints = proto_perl->Ihints;
11312 PL_amagic_generation = proto_perl->Iamagic_generation;
11314 #ifdef USE_LOCALE_COLLATE
11315 PL_collation_ix = proto_perl->Icollation_ix;
11316 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11317 PL_collation_standard = proto_perl->Icollation_standard;
11318 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11319 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11320 #endif /* USE_LOCALE_COLLATE */
11322 #ifdef USE_LOCALE_NUMERIC
11323 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11324 PL_numeric_standard = proto_perl->Inumeric_standard;
11325 PL_numeric_local = proto_perl->Inumeric_local;
11326 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11327 #endif /* !USE_LOCALE_NUMERIC */
11329 /* utf8 character classes */
11330 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11331 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11332 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11333 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11334 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11335 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11336 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11337 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11338 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11339 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11340 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11341 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11342 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11343 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11344 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11345 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11346 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11347 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11348 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11349 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11351 /* Did the locale setup indicate UTF-8? */
11352 PL_utf8locale = proto_perl->Iutf8locale;
11353 /* Unicode features (see perlrun/-C) */
11354 PL_unicode = proto_perl->Iunicode;
11356 /* Pre-5.8 signals control */
11357 PL_signals = proto_perl->Isignals;
11359 /* times() ticks per second */
11360 PL_clocktick = proto_perl->Iclocktick;
11362 /* Recursion stopper for PerlIO_find_layer */
11363 PL_in_load_module = proto_perl->Iin_load_module;
11365 /* sort() routine */
11366 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11368 /* Not really needed/useful since the reenrant_retint is "volatile",
11369 * but do it for consistency's sake. */
11370 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11372 /* Hooks to shared SVs and locks. */
11373 PL_sharehook = proto_perl->Isharehook;
11374 PL_lockhook = proto_perl->Ilockhook;
11375 PL_unlockhook = proto_perl->Iunlockhook;
11376 PL_threadhook = proto_perl->Ithreadhook;
11378 PL_runops_std = proto_perl->Irunops_std;
11379 PL_runops_dbg = proto_perl->Irunops_dbg;
11381 #ifdef THREADS_HAVE_PIDS
11382 PL_ppid = proto_perl->Ippid;
11386 PL_last_swash_hv = NULL; /* reinits on demand */
11387 PL_last_swash_klen = 0;
11388 PL_last_swash_key[0]= '\0';
11389 PL_last_swash_tmps = (U8*)NULL;
11390 PL_last_swash_slen = 0;
11392 PL_glob_index = proto_perl->Iglob_index;
11393 PL_srand_called = proto_perl->Isrand_called;
11394 PL_uudmap['M'] = 0; /* reinits on demand */
11395 PL_bitcount = NULL; /* reinits on demand */
11397 if (proto_perl->Ipsig_pend) {
11398 Newxz(PL_psig_pend, SIG_SIZE, int);
11401 PL_psig_pend = (int*)NULL;
11404 if (proto_perl->Ipsig_ptr) {
11405 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11406 Newxz(PL_psig_name, SIG_SIZE, SV*);
11407 for (i = 1; i < SIG_SIZE; i++) {
11408 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11409 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11413 PL_psig_ptr = (SV**)NULL;
11414 PL_psig_name = (SV**)NULL;
11417 /* thrdvar.h stuff */
11419 if (flags & CLONEf_COPY_STACKS) {
11420 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11421 PL_tmps_ix = proto_perl->Ttmps_ix;
11422 PL_tmps_max = proto_perl->Ttmps_max;
11423 PL_tmps_floor = proto_perl->Ttmps_floor;
11424 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11426 while (i <= PL_tmps_ix) {
11427 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11431 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11432 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11433 Newxz(PL_markstack, i, I32);
11434 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11435 - proto_perl->Tmarkstack);
11436 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11437 - proto_perl->Tmarkstack);
11438 Copy(proto_perl->Tmarkstack, PL_markstack,
11439 PL_markstack_ptr - PL_markstack + 1, I32);
11441 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11442 * NOTE: unlike the others! */
11443 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11444 PL_scopestack_max = proto_perl->Tscopestack_max;
11445 Newxz(PL_scopestack, PL_scopestack_max, I32);
11446 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11448 /* NOTE: si_dup() looks at PL_markstack */
11449 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11451 /* PL_curstack = PL_curstackinfo->si_stack; */
11452 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11453 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11455 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11456 PL_stack_base = AvARRAY(PL_curstack);
11457 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11458 - proto_perl->Tstack_base);
11459 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11461 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11462 * NOTE: unlike the others! */
11463 PL_savestack_ix = proto_perl->Tsavestack_ix;
11464 PL_savestack_max = proto_perl->Tsavestack_max;
11465 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11466 PL_savestack = ss_dup(proto_perl, param);
11470 ENTER; /* perl_destruct() wants to LEAVE; */
11472 /* although we're not duplicating the tmps stack, we should still
11473 * add entries for any SVs on the tmps stack that got cloned by a
11474 * non-refcount means (eg a temp in @_); otherwise they will be
11477 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11478 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11479 proto_perl->Ttmps_stack[i]);
11480 if (nsv && !SvREFCNT(nsv)) {
11482 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11487 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11488 PL_top_env = &PL_start_env;
11490 PL_op = proto_perl->Top;
11493 PL_Xpv = (XPV*)NULL;
11494 PL_na = proto_perl->Tna;
11496 PL_statbuf = proto_perl->Tstatbuf;
11497 PL_statcache = proto_perl->Tstatcache;
11498 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11499 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11501 PL_timesbuf = proto_perl->Ttimesbuf;
11504 PL_tainted = proto_perl->Ttainted;
11505 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11506 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11507 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11508 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11509 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11510 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11511 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11512 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11513 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11515 PL_restartop = proto_perl->Trestartop;
11516 PL_in_eval = proto_perl->Tin_eval;
11517 PL_delaymagic = proto_perl->Tdelaymagic;
11518 PL_dirty = proto_perl->Tdirty;
11519 PL_localizing = proto_perl->Tlocalizing;
11521 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11522 PL_hv_fetch_ent_mh = NULL;
11523 PL_modcount = proto_perl->Tmodcount;
11524 PL_lastgotoprobe = NULL;
11525 PL_dumpindent = proto_perl->Tdumpindent;
11527 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11528 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11529 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11530 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11531 PL_efloatbuf = NULL; /* reinits on demand */
11532 PL_efloatsize = 0; /* reinits on demand */
11536 PL_screamfirst = NULL;
11537 PL_screamnext = NULL;
11538 PL_maxscream = -1; /* reinits on demand */
11539 PL_lastscream = NULL;
11541 PL_watchaddr = NULL;
11544 PL_regdummy = proto_perl->Tregdummy;
11545 PL_colorset = 0; /* reinits PL_colors[] */
11546 /*PL_colors[6] = {0,0,0,0,0,0};*/
11548 /* RE engine - function pointers */
11549 PL_regcompp = proto_perl->Tregcompp;
11550 PL_regexecp = proto_perl->Tregexecp;
11551 PL_regint_start = proto_perl->Tregint_start;
11552 PL_regint_string = proto_perl->Tregint_string;
11553 PL_regfree = proto_perl->Tregfree;
11554 Zero(&PL_reg_state, 1, struct re_save_state);
11555 PL_reginterp_cnt = 0;
11556 PL_regmatch_slab = NULL;
11558 /* Pluggable optimizer */
11559 PL_peepp = proto_perl->Tpeepp;
11561 PL_stashcache = newHV();
11563 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11564 ptr_table_free(PL_ptr_table);
11565 PL_ptr_table = NULL;
11568 /* Call the ->CLONE method, if it exists, for each of the stashes
11569 identified by sv_dup() above.
11571 while(av_len(param->stashes) != -1) {
11572 HV* const stash = (HV*) av_shift(param->stashes);
11573 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11574 if (cloner && GvCV(cloner)) {
11579 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11581 call_sv((SV*)GvCV(cloner), G_DISCARD);
11587 SvREFCNT_dec(param->stashes);
11589 /* orphaned? eg threads->new inside BEGIN or use */
11590 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11591 SvREFCNT_inc_simple_void(PL_compcv);
11592 SAVEFREESV(PL_compcv);
11598 #endif /* USE_ITHREADS */
11601 =head1 Unicode Support
11603 =for apidoc sv_recode_to_utf8
11605 The encoding is assumed to be an Encode object, on entry the PV
11606 of the sv is assumed to be octets in that encoding, and the sv
11607 will be converted into Unicode (and UTF-8).
11609 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11610 is not a reference, nothing is done to the sv. If the encoding is not
11611 an C<Encode::XS> Encoding object, bad things will happen.
11612 (See F<lib/encoding.pm> and L<Encode>).
11614 The PV of the sv is returned.
11619 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11622 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11636 Passing sv_yes is wrong - it needs to be or'ed set of constants
11637 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11638 remove converted chars from source.
11640 Both will default the value - let them.
11642 XPUSHs(&PL_sv_yes);
11645 call_method("decode", G_SCALAR);
11649 s = SvPV_const(uni, len);
11650 if (s != SvPVX_const(sv)) {
11651 SvGROW(sv, len + 1);
11652 Move(s, SvPVX(sv), len + 1, char);
11653 SvCUR_set(sv, len);
11660 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11664 =for apidoc sv_cat_decode
11666 The encoding is assumed to be an Encode object, the PV of the ssv is
11667 assumed to be octets in that encoding and decoding the input starts
11668 from the position which (PV + *offset) pointed to. The dsv will be
11669 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11670 when the string tstr appears in decoding output or the input ends on
11671 the PV of the ssv. The value which the offset points will be modified
11672 to the last input position on the ssv.
11674 Returns TRUE if the terminator was found, else returns FALSE.
11679 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11680 SV *ssv, int *offset, char *tstr, int tlen)
11684 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11695 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11696 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11698 call_method("cat_decode", G_SCALAR);
11700 ret = SvTRUE(TOPs);
11701 *offset = SvIV(offsv);
11707 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11712 /* ---------------------------------------------------------------------
11714 * support functions for report_uninit()
11717 /* the maxiumum size of array or hash where we will scan looking
11718 * for the undefined element that triggered the warning */
11720 #define FUV_MAX_SEARCH_SIZE 1000
11722 /* Look for an entry in the hash whose value has the same SV as val;
11723 * If so, return a mortal copy of the key. */
11726 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11729 register HE **array;
11732 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11733 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11736 array = HvARRAY(hv);
11738 for (i=HvMAX(hv); i>0; i--) {
11739 register HE *entry;
11740 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11741 if (HeVAL(entry) != val)
11743 if ( HeVAL(entry) == &PL_sv_undef ||
11744 HeVAL(entry) == &PL_sv_placeholder)
11748 if (HeKLEN(entry) == HEf_SVKEY)
11749 return sv_mortalcopy(HeKEY_sv(entry));
11750 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11756 /* Look for an entry in the array whose value has the same SV as val;
11757 * If so, return the index, otherwise return -1. */
11760 S_find_array_subscript(pTHX_ AV *av, SV* val)
11763 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11764 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11767 if (val != &PL_sv_undef) {
11768 SV ** const svp = AvARRAY(av);
11771 for (i=AvFILLp(av); i>=0; i--)
11778 /* S_varname(): return the name of a variable, optionally with a subscript.
11779 * If gv is non-zero, use the name of that global, along with gvtype (one
11780 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11781 * targ. Depending on the value of the subscript_type flag, return:
11784 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11785 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11786 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11787 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11790 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11791 SV* keyname, I32 aindex, int subscript_type)
11794 SV * const name = sv_newmortal();
11797 buffer[0] = gvtype;
11800 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11802 gv_fullname4(name, gv, buffer, 0);
11804 if ((unsigned int)SvPVX(name)[1] <= 26) {
11806 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11808 /* Swap the 1 unprintable control character for the 2 byte pretty
11809 version - ie substr($name, 1, 1) = $buffer; */
11810 sv_insert(name, 1, 1, buffer, 2);
11815 CV * const cv = find_runcv(&unused);
11819 if (!cv || !CvPADLIST(cv))
11821 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11822 sv = *av_fetch(av, targ, FALSE);
11823 /* SvLEN in a pad name is not to be trusted */
11824 sv_setpv(name, SvPV_nolen_const(sv));
11827 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11828 SV * const sv = newSV(0);
11829 *SvPVX(name) = '$';
11830 Perl_sv_catpvf(aTHX_ name, "{%s}",
11831 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11834 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11835 *SvPVX(name) = '$';
11836 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11838 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11839 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11846 =for apidoc find_uninit_var
11848 Find the name of the undefined variable (if any) that caused the operator o
11849 to issue a "Use of uninitialized value" warning.
11850 If match is true, only return a name if it's value matches uninit_sv.
11851 So roughly speaking, if a unary operator (such as OP_COS) generates a
11852 warning, then following the direct child of the op may yield an
11853 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11854 other hand, with OP_ADD there are two branches to follow, so we only print
11855 the variable name if we get an exact match.
11857 The name is returned as a mortal SV.
11859 Assumes that PL_op is the op that originally triggered the error, and that
11860 PL_comppad/PL_curpad points to the currently executing pad.
11866 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11874 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11875 uninit_sv == &PL_sv_placeholder)))
11878 switch (obase->op_type) {
11885 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11886 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11889 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11891 if (pad) { /* @lex, %lex */
11892 sv = PAD_SVl(obase->op_targ);
11896 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11897 /* @global, %global */
11898 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11901 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11903 else /* @{expr}, %{expr} */
11904 return find_uninit_var(cUNOPx(obase)->op_first,
11908 /* attempt to find a match within the aggregate */
11910 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11912 subscript_type = FUV_SUBSCRIPT_HASH;
11915 index = find_array_subscript((AV*)sv, uninit_sv);
11917 subscript_type = FUV_SUBSCRIPT_ARRAY;
11920 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11923 return varname(gv, hash ? '%' : '@', obase->op_targ,
11924 keysv, index, subscript_type);
11928 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11930 return varname(NULL, '$', obase->op_targ,
11931 NULL, 0, FUV_SUBSCRIPT_NONE);
11934 gv = cGVOPx_gv(obase);
11935 if (!gv || (match && GvSV(gv) != uninit_sv))
11937 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11940 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11943 av = (AV*)PAD_SV(obase->op_targ);
11944 if (!av || SvRMAGICAL(av))
11946 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11947 if (!svp || *svp != uninit_sv)
11950 return varname(NULL, '$', obase->op_targ,
11951 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11954 gv = cGVOPx_gv(obase);
11960 if (!av || SvRMAGICAL(av))
11962 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11963 if (!svp || *svp != uninit_sv)
11966 return varname(gv, '$', 0,
11967 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11972 o = cUNOPx(obase)->op_first;
11973 if (!o || o->op_type != OP_NULL ||
11974 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11976 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11980 if (PL_op == obase)
11981 /* $a[uninit_expr] or $h{uninit_expr} */
11982 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11985 o = cBINOPx(obase)->op_first;
11986 kid = cBINOPx(obase)->op_last;
11988 /* get the av or hv, and optionally the gv */
11990 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11991 sv = PAD_SV(o->op_targ);
11993 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11994 && cUNOPo->op_first->op_type == OP_GV)
11996 gv = cGVOPx_gv(cUNOPo->op_first);
11999 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12004 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12005 /* index is constant */
12009 if (obase->op_type == OP_HELEM) {
12010 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12011 if (!he || HeVAL(he) != uninit_sv)
12015 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12016 if (!svp || *svp != uninit_sv)
12020 if (obase->op_type == OP_HELEM)
12021 return varname(gv, '%', o->op_targ,
12022 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12024 return varname(gv, '@', o->op_targ, NULL,
12025 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12028 /* index is an expression;
12029 * attempt to find a match within the aggregate */
12030 if (obase->op_type == OP_HELEM) {
12031 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12033 return varname(gv, '%', o->op_targ,
12034 keysv, 0, FUV_SUBSCRIPT_HASH);
12037 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12039 return varname(gv, '@', o->op_targ,
12040 NULL, index, FUV_SUBSCRIPT_ARRAY);
12045 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12047 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12052 /* only examine RHS */
12053 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12056 o = cUNOPx(obase)->op_first;
12057 if (o->op_type == OP_PUSHMARK)
12060 if (!o->op_sibling) {
12061 /* one-arg version of open is highly magical */
12063 if (o->op_type == OP_GV) { /* open FOO; */
12065 if (match && GvSV(gv) != uninit_sv)
12067 return varname(gv, '$', 0,
12068 NULL, 0, FUV_SUBSCRIPT_NONE);
12070 /* other possibilities not handled are:
12071 * open $x; or open my $x; should return '${*$x}'
12072 * open expr; should return '$'.expr ideally
12078 /* ops where $_ may be an implicit arg */
12082 if ( !(obase->op_flags & OPf_STACKED)) {
12083 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12084 ? PAD_SVl(obase->op_targ)
12087 sv = sv_newmortal();
12088 sv_setpvn(sv, "$_", 2);
12096 /* skip filehandle as it can't produce 'undef' warning */
12097 o = cUNOPx(obase)->op_first;
12098 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12099 o = o->op_sibling->op_sibling;
12106 match = 1; /* XS or custom code could trigger random warnings */
12111 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12112 return sv_2mortal(newSVpvs("${$/}"));
12117 if (!(obase->op_flags & OPf_KIDS))
12119 o = cUNOPx(obase)->op_first;
12125 /* if all except one arg are constant, or have no side-effects,
12126 * or are optimized away, then it's unambiguous */
12128 for (kid=o; kid; kid = kid->op_sibling) {
12130 const OPCODE type = kid->op_type;
12131 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12132 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12133 || (type == OP_PUSHMARK)
12137 if (o2) { /* more than one found */
12144 return find_uninit_var(o2, uninit_sv, match);
12146 /* scan all args */
12148 sv = find_uninit_var(o, uninit_sv, 1);
12160 =for apidoc report_uninit
12162 Print appropriate "Use of uninitialized variable" warning
12168 Perl_report_uninit(pTHX_ SV* uninit_sv)
12172 SV* varname = NULL;
12174 varname = find_uninit_var(PL_op, uninit_sv,0);
12176 sv_insert(varname, 0, 0, " ", 1);
12178 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12179 varname ? SvPV_nolen_const(varname) : "",
12180 " in ", OP_DESC(PL_op));
12183 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12189 * c-indentation-style: bsd
12190 * c-basic-offset: 4
12191 * indent-tabs-mode: t
12194 * ex: set ts=8 sts=4 sw=4 noet: