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", *aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1052 if (!done_sanity_check) {
1053 unsigned int i = SVt_LAST;
1055 done_sanity_check = TRUE;
1058 assert (bodies_by_type[i].type == i);
1062 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1064 end = start + bdp->arena_size - body_size;
1066 /* computed count doesnt reflect the 1st slot reservation */
1067 DEBUG_m(PerlIO_printf(Perl_debug_log,
1068 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1069 start, end, bdp->arena_size, sv_type, body_size,
1070 bdp->arena_size / body_size));
1072 *root = (void *)start;
1074 while (start < end) {
1075 char * const next = start + body_size;
1076 *(void**) start = (void *)next;
1079 *(void **)start = 0;
1084 /* grab a new thing from the free list, allocating more if necessary.
1085 The inline version is used for speed in hot routines, and the
1086 function using it serves the rest (unless PURIFY).
1088 #define new_body_inline(xpv, sv_type) \
1090 void ** const r3wt = &PL_body_roots[sv_type]; \
1092 xpv = *((void **)(r3wt)) \
1093 ? *((void **)(r3wt)) : more_bodies(sv_type); \
1094 *(r3wt) = *(void**)(xpv); \
1101 S_new_body(pTHX_ svtype sv_type)
1105 new_body_inline(xpv, sv_type);
1112 =for apidoc sv_upgrade
1114 Upgrade an SV to a more complex form. Generally adds a new body type to the
1115 SV, then copies across as much information as possible from the old body.
1116 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1122 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1127 const U32 old_type = SvTYPE(sv);
1128 const struct body_details *new_type_details;
1129 const struct body_details *const old_type_details
1130 = bodies_by_type + old_type;
1132 if (new_type != SVt_PV && SvIsCOW(sv)) {
1133 sv_force_normal_flags(sv, 0);
1136 if (old_type == new_type)
1139 if (old_type > new_type)
1140 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1141 (int)old_type, (int)new_type);
1144 old_body = SvANY(sv);
1146 /* Copying structures onto other structures that have been neatly zeroed
1147 has a subtle gotcha. Consider XPVMG
1149 +------+------+------+------+------+-------+-------+
1150 | NV | CUR | LEN | IV | MAGIC | STASH |
1151 +------+------+------+------+------+-------+-------+
1152 0 4 8 12 16 20 24 28
1154 where NVs are aligned to 8 bytes, so that sizeof that structure is
1155 actually 32 bytes long, with 4 bytes of padding at the end:
1157 +------+------+------+------+------+-------+-------+------+
1158 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1159 +------+------+------+------+------+-------+-------+------+
1160 0 4 8 12 16 20 24 28 32
1162 so what happens if you allocate memory for this structure:
1164 +------+------+------+------+------+-------+-------+------+------+...
1165 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1166 +------+------+------+------+------+-------+-------+------+------+...
1167 0 4 8 12 16 20 24 28 32 36
1169 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1170 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1171 started out as zero once, but it's quite possible that it isn't. So now,
1172 rather than a nicely zeroed GP, you have it pointing somewhere random.
1175 (In fact, GP ends up pointing at a previous GP structure, because the
1176 principle cause of the padding in XPVMG getting garbage is a copy of
1177 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1179 So we are careful and work out the size of used parts of all the
1186 if (new_type < SVt_PVIV) {
1187 new_type = (new_type == SVt_NV)
1188 ? SVt_PVNV : SVt_PVIV;
1192 if (new_type < SVt_PVNV) {
1193 new_type = SVt_PVNV;
1199 assert(new_type > SVt_PV);
1200 assert(SVt_IV < SVt_PV);
1201 assert(SVt_NV < SVt_PV);
1208 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1209 there's no way that it can be safely upgraded, because perl.c
1210 expects to Safefree(SvANY(PL_mess_sv)) */
1211 assert(sv != PL_mess_sv);
1212 /* This flag bit is used to mean other things in other scalar types.
1213 Given that it only has meaning inside the pad, it shouldn't be set
1214 on anything that can get upgraded. */
1215 assert(!SvPAD_TYPED(sv));
1218 if (old_type_details->cant_upgrade)
1219 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1220 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1222 new_type_details = bodies_by_type + new_type;
1224 SvFLAGS(sv) &= ~SVTYPEMASK;
1225 SvFLAGS(sv) |= new_type;
1227 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1228 the return statements above will have triggered. */
1229 assert (new_type != SVt_NULL);
1232 assert(old_type == SVt_NULL);
1233 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1237 assert(old_type == SVt_NULL);
1238 SvANY(sv) = new_XNV();
1242 assert(old_type == SVt_NULL);
1243 SvANY(sv) = &sv->sv_u.svu_rv;
1248 assert(new_type_details->body_size);
1251 assert(new_type_details->arena);
1252 assert(new_type_details->arena_size);
1253 /* This points to the start of the allocated area. */
1254 new_body_inline(new_body, new_type);
1255 Zero(new_body, new_type_details->body_size, char);
1256 new_body = ((char *)new_body) - new_type_details->offset;
1258 /* We always allocated the full length item with PURIFY. To do this
1259 we fake things so that arena is false for all 16 types.. */
1260 new_body = new_NOARENAZ(new_type_details);
1262 SvANY(sv) = new_body;
1263 if (new_type == SVt_PVAV) {
1269 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1270 The target created by newSVrv also is, and it can have magic.
1271 However, it never has SvPVX set.
1273 if (old_type >= SVt_RV) {
1274 assert(SvPVX_const(sv) == 0);
1277 /* Could put this in the else clause below, as PVMG must have SvPVX
1278 0 already (the assertion above) */
1281 if (old_type >= SVt_PVMG) {
1282 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1283 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1289 /* XXX Is this still needed? Was it ever needed? Surely as there is
1290 no route from NV to PVIV, NOK can never be true */
1291 assert(!SvNOKp(sv));
1303 assert(new_type_details->body_size);
1304 /* We always allocated the full length item with PURIFY. To do this
1305 we fake things so that arena is false for all 16 types.. */
1306 if(new_type_details->arena) {
1307 /* This points to the start of the allocated area. */
1308 new_body_inline(new_body, new_type);
1309 Zero(new_body, new_type_details->body_size, char);
1310 new_body = ((char *)new_body) - new_type_details->offset;
1312 new_body = new_NOARENAZ(new_type_details);
1314 SvANY(sv) = new_body;
1316 if (old_type_details->copy) {
1317 /* There is now the potential for an upgrade from something without
1318 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1319 int offset = old_type_details->offset;
1320 int length = old_type_details->copy;
1322 if (new_type_details->offset > old_type_details->offset) {
1323 const int difference
1324 = new_type_details->offset - old_type_details->offset;
1325 offset += difference;
1326 length -= difference;
1328 assert (length >= 0);
1330 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1334 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1335 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1336 * correct 0.0 for us. Otherwise, if the old body didn't have an
1337 * NV slot, but the new one does, then we need to initialise the
1338 * freshly created NV slot with whatever the correct bit pattern is
1340 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1344 if (new_type == SVt_PVIO)
1345 IoPAGE_LEN(sv) = 60;
1346 if (old_type < SVt_RV)
1350 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1351 (unsigned long)new_type);
1354 if (old_type_details->arena) {
1355 /* If there was an old body, then we need to free it.
1356 Note that there is an assumption that all bodies of types that
1357 can be upgraded came from arenas. Only the more complex non-
1358 upgradable types are allowed to be directly malloc()ed. */
1360 my_safefree(old_body);
1362 del_body((void*)((char*)old_body + old_type_details->offset),
1363 &PL_body_roots[old_type]);
1369 =for apidoc sv_backoff
1371 Remove any string offset. You should normally use the C<SvOOK_off> macro
1378 Perl_sv_backoff(pTHX_ register SV *sv)
1380 PERL_UNUSED_CONTEXT;
1382 assert(SvTYPE(sv) != SVt_PVHV);
1383 assert(SvTYPE(sv) != SVt_PVAV);
1385 const char * const s = SvPVX_const(sv);
1386 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1387 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1389 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1391 SvFLAGS(sv) &= ~SVf_OOK;
1398 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1399 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1400 Use the C<SvGROW> wrapper instead.
1406 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1410 if (PL_madskills && newlen >= 0x100000) {
1411 PerlIO_printf(Perl_debug_log,
1412 "Allocation too large: %"UVxf"\n", (UV)newlen);
1414 #ifdef HAS_64K_LIMIT
1415 if (newlen >= 0x10000) {
1416 PerlIO_printf(Perl_debug_log,
1417 "Allocation too large: %"UVxf"\n", (UV)newlen);
1420 #endif /* HAS_64K_LIMIT */
1423 if (SvTYPE(sv) < SVt_PV) {
1424 sv_upgrade(sv, SVt_PV);
1425 s = SvPVX_mutable(sv);
1427 else if (SvOOK(sv)) { /* pv is offset? */
1429 s = SvPVX_mutable(sv);
1430 if (newlen > SvLEN(sv))
1431 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1432 #ifdef HAS_64K_LIMIT
1433 if (newlen >= 0x10000)
1438 s = SvPVX_mutable(sv);
1440 if (newlen > SvLEN(sv)) { /* need more room? */
1441 newlen = PERL_STRLEN_ROUNDUP(newlen);
1442 if (SvLEN(sv) && s) {
1444 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1450 s = saferealloc(s, newlen);
1453 s = safemalloc(newlen);
1454 if (SvPVX_const(sv) && SvCUR(sv)) {
1455 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1459 SvLEN_set(sv, newlen);
1465 =for apidoc sv_setiv
1467 Copies an integer into the given SV, upgrading first if necessary.
1468 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1474 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1477 SV_CHECK_THINKFIRST_COW_DROP(sv);
1478 switch (SvTYPE(sv)) {
1480 sv_upgrade(sv, SVt_IV);
1483 sv_upgrade(sv, SVt_PVNV);
1487 sv_upgrade(sv, SVt_PVIV);
1496 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1499 (void)SvIOK_only(sv); /* validate number */
1505 =for apidoc sv_setiv_mg
1507 Like C<sv_setiv>, but also handles 'set' magic.
1513 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1520 =for apidoc sv_setuv
1522 Copies an unsigned integer into the given SV, upgrading first if necessary.
1523 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1529 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1531 /* With these two if statements:
1532 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1535 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1537 If you wish to remove them, please benchmark to see what the effect is
1539 if (u <= (UV)IV_MAX) {
1540 sv_setiv(sv, (IV)u);
1549 =for apidoc sv_setuv_mg
1551 Like C<sv_setuv>, but also handles 'set' magic.
1557 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1566 =for apidoc sv_setnv
1568 Copies a double into the given SV, upgrading first if necessary.
1569 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1575 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1578 SV_CHECK_THINKFIRST_COW_DROP(sv);
1579 switch (SvTYPE(sv)) {
1582 sv_upgrade(sv, SVt_NV);
1587 sv_upgrade(sv, SVt_PVNV);
1596 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1600 (void)SvNOK_only(sv); /* validate number */
1605 =for apidoc sv_setnv_mg
1607 Like C<sv_setnv>, but also handles 'set' magic.
1613 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1619 /* Print an "isn't numeric" warning, using a cleaned-up,
1620 * printable version of the offending string
1624 S_not_a_number(pTHX_ SV *sv)
1632 dsv = sv_2mortal(newSVpvs(""));
1633 pv = sv_uni_display(dsv, sv, 10, 0);
1636 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1637 /* each *s can expand to 4 chars + "...\0",
1638 i.e. need room for 8 chars */
1640 const char *s = SvPVX_const(sv);
1641 const char * const end = s + SvCUR(sv);
1642 for ( ; s < end && d < limit; s++ ) {
1644 if (ch & 128 && !isPRINT_LC(ch)) {
1653 else if (ch == '\r') {
1657 else if (ch == '\f') {
1661 else if (ch == '\\') {
1665 else if (ch == '\0') {
1669 else if (isPRINT_LC(ch))
1686 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1687 "Argument \"%s\" isn't numeric in %s", pv,
1690 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1691 "Argument \"%s\" isn't numeric", pv);
1695 =for apidoc looks_like_number
1697 Test if the content of an SV looks like a number (or is a number).
1698 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1699 non-numeric warning), even if your atof() doesn't grok them.
1705 Perl_looks_like_number(pTHX_ SV *sv)
1707 register const char *sbegin;
1711 sbegin = SvPVX_const(sv);
1714 else if (SvPOKp(sv))
1715 sbegin = SvPV_const(sv, len);
1717 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1718 return grok_number(sbegin, len, NULL);
1722 S_glob_2number(pTHX_ GV * const gv)
1724 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1725 SV *const buffer = sv_newmortal();
1727 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1730 gv_efullname3(buffer, gv, "*");
1731 SvFLAGS(gv) |= wasfake;
1733 /* We know that all GVs stringify to something that is not-a-number,
1734 so no need to test that. */
1735 if (ckWARN(WARN_NUMERIC))
1736 not_a_number(buffer);
1737 /* We just want something true to return, so that S_sv_2iuv_common
1738 can tail call us and return true. */
1743 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1745 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1746 SV *const buffer = sv_newmortal();
1748 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1751 gv_efullname3(buffer, gv, "*");
1752 SvFLAGS(gv) |= wasfake;
1754 assert(SvPOK(buffer));
1755 *len = SvCUR(buffer);
1756 return SvPVX(buffer);
1759 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1760 until proven guilty, assume that things are not that bad... */
1765 As 64 bit platforms often have an NV that doesn't preserve all bits of
1766 an IV (an assumption perl has been based on to date) it becomes necessary
1767 to remove the assumption that the NV always carries enough precision to
1768 recreate the IV whenever needed, and that the NV is the canonical form.
1769 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1770 precision as a side effect of conversion (which would lead to insanity
1771 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1772 1) to distinguish between IV/UV/NV slots that have cached a valid
1773 conversion where precision was lost and IV/UV/NV slots that have a
1774 valid conversion which has lost no precision
1775 2) to ensure that if a numeric conversion to one form is requested that
1776 would lose precision, the precise conversion (or differently
1777 imprecise conversion) is also performed and cached, to prevent
1778 requests for different numeric formats on the same SV causing
1779 lossy conversion chains. (lossless conversion chains are perfectly
1784 SvIOKp is true if the IV slot contains a valid value
1785 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1786 SvNOKp is true if the NV slot contains a valid value
1787 SvNOK is true only if the NV value is accurate
1790 while converting from PV to NV, check to see if converting that NV to an
1791 IV(or UV) would lose accuracy over a direct conversion from PV to
1792 IV(or UV). If it would, cache both conversions, return NV, but mark
1793 SV as IOK NOKp (ie not NOK).
1795 While converting from PV to IV, check to see if converting that IV to an
1796 NV would lose accuracy over a direct conversion from PV to NV. If it
1797 would, cache both conversions, flag similarly.
1799 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1800 correctly because if IV & NV were set NV *always* overruled.
1801 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1802 changes - now IV and NV together means that the two are interchangeable:
1803 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1805 The benefit of this is that operations such as pp_add know that if
1806 SvIOK is true for both left and right operands, then integer addition
1807 can be used instead of floating point (for cases where the result won't
1808 overflow). Before, floating point was always used, which could lead to
1809 loss of precision compared with integer addition.
1811 * making IV and NV equal status should make maths accurate on 64 bit
1813 * may speed up maths somewhat if pp_add and friends start to use
1814 integers when possible instead of fp. (Hopefully the overhead in
1815 looking for SvIOK and checking for overflow will not outweigh the
1816 fp to integer speedup)
1817 * will slow down integer operations (callers of SvIV) on "inaccurate"
1818 values, as the change from SvIOK to SvIOKp will cause a call into
1819 sv_2iv each time rather than a macro access direct to the IV slot
1820 * should speed up number->string conversion on integers as IV is
1821 favoured when IV and NV are equally accurate
1823 ####################################################################
1824 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1825 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1826 On the other hand, SvUOK is true iff UV.
1827 ####################################################################
1829 Your mileage will vary depending your CPU's relative fp to integer
1833 #ifndef NV_PRESERVES_UV
1834 # define IS_NUMBER_UNDERFLOW_IV 1
1835 # define IS_NUMBER_UNDERFLOW_UV 2
1836 # define IS_NUMBER_IV_AND_UV 2
1837 # define IS_NUMBER_OVERFLOW_IV 4
1838 # define IS_NUMBER_OVERFLOW_UV 5
1840 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1842 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1844 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1847 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));
1848 if (SvNVX(sv) < (NV)IV_MIN) {
1849 (void)SvIOKp_on(sv);
1851 SvIV_set(sv, IV_MIN);
1852 return IS_NUMBER_UNDERFLOW_IV;
1854 if (SvNVX(sv) > (NV)UV_MAX) {
1855 (void)SvIOKp_on(sv);
1858 SvUV_set(sv, UV_MAX);
1859 return IS_NUMBER_OVERFLOW_UV;
1861 (void)SvIOKp_on(sv);
1863 /* Can't use strtol etc to convert this string. (See truth table in
1865 if (SvNVX(sv) <= (UV)IV_MAX) {
1866 SvIV_set(sv, I_V(SvNVX(sv)));
1867 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1868 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1870 /* Integer is imprecise. NOK, IOKp */
1872 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1875 SvUV_set(sv, U_V(SvNVX(sv)));
1876 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1877 if (SvUVX(sv) == UV_MAX) {
1878 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1879 possibly be preserved by NV. Hence, it must be overflow.
1881 return IS_NUMBER_OVERFLOW_UV;
1883 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1885 /* Integer is imprecise. NOK, IOKp */
1887 return IS_NUMBER_OVERFLOW_IV;
1889 #endif /* !NV_PRESERVES_UV*/
1892 S_sv_2iuv_common(pTHX_ SV *sv) {
1895 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1896 * without also getting a cached IV/UV from it at the same time
1897 * (ie PV->NV conversion should detect loss of accuracy and cache
1898 * IV or UV at same time to avoid this. */
1899 /* IV-over-UV optimisation - choose to cache IV if possible */
1901 if (SvTYPE(sv) == SVt_NV)
1902 sv_upgrade(sv, SVt_PVNV);
1904 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1905 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1906 certainly cast into the IV range at IV_MAX, whereas the correct
1907 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1909 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1910 if (Perl_isnan(SvNVX(sv))) {
1916 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1917 SvIV_set(sv, I_V(SvNVX(sv)));
1918 if (SvNVX(sv) == (NV) SvIVX(sv)
1919 #ifndef NV_PRESERVES_UV
1920 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1921 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1922 /* Don't flag it as "accurately an integer" if the number
1923 came from a (by definition imprecise) NV operation, and
1924 we're outside the range of NV integer precision */
1927 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1928 DEBUG_c(PerlIO_printf(Perl_debug_log,
1929 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1935 /* IV not precise. No need to convert from PV, as NV
1936 conversion would already have cached IV if it detected
1937 that PV->IV would be better than PV->NV->IV
1938 flags already correct - don't set public IOK. */
1939 DEBUG_c(PerlIO_printf(Perl_debug_log,
1940 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1945 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1946 but the cast (NV)IV_MIN rounds to a the value less (more
1947 negative) than IV_MIN which happens to be equal to SvNVX ??
1948 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1949 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1950 (NV)UVX == NVX are both true, but the values differ. :-(
1951 Hopefully for 2s complement IV_MIN is something like
1952 0x8000000000000000 which will be exact. NWC */
1955 SvUV_set(sv, U_V(SvNVX(sv)));
1957 (SvNVX(sv) == (NV) SvUVX(sv))
1958 #ifndef NV_PRESERVES_UV
1959 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1960 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1961 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1962 /* Don't flag it as "accurately an integer" if the number
1963 came from a (by definition imprecise) NV operation, and
1964 we're outside the range of NV integer precision */
1969 DEBUG_c(PerlIO_printf(Perl_debug_log,
1970 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1976 else if (SvPOKp(sv) && SvLEN(sv)) {
1978 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1979 /* We want to avoid a possible problem when we cache an IV/ a UV which
1980 may be later translated to an NV, and the resulting NV is not
1981 the same as the direct translation of the initial string
1982 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1983 be careful to ensure that the value with the .456 is around if the
1984 NV value is requested in the future).
1986 This means that if we cache such an IV/a UV, we need to cache the
1987 NV as well. Moreover, we trade speed for space, and do not
1988 cache the NV if we are sure it's not needed.
1991 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1992 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1993 == IS_NUMBER_IN_UV) {
1994 /* It's definitely an integer, only upgrade to PVIV */
1995 if (SvTYPE(sv) < SVt_PVIV)
1996 sv_upgrade(sv, SVt_PVIV);
1998 } else if (SvTYPE(sv) < SVt_PVNV)
1999 sv_upgrade(sv, SVt_PVNV);
2001 /* If NVs preserve UVs then we only use the UV value if we know that
2002 we aren't going to call atof() below. If NVs don't preserve UVs
2003 then the value returned may have more precision than atof() will
2004 return, even though value isn't perfectly accurate. */
2005 if ((numtype & (IS_NUMBER_IN_UV
2006 #ifdef NV_PRESERVES_UV
2009 )) == IS_NUMBER_IN_UV) {
2010 /* This won't turn off the public IOK flag if it was set above */
2011 (void)SvIOKp_on(sv);
2013 if (!(numtype & IS_NUMBER_NEG)) {
2015 if (value <= (UV)IV_MAX) {
2016 SvIV_set(sv, (IV)value);
2018 /* it didn't overflow, and it was positive. */
2019 SvUV_set(sv, value);
2023 /* 2s complement assumption */
2024 if (value <= (UV)IV_MIN) {
2025 SvIV_set(sv, -(IV)value);
2027 /* Too negative for an IV. This is a double upgrade, but
2028 I'm assuming it will be rare. */
2029 if (SvTYPE(sv) < SVt_PVNV)
2030 sv_upgrade(sv, SVt_PVNV);
2034 SvNV_set(sv, -(NV)value);
2035 SvIV_set(sv, IV_MIN);
2039 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2040 will be in the previous block to set the IV slot, and the next
2041 block to set the NV slot. So no else here. */
2043 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2044 != IS_NUMBER_IN_UV) {
2045 /* It wasn't an (integer that doesn't overflow the UV). */
2046 SvNV_set(sv, Atof(SvPVX_const(sv)));
2048 if (! numtype && ckWARN(WARN_NUMERIC))
2051 #if defined(USE_LONG_DOUBLE)
2052 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2053 PTR2UV(sv), SvNVX(sv)));
2055 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2056 PTR2UV(sv), SvNVX(sv)));
2059 #ifdef NV_PRESERVES_UV
2060 (void)SvIOKp_on(sv);
2062 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2063 SvIV_set(sv, I_V(SvNVX(sv)));
2064 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2067 NOOP; /* Integer is imprecise. NOK, IOKp */
2069 /* UV will not work better than IV */
2071 if (SvNVX(sv) > (NV)UV_MAX) {
2073 /* Integer is inaccurate. NOK, IOKp, is UV */
2074 SvUV_set(sv, UV_MAX);
2076 SvUV_set(sv, U_V(SvNVX(sv)));
2077 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2078 NV preservse UV so can do correct comparison. */
2079 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2082 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2087 #else /* NV_PRESERVES_UV */
2088 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2089 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2090 /* The IV/UV slot will have been set from value returned by
2091 grok_number above. The NV slot has just been set using
2094 assert (SvIOKp(sv));
2096 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2097 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2098 /* Small enough to preserve all bits. */
2099 (void)SvIOKp_on(sv);
2101 SvIV_set(sv, I_V(SvNVX(sv)));
2102 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2104 /* Assumption: first non-preserved integer is < IV_MAX,
2105 this NV is in the preserved range, therefore: */
2106 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2108 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);
2112 0 0 already failed to read UV.
2113 0 1 already failed to read UV.
2114 1 0 you won't get here in this case. IV/UV
2115 slot set, public IOK, Atof() unneeded.
2116 1 1 already read UV.
2117 so there's no point in sv_2iuv_non_preserve() attempting
2118 to use atol, strtol, strtoul etc. */
2119 sv_2iuv_non_preserve (sv, numtype);
2122 #endif /* NV_PRESERVES_UV */
2126 if (isGV_with_GP(sv))
2127 return glob_2number((GV *)sv);
2129 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2130 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2133 if (SvTYPE(sv) < SVt_IV)
2134 /* Typically the caller expects that sv_any is not NULL now. */
2135 sv_upgrade(sv, SVt_IV);
2136 /* Return 0 from the caller. */
2143 =for apidoc sv_2iv_flags
2145 Return the integer value of an SV, doing any necessary string
2146 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2147 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2153 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2158 if (SvGMAGICAL(sv)) {
2159 if (flags & SV_GMAGIC)
2164 return I_V(SvNVX(sv));
2166 if (SvPOKp(sv) && SvLEN(sv)) {
2169 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2171 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2172 == IS_NUMBER_IN_UV) {
2173 /* It's definitely an integer */
2174 if (numtype & IS_NUMBER_NEG) {
2175 if (value < (UV)IV_MIN)
2178 if (value < (UV)IV_MAX)
2183 if (ckWARN(WARN_NUMERIC))
2186 return I_V(Atof(SvPVX_const(sv)));
2191 assert(SvTYPE(sv) >= SVt_PVMG);
2192 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2193 } else if (SvTHINKFIRST(sv)) {
2197 SV * const tmpstr=AMG_CALLun(sv,numer);
2198 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2199 return SvIV(tmpstr);
2202 return PTR2IV(SvRV(sv));
2205 sv_force_normal_flags(sv, 0);
2207 if (SvREADONLY(sv) && !SvOK(sv)) {
2208 if (ckWARN(WARN_UNINITIALIZED))
2214 if (S_sv_2iuv_common(aTHX_ sv))
2217 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2218 PTR2UV(sv),SvIVX(sv)));
2219 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2223 =for apidoc sv_2uv_flags
2225 Return the unsigned integer value of an SV, doing any necessary string
2226 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2227 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2233 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2238 if (SvGMAGICAL(sv)) {
2239 if (flags & SV_GMAGIC)
2244 return U_V(SvNVX(sv));
2245 if (SvPOKp(sv) && SvLEN(sv)) {
2248 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2250 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2251 == IS_NUMBER_IN_UV) {
2252 /* It's definitely an integer */
2253 if (!(numtype & IS_NUMBER_NEG))
2257 if (ckWARN(WARN_NUMERIC))
2260 return U_V(Atof(SvPVX_const(sv)));
2265 assert(SvTYPE(sv) >= SVt_PVMG);
2266 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2267 } else if (SvTHINKFIRST(sv)) {
2271 SV *const tmpstr = AMG_CALLun(sv,numer);
2272 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2273 return SvUV(tmpstr);
2276 return PTR2UV(SvRV(sv));
2279 sv_force_normal_flags(sv, 0);
2281 if (SvREADONLY(sv) && !SvOK(sv)) {
2282 if (ckWARN(WARN_UNINITIALIZED))
2288 if (S_sv_2iuv_common(aTHX_ sv))
2292 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2293 PTR2UV(sv),SvUVX(sv)));
2294 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2300 Return the num value of an SV, doing any necessary string or integer
2301 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2308 Perl_sv_2nv(pTHX_ register SV *sv)
2313 if (SvGMAGICAL(sv)) {
2317 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2318 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2319 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2321 return Atof(SvPVX_const(sv));
2325 return (NV)SvUVX(sv);
2327 return (NV)SvIVX(sv);
2332 assert(SvTYPE(sv) >= SVt_PVMG);
2333 /* This falls through to the report_uninit near the end of the
2335 } else if (SvTHINKFIRST(sv)) {
2339 SV *const tmpstr = AMG_CALLun(sv,numer);
2340 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2341 return SvNV(tmpstr);
2344 return PTR2NV(SvRV(sv));
2347 sv_force_normal_flags(sv, 0);
2349 if (SvREADONLY(sv) && !SvOK(sv)) {
2350 if (ckWARN(WARN_UNINITIALIZED))
2355 if (SvTYPE(sv) < SVt_NV) {
2356 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2357 sv_upgrade(sv, SVt_NV);
2358 #ifdef USE_LONG_DOUBLE
2360 STORE_NUMERIC_LOCAL_SET_STANDARD();
2361 PerlIO_printf(Perl_debug_log,
2362 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2363 PTR2UV(sv), SvNVX(sv));
2364 RESTORE_NUMERIC_LOCAL();
2368 STORE_NUMERIC_LOCAL_SET_STANDARD();
2369 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2370 PTR2UV(sv), SvNVX(sv));
2371 RESTORE_NUMERIC_LOCAL();
2375 else if (SvTYPE(sv) < SVt_PVNV)
2376 sv_upgrade(sv, SVt_PVNV);
2381 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2382 #ifdef NV_PRESERVES_UV
2385 /* Only set the public NV OK flag if this NV preserves the IV */
2386 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2387 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2388 : (SvIVX(sv) == I_V(SvNVX(sv))))
2394 else if (SvPOKp(sv) && SvLEN(sv)) {
2396 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2397 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2399 #ifdef NV_PRESERVES_UV
2400 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2401 == IS_NUMBER_IN_UV) {
2402 /* It's definitely an integer */
2403 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2405 SvNV_set(sv, Atof(SvPVX_const(sv)));
2408 SvNV_set(sv, Atof(SvPVX_const(sv)));
2409 /* Only set the public NV OK flag if this NV preserves the value in
2410 the PV at least as well as an IV/UV would.
2411 Not sure how to do this 100% reliably. */
2412 /* if that shift count is out of range then Configure's test is
2413 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2415 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2416 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2417 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2418 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2419 /* Can't use strtol etc to convert this string, so don't try.
2420 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2423 /* value has been set. It may not be precise. */
2424 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2425 /* 2s complement assumption for (UV)IV_MIN */
2426 SvNOK_on(sv); /* Integer is too negative. */
2431 if (numtype & IS_NUMBER_NEG) {
2432 SvIV_set(sv, -(IV)value);
2433 } else if (value <= (UV)IV_MAX) {
2434 SvIV_set(sv, (IV)value);
2436 SvUV_set(sv, value);
2440 if (numtype & IS_NUMBER_NOT_INT) {
2441 /* I believe that even if the original PV had decimals,
2442 they are lost beyond the limit of the FP precision.
2443 However, neither is canonical, so both only get p
2444 flags. NWC, 2000/11/25 */
2445 /* Both already have p flags, so do nothing */
2447 const NV nv = SvNVX(sv);
2448 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2449 if (SvIVX(sv) == I_V(nv)) {
2452 /* It had no "." so it must be integer. */
2456 /* between IV_MAX and NV(UV_MAX).
2457 Could be slightly > UV_MAX */
2459 if (numtype & IS_NUMBER_NOT_INT) {
2460 /* UV and NV both imprecise. */
2462 const UV nv_as_uv = U_V(nv);
2464 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2473 #endif /* NV_PRESERVES_UV */
2476 if (isGV_with_GP(sv)) {
2477 glob_2number((GV *)sv);
2481 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2483 assert (SvTYPE(sv) >= SVt_NV);
2484 /* Typically the caller expects that sv_any is not NULL now. */
2485 /* XXX Ilya implies that this is a bug in callers that assume this
2486 and ideally should be fixed. */
2489 #if defined(USE_LONG_DOUBLE)
2491 STORE_NUMERIC_LOCAL_SET_STANDARD();
2492 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2493 PTR2UV(sv), SvNVX(sv));
2494 RESTORE_NUMERIC_LOCAL();
2498 STORE_NUMERIC_LOCAL_SET_STANDARD();
2499 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2500 PTR2UV(sv), SvNVX(sv));
2501 RESTORE_NUMERIC_LOCAL();
2507 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2508 * UV as a string towards the end of buf, and return pointers to start and
2511 * We assume that buf is at least TYPE_CHARS(UV) long.
2515 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2517 char *ptr = buf + TYPE_CHARS(UV);
2518 char * const ebuf = ptr;
2531 *--ptr = '0' + (char)(uv % 10);
2539 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2540 * a regexp to its stringified form.
2544 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2546 const regexp * const re = (regexp *)mg->mg_obj;
2549 const char *fptr = "msix";
2554 bool need_newline = 0;
2555 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2557 while((ch = *fptr++)) {
2559 reflags[left++] = ch;
2562 reflags[right--] = ch;
2567 reflags[left] = '-';
2571 mg->mg_len = re->prelen + 4 + left;
2573 * If /x was used, we have to worry about a regex ending with a
2574 * comment later being embedded within another regex. If so, we don't
2575 * want this regex's "commentization" to leak out to the right part of
2576 * the enclosing regex, we must cap it with a newline.
2578 * So, if /x was used, we scan backwards from the end of the regex. If
2579 * we find a '#' before we find a newline, we need to add a newline
2580 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2581 * we don't need to add anything. -jfriedl
2583 if (PMf_EXTENDED & re->reganch) {
2584 const char *endptr = re->precomp + re->prelen;
2585 while (endptr >= re->precomp) {
2586 const char c = *(endptr--);
2588 break; /* don't need another */
2590 /* we end while in a comment, so we need a newline */
2591 mg->mg_len++; /* save space for it */
2592 need_newline = 1; /* note to add it */
2598 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2599 mg->mg_ptr[0] = '(';
2600 mg->mg_ptr[1] = '?';
2601 Copy(reflags, mg->mg_ptr+2, left, char);
2602 *(mg->mg_ptr+left+2) = ':';
2603 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2605 mg->mg_ptr[mg->mg_len - 2] = '\n';
2606 mg->mg_ptr[mg->mg_len - 1] = ')';
2607 mg->mg_ptr[mg->mg_len] = 0;
2609 PL_reginterp_cnt += re->program[0].next_off;
2611 if (re->reganch & ROPT_UTF8)
2621 =for apidoc sv_2pv_flags
2623 Returns a pointer to the string value of an SV, and sets *lp to its length.
2624 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2626 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2627 usually end up here too.
2633 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2643 if (SvGMAGICAL(sv)) {
2644 if (flags & SV_GMAGIC)
2649 if (flags & SV_MUTABLE_RETURN)
2650 return SvPVX_mutable(sv);
2651 if (flags & SV_CONST_RETURN)
2652 return (char *)SvPVX_const(sv);
2655 if (SvIOKp(sv) || SvNOKp(sv)) {
2656 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2662 ? snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2663 : snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2665 ? my_sprintf(tbuf, "%"UVuf, (UV)SvUVX(sv))
2666 : my_sprintf(tbuf, "%"IVdf, (IV)SvIVX(sv));
2667 #endif /* #ifdef USE_SNPRINTF */
2669 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2676 #ifdef FIXNEGATIVEZERO
2677 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2683 SvUPGRADE(sv, SVt_PV);
2686 s = SvGROW_mutable(sv, len + 1);
2689 return memcpy(s, tbuf, len + 1);
2695 assert(SvTYPE(sv) >= SVt_PVMG);
2696 /* This falls through to the report_uninit near the end of the
2698 } else if (SvTHINKFIRST(sv)) {
2702 SV *const tmpstr = AMG_CALLun(sv,string);
2703 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2705 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2709 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2710 if (flags & SV_CONST_RETURN) {
2711 pv = (char *) SvPVX_const(tmpstr);
2713 pv = (flags & SV_MUTABLE_RETURN)
2714 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2717 *lp = SvCUR(tmpstr);
2719 pv = sv_2pv_flags(tmpstr, lp, flags);
2731 const SV *const referent = (SV*)SvRV(sv);
2734 tsv = sv_2mortal(newSVpvs("NULLREF"));
2735 } else if (SvTYPE(referent) == SVt_PVMG
2736 && ((SvFLAGS(referent) &
2737 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2738 == (SVs_OBJECT|SVs_SMG))
2739 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2740 return stringify_regexp(sv, mg, lp);
2742 const char *const typestr = sv_reftype(referent, 0);
2744 tsv = sv_newmortal();
2745 if (SvOBJECT(referent)) {
2746 const char *const name = HvNAME_get(SvSTASH(referent));
2747 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2748 name ? name : "__ANON__" , typestr,
2752 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2760 if (SvREADONLY(sv) && !SvOK(sv)) {
2761 if (ckWARN(WARN_UNINITIALIZED))
2768 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2769 /* I'm assuming that if both IV and NV are equally valid then
2770 converting the IV is going to be more efficient */
2771 const U32 isIOK = SvIOK(sv);
2772 const U32 isUIOK = SvIsUV(sv);
2773 char buf[TYPE_CHARS(UV)];
2776 if (SvTYPE(sv) < SVt_PVIV)
2777 sv_upgrade(sv, SVt_PVIV);
2778 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2779 /* inlined from sv_setpvn */
2780 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2781 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2782 SvCUR_set(sv, ebuf - ptr);
2792 else if (SvNOKp(sv)) {
2793 const int olderrno = errno;
2794 if (SvTYPE(sv) < SVt_PVNV)
2795 sv_upgrade(sv, SVt_PVNV);
2796 /* The +20 is pure guesswork. Configure test needed. --jhi */
2797 s = SvGROW_mutable(sv, NV_DIG + 20);
2798 /* some Xenix systems wipe out errno here */
2800 if (SvNVX(sv) == 0.0)
2801 (void)strcpy(s,"0");
2805 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2808 #ifdef FIXNEGATIVEZERO
2809 if (*s == '-' && s[1] == '0' && !s[2])
2819 if (isGV_with_GP(sv))
2820 return glob_2pv((GV *)sv, lp);
2822 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2826 if (SvTYPE(sv) < SVt_PV)
2827 /* Typically the caller expects that sv_any is not NULL now. */
2828 sv_upgrade(sv, SVt_PV);
2832 const STRLEN len = s - SvPVX_const(sv);
2838 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2839 PTR2UV(sv),SvPVX_const(sv)));
2840 if (flags & SV_CONST_RETURN)
2841 return (char *)SvPVX_const(sv);
2842 if (flags & SV_MUTABLE_RETURN)
2843 return SvPVX_mutable(sv);
2848 =for apidoc sv_copypv
2850 Copies a stringified representation of the source SV into the
2851 destination SV. Automatically performs any necessary mg_get and
2852 coercion of numeric values into strings. Guaranteed to preserve
2853 UTF-8 flag even from overloaded objects. Similar in nature to
2854 sv_2pv[_flags] but operates directly on an SV instead of just the
2855 string. Mostly uses sv_2pv_flags to do its work, except when that
2856 would lose the UTF-8'ness of the PV.
2862 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2865 const char * const s = SvPV_const(ssv,len);
2866 sv_setpvn(dsv,s,len);
2874 =for apidoc sv_2pvbyte
2876 Return a pointer to the byte-encoded representation of the SV, and set *lp
2877 to its length. May cause the SV to be downgraded from UTF-8 as a
2880 Usually accessed via the C<SvPVbyte> macro.
2886 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2888 sv_utf8_downgrade(sv,0);
2889 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2893 =for apidoc sv_2pvutf8
2895 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2896 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2898 Usually accessed via the C<SvPVutf8> macro.
2904 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2906 sv_utf8_upgrade(sv);
2907 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2912 =for apidoc sv_2bool
2914 This function is only called on magical items, and is only used by
2915 sv_true() or its macro equivalent.
2921 Perl_sv_2bool(pTHX_ register SV *sv)
2930 SV * const tmpsv = AMG_CALLun(sv,bool_);
2931 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2932 return (bool)SvTRUE(tmpsv);
2934 return SvRV(sv) != 0;
2937 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2939 (*sv->sv_u.svu_pv > '0' ||
2940 Xpvtmp->xpv_cur > 1 ||
2941 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2948 return SvIVX(sv) != 0;
2951 return SvNVX(sv) != 0.0;
2953 if (isGV_with_GP(sv))
2963 =for apidoc sv_utf8_upgrade
2965 Converts the PV of an SV to its UTF-8-encoded form.
2966 Forces the SV to string form if it is not already.
2967 Always sets the SvUTF8 flag to avoid future validity checks even
2968 if all the bytes have hibit clear.
2970 This is not as a general purpose byte encoding to Unicode interface:
2971 use the Encode extension for that.
2973 =for apidoc sv_utf8_upgrade_flags
2975 Converts the PV of an SV to its UTF-8-encoded form.
2976 Forces the SV to string form if it is not already.
2977 Always sets the SvUTF8 flag to avoid future validity checks even
2978 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2979 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2980 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2982 This is not as a general purpose byte encoding to Unicode interface:
2983 use the Encode extension for that.
2989 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2992 if (sv == &PL_sv_undef)
2996 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2997 (void) sv_2pv_flags(sv,&len, flags);
3001 (void) SvPV_force(sv,len);
3010 sv_force_normal_flags(sv, 0);
3013 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3014 sv_recode_to_utf8(sv, PL_encoding);
3015 else { /* Assume Latin-1/EBCDIC */
3016 /* This function could be much more efficient if we
3017 * had a FLAG in SVs to signal if there are any hibit
3018 * chars in the PV. Given that there isn't such a flag
3019 * make the loop as fast as possible. */
3020 const U8 * const s = (U8 *) SvPVX_const(sv);
3021 const U8 * const e = (U8 *) SvEND(sv);
3026 /* Check for hi bit */
3027 if (!NATIVE_IS_INVARIANT(ch)) {
3028 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3029 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3031 SvPV_free(sv); /* No longer using what was there before. */
3032 SvPV_set(sv, (char*)recoded);
3033 SvCUR_set(sv, len - 1);
3034 SvLEN_set(sv, len); /* No longer know the real size. */
3038 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3045 =for apidoc sv_utf8_downgrade
3047 Attempts to convert the PV of an SV from characters to bytes.
3048 If the PV contains a character beyond byte, this conversion will fail;
3049 in this case, either returns false or, if C<fail_ok> is not
3052 This is not as a general purpose Unicode to byte encoding interface:
3053 use the Encode extension for that.
3059 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3062 if (SvPOKp(sv) && SvUTF8(sv)) {
3068 sv_force_normal_flags(sv, 0);
3070 s = (U8 *) SvPV(sv, len);
3071 if (!utf8_to_bytes(s, &len)) {
3076 Perl_croak(aTHX_ "Wide character in %s",
3079 Perl_croak(aTHX_ "Wide character");
3090 =for apidoc sv_utf8_encode
3092 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3093 flag off so that it looks like octets again.
3099 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3101 (void) sv_utf8_upgrade(sv);
3103 sv_force_normal_flags(sv, 0);
3105 if (SvREADONLY(sv)) {
3106 Perl_croak(aTHX_ PL_no_modify);
3112 =for apidoc sv_utf8_decode
3114 If the PV of the SV is an octet sequence in UTF-8
3115 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3116 so that it looks like a character. If the PV contains only single-byte
3117 characters, the C<SvUTF8> flag stays being off.
3118 Scans PV for validity and returns false if the PV is invalid UTF-8.
3124 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3130 /* The octets may have got themselves encoded - get them back as
3133 if (!sv_utf8_downgrade(sv, TRUE))
3136 /* it is actually just a matter of turning the utf8 flag on, but
3137 * we want to make sure everything inside is valid utf8 first.
3139 c = (const U8 *) SvPVX_const(sv);
3140 if (!is_utf8_string(c, SvCUR(sv)+1))
3142 e = (const U8 *) SvEND(sv);
3145 if (!UTF8_IS_INVARIANT(ch)) {
3155 =for apidoc sv_setsv
3157 Copies the contents of the source SV C<ssv> into the destination SV
3158 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3159 function if the source SV needs to be reused. Does not handle 'set' magic.
3160 Loosely speaking, it performs a copy-by-value, obliterating any previous
3161 content of the destination.
3163 You probably want to use one of the assortment of wrappers, such as
3164 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3165 C<SvSetMagicSV_nosteal>.
3167 =for apidoc sv_setsv_flags
3169 Copies the contents of the source SV C<ssv> into the destination SV
3170 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3171 function if the source SV needs to be reused. Does not handle 'set' magic.
3172 Loosely speaking, it performs a copy-by-value, obliterating any previous
3173 content of the destination.
3174 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3175 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3176 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3177 and C<sv_setsv_nomg> are implemented in terms of this function.
3179 You probably want to use one of the assortment of wrappers, such as
3180 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3181 C<SvSetMagicSV_nosteal>.
3183 This is the primary function for copying scalars, and most other
3184 copy-ish functions and macros use this underneath.
3190 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3192 if (dtype != SVt_PVGV) {
3193 const char * const name = GvNAME(sstr);
3194 const STRLEN len = GvNAMELEN(sstr);
3195 /* don't upgrade SVt_PVLV: it can hold a glob */
3196 if (dtype != SVt_PVLV) {
3197 if (dtype >= SVt_PV) {
3203 sv_upgrade(dstr, SVt_PVGV);
3204 (void)SvOK_off(dstr);
3207 GvSTASH(dstr) = GvSTASH(sstr);
3209 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3210 gv_name_set((GV *)dstr, name, len, GV_ADD);
3211 SvFAKE_on(dstr); /* can coerce to non-glob */
3214 #ifdef GV_UNIQUE_CHECK
3215 if (GvUNIQUE((GV*)dstr)) {
3216 Perl_croak(aTHX_ PL_no_modify);
3222 (void)SvOK_off(dstr);
3224 GvINTRO_off(dstr); /* one-shot flag */
3225 GvGP(dstr) = gp_ref(GvGP(sstr));
3226 if (SvTAINTED(sstr))
3228 if (GvIMPORTED(dstr) != GVf_IMPORTED
3229 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3231 GvIMPORTED_on(dstr);
3238 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3239 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3241 const int intro = GvINTRO(dstr);
3244 const U32 stype = SvTYPE(sref);
3247 #ifdef GV_UNIQUE_CHECK
3248 if (GvUNIQUE((GV*)dstr)) {
3249 Perl_croak(aTHX_ PL_no_modify);
3254 GvINTRO_off(dstr); /* one-shot flag */
3255 GvLINE(dstr) = CopLINE(PL_curcop);
3256 GvEGV(dstr) = (GV*)dstr;
3261 location = (SV **) &GvCV(dstr);
3262 import_flag = GVf_IMPORTED_CV;
3265 location = (SV **) &GvHV(dstr);
3266 import_flag = GVf_IMPORTED_HV;
3269 location = (SV **) &GvAV(dstr);
3270 import_flag = GVf_IMPORTED_AV;
3273 location = (SV **) &GvIOp(dstr);
3276 location = (SV **) &GvFORM(dstr);
3278 location = &GvSV(dstr);
3279 import_flag = GVf_IMPORTED_SV;
3282 if (stype == SVt_PVCV) {
3283 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3284 SvREFCNT_dec(GvCV(dstr));
3286 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3287 PL_sub_generation++;
3290 SAVEGENERICSV(*location);
3294 if (stype == SVt_PVCV && *location != sref) {
3295 CV* const cv = (CV*)*location;
3297 if (!GvCVGEN((GV*)dstr) &&
3298 (CvROOT(cv) || CvXSUB(cv)))
3300 /* Redefining a sub - warning is mandatory if
3301 it was a const and its value changed. */
3302 if (CvCONST(cv) && CvCONST((CV*)sref)
3303 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3305 /* They are 2 constant subroutines generated from
3306 the same constant. This probably means that
3307 they are really the "same" proxy subroutine
3308 instantiated in 2 places. Most likely this is
3309 when a constant is exported twice. Don't warn.
3312 else if (ckWARN(WARN_REDEFINE)
3314 && (!CvCONST((CV*)sref)
3315 || sv_cmp(cv_const_sv(cv),
3316 cv_const_sv((CV*)sref))))) {
3317 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3319 ? "Constant subroutine %s::%s redefined"
3320 : "Subroutine %s::%s redefined",
3321 HvNAME_get(GvSTASH((GV*)dstr)),
3322 GvENAME((GV*)dstr));
3326 cv_ckproto_len(cv, (GV*)dstr,
3327 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3328 SvPOK(sref) ? SvCUR(sref) : 0);
3330 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3331 GvASSUMECV_on(dstr);
3332 PL_sub_generation++;
3335 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3336 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3337 GvFLAGS(dstr) |= import_flag;
3342 if (SvTAINTED(sstr))
3348 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3351 register U32 sflags;
3357 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3359 sstr = &PL_sv_undef;
3360 stype = SvTYPE(sstr);
3361 dtype = SvTYPE(dstr);
3366 /* need to nuke the magic */
3368 SvRMAGICAL_off(dstr);
3371 /* There's a lot of redundancy below but we're going for speed here */
3376 if (dtype != SVt_PVGV) {
3377 (void)SvOK_off(dstr);
3385 sv_upgrade(dstr, SVt_IV);
3390 sv_upgrade(dstr, SVt_PVIV);
3393 (void)SvIOK_only(dstr);
3394 SvIV_set(dstr, SvIVX(sstr));
3397 /* SvTAINTED can only be true if the SV has taint magic, which in
3398 turn means that the SV type is PVMG (or greater). This is the
3399 case statement for SVt_IV, so this cannot be true (whatever gcov
3401 assert(!SvTAINTED(sstr));
3411 sv_upgrade(dstr, SVt_NV);
3416 sv_upgrade(dstr, SVt_PVNV);
3419 SvNV_set(dstr, SvNVX(sstr));
3420 (void)SvNOK_only(dstr);
3421 /* SvTAINTED can only be true if the SV has taint magic, which in
3422 turn means that the SV type is PVMG (or greater). This is the
3423 case statement for SVt_NV, so this cannot be true (whatever gcov
3425 assert(!SvTAINTED(sstr));
3432 sv_upgrade(dstr, SVt_RV);
3435 #ifdef PERL_OLD_COPY_ON_WRITE
3436 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3437 if (dtype < SVt_PVIV)
3438 sv_upgrade(dstr, SVt_PVIV);
3445 sv_upgrade(dstr, SVt_PV);
3448 if (dtype < SVt_PVIV)
3449 sv_upgrade(dstr, SVt_PVIV);
3452 if (dtype < SVt_PVNV)
3453 sv_upgrade(dstr, SVt_PVNV);
3457 const char * const type = sv_reftype(sstr,0);
3459 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3461 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3466 if (dtype <= SVt_PVGV) {
3467 glob_assign_glob(dstr, sstr, dtype);
3475 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3477 if ((int)SvTYPE(sstr) != stype) {
3478 stype = SvTYPE(sstr);
3479 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3480 glob_assign_glob(dstr, sstr, dtype);
3485 if (stype == SVt_PVLV)
3486 SvUPGRADE(dstr, SVt_PVNV);
3488 SvUPGRADE(dstr, (U32)stype);
3491 /* dstr may have been upgraded. */
3492 dtype = SvTYPE(dstr);
3493 sflags = SvFLAGS(sstr);
3495 if (sflags & SVf_ROK) {
3496 if (dtype == SVt_PVGV &&
3497 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3500 if (GvIMPORTED(dstr) != GVf_IMPORTED
3501 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3503 GvIMPORTED_on(dstr);
3508 glob_assign_glob(dstr, sstr, dtype);
3512 if (dtype >= SVt_PV) {
3513 if (dtype == SVt_PVGV) {
3514 glob_assign_ref(dstr, sstr);
3517 if (SvPVX_const(dstr)) {
3523 (void)SvOK_off(dstr);
3524 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3525 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3526 assert(!(sflags & SVp_NOK));
3527 assert(!(sflags & SVp_IOK));
3528 assert(!(sflags & SVf_NOK));
3529 assert(!(sflags & SVf_IOK));
3531 else if (dtype == SVt_PVGV) {
3532 if (!(sflags & SVf_OK)) {
3533 if (ckWARN(WARN_MISC))
3534 Perl_warner(aTHX_ packWARN(WARN_MISC),
3535 "Undefined value assigned to typeglob");
3538 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3539 if (dstr != (SV*)gv) {
3542 GvGP(dstr) = gp_ref(GvGP(gv));
3546 else if (sflags & SVp_POK) {
3550 * Check to see if we can just swipe the string. If so, it's a
3551 * possible small lose on short strings, but a big win on long ones.
3552 * It might even be a win on short strings if SvPVX_const(dstr)
3553 * has to be allocated and SvPVX_const(sstr) has to be freed.
3556 /* Whichever path we take through the next code, we want this true,
3557 and doing it now facilitates the COW check. */
3558 (void)SvPOK_only(dstr);
3561 /* We're not already COW */
3562 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3563 #ifndef PERL_OLD_COPY_ON_WRITE
3564 /* or we are, but dstr isn't a suitable target. */
3565 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3570 (sflags & SVs_TEMP) && /* slated for free anyway? */
3571 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3572 (!(flags & SV_NOSTEAL)) &&
3573 /* and we're allowed to steal temps */
3574 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3575 SvLEN(sstr) && /* and really is a string */
3576 /* and won't be needed again, potentially */
3577 !(PL_op && PL_op->op_type == OP_AASSIGN))
3578 #ifdef PERL_OLD_COPY_ON_WRITE
3579 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3580 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3581 && SvTYPE(sstr) >= SVt_PVIV)
3584 /* Failed the swipe test, and it's not a shared hash key either.
3585 Have to copy the string. */
3586 STRLEN len = SvCUR(sstr);
3587 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3588 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3589 SvCUR_set(dstr, len);
3590 *SvEND(dstr) = '\0';
3592 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3594 /* Either it's a shared hash key, or it's suitable for
3595 copy-on-write or we can swipe the string. */
3597 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3601 #ifdef PERL_OLD_COPY_ON_WRITE
3603 /* I believe I should acquire a global SV mutex if
3604 it's a COW sv (not a shared hash key) to stop
3605 it going un copy-on-write.
3606 If the source SV has gone un copy on write between up there
3607 and down here, then (assert() that) it is of the correct
3608 form to make it copy on write again */
3609 if ((sflags & (SVf_FAKE | SVf_READONLY))
3610 != (SVf_FAKE | SVf_READONLY)) {
3611 SvREADONLY_on(sstr);
3613 /* Make the source SV into a loop of 1.
3614 (about to become 2) */
3615 SV_COW_NEXT_SV_SET(sstr, sstr);
3619 /* Initial code is common. */
3620 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3625 /* making another shared SV. */
3626 STRLEN cur = SvCUR(sstr);
3627 STRLEN len = SvLEN(sstr);
3628 #ifdef PERL_OLD_COPY_ON_WRITE
3630 assert (SvTYPE(dstr) >= SVt_PVIV);
3631 /* SvIsCOW_normal */
3632 /* splice us in between source and next-after-source. */
3633 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3634 SV_COW_NEXT_SV_SET(sstr, dstr);
3635 SvPV_set(dstr, SvPVX_mutable(sstr));
3639 /* SvIsCOW_shared_hash */
3640 DEBUG_C(PerlIO_printf(Perl_debug_log,
3641 "Copy on write: Sharing hash\n"));
3643 assert (SvTYPE(dstr) >= SVt_PV);
3645 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3647 SvLEN_set(dstr, len);
3648 SvCUR_set(dstr, cur);
3649 SvREADONLY_on(dstr);
3651 /* Relesase a global SV mutex. */
3654 { /* Passes the swipe test. */
3655 SvPV_set(dstr, SvPVX_mutable(sstr));
3656 SvLEN_set(dstr, SvLEN(sstr));
3657 SvCUR_set(dstr, SvCUR(sstr));
3660 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3661 SvPV_set(sstr, NULL);
3667 if (sflags & SVp_NOK) {
3668 SvNV_set(dstr, SvNVX(sstr));
3670 if (sflags & SVp_IOK) {
3671 SvRELEASE_IVX(dstr);
3672 SvIV_set(dstr, SvIVX(sstr));
3673 /* Must do this otherwise some other overloaded use of 0x80000000
3674 gets confused. I guess SVpbm_VALID */
3675 if (sflags & SVf_IVisUV)
3678 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3681 const MAGIC * const smg = SvVOK(sstr);
3683 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3684 smg->mg_ptr, smg->mg_len);
3685 SvRMAGICAL_on(dstr);
3689 else if (sflags & (SVp_IOK|SVp_NOK)) {
3690 (void)SvOK_off(dstr);
3691 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3693 if (sflags & SVp_IOK) {
3694 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3695 SvIV_set(dstr, SvIVX(sstr));
3697 if (sflags & SVp_NOK) {
3698 SvNV_set(dstr, SvNVX(sstr));
3702 if (isGV_with_GP(sstr)) {
3703 /* This stringification rule for globs is spread in 3 places.
3704 This feels bad. FIXME. */
3705 const U32 wasfake = sflags & SVf_FAKE;
3707 /* FAKE globs can get coerced, so need to turn this off
3708 temporarily if it is on. */
3710 gv_efullname3(dstr, (GV *)sstr, "*");
3711 SvFLAGS(sstr) |= wasfake;
3712 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3715 (void)SvOK_off(dstr);
3717 if (SvTAINTED(sstr))
3722 =for apidoc sv_setsv_mg
3724 Like C<sv_setsv>, but also handles 'set' magic.
3730 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3732 sv_setsv(dstr,sstr);
3736 #ifdef PERL_OLD_COPY_ON_WRITE
3738 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3740 STRLEN cur = SvCUR(sstr);
3741 STRLEN len = SvLEN(sstr);
3742 register char *new_pv;
3745 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3753 if (SvTHINKFIRST(dstr))
3754 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3755 else if (SvPVX_const(dstr))
3756 Safefree(SvPVX_const(dstr));
3760 SvUPGRADE(dstr, SVt_PVIV);
3762 assert (SvPOK(sstr));
3763 assert (SvPOKp(sstr));
3764 assert (!SvIOK(sstr));
3765 assert (!SvIOKp(sstr));
3766 assert (!SvNOK(sstr));
3767 assert (!SvNOKp(sstr));
3769 if (SvIsCOW(sstr)) {
3771 if (SvLEN(sstr) == 0) {
3772 /* source is a COW shared hash key. */
3773 DEBUG_C(PerlIO_printf(Perl_debug_log,
3774 "Fast copy on write: Sharing hash\n"));
3775 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3778 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3780 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3781 SvUPGRADE(sstr, SVt_PVIV);
3782 SvREADONLY_on(sstr);
3784 DEBUG_C(PerlIO_printf(Perl_debug_log,
3785 "Fast copy on write: Converting sstr to COW\n"));
3786 SV_COW_NEXT_SV_SET(dstr, sstr);
3788 SV_COW_NEXT_SV_SET(sstr, dstr);
3789 new_pv = SvPVX_mutable(sstr);
3792 SvPV_set(dstr, new_pv);
3793 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3796 SvLEN_set(dstr, len);
3797 SvCUR_set(dstr, cur);
3806 =for apidoc sv_setpvn
3808 Copies a string into an SV. The C<len> parameter indicates the number of
3809 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3810 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3816 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3819 register char *dptr;
3821 SV_CHECK_THINKFIRST_COW_DROP(sv);
3827 /* len is STRLEN which is unsigned, need to copy to signed */
3830 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3832 SvUPGRADE(sv, SVt_PV);
3834 dptr = SvGROW(sv, len + 1);
3835 Move(ptr,dptr,len,char);
3838 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3843 =for apidoc sv_setpvn_mg
3845 Like C<sv_setpvn>, but also handles 'set' magic.
3851 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3853 sv_setpvn(sv,ptr,len);
3858 =for apidoc sv_setpv
3860 Copies a string into an SV. The string must be null-terminated. Does not
3861 handle 'set' magic. See C<sv_setpv_mg>.
3867 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3870 register STRLEN len;
3872 SV_CHECK_THINKFIRST_COW_DROP(sv);
3878 SvUPGRADE(sv, SVt_PV);
3880 SvGROW(sv, len + 1);
3881 Move(ptr,SvPVX(sv),len+1,char);
3883 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3888 =for apidoc sv_setpv_mg
3890 Like C<sv_setpv>, but also handles 'set' magic.
3896 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3903 =for apidoc sv_usepvn_flags
3905 Tells an SV to use C<ptr> to find its string value. Normally the
3906 string is stored inside the SV but sv_usepvn allows the SV to use an
3907 outside string. The C<ptr> should point to memory that was allocated
3908 by C<malloc>. The string length, C<len>, must be supplied. By default
3909 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3910 so that pointer should not be freed or used by the programmer after
3911 giving it to sv_usepvn, and neither should any pointers from "behind"
3912 that pointer (e.g. ptr + 1) be used.
3914 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3915 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3916 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3917 C<len>, and already meets the requirements for storing in C<SvPVX>)
3923 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3927 SV_CHECK_THINKFIRST_COW_DROP(sv);
3928 SvUPGRADE(sv, SVt_PV);
3931 if (flags & SV_SMAGIC)
3935 if (SvPVX_const(sv))
3938 if (flags & SV_HAS_TRAILING_NUL)
3939 assert(ptr[len] == '\0');
3941 allocate = (flags & SV_HAS_TRAILING_NUL)
3942 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3943 if (flags & SV_HAS_TRAILING_NUL) {
3944 /* It's long enough - do nothing.
3945 Specfically Perl_newCONSTSUB is relying on this. */
3948 /* Force a move to shake out bugs in callers. */
3949 char *new_ptr = safemalloc(allocate);
3950 Copy(ptr, new_ptr, len, char);
3951 PoisonFree(ptr,len,char);
3955 ptr = saferealloc (ptr, allocate);
3960 SvLEN_set(sv, allocate);
3961 if (!(flags & SV_HAS_TRAILING_NUL)) {
3964 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3966 if (flags & SV_SMAGIC)
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3971 /* Need to do this *after* making the SV normal, as we need the buffer
3972 pointer to remain valid until after we've copied it. If we let go too early,
3973 another thread could invalidate it by unsharing last of the same hash key
3974 (which it can do by means other than releasing copy-on-write Svs)
3975 or by changing the other copy-on-write SVs in the loop. */
3977 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3979 if (len) { /* this SV was SvIsCOW_normal(sv) */
3980 /* we need to find the SV pointing to us. */
3981 SV *current = SV_COW_NEXT_SV(after);
3983 if (current == sv) {
3984 /* The SV we point to points back to us (there were only two of us
3986 Hence other SV is no longer copy on write either. */
3988 SvREADONLY_off(after);
3990 /* We need to follow the pointers around the loop. */
3992 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3995 /* don't loop forever if the structure is bust, and we have
3996 a pointer into a closed loop. */
3997 assert (current != after);
3998 assert (SvPVX_const(current) == pvx);
4000 /* Make the SV before us point to the SV after us. */
4001 SV_COW_NEXT_SV_SET(current, after);
4004 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4009 Perl_sv_release_IVX(pTHX_ register SV *sv)
4012 sv_force_normal_flags(sv, 0);
4018 =for apidoc sv_force_normal_flags
4020 Undo various types of fakery on an SV: if the PV is a shared string, make
4021 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4022 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4023 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4024 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4025 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4026 set to some other value.) In addition, the C<flags> parameter gets passed to
4027 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4028 with flags set to 0.
4034 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4037 #ifdef PERL_OLD_COPY_ON_WRITE
4038 if (SvREADONLY(sv)) {
4039 /* At this point I believe I should acquire a global SV mutex. */
4041 const char * const pvx = SvPVX_const(sv);
4042 const STRLEN len = SvLEN(sv);
4043 const STRLEN cur = SvCUR(sv);
4044 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4046 PerlIO_printf(Perl_debug_log,
4047 "Copy on write: Force normal %ld\n",
4053 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4056 if (flags & SV_COW_DROP_PV) {
4057 /* OK, so we don't need to copy our buffer. */
4060 SvGROW(sv, cur + 1);
4061 Move(pvx,SvPVX(sv),cur,char);
4065 sv_release_COW(sv, pvx, len, next);
4070 else if (IN_PERL_RUNTIME)
4071 Perl_croak(aTHX_ PL_no_modify);
4072 /* At this point I believe that I can drop the global SV mutex. */
4075 if (SvREADONLY(sv)) {
4077 const char * const pvx = SvPVX_const(sv);
4078 const STRLEN len = SvCUR(sv);
4083 SvGROW(sv, len + 1);
4084 Move(pvx,SvPVX(sv),len,char);
4086 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4088 else if (IN_PERL_RUNTIME)
4089 Perl_croak(aTHX_ PL_no_modify);
4093 sv_unref_flags(sv, flags);
4094 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4101 Efficient removal of characters from the beginning of the string buffer.
4102 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4103 the string buffer. The C<ptr> becomes the first character of the adjusted
4104 string. Uses the "OOK hack".
4105 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4106 refer to the same chunk of data.
4112 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4114 register STRLEN delta;
4115 if (!ptr || !SvPOKp(sv))
4117 delta = ptr - SvPVX_const(sv);
4118 SV_CHECK_THINKFIRST(sv);
4119 if (SvTYPE(sv) < SVt_PVIV)
4120 sv_upgrade(sv,SVt_PVIV);
4123 if (!SvLEN(sv)) { /* make copy of shared string */
4124 const char *pvx = SvPVX_const(sv);
4125 const STRLEN len = SvCUR(sv);
4126 SvGROW(sv, len + 1);
4127 Move(pvx,SvPVX(sv),len,char);
4131 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4132 and we do that anyway inside the SvNIOK_off
4134 SvFLAGS(sv) |= SVf_OOK;
4137 SvLEN_set(sv, SvLEN(sv) - delta);
4138 SvCUR_set(sv, SvCUR(sv) - delta);
4139 SvPV_set(sv, SvPVX(sv) + delta);
4140 SvIV_set(sv, SvIVX(sv) + delta);
4144 =for apidoc sv_catpvn
4146 Concatenates the string onto the end of the string which is in the SV. The
4147 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4148 status set, then the bytes appended should be valid UTF-8.
4149 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4151 =for apidoc sv_catpvn_flags
4153 Concatenates the string onto the end of the string which is in the SV. The
4154 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4155 status set, then the bytes appended should be valid UTF-8.
4156 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4157 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4158 in terms of this function.
4164 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4168 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4170 SvGROW(dsv, dlen + slen + 1);
4172 sstr = SvPVX_const(dsv);
4173 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4174 SvCUR_set(dsv, SvCUR(dsv) + slen);
4176 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4178 if (flags & SV_SMAGIC)
4183 =for apidoc sv_catsv
4185 Concatenates the string from SV C<ssv> onto the end of the string in
4186 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4187 not 'set' magic. See C<sv_catsv_mg>.
4189 =for apidoc sv_catsv_flags
4191 Concatenates the string from SV C<ssv> onto the end of the string in
4192 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4193 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4194 and C<sv_catsv_nomg> are implemented in terms of this function.
4199 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4204 const char *spv = SvPV_const(ssv, slen);
4206 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4207 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4208 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4209 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4210 dsv->sv_flags doesn't have that bit set.
4211 Andy Dougherty 12 Oct 2001
4213 const I32 sutf8 = DO_UTF8(ssv);
4216 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4218 dutf8 = DO_UTF8(dsv);
4220 if (dutf8 != sutf8) {
4222 /* Not modifying source SV, so taking a temporary copy. */
4223 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4225 sv_utf8_upgrade(csv);
4226 spv = SvPV_const(csv, slen);
4229 sv_utf8_upgrade_nomg(dsv);
4231 sv_catpvn_nomg(dsv, spv, slen);
4234 if (flags & SV_SMAGIC)
4239 =for apidoc sv_catpv
4241 Concatenates the string onto the end of the string which is in the SV.
4242 If the SV has the UTF-8 status set, then the bytes appended should be
4243 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4248 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4251 register STRLEN len;
4257 junk = SvPV_force(sv, tlen);
4259 SvGROW(sv, tlen + len + 1);
4261 ptr = SvPVX_const(sv);
4262 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4263 SvCUR_set(sv, SvCUR(sv) + len);
4264 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4269 =for apidoc sv_catpv_mg
4271 Like C<sv_catpv>, but also handles 'set' magic.
4277 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4286 Creates a new SV. A non-zero C<len> parameter indicates the number of
4287 bytes of preallocated string space the SV should have. An extra byte for a
4288 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4289 space is allocated.) The reference count for the new SV is set to 1.
4291 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4292 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4293 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4294 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4295 modules supporting older perls.
4301 Perl_newSV(pTHX_ STRLEN len)
4308 sv_upgrade(sv, SVt_PV);
4309 SvGROW(sv, len + 1);
4314 =for apidoc sv_magicext
4316 Adds magic to an SV, upgrading it if necessary. Applies the
4317 supplied vtable and returns a pointer to the magic added.
4319 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4320 In particular, you can add magic to SvREADONLY SVs, and add more than
4321 one instance of the same 'how'.
4323 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4324 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4325 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4326 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4328 (This is now used as a subroutine by C<sv_magic>.)
4333 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4334 const char* name, I32 namlen)
4339 if (SvTYPE(sv) < SVt_PVMG) {
4340 SvUPGRADE(sv, SVt_PVMG);
4342 Newxz(mg, 1, MAGIC);
4343 mg->mg_moremagic = SvMAGIC(sv);
4344 SvMAGIC_set(sv, mg);
4346 /* Sometimes a magic contains a reference loop, where the sv and
4347 object refer to each other. To prevent a reference loop that
4348 would prevent such objects being freed, we look for such loops
4349 and if we find one we avoid incrementing the object refcount.
4351 Note we cannot do this to avoid self-tie loops as intervening RV must
4352 have its REFCNT incremented to keep it in existence.
4355 if (!obj || obj == sv ||
4356 how == PERL_MAGIC_arylen ||
4357 how == PERL_MAGIC_qr ||
4358 how == PERL_MAGIC_symtab ||
4359 (SvTYPE(obj) == SVt_PVGV &&
4360 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4361 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4362 GvFORM(obj) == (CV*)sv)))
4367 mg->mg_obj = SvREFCNT_inc_simple(obj);
4368 mg->mg_flags |= MGf_REFCOUNTED;
4371 /* Normal self-ties simply pass a null object, and instead of
4372 using mg_obj directly, use the SvTIED_obj macro to produce a
4373 new RV as needed. For glob "self-ties", we are tieing the PVIO
4374 with an RV obj pointing to the glob containing the PVIO. In
4375 this case, to avoid a reference loop, we need to weaken the
4379 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4380 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4386 mg->mg_len = namlen;
4389 mg->mg_ptr = savepvn(name, namlen);
4390 else if (namlen == HEf_SVKEY)
4391 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4393 mg->mg_ptr = (char *) name;
4395 mg->mg_virtual = vtable;
4399 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4404 =for apidoc sv_magic
4406 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4407 then adds a new magic item of type C<how> to the head of the magic list.
4409 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4410 handling of the C<name> and C<namlen> arguments.
4412 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4413 to add more than one instance of the same 'how'.
4419 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4425 #ifdef PERL_OLD_COPY_ON_WRITE
4427 sv_force_normal_flags(sv, 0);
4429 if (SvREADONLY(sv)) {
4431 /* its okay to attach magic to shared strings; the subsequent
4432 * upgrade to PVMG will unshare the string */
4433 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4436 && how != PERL_MAGIC_regex_global
4437 && how != PERL_MAGIC_bm
4438 && how != PERL_MAGIC_fm
4439 && how != PERL_MAGIC_sv
4440 && how != PERL_MAGIC_backref
4443 Perl_croak(aTHX_ PL_no_modify);
4446 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4447 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4448 /* sv_magic() refuses to add a magic of the same 'how' as an
4451 if (how == PERL_MAGIC_taint) {
4453 /* Any scalar which already had taint magic on which someone
4454 (erroneously?) did SvIOK_on() or similar will now be
4455 incorrectly sporting public "OK" flags. */
4456 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4464 vtable = &PL_vtbl_sv;
4466 case PERL_MAGIC_overload:
4467 vtable = &PL_vtbl_amagic;
4469 case PERL_MAGIC_overload_elem:
4470 vtable = &PL_vtbl_amagicelem;
4472 case PERL_MAGIC_overload_table:
4473 vtable = &PL_vtbl_ovrld;
4476 vtable = &PL_vtbl_bm;
4478 case PERL_MAGIC_regdata:
4479 vtable = &PL_vtbl_regdata;
4481 case PERL_MAGIC_regdatum:
4482 vtable = &PL_vtbl_regdatum;
4484 case PERL_MAGIC_env:
4485 vtable = &PL_vtbl_env;
4488 vtable = &PL_vtbl_fm;
4490 case PERL_MAGIC_envelem:
4491 vtable = &PL_vtbl_envelem;
4493 case PERL_MAGIC_regex_global:
4494 vtable = &PL_vtbl_mglob;
4496 case PERL_MAGIC_isa:
4497 vtable = &PL_vtbl_isa;
4499 case PERL_MAGIC_isaelem:
4500 vtable = &PL_vtbl_isaelem;
4502 case PERL_MAGIC_nkeys:
4503 vtable = &PL_vtbl_nkeys;
4505 case PERL_MAGIC_dbfile:
4508 case PERL_MAGIC_dbline:
4509 vtable = &PL_vtbl_dbline;
4511 #ifdef USE_LOCALE_COLLATE
4512 case PERL_MAGIC_collxfrm:
4513 vtable = &PL_vtbl_collxfrm;
4515 #endif /* USE_LOCALE_COLLATE */
4516 case PERL_MAGIC_tied:
4517 vtable = &PL_vtbl_pack;
4519 case PERL_MAGIC_tiedelem:
4520 case PERL_MAGIC_tiedscalar:
4521 vtable = &PL_vtbl_packelem;
4524 vtable = &PL_vtbl_regexp;
4526 case PERL_MAGIC_hints:
4527 /* As this vtable is all NULL, we can reuse it. */
4528 case PERL_MAGIC_sig:
4529 vtable = &PL_vtbl_sig;
4531 case PERL_MAGIC_sigelem:
4532 vtable = &PL_vtbl_sigelem;
4534 case PERL_MAGIC_taint:
4535 vtable = &PL_vtbl_taint;
4537 case PERL_MAGIC_uvar:
4538 vtable = &PL_vtbl_uvar;
4540 case PERL_MAGIC_vec:
4541 vtable = &PL_vtbl_vec;
4543 case PERL_MAGIC_arylen_p:
4544 case PERL_MAGIC_rhash:
4545 case PERL_MAGIC_symtab:
4546 case PERL_MAGIC_vstring:
4549 case PERL_MAGIC_utf8:
4550 vtable = &PL_vtbl_utf8;
4552 case PERL_MAGIC_substr:
4553 vtable = &PL_vtbl_substr;
4555 case PERL_MAGIC_defelem:
4556 vtable = &PL_vtbl_defelem;
4558 case PERL_MAGIC_arylen:
4559 vtable = &PL_vtbl_arylen;
4561 case PERL_MAGIC_pos:
4562 vtable = &PL_vtbl_pos;
4564 case PERL_MAGIC_backref:
4565 vtable = &PL_vtbl_backref;
4567 case PERL_MAGIC_hintselem:
4568 vtable = &PL_vtbl_hintselem;
4570 case PERL_MAGIC_ext:
4571 /* Reserved for use by extensions not perl internals. */
4572 /* Useful for attaching extension internal data to perl vars. */
4573 /* Note that multiple extensions may clash if magical scalars */
4574 /* etc holding private data from one are passed to another. */
4578 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4581 /* Rest of work is done else where */
4582 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4585 case PERL_MAGIC_taint:
4588 case PERL_MAGIC_ext:
4589 case PERL_MAGIC_dbfile:
4596 =for apidoc sv_unmagic
4598 Removes all magic of type C<type> from an SV.
4604 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4608 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4610 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4611 for (mg = *mgp; mg; mg = *mgp) {
4612 if (mg->mg_type == type) {
4613 const MGVTBL* const vtbl = mg->mg_virtual;
4614 *mgp = mg->mg_moremagic;
4615 if (vtbl && vtbl->svt_free)
4616 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4617 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4619 Safefree(mg->mg_ptr);
4620 else if (mg->mg_len == HEf_SVKEY)
4621 SvREFCNT_dec((SV*)mg->mg_ptr);
4622 else if (mg->mg_type == PERL_MAGIC_utf8)
4623 Safefree(mg->mg_ptr);
4625 if (mg->mg_flags & MGf_REFCOUNTED)
4626 SvREFCNT_dec(mg->mg_obj);
4630 mgp = &mg->mg_moremagic;
4634 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4635 SvMAGIC_set(sv, NULL);
4642 =for apidoc sv_rvweaken
4644 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4645 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4646 push a back-reference to this RV onto the array of backreferences
4647 associated with that magic.
4653 Perl_sv_rvweaken(pTHX_ SV *sv)
4656 if (!SvOK(sv)) /* let undefs pass */
4659 Perl_croak(aTHX_ "Can't weaken a nonreference");
4660 else if (SvWEAKREF(sv)) {
4661 if (ckWARN(WARN_MISC))
4662 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4666 Perl_sv_add_backref(aTHX_ tsv, sv);
4672 /* Give tsv backref magic if it hasn't already got it, then push a
4673 * back-reference to sv onto the array associated with the backref magic.
4677 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4682 if (SvTYPE(tsv) == SVt_PVHV) {
4683 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4687 /* There is no AV in the offical place - try a fixup. */
4688 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4691 /* Aha. They've got it stowed in magic. Bring it back. */
4692 av = (AV*)mg->mg_obj;
4693 /* Stop mg_free decreasing the refernce count. */
4695 /* Stop mg_free even calling the destructor, given that
4696 there's no AV to free up. */
4698 sv_unmagic(tsv, PERL_MAGIC_backref);
4702 SvREFCNT_inc_simple_void(av);
4707 const MAGIC *const mg
4708 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4710 av = (AV*)mg->mg_obj;
4714 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4715 /* av now has a refcnt of 2, which avoids it getting freed
4716 * before us during global cleanup. The extra ref is removed
4717 * by magic_killbackrefs() when tsv is being freed */
4720 if (AvFILLp(av) >= AvMAX(av)) {
4721 av_extend(av, AvFILLp(av)+1);
4723 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4726 /* delete a back-reference to ourselves from the backref magic associated
4727 * with the SV we point to.
4731 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4738 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4739 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4740 /* We mustn't attempt to "fix up" the hash here by moving the
4741 backreference array back to the hv_aux structure, as that is stored
4742 in the main HvARRAY(), and hfreentries assumes that no-one
4743 reallocates HvARRAY() while it is running. */
4746 const MAGIC *const mg
4747 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4749 av = (AV *)mg->mg_obj;
4752 if (PL_in_clean_all)
4754 Perl_croak(aTHX_ "panic: del_backref");
4761 /* We shouldn't be in here more than once, but for paranoia reasons lets
4763 for (i = AvFILLp(av); i >= 0; i--) {
4765 const SSize_t fill = AvFILLp(av);
4767 /* We weren't the last entry.
4768 An unordered list has this property that you can take the
4769 last element off the end to fill the hole, and it's still
4770 an unordered list :-)
4775 AvFILLp(av) = fill - 1;
4781 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4783 SV **svp = AvARRAY(av);
4785 PERL_UNUSED_ARG(sv);
4787 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4788 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4789 if (svp && !SvIS_FREED(av)) {
4790 SV *const *const last = svp + AvFILLp(av);
4792 while (svp <= last) {
4794 SV *const referrer = *svp;
4795 if (SvWEAKREF(referrer)) {
4796 /* XXX Should we check that it hasn't changed? */
4797 SvRV_set(referrer, 0);
4799 SvWEAKREF_off(referrer);
4800 } else if (SvTYPE(referrer) == SVt_PVGV ||
4801 SvTYPE(referrer) == SVt_PVLV) {
4802 /* You lookin' at me? */
4803 assert(GvSTASH(referrer));
4804 assert(GvSTASH(referrer) == (HV*)sv);
4805 GvSTASH(referrer) = 0;
4808 "panic: magic_killbackrefs (flags=%"UVxf")",
4809 (UV)SvFLAGS(referrer));
4817 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4822 =for apidoc sv_insert
4824 Inserts a string at the specified offset/length within the SV. Similar to
4825 the Perl substr() function.
4831 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4836 register char *midend;
4837 register char *bigend;
4843 Perl_croak(aTHX_ "Can't modify non-existent substring");
4844 SvPV_force(bigstr, curlen);
4845 (void)SvPOK_only_UTF8(bigstr);
4846 if (offset + len > curlen) {
4847 SvGROW(bigstr, offset+len+1);
4848 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4849 SvCUR_set(bigstr, offset+len);
4853 i = littlelen - len;
4854 if (i > 0) { /* string might grow */
4855 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4856 mid = big + offset + len;
4857 midend = bigend = big + SvCUR(bigstr);
4860 while (midend > mid) /* shove everything down */
4861 *--bigend = *--midend;
4862 Move(little,big+offset,littlelen,char);
4863 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4868 Move(little,SvPVX(bigstr)+offset,len,char);
4873 big = SvPVX(bigstr);
4876 bigend = big + SvCUR(bigstr);
4878 if (midend > bigend)
4879 Perl_croak(aTHX_ "panic: sv_insert");
4881 if (mid - big > bigend - midend) { /* faster to shorten from end */
4883 Move(little, mid, littlelen,char);
4886 i = bigend - midend;
4888 Move(midend, mid, i,char);
4892 SvCUR_set(bigstr, mid - big);
4894 else if ((i = mid - big)) { /* faster from front */
4895 midend -= littlelen;
4897 sv_chop(bigstr,midend-i);
4902 Move(little, mid, littlelen,char);
4904 else if (littlelen) {
4905 midend -= littlelen;
4906 sv_chop(bigstr,midend);
4907 Move(little,midend,littlelen,char);
4910 sv_chop(bigstr,midend);
4916 =for apidoc sv_replace
4918 Make the first argument a copy of the second, then delete the original.
4919 The target SV physically takes over ownership of the body of the source SV
4920 and inherits its flags; however, the target keeps any magic it owns,
4921 and any magic in the source is discarded.
4922 Note that this is a rather specialist SV copying operation; most of the
4923 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4929 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4932 const U32 refcnt = SvREFCNT(sv);
4933 SV_CHECK_THINKFIRST_COW_DROP(sv);
4934 if (SvREFCNT(nsv) != 1) {
4935 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4936 UVuf " != 1)", (UV) SvREFCNT(nsv));
4938 if (SvMAGICAL(sv)) {
4942 sv_upgrade(nsv, SVt_PVMG);
4943 SvMAGIC_set(nsv, SvMAGIC(sv));
4944 SvFLAGS(nsv) |= SvMAGICAL(sv);
4946 SvMAGIC_set(sv, NULL);
4950 assert(!SvREFCNT(sv));
4951 #ifdef DEBUG_LEAKING_SCALARS
4952 sv->sv_flags = nsv->sv_flags;
4953 sv->sv_any = nsv->sv_any;
4954 sv->sv_refcnt = nsv->sv_refcnt;
4955 sv->sv_u = nsv->sv_u;
4957 StructCopy(nsv,sv,SV);
4959 /* Currently could join these into one piece of pointer arithmetic, but
4960 it would be unclear. */
4961 if(SvTYPE(sv) == SVt_IV)
4963 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4964 else if (SvTYPE(sv) == SVt_RV) {
4965 SvANY(sv) = &sv->sv_u.svu_rv;
4969 #ifdef PERL_OLD_COPY_ON_WRITE
4970 if (SvIsCOW_normal(nsv)) {
4971 /* We need to follow the pointers around the loop to make the
4972 previous SV point to sv, rather than nsv. */
4975 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4978 assert(SvPVX_const(current) == SvPVX_const(nsv));
4980 /* Make the SV before us point to the SV after us. */
4982 PerlIO_printf(Perl_debug_log, "previous is\n");
4984 PerlIO_printf(Perl_debug_log,
4985 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4986 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4988 SV_COW_NEXT_SV_SET(current, sv);
4991 SvREFCNT(sv) = refcnt;
4992 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4998 =for apidoc sv_clear
5000 Clear an SV: call any destructors, free up any memory used by the body,
5001 and free the body itself. The SV's head is I<not> freed, although
5002 its type is set to all 1's so that it won't inadvertently be assumed
5003 to be live during global destruction etc.
5004 This function should only be called when REFCNT is zero. Most of the time
5005 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5012 Perl_sv_clear(pTHX_ register SV *sv)
5015 const U32 type = SvTYPE(sv);
5016 const struct body_details *const sv_type_details
5017 = bodies_by_type + type;
5020 assert(SvREFCNT(sv) == 0);
5022 if (type <= SVt_IV) {
5023 /* See the comment in sv.h about the collusion between this early
5024 return and the overloading of the NULL and IV slots in the size
5030 if (PL_defstash) { /* Still have a symbol table? */
5035 stash = SvSTASH(sv);
5036 destructor = StashHANDLER(stash,DESTROY);
5038 SV* const tmpref = newRV(sv);
5039 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5041 PUSHSTACKi(PERLSI_DESTROY);
5046 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5052 if(SvREFCNT(tmpref) < 2) {
5053 /* tmpref is not kept alive! */
5055 SvRV_set(tmpref, NULL);
5058 SvREFCNT_dec(tmpref);
5060 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5064 if (PL_in_clean_objs)
5065 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5067 /* DESTROY gave object new lease on life */
5073 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5074 SvOBJECT_off(sv); /* Curse the object. */
5075 if (type != SVt_PVIO)
5076 --PL_sv_objcount; /* XXX Might want something more general */
5079 if (type >= SVt_PVMG) {
5081 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5082 (ourstash = OURSTASH(sv))) {
5083 SvREFCNT_dec(ourstash);
5084 } else if (SvMAGIC(sv))
5086 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5087 SvREFCNT_dec(SvSTASH(sv));
5092 IoIFP(sv) != PerlIO_stdin() &&
5093 IoIFP(sv) != PerlIO_stdout() &&
5094 IoIFP(sv) != PerlIO_stderr())
5096 io_close((IO*)sv, FALSE);
5098 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5099 PerlDir_close(IoDIRP(sv));
5100 IoDIRP(sv) = (DIR*)NULL;
5101 Safefree(IoTOP_NAME(sv));
5102 Safefree(IoFMT_NAME(sv));
5103 Safefree(IoBOTTOM_NAME(sv));
5112 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5119 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5120 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5121 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5122 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5124 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5125 SvREFCNT_dec(LvTARG(sv));
5129 if (GvNAME_HEK(sv)) {
5130 unshare_hek(GvNAME_HEK(sv));
5132 /* If we're in a stash, we don't own a reference to it. However it does
5133 have a back reference to us, which needs to be cleared. */
5135 sv_del_backref((SV*)GvSTASH(sv), sv);
5140 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5142 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5143 /* Don't even bother with turning off the OOK flag. */
5148 SV * const target = SvRV(sv);
5150 sv_del_backref(target, sv);
5152 SvREFCNT_dec(target);
5154 #ifdef PERL_OLD_COPY_ON_WRITE
5155 else if (SvPVX_const(sv)) {
5157 /* I believe I need to grab the global SV mutex here and
5158 then recheck the COW status. */
5160 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5163 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5164 SV_COW_NEXT_SV(sv));
5165 /* And drop it here. */
5167 } else if (SvLEN(sv)) {
5168 Safefree(SvPVX_const(sv));
5172 else if (SvPVX_const(sv) && SvLEN(sv))
5173 Safefree(SvPVX_mutable(sv));
5174 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5175 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5184 SvFLAGS(sv) &= SVf_BREAK;
5185 SvFLAGS(sv) |= SVTYPEMASK;
5187 if (sv_type_details->arena) {
5188 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5189 &PL_body_roots[type]);
5191 else if (sv_type_details->body_size) {
5192 my_safefree(SvANY(sv));
5197 =for apidoc sv_newref
5199 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5206 Perl_sv_newref(pTHX_ SV *sv)
5208 PERL_UNUSED_CONTEXT;
5217 Decrement an SV's reference count, and if it drops to zero, call
5218 C<sv_clear> to invoke destructors and free up any memory used by
5219 the body; finally, deallocate the SV's head itself.
5220 Normally called via a wrapper macro C<SvREFCNT_dec>.
5226 Perl_sv_free(pTHX_ SV *sv)
5231 if (SvREFCNT(sv) == 0) {
5232 if (SvFLAGS(sv) & SVf_BREAK)
5233 /* this SV's refcnt has been artificially decremented to
5234 * trigger cleanup */
5236 if (PL_in_clean_all) /* All is fair */
5238 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5239 /* make sure SvREFCNT(sv)==0 happens very seldom */
5240 SvREFCNT(sv) = (~(U32)0)/2;
5243 if (ckWARN_d(WARN_INTERNAL)) {
5244 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5245 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5246 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5247 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5248 Perl_dump_sv_child(aTHX_ sv);
5253 if (--(SvREFCNT(sv)) > 0)
5255 Perl_sv_free2(aTHX_ sv);
5259 Perl_sv_free2(pTHX_ SV *sv)
5264 if (ckWARN_d(WARN_DEBUGGING))
5265 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5266 "Attempt to free temp prematurely: SV 0x%"UVxf
5267 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5271 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5272 /* make sure SvREFCNT(sv)==0 happens very seldom */
5273 SvREFCNT(sv) = (~(U32)0)/2;
5284 Returns the length of the string in the SV. Handles magic and type
5285 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5291 Perl_sv_len(pTHX_ register SV *sv)
5299 len = mg_length(sv);
5301 (void)SvPV_const(sv, len);
5306 =for apidoc sv_len_utf8
5308 Returns the number of characters in the string in an SV, counting wide
5309 UTF-8 bytes as a single character. Handles magic and type coercion.
5315 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5316 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5317 * (Note that the mg_len is not the length of the mg_ptr field.
5318 * This allows the cache to store the character length of the string without
5319 * needing to malloc() extra storage to attach to the mg_ptr.)
5324 Perl_sv_len_utf8(pTHX_ register SV *sv)
5330 return mg_length(sv);
5334 const U8 *s = (U8*)SvPV_const(sv, len);
5338 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5340 if (mg && mg->mg_len != -1) {
5342 if (PL_utf8cache < 0) {
5343 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5345 /* Need to turn the assertions off otherwise we may
5346 recurse infinitely while printing error messages.
5348 SAVEI8(PL_utf8cache);
5350 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5351 " real %"UVf" for %"SVf,
5352 (UV) ulen, (UV) real, (void*)sv);
5357 ulen = Perl_utf8_length(aTHX_ s, s + len);
5358 if (!SvREADONLY(sv)) {
5360 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5361 &PL_vtbl_utf8, 0, 0);
5369 return Perl_utf8_length(aTHX_ s, s + len);
5373 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5376 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5379 const U8 *s = start;
5381 while (s < send && uoffset--)
5384 /* This is the existing behaviour. Possibly it should be a croak, as
5385 it's actually a bounds error */
5391 /* Given the length of the string in both bytes and UTF-8 characters, decide
5392 whether to walk forwards or backwards to find the byte corresponding to
5393 the passed in UTF-8 offset. */
5395 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5396 STRLEN uoffset, STRLEN uend)
5398 STRLEN backw = uend - uoffset;
5399 if (uoffset < 2 * backw) {
5400 /* The assumption is that going forwards is twice the speed of going
5401 forward (that's where the 2 * backw comes from).
5402 (The real figure of course depends on the UTF-8 data.) */
5403 return sv_pos_u2b_forwards(start, send, uoffset);
5408 while (UTF8_IS_CONTINUATION(*send))
5411 return send - start;
5414 /* For the string representation of the given scalar, find the byte
5415 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5416 give another position in the string, *before* the sought offset, which
5417 (which is always true, as 0, 0 is a valid pair of positions), which should
5418 help reduce the amount of linear searching.
5419 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5420 will be used to reduce the amount of linear searching. The cache will be
5421 created if necessary, and the found value offered to it for update. */
5423 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5424 const U8 *const send, STRLEN uoffset,
5425 STRLEN uoffset0, STRLEN boffset0) {
5426 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5429 assert (uoffset >= uoffset0);
5431 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5432 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5433 if ((*mgp)->mg_ptr) {
5434 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5435 if (cache[0] == uoffset) {
5436 /* An exact match. */
5439 if (cache[2] == uoffset) {
5440 /* An exact match. */
5444 if (cache[0] < uoffset) {
5445 /* The cache already knows part of the way. */
5446 if (cache[0] > uoffset0) {
5447 /* The cache knows more than the passed in pair */
5448 uoffset0 = cache[0];
5449 boffset0 = cache[1];
5451 if ((*mgp)->mg_len != -1) {
5452 /* And we know the end too. */
5454 + sv_pos_u2b_midway(start + boffset0, send,
5456 (*mgp)->mg_len - uoffset0);
5459 + sv_pos_u2b_forwards(start + boffset0,
5460 send, uoffset - uoffset0);
5463 else if (cache[2] < uoffset) {
5464 /* We're between the two cache entries. */
5465 if (cache[2] > uoffset0) {
5466 /* and the cache knows more than the passed in pair */
5467 uoffset0 = cache[2];
5468 boffset0 = cache[3];
5472 + sv_pos_u2b_midway(start + boffset0,
5475 cache[0] - uoffset0);
5478 + sv_pos_u2b_midway(start + boffset0,
5481 cache[2] - uoffset0);
5485 else if ((*mgp)->mg_len != -1) {
5486 /* If we can take advantage of a passed in offset, do so. */
5487 /* In fact, offset0 is either 0, or less than offset, so don't
5488 need to worry about the other possibility. */
5490 + sv_pos_u2b_midway(start + boffset0, send,
5492 (*mgp)->mg_len - uoffset0);
5497 if (!found || PL_utf8cache < 0) {
5498 const STRLEN real_boffset
5499 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5500 send, uoffset - uoffset0);
5502 if (found && PL_utf8cache < 0) {
5503 if (real_boffset != boffset) {
5504 /* Need to turn the assertions off otherwise we may recurse
5505 infinitely while printing error messages. */
5506 SAVEI8(PL_utf8cache);
5508 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5509 " real %"UVf" for %"SVf,
5510 (UV) boffset, (UV) real_boffset, (void*)sv);
5513 boffset = real_boffset;
5516 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5522 =for apidoc sv_pos_u2b
5524 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5525 the start of the string, to a count of the equivalent number of bytes; if
5526 lenp is non-zero, it does the same to lenp, but this time starting from
5527 the offset, rather than from the start of the string. Handles magic and
5534 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5535 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5536 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5541 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5549 start = (U8*)SvPV_const(sv, len);
5551 STRLEN uoffset = (STRLEN) *offsetp;
5552 const U8 * const send = start + len;
5554 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5557 *offsetp = (I32) boffset;
5560 /* Convert the relative offset to absolute. */
5561 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5562 const STRLEN boffset2
5563 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5564 uoffset, boffset) - boffset;
5578 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5579 byte length pairing. The (byte) length of the total SV is passed in too,
5580 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5581 may not have updated SvCUR, so we can't rely on reading it directly.
5583 The proffered utf8/byte length pairing isn't used if the cache already has
5584 two pairs, and swapping either for the proffered pair would increase the
5585 RMS of the intervals between known byte offsets.
5587 The cache itself consists of 4 STRLEN values
5588 0: larger UTF-8 offset
5589 1: corresponding byte offset
5590 2: smaller UTF-8 offset
5591 3: corresponding byte offset
5593 Unused cache pairs have the value 0, 0.
5594 Keeping the cache "backwards" means that the invariant of
5595 cache[0] >= cache[2] is maintained even with empty slots, which means that
5596 the code that uses it doesn't need to worry if only 1 entry has actually
5597 been set to non-zero. It also makes the "position beyond the end of the
5598 cache" logic much simpler, as the first slot is always the one to start
5602 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5610 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5612 (*mgp)->mg_len = -1;
5616 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5617 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5618 (*mgp)->mg_ptr = (char *) cache;
5622 if (PL_utf8cache < 0) {
5623 const U8 *start = (const U8 *) SvPVX_const(sv);
5624 const U8 *const end = start + byte;
5625 STRLEN realutf8 = 0;
5627 while (start < end) {
5628 start += UTF8SKIP(start);
5632 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5633 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5634 doesn't? I don't know whether this difference was introduced with
5635 the caching code in 5.8.1. */
5637 if (realutf8 != utf8) {
5638 /* Need to turn the assertions off otherwise we may recurse
5639 infinitely while printing error messages. */
5640 SAVEI8(PL_utf8cache);
5642 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5643 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5647 /* Cache is held with the later position first, to simplify the code
5648 that deals with unbounded ends. */
5650 ASSERT_UTF8_CACHE(cache);
5651 if (cache[1] == 0) {
5652 /* Cache is totally empty */
5655 } else if (cache[3] == 0) {
5656 if (byte > cache[1]) {
5657 /* New one is larger, so goes first. */
5658 cache[2] = cache[0];
5659 cache[3] = cache[1];
5667 #define THREEWAY_SQUARE(a,b,c,d) \
5668 ((float)((d) - (c))) * ((float)((d) - (c))) \
5669 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5670 + ((float)((b) - (a))) * ((float)((b) - (a)))
5672 /* Cache has 2 slots in use, and we know three potential pairs.
5673 Keep the two that give the lowest RMS distance. Do the
5674 calcualation in bytes simply because we always know the byte
5675 length. squareroot has the same ordering as the positive value,
5676 so don't bother with the actual square root. */
5677 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5678 if (byte > cache[1]) {
5679 /* New position is after the existing pair of pairs. */
5680 const float keep_earlier
5681 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5682 const float keep_later
5683 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5685 if (keep_later < keep_earlier) {
5686 if (keep_later < existing) {
5687 cache[2] = cache[0];
5688 cache[3] = cache[1];
5694 if (keep_earlier < existing) {
5700 else if (byte > cache[3]) {
5701 /* New position is between the existing pair of pairs. */
5702 const float keep_earlier
5703 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5704 const float keep_later
5705 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5707 if (keep_later < keep_earlier) {
5708 if (keep_later < existing) {
5714 if (keep_earlier < existing) {
5721 /* New position is before the existing pair of pairs. */
5722 const float keep_earlier
5723 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5724 const float keep_later
5725 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5727 if (keep_later < keep_earlier) {
5728 if (keep_later < existing) {
5734 if (keep_earlier < existing) {
5735 cache[0] = cache[2];
5736 cache[1] = cache[3];
5743 ASSERT_UTF8_CACHE(cache);
5746 /* If we don't know the character offset of the end of a region, our only
5747 option is to walk forwards to the target byte offset. */
5749 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5752 while (s < target) {
5755 /* Call utf8n_to_uvchr() to validate the sequence
5756 * (unless a simple non-UTF character) */
5757 if (!UTF8_IS_INVARIANT(*s))
5758 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5769 /* We already know all of the way, now we may be able to walk back. The same
5770 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5771 backward is half the speed of walking forward. */
5773 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5776 const STRLEN forw = target - s;
5777 STRLEN backw = end - target;
5779 if (forw < 2 * backw) {
5780 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5783 while (end > target) {
5785 while (UTF8_IS_CONTINUATION(*end)) {
5794 =for apidoc sv_pos_b2u
5796 Converts the value pointed to by offsetp from a count of bytes from the
5797 start of the string, to a count of the equivalent number of UTF-8 chars.
5798 Handles magic and type coercion.
5804 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5805 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5810 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5813 const STRLEN byte = *offsetp;
5814 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5823 s = (const U8*)SvPV_const(sv, blen);
5826 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5830 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5831 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5833 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5834 if (cache[1] == byte) {
5835 /* An exact match. */
5836 *offsetp = cache[0];
5839 if (cache[3] == byte) {
5840 /* An exact match. */
5841 *offsetp = cache[2];
5845 if (cache[1] < byte) {
5846 /* We already know part of the way. */
5847 if (mg->mg_len != -1) {
5848 /* Actually, we know the end too. */
5850 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5851 s + blen, mg->mg_len - cache[0]);
5854 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5857 else if (cache[3] < byte) {
5858 /* We're between the two cached pairs, so we do the calculation
5859 offset by the byte/utf-8 positions for the earlier pair,
5860 then add the utf-8 characters from the string start to
5862 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5863 s + cache[1], cache[0] - cache[2])
5867 else { /* cache[3] > byte */
5868 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5872 ASSERT_UTF8_CACHE(cache);
5874 } else if (mg->mg_len != -1) {
5875 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5879 if (!found || PL_utf8cache < 0) {
5880 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5882 if (found && PL_utf8cache < 0) {
5883 if (len != real_len) {
5884 /* Need to turn the assertions off otherwise we may recurse
5885 infinitely while printing error messages. */
5886 SAVEI8(PL_utf8cache);
5888 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5889 " real %"UVf" for %"SVf,
5890 (UV) len, (UV) real_len, (void*)sv);
5897 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5903 Returns a boolean indicating whether the strings in the two SVs are
5904 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5905 coerce its args to strings if necessary.
5911 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5920 SV* svrecode = NULL;
5927 pv1 = SvPV_const(sv1, cur1);
5934 pv2 = SvPV_const(sv2, cur2);
5936 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5937 /* Differing utf8ness.
5938 * Do not UTF8size the comparands as a side-effect. */
5941 svrecode = newSVpvn(pv2, cur2);
5942 sv_recode_to_utf8(svrecode, PL_encoding);
5943 pv2 = SvPV_const(svrecode, cur2);
5946 svrecode = newSVpvn(pv1, cur1);
5947 sv_recode_to_utf8(svrecode, PL_encoding);
5948 pv1 = SvPV_const(svrecode, cur1);
5950 /* Now both are in UTF-8. */
5952 SvREFCNT_dec(svrecode);
5957 bool is_utf8 = TRUE;
5960 /* sv1 is the UTF-8 one,
5961 * if is equal it must be downgrade-able */
5962 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5968 /* sv2 is the UTF-8 one,
5969 * if is equal it must be downgrade-able */
5970 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5976 /* Downgrade not possible - cannot be eq */
5984 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5986 SvREFCNT_dec(svrecode);
5996 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5997 string in C<sv1> is less than, equal to, or greater than the string in
5998 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5999 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6005 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6009 const char *pv1, *pv2;
6012 SV *svrecode = NULL;
6019 pv1 = SvPV_const(sv1, cur1);
6026 pv2 = SvPV_const(sv2, cur2);
6028 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6029 /* Differing utf8ness.
6030 * Do not UTF8size the comparands as a side-effect. */
6033 svrecode = newSVpvn(pv2, cur2);
6034 sv_recode_to_utf8(svrecode, PL_encoding);
6035 pv2 = SvPV_const(svrecode, cur2);
6038 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6043 svrecode = newSVpvn(pv1, cur1);
6044 sv_recode_to_utf8(svrecode, PL_encoding);
6045 pv1 = SvPV_const(svrecode, cur1);
6048 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6054 cmp = cur2 ? -1 : 0;
6058 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6061 cmp = retval < 0 ? -1 : 1;
6062 } else if (cur1 == cur2) {
6065 cmp = cur1 < cur2 ? -1 : 1;
6069 SvREFCNT_dec(svrecode);
6077 =for apidoc sv_cmp_locale
6079 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6080 'use bytes' aware, handles get magic, and will coerce its args to strings
6081 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6087 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6090 #ifdef USE_LOCALE_COLLATE
6096 if (PL_collation_standard)
6100 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6102 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6104 if (!pv1 || !len1) {
6115 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6118 return retval < 0 ? -1 : 1;
6121 * When the result of collation is equality, that doesn't mean
6122 * that there are no differences -- some locales exclude some
6123 * characters from consideration. So to avoid false equalities,
6124 * we use the raw string as a tiebreaker.
6130 #endif /* USE_LOCALE_COLLATE */
6132 return sv_cmp(sv1, sv2);
6136 #ifdef USE_LOCALE_COLLATE
6139 =for apidoc sv_collxfrm
6141 Add Collate Transform magic to an SV if it doesn't already have it.
6143 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6144 scalar data of the variable, but transformed to such a format that a normal
6145 memory comparison can be used to compare the data according to the locale
6152 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6157 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6158 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6164 Safefree(mg->mg_ptr);
6165 s = SvPV_const(sv, len);
6166 if ((xf = mem_collxfrm(s, len, &xlen))) {
6167 if (SvREADONLY(sv)) {
6170 return xf + sizeof(PL_collation_ix);
6173 #ifdef PERL_OLD_COPY_ON_WRITE
6175 sv_force_normal_flags(sv, 0);
6177 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6191 if (mg && mg->mg_ptr) {
6193 return mg->mg_ptr + sizeof(PL_collation_ix);
6201 #endif /* USE_LOCALE_COLLATE */
6206 Get a line from the filehandle and store it into the SV, optionally
6207 appending to the currently-stored string.
6213 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6218 register STDCHAR rslast;
6219 register STDCHAR *bp;
6224 if (SvTHINKFIRST(sv))
6225 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6226 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6228 However, perlbench says it's slower, because the existing swipe code
6229 is faster than copy on write.
6230 Swings and roundabouts. */
6231 SvUPGRADE(sv, SVt_PV);
6236 if (PerlIO_isutf8(fp)) {
6238 sv_utf8_upgrade_nomg(sv);
6239 sv_pos_u2b(sv,&append,0);
6241 } else if (SvUTF8(sv)) {
6242 SV * const tsv = newSV(0);
6243 sv_gets(tsv, fp, 0);
6244 sv_utf8_upgrade_nomg(tsv);
6245 SvCUR_set(sv,append);
6248 goto return_string_or_null;
6253 if (PerlIO_isutf8(fp))
6256 if (IN_PERL_COMPILETIME) {
6257 /* we always read code in line mode */
6261 else if (RsSNARF(PL_rs)) {
6262 /* If it is a regular disk file use size from stat() as estimate
6263 of amount we are going to read -- may result in mallocing
6264 more memory than we really need if the layers below reduce
6265 the size we read (e.g. CRLF or a gzip layer).
6268 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6269 const Off_t offset = PerlIO_tell(fp);
6270 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6271 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6277 else if (RsRECORD(PL_rs)) {
6282 /* Grab the size of the record we're getting */
6283 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6284 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6287 /* VMS wants read instead of fread, because fread doesn't respect */
6288 /* RMS record boundaries. This is not necessarily a good thing to be */
6289 /* doing, but we've got no other real choice - except avoid stdio
6290 as implementation - perhaps write a :vms layer ?
6292 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6294 bytesread = PerlIO_read(fp, buffer, recsize);
6298 SvCUR_set(sv, bytesread += append);
6299 buffer[bytesread] = '\0';
6300 goto return_string_or_null;
6302 else if (RsPARA(PL_rs)) {
6308 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6309 if (PerlIO_isutf8(fp)) {
6310 rsptr = SvPVutf8(PL_rs, rslen);
6313 if (SvUTF8(PL_rs)) {
6314 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6315 Perl_croak(aTHX_ "Wide character in $/");
6318 rsptr = SvPV_const(PL_rs, rslen);
6322 rslast = rslen ? rsptr[rslen - 1] : '\0';
6324 if (rspara) { /* have to do this both before and after */
6325 do { /* to make sure file boundaries work right */
6328 i = PerlIO_getc(fp);
6332 PerlIO_ungetc(fp,i);
6338 /* See if we know enough about I/O mechanism to cheat it ! */
6340 /* This used to be #ifdef test - it is made run-time test for ease
6341 of abstracting out stdio interface. One call should be cheap
6342 enough here - and may even be a macro allowing compile
6346 if (PerlIO_fast_gets(fp)) {
6349 * We're going to steal some values from the stdio struct
6350 * and put EVERYTHING in the innermost loop into registers.
6352 register STDCHAR *ptr;
6356 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6357 /* An ungetc()d char is handled separately from the regular
6358 * buffer, so we getc() it back out and stuff it in the buffer.
6360 i = PerlIO_getc(fp);
6361 if (i == EOF) return 0;
6362 *(--((*fp)->_ptr)) = (unsigned char) i;
6366 /* Here is some breathtakingly efficient cheating */
6368 cnt = PerlIO_get_cnt(fp); /* get count into register */
6369 /* make sure we have the room */
6370 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6371 /* Not room for all of it
6372 if we are looking for a separator and room for some
6374 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6375 /* just process what we have room for */
6376 shortbuffered = cnt - SvLEN(sv) + append + 1;
6377 cnt -= shortbuffered;
6381 /* remember that cnt can be negative */
6382 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6387 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6388 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6389 DEBUG_P(PerlIO_printf(Perl_debug_log,
6390 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6391 DEBUG_P(PerlIO_printf(Perl_debug_log,
6392 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6393 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6394 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6399 while (cnt > 0) { /* this | eat */
6401 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6402 goto thats_all_folks; /* screams | sed :-) */
6406 Copy(ptr, bp, cnt, char); /* this | eat */
6407 bp += cnt; /* screams | dust */
6408 ptr += cnt; /* louder | sed :-) */
6413 if (shortbuffered) { /* oh well, must extend */
6414 cnt = shortbuffered;
6416 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6418 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6419 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6423 DEBUG_P(PerlIO_printf(Perl_debug_log,
6424 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6425 PTR2UV(ptr),(long)cnt));
6426 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6428 DEBUG_P(PerlIO_printf(Perl_debug_log,
6429 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6430 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6431 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6433 /* This used to call 'filbuf' in stdio form, but as that behaves like
6434 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6435 another abstraction. */
6436 i = PerlIO_getc(fp); /* get more characters */
6438 DEBUG_P(PerlIO_printf(Perl_debug_log,
6439 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6440 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6441 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6443 cnt = PerlIO_get_cnt(fp);
6444 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6445 DEBUG_P(PerlIO_printf(Perl_debug_log,
6446 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6448 if (i == EOF) /* all done for ever? */
6449 goto thats_really_all_folks;
6451 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6453 SvGROW(sv, bpx + cnt + 2);
6454 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6456 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6458 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6459 goto thats_all_folks;
6463 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6464 memNE((char*)bp - rslen, rsptr, rslen))
6465 goto screamer; /* go back to the fray */
6466 thats_really_all_folks:
6468 cnt += shortbuffered;
6469 DEBUG_P(PerlIO_printf(Perl_debug_log,
6470 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6471 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6472 DEBUG_P(PerlIO_printf(Perl_debug_log,
6473 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6474 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6475 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6477 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6478 DEBUG_P(PerlIO_printf(Perl_debug_log,
6479 "Screamer: done, len=%ld, string=|%.*s|\n",
6480 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6484 /*The big, slow, and stupid way. */
6485 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6486 STDCHAR *buf = NULL;
6487 Newx(buf, 8192, STDCHAR);
6495 register const STDCHAR * const bpe = buf + sizeof(buf);
6497 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6498 ; /* keep reading */
6502 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6503 /* Accomodate broken VAXC compiler, which applies U8 cast to
6504 * both args of ?: operator, causing EOF to change into 255
6507 i = (U8)buf[cnt - 1];
6513 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6515 sv_catpvn(sv, (char *) buf, cnt);
6517 sv_setpvn(sv, (char *) buf, cnt);
6519 if (i != EOF && /* joy */
6521 SvCUR(sv) < rslen ||
6522 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6526 * If we're reading from a TTY and we get a short read,
6527 * indicating that the user hit his EOF character, we need
6528 * to notice it now, because if we try to read from the TTY
6529 * again, the EOF condition will disappear.
6531 * The comparison of cnt to sizeof(buf) is an optimization
6532 * that prevents unnecessary calls to feof().
6536 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6540 #ifdef USE_HEAP_INSTEAD_OF_STACK
6545 if (rspara) { /* have to do this both before and after */
6546 while (i != EOF) { /* to make sure file boundaries work right */
6547 i = PerlIO_getc(fp);
6549 PerlIO_ungetc(fp,i);
6555 return_string_or_null:
6556 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6562 Auto-increment of the value in the SV, doing string to numeric conversion
6563 if necessary. Handles 'get' magic.
6569 Perl_sv_inc(pTHX_ register SV *sv)
6578 if (SvTHINKFIRST(sv)) {
6580 sv_force_normal_flags(sv, 0);
6581 if (SvREADONLY(sv)) {
6582 if (IN_PERL_RUNTIME)
6583 Perl_croak(aTHX_ PL_no_modify);
6587 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6589 i = PTR2IV(SvRV(sv));
6594 flags = SvFLAGS(sv);
6595 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6596 /* It's (privately or publicly) a float, but not tested as an
6597 integer, so test it to see. */
6599 flags = SvFLAGS(sv);
6601 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6602 /* It's publicly an integer, or privately an integer-not-float */
6603 #ifdef PERL_PRESERVE_IVUV
6607 if (SvUVX(sv) == UV_MAX)
6608 sv_setnv(sv, UV_MAX_P1);
6610 (void)SvIOK_only_UV(sv);
6611 SvUV_set(sv, SvUVX(sv) + 1);
6613 if (SvIVX(sv) == IV_MAX)
6614 sv_setuv(sv, (UV)IV_MAX + 1);
6616 (void)SvIOK_only(sv);
6617 SvIV_set(sv, SvIVX(sv) + 1);
6622 if (flags & SVp_NOK) {
6623 (void)SvNOK_only(sv);
6624 SvNV_set(sv, SvNVX(sv) + 1.0);
6628 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6629 if ((flags & SVTYPEMASK) < SVt_PVIV)
6630 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6631 (void)SvIOK_only(sv);
6636 while (isALPHA(*d)) d++;
6637 while (isDIGIT(*d)) d++;
6639 #ifdef PERL_PRESERVE_IVUV
6640 /* Got to punt this as an integer if needs be, but we don't issue
6641 warnings. Probably ought to make the sv_iv_please() that does
6642 the conversion if possible, and silently. */
6643 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6644 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6645 /* Need to try really hard to see if it's an integer.
6646 9.22337203685478e+18 is an integer.
6647 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6648 so $a="9.22337203685478e+18"; $a+0; $a++
6649 needs to be the same as $a="9.22337203685478e+18"; $a++
6656 /* sv_2iv *should* have made this an NV */
6657 if (flags & SVp_NOK) {
6658 (void)SvNOK_only(sv);
6659 SvNV_set(sv, SvNVX(sv) + 1.0);
6662 /* I don't think we can get here. Maybe I should assert this
6663 And if we do get here I suspect that sv_setnv will croak. NWC
6665 #if defined(USE_LONG_DOUBLE)
6666 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6667 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6669 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6670 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6673 #endif /* PERL_PRESERVE_IVUV */
6674 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6678 while (d >= SvPVX_const(sv)) {
6686 /* MKS: The original code here died if letters weren't consecutive.
6687 * at least it didn't have to worry about non-C locales. The
6688 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6689 * arranged in order (although not consecutively) and that only
6690 * [A-Za-z] are accepted by isALPHA in the C locale.
6692 if (*d != 'z' && *d != 'Z') {
6693 do { ++*d; } while (!isALPHA(*d));
6696 *(d--) -= 'z' - 'a';
6701 *(d--) -= 'z' - 'a' + 1;
6705 /* oh,oh, the number grew */
6706 SvGROW(sv, SvCUR(sv) + 2);
6707 SvCUR_set(sv, SvCUR(sv) + 1);
6708 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6719 Auto-decrement of the value in the SV, doing string to numeric conversion
6720 if necessary. Handles 'get' magic.
6726 Perl_sv_dec(pTHX_ register SV *sv)
6734 if (SvTHINKFIRST(sv)) {
6736 sv_force_normal_flags(sv, 0);
6737 if (SvREADONLY(sv)) {
6738 if (IN_PERL_RUNTIME)
6739 Perl_croak(aTHX_ PL_no_modify);
6743 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6745 i = PTR2IV(SvRV(sv));
6750 /* Unlike sv_inc we don't have to worry about string-never-numbers
6751 and keeping them magic. But we mustn't warn on punting */
6752 flags = SvFLAGS(sv);
6753 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6754 /* It's publicly an integer, or privately an integer-not-float */
6755 #ifdef PERL_PRESERVE_IVUV
6759 if (SvUVX(sv) == 0) {
6760 (void)SvIOK_only(sv);
6764 (void)SvIOK_only_UV(sv);
6765 SvUV_set(sv, SvUVX(sv) - 1);
6768 if (SvIVX(sv) == IV_MIN)
6769 sv_setnv(sv, (NV)IV_MIN - 1.0);
6771 (void)SvIOK_only(sv);
6772 SvIV_set(sv, SvIVX(sv) - 1);
6777 if (flags & SVp_NOK) {
6778 SvNV_set(sv, SvNVX(sv) - 1.0);
6779 (void)SvNOK_only(sv);
6782 if (!(flags & SVp_POK)) {
6783 if ((flags & SVTYPEMASK) < SVt_PVIV)
6784 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6786 (void)SvIOK_only(sv);
6789 #ifdef PERL_PRESERVE_IVUV
6791 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6792 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6793 /* Need to try really hard to see if it's an integer.
6794 9.22337203685478e+18 is an integer.
6795 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6796 so $a="9.22337203685478e+18"; $a+0; $a--
6797 needs to be the same as $a="9.22337203685478e+18"; $a--
6804 /* sv_2iv *should* have made this an NV */
6805 if (flags & SVp_NOK) {
6806 (void)SvNOK_only(sv);
6807 SvNV_set(sv, SvNVX(sv) - 1.0);
6810 /* I don't think we can get here. Maybe I should assert this
6811 And if we do get here I suspect that sv_setnv will croak. NWC
6813 #if defined(USE_LONG_DOUBLE)
6814 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6815 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6817 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6818 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6822 #endif /* PERL_PRESERVE_IVUV */
6823 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6827 =for apidoc sv_mortalcopy
6829 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6830 The new SV is marked as mortal. It will be destroyed "soon", either by an
6831 explicit call to FREETMPS, or by an implicit call at places such as
6832 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6837 /* Make a string that will exist for the duration of the expression
6838 * evaluation. Actually, it may have to last longer than that, but
6839 * hopefully we won't free it until it has been assigned to a
6840 * permanent location. */
6843 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6849 sv_setsv(sv,oldstr);
6851 PL_tmps_stack[++PL_tmps_ix] = sv;
6857 =for apidoc sv_newmortal
6859 Creates a new null SV which is mortal. The reference count of the SV is
6860 set to 1. It will be destroyed "soon", either by an explicit call to
6861 FREETMPS, or by an implicit call at places such as statement boundaries.
6862 See also C<sv_mortalcopy> and C<sv_2mortal>.
6868 Perl_sv_newmortal(pTHX)
6874 SvFLAGS(sv) = SVs_TEMP;
6876 PL_tmps_stack[++PL_tmps_ix] = sv;
6881 =for apidoc sv_2mortal
6883 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6884 by an explicit call to FREETMPS, or by an implicit call at places such as
6885 statement boundaries. SvTEMP() is turned on which means that the SV's
6886 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6887 and C<sv_mortalcopy>.
6893 Perl_sv_2mortal(pTHX_ register SV *sv)
6898 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6901 PL_tmps_stack[++PL_tmps_ix] = sv;
6909 Creates a new SV and copies a string into it. The reference count for the
6910 SV is set to 1. If C<len> is zero, Perl will compute the length using
6911 strlen(). For efficiency, consider using C<newSVpvn> instead.
6917 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6923 sv_setpvn(sv,s,len ? len : strlen(s));
6928 =for apidoc newSVpvn
6930 Creates a new SV and copies a string into it. The reference count for the
6931 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6932 string. You are responsible for ensuring that the source string is at least
6933 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6939 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6945 sv_setpvn(sv,s,len);
6951 =for apidoc newSVhek
6953 Creates a new SV from the hash key structure. It will generate scalars that
6954 point to the shared string table where possible. Returns a new (undefined)
6955 SV if the hek is NULL.
6961 Perl_newSVhek(pTHX_ const HEK *hek)
6971 if (HEK_LEN(hek) == HEf_SVKEY) {
6972 return newSVsv(*(SV**)HEK_KEY(hek));
6974 const int flags = HEK_FLAGS(hek);
6975 if (flags & HVhek_WASUTF8) {
6977 Andreas would like keys he put in as utf8 to come back as utf8
6979 STRLEN utf8_len = HEK_LEN(hek);
6980 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6981 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6984 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6986 } else if (flags & HVhek_REHASH) {
6987 /* We don't have a pointer to the hv, so we have to replicate the
6988 flag into every HEK. This hv is using custom a hasing
6989 algorithm. Hence we can't return a shared string scalar, as
6990 that would contain the (wrong) hash value, and might get passed
6991 into an hv routine with a regular hash */
6993 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6998 /* This will be overwhelminly the most common case. */
7000 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7001 more efficient than sharepvn(). */
7005 sv_upgrade(sv, SVt_PV);
7006 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7007 SvCUR_set(sv, HEK_LEN(hek));
7020 =for apidoc newSVpvn_share
7022 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7023 table. If the string does not already exist in the table, it is created
7024 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7025 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7026 otherwise the hash is computed. The idea here is that as the string table
7027 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7028 hash lookup will avoid string compare.
7034 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7038 bool is_utf8 = FALSE;
7039 const char *const orig_src = src;
7042 STRLEN tmplen = -len;
7044 /* See the note in hv.c:hv_fetch() --jhi */
7045 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7049 PERL_HASH(hash, src, len);
7051 sv_upgrade(sv, SVt_PV);
7052 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7060 if (src != orig_src)
7066 #if defined(PERL_IMPLICIT_CONTEXT)
7068 /* pTHX_ magic can't cope with varargs, so this is a no-context
7069 * version of the main function, (which may itself be aliased to us).
7070 * Don't access this version directly.
7074 Perl_newSVpvf_nocontext(const char* pat, ...)
7079 va_start(args, pat);
7080 sv = vnewSVpvf(pat, &args);
7087 =for apidoc newSVpvf
7089 Creates a new SV and initializes it with the string formatted like
7096 Perl_newSVpvf(pTHX_ const char* pat, ...)
7100 va_start(args, pat);
7101 sv = vnewSVpvf(pat, &args);
7106 /* backend for newSVpvf() and newSVpvf_nocontext() */
7109 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7114 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7121 Creates a new SV and copies a floating point value into it.
7122 The reference count for the SV is set to 1.
7128 Perl_newSVnv(pTHX_ NV n)
7141 Creates a new SV and copies an integer into it. The reference count for the
7148 Perl_newSViv(pTHX_ IV i)
7161 Creates a new SV and copies an unsigned integer into it.
7162 The reference count for the SV is set to 1.
7168 Perl_newSVuv(pTHX_ UV u)
7179 =for apidoc newRV_noinc
7181 Creates an RV wrapper for an SV. The reference count for the original
7182 SV is B<not> incremented.
7188 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7194 sv_upgrade(sv, SVt_RV);
7196 SvRV_set(sv, tmpRef);
7201 /* newRV_inc is the official function name to use now.
7202 * newRV_inc is in fact #defined to newRV in sv.h
7206 Perl_newRV(pTHX_ SV *sv)
7209 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7215 Creates a new SV which is an exact duplicate of the original SV.
7222 Perl_newSVsv(pTHX_ register SV *old)
7229 if (SvTYPE(old) == SVTYPEMASK) {
7230 if (ckWARN_d(WARN_INTERNAL))
7231 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7235 /* SV_GMAGIC is the default for sv_setv()
7236 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7237 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7238 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7243 =for apidoc sv_reset
7245 Underlying implementation for the C<reset> Perl function.
7246 Note that the perl-level function is vaguely deprecated.
7252 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7255 char todo[PERL_UCHAR_MAX+1];
7260 if (!*s) { /* reset ?? searches */
7261 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7263 PMOP *pm = (PMOP *) mg->mg_obj;
7265 pm->op_pmdynflags &= ~PMdf_USED;
7272 /* reset variables */
7274 if (!HvARRAY(stash))
7277 Zero(todo, 256, char);
7280 I32 i = (unsigned char)*s;
7284 max = (unsigned char)*s++;
7285 for ( ; i <= max; i++) {
7288 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7290 for (entry = HvARRAY(stash)[i];
7292 entry = HeNEXT(entry))
7297 if (!todo[(U8)*HeKEY(entry)])
7299 gv = (GV*)HeVAL(entry);
7302 if (SvTHINKFIRST(sv)) {
7303 if (!SvREADONLY(sv) && SvROK(sv))
7305 /* XXX Is this continue a bug? Why should THINKFIRST
7306 exempt us from resetting arrays and hashes? */
7310 if (SvTYPE(sv) >= SVt_PV) {
7312 if (SvPVX_const(sv) != NULL)
7320 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7322 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7325 # if defined(USE_ENVIRON_ARRAY)
7328 # endif /* USE_ENVIRON_ARRAY */
7339 Using various gambits, try to get an IO from an SV: the IO slot if its a
7340 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7341 named after the PV if we're a string.
7347 Perl_sv_2io(pTHX_ SV *sv)
7352 switch (SvTYPE(sv)) {
7360 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7364 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7366 return sv_2io(SvRV(sv));
7367 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7373 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7382 Using various gambits, try to get a CV from an SV; in addition, try if
7383 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7384 The flags in C<lref> are passed to sv_fetchsv.
7390 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7401 switch (SvTYPE(sv)) {
7420 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7421 tryAMAGICunDEREF(to_cv);
7424 if (SvTYPE(sv) == SVt_PVCV) {
7433 Perl_croak(aTHX_ "Not a subroutine reference");
7438 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7444 /* Some flags to gv_fetchsv mean don't really create the GV */
7445 if (SvTYPE(gv) != SVt_PVGV) {
7451 if (lref && !GvCVu(gv)) {
7455 gv_efullname3(tmpsv, gv, NULL);
7456 /* XXX this is probably not what they think they're getting.
7457 * It has the same effect as "sub name;", i.e. just a forward
7459 newSUB(start_subparse(FALSE, 0),
7460 newSVOP(OP_CONST, 0, tmpsv),
7464 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7474 Returns true if the SV has a true value by Perl's rules.
7475 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7476 instead use an in-line version.
7482 Perl_sv_true(pTHX_ register SV *sv)
7487 register const XPV* const tXpv = (XPV*)SvANY(sv);
7489 (tXpv->xpv_cur > 1 ||
7490 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7497 return SvIVX(sv) != 0;
7500 return SvNVX(sv) != 0.0;
7502 return sv_2bool(sv);
7508 =for apidoc sv_pvn_force
7510 Get a sensible string out of the SV somehow.
7511 A private implementation of the C<SvPV_force> macro for compilers which
7512 can't cope with complex macro expressions. Always use the macro instead.
7514 =for apidoc sv_pvn_force_flags
7516 Get a sensible string out of the SV somehow.
7517 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7518 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7519 implemented in terms of this function.
7520 You normally want to use the various wrapper macros instead: see
7521 C<SvPV_force> and C<SvPV_force_nomg>
7527 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7530 if (SvTHINKFIRST(sv) && !SvROK(sv))
7531 sv_force_normal_flags(sv, 0);
7541 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7542 const char * const ref = sv_reftype(sv,0);
7544 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7545 ref, OP_NAME(PL_op));
7547 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7549 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7550 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7552 s = sv_2pv_flags(sv, &len, flags);
7556 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7559 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7560 SvGROW(sv, len + 1);
7561 Move(s,SvPVX(sv),len,char);
7566 SvPOK_on(sv); /* validate pointer */
7568 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7569 PTR2UV(sv),SvPVX_const(sv)));
7572 return SvPVX_mutable(sv);
7576 =for apidoc sv_pvbyten_force
7578 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7584 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7586 sv_pvn_force(sv,lp);
7587 sv_utf8_downgrade(sv,0);
7593 =for apidoc sv_pvutf8n_force
7595 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7601 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7603 sv_pvn_force(sv,lp);
7604 sv_utf8_upgrade(sv);
7610 =for apidoc sv_reftype
7612 Returns a string describing what the SV is a reference to.
7618 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7620 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7621 inside return suggests a const propagation bug in g++. */
7622 if (ob && SvOBJECT(sv)) {
7623 char * const name = HvNAME_get(SvSTASH(sv));
7624 return name ? name : (char *) "__ANON__";
7627 switch (SvTYPE(sv)) {
7644 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7645 /* tied lvalues should appear to be
7646 * scalars for backwards compatitbility */
7647 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7648 ? "SCALAR" : "LVALUE");
7649 case SVt_PVAV: return "ARRAY";
7650 case SVt_PVHV: return "HASH";
7651 case SVt_PVCV: return "CODE";
7652 case SVt_PVGV: return "GLOB";
7653 case SVt_PVFM: return "FORMAT";
7654 case SVt_PVIO: return "IO";
7655 default: return "UNKNOWN";
7661 =for apidoc sv_isobject
7663 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7664 object. If the SV is not an RV, or if the object is not blessed, then this
7671 Perl_sv_isobject(pTHX_ SV *sv)
7687 Returns a boolean indicating whether the SV is blessed into the specified
7688 class. This does not check for subtypes; use C<sv_derived_from> to verify
7689 an inheritance relationship.
7695 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7706 hvname = HvNAME_get(SvSTASH(sv));
7710 return strEQ(hvname, name);
7716 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7717 it will be upgraded to one. If C<classname> is non-null then the new SV will
7718 be blessed in the specified package. The new SV is returned and its
7719 reference count is 1.
7725 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7732 SV_CHECK_THINKFIRST_COW_DROP(rv);
7735 if (SvTYPE(rv) >= SVt_PVMG) {
7736 const U32 refcnt = SvREFCNT(rv);
7740 SvREFCNT(rv) = refcnt;
7742 sv_upgrade(rv, SVt_RV);
7743 } else if (SvROK(rv)) {
7744 SvREFCNT_dec(SvRV(rv));
7745 } else if (SvTYPE(rv) < SVt_RV)
7746 sv_upgrade(rv, SVt_RV);
7747 else if (SvTYPE(rv) > SVt_RV) {
7758 HV* const stash = gv_stashpv(classname, TRUE);
7759 (void)sv_bless(rv, stash);
7765 =for apidoc sv_setref_pv
7767 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7768 argument will be upgraded to an RV. That RV will be modified to point to
7769 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7770 into the SV. The C<classname> argument indicates the package for the
7771 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7772 will have a reference count of 1, and the RV will be returned.
7774 Do not use with other Perl types such as HV, AV, SV, CV, because those
7775 objects will become corrupted by the pointer copy process.
7777 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7783 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7787 sv_setsv(rv, &PL_sv_undef);
7791 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7796 =for apidoc sv_setref_iv
7798 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7799 argument will be upgraded to an RV. That RV will be modified to point to
7800 the new SV. The C<classname> argument indicates the package for the
7801 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7802 will have a reference count of 1, and the RV will be returned.
7808 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7810 sv_setiv(newSVrv(rv,classname), iv);
7815 =for apidoc sv_setref_uv
7817 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7818 argument will be upgraded to an RV. That RV will be modified to point to
7819 the new SV. The C<classname> argument indicates the package for the
7820 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7821 will have a reference count of 1, and the RV will be returned.
7827 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7829 sv_setuv(newSVrv(rv,classname), uv);
7834 =for apidoc sv_setref_nv
7836 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7837 argument will be upgraded to an RV. That RV will be modified to point to
7838 the new SV. The C<classname> argument indicates the package for the
7839 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7840 will have a reference count of 1, and the RV will be returned.
7846 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7848 sv_setnv(newSVrv(rv,classname), nv);
7853 =for apidoc sv_setref_pvn
7855 Copies a string into a new SV, optionally blessing the SV. The length of the
7856 string must be specified with C<n>. The C<rv> argument will be upgraded to
7857 an RV. That RV will be modified to point to the new SV. The C<classname>
7858 argument indicates the package for the blessing. Set C<classname> to
7859 C<NULL> to avoid the blessing. The new SV will have a reference count
7860 of 1, and the RV will be returned.
7862 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7868 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7870 sv_setpvn(newSVrv(rv,classname), pv, n);
7875 =for apidoc sv_bless
7877 Blesses an SV into a specified package. The SV must be an RV. The package
7878 must be designated by its stash (see C<gv_stashpv()>). The reference count
7879 of the SV is unaffected.
7885 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7890 Perl_croak(aTHX_ "Can't bless non-reference value");
7892 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7893 if (SvREADONLY(tmpRef))
7894 Perl_croak(aTHX_ PL_no_modify);
7895 if (SvOBJECT(tmpRef)) {
7896 if (SvTYPE(tmpRef) != SVt_PVIO)
7898 SvREFCNT_dec(SvSTASH(tmpRef));
7901 SvOBJECT_on(tmpRef);
7902 if (SvTYPE(tmpRef) != SVt_PVIO)
7904 SvUPGRADE(tmpRef, SVt_PVMG);
7905 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7912 if(SvSMAGICAL(tmpRef))
7913 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7921 /* Downgrades a PVGV to a PVMG.
7925 S_sv_unglob(pTHX_ SV *sv)
7929 SV * const temp = sv_newmortal();
7931 assert(SvTYPE(sv) == SVt_PVGV);
7933 gv_efullname3(temp, (GV *) sv, "*");
7939 sv_del_backref((SV*)GvSTASH(sv), sv);
7943 if (GvNAME_HEK(sv)) {
7944 unshare_hek(GvNAME_HEK(sv));
7948 /* need to keep SvANY(sv) in the right arena */
7949 xpvmg = new_XPVMG();
7950 StructCopy(SvANY(sv), xpvmg, XPVMG);
7951 del_XPVGV(SvANY(sv));
7954 SvFLAGS(sv) &= ~SVTYPEMASK;
7955 SvFLAGS(sv) |= SVt_PVMG;
7957 /* Intentionally not calling any local SET magic, as this isn't so much a
7958 set operation as merely an internal storage change. */
7959 sv_setsv_flags(sv, temp, 0);
7963 =for apidoc sv_unref_flags
7965 Unsets the RV status of the SV, and decrements the reference count of
7966 whatever was being referenced by the RV. This can almost be thought of
7967 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7968 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7969 (otherwise the decrementing is conditional on the reference count being
7970 different from one or the reference being a readonly SV).
7977 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7979 SV* const target = SvRV(ref);
7981 if (SvWEAKREF(ref)) {
7982 sv_del_backref(target, ref);
7984 SvRV_set(ref, NULL);
7987 SvRV_set(ref, NULL);
7989 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7990 assigned to as BEGIN {$a = \"Foo"} will fail. */
7991 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7992 SvREFCNT_dec(target);
7993 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7994 sv_2mortal(target); /* Schedule for freeing later */
7998 =for apidoc sv_untaint
8000 Untaint an SV. Use C<SvTAINTED_off> instead.
8005 Perl_sv_untaint(pTHX_ SV *sv)
8007 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8008 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8015 =for apidoc sv_tainted
8017 Test an SV for taintedness. Use C<SvTAINTED> instead.
8022 Perl_sv_tainted(pTHX_ SV *sv)
8024 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8025 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8026 if (mg && (mg->mg_len & 1) )
8033 =for apidoc sv_setpviv
8035 Copies an integer into the given SV, also updating its string value.
8036 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8042 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8044 char buf[TYPE_CHARS(UV)];
8046 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8048 sv_setpvn(sv, ptr, ebuf - ptr);
8052 =for apidoc sv_setpviv_mg
8054 Like C<sv_setpviv>, but also handles 'set' magic.
8060 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8066 #if defined(PERL_IMPLICIT_CONTEXT)
8068 /* pTHX_ magic can't cope with varargs, so this is a no-context
8069 * version of the main function, (which may itself be aliased to us).
8070 * Don't access this version directly.
8074 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8078 va_start(args, pat);
8079 sv_vsetpvf(sv, pat, &args);
8083 /* pTHX_ magic can't cope with varargs, so this is a no-context
8084 * version of the main function, (which may itself be aliased to us).
8085 * Don't access this version directly.
8089 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8093 va_start(args, pat);
8094 sv_vsetpvf_mg(sv, pat, &args);
8100 =for apidoc sv_setpvf
8102 Works like C<sv_catpvf> but copies the text into the SV instead of
8103 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8109 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8112 va_start(args, pat);
8113 sv_vsetpvf(sv, pat, &args);
8118 =for apidoc sv_vsetpvf
8120 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8121 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8123 Usually used via its frontend C<sv_setpvf>.
8129 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8131 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8135 =for apidoc sv_setpvf_mg
8137 Like C<sv_setpvf>, but also handles 'set' magic.
8143 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8146 va_start(args, pat);
8147 sv_vsetpvf_mg(sv, pat, &args);
8152 =for apidoc sv_vsetpvf_mg
8154 Like C<sv_vsetpvf>, but also handles 'set' magic.
8156 Usually used via its frontend C<sv_setpvf_mg>.
8162 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8164 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8168 #if defined(PERL_IMPLICIT_CONTEXT)
8170 /* pTHX_ magic can't cope with varargs, so this is a no-context
8171 * version of the main function, (which may itself be aliased to us).
8172 * Don't access this version directly.
8176 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8180 va_start(args, pat);
8181 sv_vcatpvf(sv, pat, &args);
8185 /* pTHX_ magic can't cope with varargs, so this is a no-context
8186 * version of the main function, (which may itself be aliased to us).
8187 * Don't access this version directly.
8191 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8195 va_start(args, pat);
8196 sv_vcatpvf_mg(sv, pat, &args);
8202 =for apidoc sv_catpvf
8204 Processes its arguments like C<sprintf> and appends the formatted
8205 output to an SV. If the appended data contains "wide" characters
8206 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8207 and characters >255 formatted with %c), the original SV might get
8208 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8209 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8210 valid UTF-8; if the original SV was bytes, the pattern should be too.
8215 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8218 va_start(args, pat);
8219 sv_vcatpvf(sv, pat, &args);
8224 =for apidoc sv_vcatpvf
8226 Processes its arguments like C<vsprintf> and appends the formatted output
8227 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8229 Usually used via its frontend C<sv_catpvf>.
8235 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8237 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8241 =for apidoc sv_catpvf_mg
8243 Like C<sv_catpvf>, but also handles 'set' magic.
8249 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8252 va_start(args, pat);
8253 sv_vcatpvf_mg(sv, pat, &args);
8258 =for apidoc sv_vcatpvf_mg
8260 Like C<sv_vcatpvf>, but also handles 'set' magic.
8262 Usually used via its frontend C<sv_catpvf_mg>.
8268 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8270 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8275 =for apidoc sv_vsetpvfn
8277 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8280 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8286 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8288 sv_setpvn(sv, "", 0);
8289 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8293 S_expect_number(pTHX_ char** pattern)
8297 switch (**pattern) {
8298 case '1': case '2': case '3':
8299 case '4': case '5': case '6':
8300 case '7': case '8': case '9':
8301 var = *(*pattern)++ - '0';
8302 while (isDIGIT(**pattern)) {
8303 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8305 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8313 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8315 const int neg = nv < 0;
8324 if (uv & 1 && uv == nv)
8325 uv--; /* Round to even */
8327 const unsigned dig = uv % 10;
8340 =for apidoc sv_vcatpvfn
8342 Processes its arguments like C<vsprintf> and appends the formatted output
8343 to an SV. Uses an array of SVs if the C style variable argument list is
8344 missing (NULL). When running with taint checks enabled, indicates via
8345 C<maybe_tainted> if results are untrustworthy (often due to the use of
8348 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8354 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8355 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8356 vec_utf8 = DO_UTF8(vecsv);
8358 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8361 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8369 static const char nullstr[] = "(null)";
8371 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8372 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8374 /* Times 4: a decimal digit takes more than 3 binary digits.
8375 * NV_DIG: mantissa takes than many decimal digits.
8376 * Plus 32: Playing safe. */
8377 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8378 /* large enough for "%#.#f" --chip */
8379 /* what about long double NVs? --jhi */
8381 PERL_UNUSED_ARG(maybe_tainted);
8383 /* no matter what, this is a string now */
8384 (void)SvPV_force(sv, origlen);
8386 /* special-case "", "%s", and "%-p" (SVf - see below) */
8389 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8391 const char * const s = va_arg(*args, char*);
8392 sv_catpv(sv, s ? s : nullstr);
8394 else if (svix < svmax) {
8395 sv_catsv(sv, *svargs);
8399 if (args && patlen == 3 && pat[0] == '%' &&
8400 pat[1] == '-' && pat[2] == 'p') {
8401 argsv = va_arg(*args, SV*);
8402 sv_catsv(sv, argsv);
8406 #ifndef USE_LONG_DOUBLE
8407 /* special-case "%.<number>[gf]" */
8408 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8409 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8410 unsigned digits = 0;
8414 while (*pp >= '0' && *pp <= '9')
8415 digits = 10 * digits + (*pp++ - '0');
8416 if (pp - pat == (int)patlen - 1) {
8424 /* Add check for digits != 0 because it seems that some
8425 gconverts are buggy in this case, and we don't yet have
8426 a Configure test for this. */
8427 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8428 /* 0, point, slack */
8429 Gconvert(nv, (int)digits, 0, ebuf);
8431 if (*ebuf) /* May return an empty string for digits==0 */
8434 } else if (!digits) {
8437 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8438 sv_catpvn(sv, p, l);
8444 #endif /* !USE_LONG_DOUBLE */
8446 if (!args && svix < svmax && DO_UTF8(*svargs))
8449 patend = (char*)pat + patlen;
8450 for (p = (char*)pat; p < patend; p = q) {
8453 bool vectorize = FALSE;
8454 bool vectorarg = FALSE;
8455 bool vec_utf8 = FALSE;
8461 bool has_precis = FALSE;
8463 const I32 osvix = svix;
8464 bool is_utf8 = FALSE; /* is this item utf8? */
8465 #ifdef HAS_LDBL_SPRINTF_BUG
8466 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8467 with sfio - Allen <allens@cpan.org> */
8468 bool fix_ldbl_sprintf_bug = FALSE;
8472 U8 utf8buf[UTF8_MAXBYTES+1];
8473 STRLEN esignlen = 0;
8475 const char *eptr = NULL;
8478 const U8 *vecstr = NULL;
8485 /* we need a long double target in case HAS_LONG_DOUBLE but
8488 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8496 const char *dotstr = ".";
8497 STRLEN dotstrlen = 1;
8498 I32 efix = 0; /* explicit format parameter index */
8499 I32 ewix = 0; /* explicit width index */
8500 I32 epix = 0; /* explicit precision index */
8501 I32 evix = 0; /* explicit vector index */
8502 bool asterisk = FALSE;
8504 /* echo everything up to the next format specification */
8505 for (q = p; q < patend && *q != '%'; ++q) ;
8507 if (has_utf8 && !pat_utf8)
8508 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8510 sv_catpvn(sv, p, q - p);
8517 We allow format specification elements in this order:
8518 \d+\$ explicit format parameter index
8520 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8521 0 flag (as above): repeated to allow "v02"
8522 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8523 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8525 [%bcdefginopsuxDFOUX] format (mandatory)
8530 As of perl5.9.3, printf format checking is on by default.
8531 Internally, perl uses %p formats to provide an escape to
8532 some extended formatting. This block deals with those
8533 extensions: if it does not match, (char*)q is reset and
8534 the normal format processing code is used.
8536 Currently defined extensions are:
8537 %p include pointer address (standard)
8538 %-p (SVf) include an SV (previously %_)
8539 %-<num>p include an SV with precision <num>
8540 %1p (VDf) include a v-string (as %vd)
8541 %<num>p reserved for future extensions
8543 Robin Barker 2005-07-14
8550 n = expect_number(&q);
8557 argsv = va_arg(*args, SV*);
8558 eptr = SvPVx_const(argsv, elen);
8564 else if (n == vdNUMBER) { /* VDf */
8571 if (ckWARN_d(WARN_INTERNAL))
8572 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8573 "internal %%<num>p might conflict with future printf extensions");
8579 if ( (width = expect_number(&q)) ) {
8620 if ( (ewix = expect_number(&q)) )
8629 if ((vectorarg = asterisk)) {
8642 width = expect_number(&q);
8648 vecsv = va_arg(*args, SV*);
8650 vecsv = (evix > 0 && evix <= svmax)
8651 ? svargs[evix-1] : &PL_sv_undef;
8653 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8655 dotstr = SvPV_const(vecsv, dotstrlen);
8656 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8657 bad with tied or overloaded values that return UTF8. */
8660 else if (has_utf8) {
8661 vecsv = sv_mortalcopy(vecsv);
8662 sv_utf8_upgrade(vecsv);
8663 dotstr = SvPV_const(vecsv, dotstrlen);
8670 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8671 vecsv = svargs[efix ? efix-1 : svix++];
8672 vecstr = (U8*)SvPV_const(vecsv,veclen);
8673 vec_utf8 = DO_UTF8(vecsv);
8675 /* if this is a version object, we need to convert
8676 * back into v-string notation and then let the
8677 * vectorize happen normally
8679 if (sv_derived_from(vecsv, "version")) {
8680 char *version = savesvpv(vecsv);
8681 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8682 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8683 "vector argument not supported with alpha versions");
8686 vecsv = sv_newmortal();
8687 /* scan_vstring is expected to be called during
8688 * tokenization, so we need to fake up the end
8689 * of the buffer for it
8691 PL_bufend = version + veclen;
8692 scan_vstring(version, vecsv);
8693 vecstr = (U8*)SvPV_const(vecsv, veclen);
8694 vec_utf8 = DO_UTF8(vecsv);
8706 i = va_arg(*args, int);
8708 i = (ewix ? ewix <= svmax : svix < svmax) ?
8709 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8711 width = (i < 0) ? -i : i;
8721 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8723 /* XXX: todo, support specified precision parameter */
8727 i = va_arg(*args, int);
8729 i = (ewix ? ewix <= svmax : svix < svmax)
8730 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8731 precis = (i < 0) ? 0 : i;
8736 precis = precis * 10 + (*q++ - '0');
8745 case 'I': /* Ix, I32x, and I64x */
8747 if (q[1] == '6' && q[2] == '4') {
8753 if (q[1] == '3' && q[2] == '2') {
8763 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8774 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8775 if (*(q + 1) == 'l') { /* lld, llf */
8801 if (!vectorize && !args) {
8803 const I32 i = efix-1;
8804 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8806 argsv = (svix >= 0 && svix < svmax)
8807 ? svargs[svix++] : &PL_sv_undef;
8818 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8820 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8822 eptr = (char*)utf8buf;
8823 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8837 eptr = va_arg(*args, char*);
8839 #ifdef MACOS_TRADITIONAL
8840 /* On MacOS, %#s format is used for Pascal strings */
8845 elen = strlen(eptr);
8847 eptr = (char *)nullstr;
8848 elen = sizeof nullstr - 1;
8852 eptr = SvPVx_const(argsv, elen);
8853 if (DO_UTF8(argsv)) {
8854 if (has_precis && precis < elen) {
8856 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8859 if (width) { /* fudge width (can't fudge elen) */
8860 width += elen - sv_len_utf8(argsv);
8867 if (has_precis && elen > precis)
8874 if (alt || vectorize)
8876 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8897 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8906 esignbuf[esignlen++] = plus;
8910 case 'h': iv = (short)va_arg(*args, int); break;
8911 case 'l': iv = va_arg(*args, long); break;
8912 case 'V': iv = va_arg(*args, IV); break;
8913 default: iv = va_arg(*args, int); break;
8915 case 'q': iv = va_arg(*args, Quad_t); break;
8920 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8922 case 'h': iv = (short)tiv; break;
8923 case 'l': iv = (long)tiv; break;
8925 default: iv = tiv; break;
8927 case 'q': iv = (Quad_t)tiv; break;
8931 if ( !vectorize ) /* we already set uv above */
8936 esignbuf[esignlen++] = plus;
8940 esignbuf[esignlen++] = '-';
8983 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8994 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8995 case 'l': uv = va_arg(*args, unsigned long); break;
8996 case 'V': uv = va_arg(*args, UV); break;
8997 default: uv = va_arg(*args, unsigned); break;
8999 case 'q': uv = va_arg(*args, Uquad_t); break;
9004 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9006 case 'h': uv = (unsigned short)tuv; break;
9007 case 'l': uv = (unsigned long)tuv; break;
9009 default: uv = tuv; break;
9011 case 'q': uv = (Uquad_t)tuv; break;
9018 char *ptr = ebuf + sizeof ebuf;
9024 p = (char*)((c == 'X')
9025 ? "0123456789ABCDEF" : "0123456789abcdef");
9031 esignbuf[esignlen++] = '0';
9032 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9040 if (alt && *ptr != '0')
9051 esignbuf[esignlen++] = '0';
9052 esignbuf[esignlen++] = 'b';
9055 default: /* it had better be ten or less */
9059 } while (uv /= base);
9062 elen = (ebuf + sizeof ebuf) - ptr;
9066 zeros = precis - elen;
9067 else if (precis == 0 && elen == 1 && *eptr == '0')
9073 /* FLOATING POINT */
9076 c = 'f'; /* maybe %F isn't supported here */
9084 /* This is evil, but floating point is even more evil */
9086 /* for SV-style calling, we can only get NV
9087 for C-style calling, we assume %f is double;
9088 for simplicity we allow any of %Lf, %llf, %qf for long double
9092 #if defined(USE_LONG_DOUBLE)
9096 /* [perl #20339] - we should accept and ignore %lf rather than die */
9100 #if defined(USE_LONG_DOUBLE)
9101 intsize = args ? 0 : 'q';
9105 #if defined(HAS_LONG_DOUBLE)
9114 /* now we need (long double) if intsize == 'q', else (double) */
9116 #if LONG_DOUBLESIZE > DOUBLESIZE
9118 va_arg(*args, long double) :
9119 va_arg(*args, double)
9121 va_arg(*args, double)
9126 if (c != 'e' && c != 'E') {
9128 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9129 will cast our (long double) to (double) */
9130 (void)Perl_frexp(nv, &i);
9131 if (i == PERL_INT_MIN)
9132 Perl_die(aTHX_ "panic: frexp");
9134 need = BIT_DIGITS(i);
9136 need += has_precis ? precis : 6; /* known default */
9141 #ifdef HAS_LDBL_SPRINTF_BUG
9142 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9143 with sfio - Allen <allens@cpan.org> */
9146 # define MY_DBL_MAX DBL_MAX
9147 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9148 # if DOUBLESIZE >= 8
9149 # define MY_DBL_MAX 1.7976931348623157E+308L
9151 # define MY_DBL_MAX 3.40282347E+38L
9155 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9156 # define MY_DBL_MAX_BUG 1L
9158 # define MY_DBL_MAX_BUG MY_DBL_MAX
9162 # define MY_DBL_MIN DBL_MIN
9163 # else /* XXX guessing! -Allen */
9164 # if DOUBLESIZE >= 8
9165 # define MY_DBL_MIN 2.2250738585072014E-308L
9167 # define MY_DBL_MIN 1.17549435E-38L
9171 if ((intsize == 'q') && (c == 'f') &&
9172 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9174 /* it's going to be short enough that
9175 * long double precision is not needed */
9177 if ((nv <= 0L) && (nv >= -0L))
9178 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9180 /* would use Perl_fp_class as a double-check but not
9181 * functional on IRIX - see perl.h comments */
9183 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9184 /* It's within the range that a double can represent */
9185 #if defined(DBL_MAX) && !defined(DBL_MIN)
9186 if ((nv >= ((long double)1/DBL_MAX)) ||
9187 (nv <= (-(long double)1/DBL_MAX)))
9189 fix_ldbl_sprintf_bug = TRUE;
9192 if (fix_ldbl_sprintf_bug == TRUE) {
9202 # undef MY_DBL_MAX_BUG
9205 #endif /* HAS_LDBL_SPRINTF_BUG */
9207 need += 20; /* fudge factor */
9208 if (PL_efloatsize < need) {
9209 Safefree(PL_efloatbuf);
9210 PL_efloatsize = need + 20; /* more fudge */
9211 Newx(PL_efloatbuf, PL_efloatsize, char);
9212 PL_efloatbuf[0] = '\0';
9215 if ( !(width || left || plus || alt) && fill != '0'
9216 && has_precis && intsize != 'q' ) { /* Shortcuts */
9217 /* See earlier comment about buggy Gconvert when digits,
9219 if ( c == 'g' && precis) {
9220 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9221 /* May return an empty string for digits==0 */
9222 if (*PL_efloatbuf) {
9223 elen = strlen(PL_efloatbuf);
9224 goto float_converted;
9226 } else if ( c == 'f' && !precis) {
9227 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9232 char *ptr = ebuf + sizeof ebuf;
9235 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9236 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9237 if (intsize == 'q') {
9238 /* Copy the one or more characters in a long double
9239 * format before the 'base' ([efgEFG]) character to
9240 * the format string. */
9241 static char const prifldbl[] = PERL_PRIfldbl;
9242 char const *p = prifldbl + sizeof(prifldbl) - 3;
9243 while (p >= prifldbl) { *--ptr = *p--; }
9248 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9253 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9265 /* No taint. Otherwise we are in the strange situation
9266 * where printf() taints but print($float) doesn't.
9268 #if defined(HAS_LONG_DOUBLE)
9269 elen = ((intsize == 'q')
9270 # ifdef USE_SNPRINTF
9271 ? snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9272 : snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9274 ? my_sprintf(PL_efloatbuf, ptr, nv)
9275 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9276 # endif /* #ifdef USE_SNPRINTF */
9278 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9282 eptr = PL_efloatbuf;
9290 i = SvCUR(sv) - origlen;
9293 case 'h': *(va_arg(*args, short*)) = i; break;
9294 default: *(va_arg(*args, int*)) = i; break;
9295 case 'l': *(va_arg(*args, long*)) = i; break;
9296 case 'V': *(va_arg(*args, IV*)) = i; break;
9298 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9303 sv_setuv_mg(argsv, (UV)i);
9304 continue; /* not "break" */
9311 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9312 && ckWARN(WARN_PRINTF))
9314 SV * const msg = sv_newmortal();
9315 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9316 (PL_op->op_type == OP_PRTF) ? "" : "s");
9319 Perl_sv_catpvf(aTHX_ msg,
9320 "\"%%%c\"", c & 0xFF);
9322 Perl_sv_catpvf(aTHX_ msg,
9323 "\"%%\\%03"UVof"\"",
9326 sv_catpvs(msg, "end of string");
9327 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9330 /* output mangled stuff ... */
9336 /* ... right here, because formatting flags should not apply */
9337 SvGROW(sv, SvCUR(sv) + elen + 1);
9339 Copy(eptr, p, elen, char);
9342 SvCUR_set(sv, p - SvPVX_const(sv));
9344 continue; /* not "break" */
9347 /* calculate width before utf8_upgrade changes it */
9348 have = esignlen + zeros + elen;
9350 Perl_croak_nocontext(PL_memory_wrap);
9352 if (is_utf8 != has_utf8) {
9355 sv_utf8_upgrade(sv);
9358 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9359 sv_utf8_upgrade(nsv);
9360 eptr = SvPVX_const(nsv);
9363 SvGROW(sv, SvCUR(sv) + elen + 1);
9368 need = (have > width ? have : width);
9371 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9372 Perl_croak_nocontext(PL_memory_wrap);
9373 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9375 if (esignlen && fill == '0') {
9377 for (i = 0; i < (int)esignlen; i++)
9381 memset(p, fill, gap);
9384 if (esignlen && fill != '0') {
9386 for (i = 0; i < (int)esignlen; i++)
9391 for (i = zeros; i; i--)
9395 Copy(eptr, p, elen, char);
9399 memset(p, ' ', gap);
9404 Copy(dotstr, p, dotstrlen, char);
9408 vectorize = FALSE; /* done iterating over vecstr */
9415 SvCUR_set(sv, p - SvPVX_const(sv));
9423 /* =========================================================================
9425 =head1 Cloning an interpreter
9427 All the macros and functions in this section are for the private use of
9428 the main function, perl_clone().
9430 The foo_dup() functions make an exact copy of an existing foo thinngy.
9431 During the course of a cloning, a hash table is used to map old addresses
9432 to new addresses. The table is created and manipulated with the
9433 ptr_table_* functions.
9437 ============================================================================*/
9440 #if defined(USE_ITHREADS)
9442 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9443 #ifndef GpREFCNT_inc
9444 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9448 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9449 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9450 please unmerge ss_dup. */
9451 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9452 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9453 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9454 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9455 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9456 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9457 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9458 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9459 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9460 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9461 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9462 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9463 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9464 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9467 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9468 regcomp.c. AMS 20010712 */
9471 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9476 struct reg_substr_datum *s;
9479 return (REGEXP *)NULL;
9481 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9484 len = r->offsets[0];
9485 npar = r->nparens+1;
9487 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9488 Copy(r->program, ret->program, len+1, regnode);
9490 Newx(ret->startp, npar, I32);
9491 Copy(r->startp, ret->startp, npar, I32);
9492 Newx(ret->endp, npar, I32);
9493 Copy(r->startp, ret->startp, npar, I32);
9495 Newx(ret->substrs, 1, struct reg_substr_data);
9496 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9497 s->min_offset = r->substrs->data[i].min_offset;
9498 s->max_offset = r->substrs->data[i].max_offset;
9499 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9500 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9503 ret->regstclass = NULL;
9506 const int count = r->data->count;
9509 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9510 char, struct reg_data);
9511 Newx(d->what, count, U8);
9514 for (i = 0; i < count; i++) {
9515 d->what[i] = r->data->what[i];
9516 switch (d->what[i]) {
9517 /* legal options are one of: sfpont
9518 see also regcomp.h and pregfree() */
9520 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9523 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9526 /* This is cheating. */
9527 Newx(d->data[i], 1, struct regnode_charclass_class);
9528 StructCopy(r->data->data[i], d->data[i],
9529 struct regnode_charclass_class);
9530 ret->regstclass = (regnode*)d->data[i];
9533 /* Compiled op trees are readonly, and can thus be
9534 shared without duplication. */
9536 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9540 d->data[i] = r->data->data[i];
9543 d->data[i] = r->data->data[i];
9545 ((reg_trie_data*)d->data[i])->refcount++;
9549 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9558 Newx(ret->offsets, 2*len+1, U32);
9559 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9561 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9562 ret->refcnt = r->refcnt;
9563 ret->minlen = r->minlen;
9564 ret->prelen = r->prelen;
9565 ret->nparens = r->nparens;
9566 ret->lastparen = r->lastparen;
9567 ret->lastcloseparen = r->lastcloseparen;
9568 ret->reganch = r->reganch;
9570 ret->sublen = r->sublen;
9572 if (RX_MATCH_COPIED(ret))
9573 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9576 #ifdef PERL_OLD_COPY_ON_WRITE
9577 ret->saved_copy = NULL;
9580 ptr_table_store(PL_ptr_table, r, ret);
9584 /* duplicate a file handle */
9587 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9591 PERL_UNUSED_ARG(type);
9594 return (PerlIO*)NULL;
9596 /* look for it in the table first */
9597 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9601 /* create anew and remember what it is */
9602 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9603 ptr_table_store(PL_ptr_table, fp, ret);
9607 /* duplicate a directory handle */
9610 Perl_dirp_dup(pTHX_ DIR *dp)
9612 PERL_UNUSED_CONTEXT;
9619 /* duplicate a typeglob */
9622 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9628 /* look for it in the table first */
9629 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9633 /* create anew and remember what it is */
9635 ptr_table_store(PL_ptr_table, gp, ret);
9638 ret->gp_refcnt = 0; /* must be before any other dups! */
9639 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9640 ret->gp_io = io_dup_inc(gp->gp_io, param);
9641 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9642 ret->gp_av = av_dup_inc(gp->gp_av, param);
9643 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9644 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9645 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9646 ret->gp_cvgen = gp->gp_cvgen;
9647 ret->gp_line = gp->gp_line;
9648 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9652 /* duplicate a chain of magic */
9655 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9657 MAGIC *mgprev = (MAGIC*)NULL;
9660 return (MAGIC*)NULL;
9661 /* look for it in the table first */
9662 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9666 for (; mg; mg = mg->mg_moremagic) {
9668 Newxz(nmg, 1, MAGIC);
9670 mgprev->mg_moremagic = nmg;
9673 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9674 nmg->mg_private = mg->mg_private;
9675 nmg->mg_type = mg->mg_type;
9676 nmg->mg_flags = mg->mg_flags;
9677 if (mg->mg_type == PERL_MAGIC_qr) {
9678 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9680 else if(mg->mg_type == PERL_MAGIC_backref) {
9681 /* The backref AV has its reference count deliberately bumped by
9683 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9685 else if (mg->mg_type == PERL_MAGIC_symtab) {
9686 nmg->mg_obj = mg->mg_obj;
9689 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9690 ? sv_dup_inc(mg->mg_obj, param)
9691 : sv_dup(mg->mg_obj, param);
9693 nmg->mg_len = mg->mg_len;
9694 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9695 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9696 if (mg->mg_len > 0) {
9697 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9698 if (mg->mg_type == PERL_MAGIC_overload_table &&
9699 AMT_AMAGIC((AMT*)mg->mg_ptr))
9701 const AMT * const amtp = (AMT*)mg->mg_ptr;
9702 AMT * const namtp = (AMT*)nmg->mg_ptr;
9704 for (i = 1; i < NofAMmeth; i++) {
9705 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9709 else if (mg->mg_len == HEf_SVKEY)
9710 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9712 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9713 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9720 /* create a new pointer-mapping table */
9723 Perl_ptr_table_new(pTHX)
9726 PERL_UNUSED_CONTEXT;
9728 Newxz(tbl, 1, PTR_TBL_t);
9731 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9735 #define PTR_TABLE_HASH(ptr) \
9736 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9739 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9740 following define) and at call to new_body_inline made below in
9741 Perl_ptr_table_store()
9744 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9746 /* map an existing pointer using a table */
9748 STATIC PTR_TBL_ENT_t *
9749 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9750 PTR_TBL_ENT_t *tblent;
9751 const UV hash = PTR_TABLE_HASH(sv);
9753 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9754 for (; tblent; tblent = tblent->next) {
9755 if (tblent->oldval == sv)
9762 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9764 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9765 PERL_UNUSED_CONTEXT;
9766 return tblent ? tblent->newval : NULL;
9769 /* add a new entry to a pointer-mapping table */
9772 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9774 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9775 PERL_UNUSED_CONTEXT;
9778 tblent->newval = newsv;
9780 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9782 new_body_inline(tblent, PTE_SVSLOT);
9784 tblent->oldval = oldsv;
9785 tblent->newval = newsv;
9786 tblent->next = tbl->tbl_ary[entry];
9787 tbl->tbl_ary[entry] = tblent;
9789 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9790 ptr_table_split(tbl);
9794 /* double the hash bucket size of an existing ptr table */
9797 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9799 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9800 const UV oldsize = tbl->tbl_max + 1;
9801 UV newsize = oldsize * 2;
9803 PERL_UNUSED_CONTEXT;
9805 Renew(ary, newsize, PTR_TBL_ENT_t*);
9806 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9807 tbl->tbl_max = --newsize;
9809 for (i=0; i < oldsize; i++, ary++) {
9810 PTR_TBL_ENT_t **curentp, **entp, *ent;
9813 curentp = ary + oldsize;
9814 for (entp = ary, ent = *ary; ent; ent = *entp) {
9815 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9817 ent->next = *curentp;
9827 /* remove all the entries from a ptr table */
9830 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9832 if (tbl && tbl->tbl_items) {
9833 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9834 UV riter = tbl->tbl_max;
9837 PTR_TBL_ENT_t *entry = array[riter];
9840 PTR_TBL_ENT_t * const oentry = entry;
9841 entry = entry->next;
9850 /* clear and free a ptr table */
9853 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9858 ptr_table_clear(tbl);
9859 Safefree(tbl->tbl_ary);
9865 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9868 SvRV_set(dstr, SvWEAKREF(sstr)
9869 ? sv_dup(SvRV(sstr), param)
9870 : sv_dup_inc(SvRV(sstr), param));
9873 else if (SvPVX_const(sstr)) {
9874 /* Has something there */
9876 /* Normal PV - clone whole allocated space */
9877 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9878 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9879 /* Not that normal - actually sstr is copy on write.
9880 But we are a true, independant SV, so: */
9881 SvREADONLY_off(dstr);
9886 /* Special case - not normally malloced for some reason */
9887 if (isGV_with_GP(sstr)) {
9888 /* Don't need to do anything here. */
9890 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9891 /* A "shared" PV - clone it as "shared" PV */
9893 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9897 /* Some other special case - random pointer */
9898 SvPV_set(dstr, SvPVX(sstr));
9904 if (SvTYPE(dstr) == SVt_RV)
9905 SvRV_set(dstr, NULL);
9907 SvPV_set(dstr, NULL);
9911 /* duplicate an SV of any type (including AV, HV etc) */
9914 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9919 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9921 /* look for it in the table first */
9922 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9926 if(param->flags & CLONEf_JOIN_IN) {
9927 /** We are joining here so we don't want do clone
9928 something that is bad **/
9929 if (SvTYPE(sstr) == SVt_PVHV) {
9930 const char * const hvname = HvNAME_get(sstr);
9932 /** don't clone stashes if they already exist **/
9933 return (SV*)gv_stashpv(hvname,0);
9937 /* create anew and remember what it is */
9940 #ifdef DEBUG_LEAKING_SCALARS
9941 dstr->sv_debug_optype = sstr->sv_debug_optype;
9942 dstr->sv_debug_line = sstr->sv_debug_line;
9943 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9944 dstr->sv_debug_cloned = 1;
9945 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9948 ptr_table_store(PL_ptr_table, sstr, dstr);
9951 SvFLAGS(dstr) = SvFLAGS(sstr);
9952 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9953 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9956 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9957 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9958 PL_watch_pvx, SvPVX_const(sstr));
9961 /* don't clone objects whose class has asked us not to */
9962 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9963 SvFLAGS(dstr) &= ~SVTYPEMASK;
9968 switch (SvTYPE(sstr)) {
9973 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9974 SvIV_set(dstr, SvIVX(sstr));
9977 SvANY(dstr) = new_XNV();
9978 SvNV_set(dstr, SvNVX(sstr));
9981 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9982 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9986 /* These are all the types that need complex bodies allocating. */
9988 const svtype sv_type = SvTYPE(sstr);
9989 const struct body_details *const sv_type_details
9990 = bodies_by_type + sv_type;
9994 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9998 if (GvUNIQUE((GV*)sstr)) {
9999 NOOP; /* Do sharing here, and fall through */
10012 assert(sv_type_details->body_size);
10013 if (sv_type_details->arena) {
10014 new_body_inline(new_body, sv_type);
10016 = (void*)((char*)new_body - sv_type_details->offset);
10018 new_body = new_NOARENA(sv_type_details);
10022 SvANY(dstr) = new_body;
10025 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10026 ((char*)SvANY(dstr)) + sv_type_details->offset,
10027 sv_type_details->copy, char);
10029 Copy(((char*)SvANY(sstr)),
10030 ((char*)SvANY(dstr)),
10031 sv_type_details->body_size + sv_type_details->offset, char);
10034 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10035 && !isGV_with_GP(dstr))
10036 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10038 /* The Copy above means that all the source (unduplicated) pointers
10039 are now in the destination. We can check the flags and the
10040 pointers in either, but it's possible that there's less cache
10041 missing by always going for the destination.
10042 FIXME - instrument and check that assumption */
10043 if (sv_type >= SVt_PVMG) {
10045 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
10046 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
10047 } else if (SvMAGIC(dstr))
10048 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10050 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10053 /* The cast silences a GCC warning about unhandled types. */
10054 switch ((int)sv_type) {
10066 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10067 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10068 LvTARG(dstr) = dstr;
10069 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10070 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10072 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10075 if (GvNAME_HEK(dstr))
10076 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10078 /* Don't call sv_add_backref here as it's going to be created
10079 as part of the magic cloning of the symbol table. */
10080 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10081 if(isGV_with_GP(sstr)) {
10082 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10083 at the point of this comment. */
10084 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10085 (void)GpREFCNT_inc(GvGP(dstr));
10087 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10090 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10091 if (IoOFP(dstr) == IoIFP(sstr))
10092 IoOFP(dstr) = IoIFP(dstr);
10094 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10095 /* PL_rsfp_filters entries have fake IoDIRP() */
10096 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10097 /* I have no idea why fake dirp (rsfps)
10098 should be treated differently but otherwise
10099 we end up with leaks -- sky*/
10100 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10101 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10102 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10104 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10105 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10106 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10107 if (IoDIRP(dstr)) {
10108 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10111 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10114 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10115 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10116 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10119 if (AvARRAY((AV*)sstr)) {
10120 SV **dst_ary, **src_ary;
10121 SSize_t items = AvFILLp((AV*)sstr) + 1;
10123 src_ary = AvARRAY((AV*)sstr);
10124 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10125 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10126 SvPV_set(dstr, (char*)dst_ary);
10127 AvALLOC((AV*)dstr) = dst_ary;
10128 if (AvREAL((AV*)sstr)) {
10129 while (items-- > 0)
10130 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10133 while (items-- > 0)
10134 *dst_ary++ = sv_dup(*src_ary++, param);
10136 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10137 while (items-- > 0) {
10138 *dst_ary++ = &PL_sv_undef;
10142 SvPV_set(dstr, NULL);
10143 AvALLOC((AV*)dstr) = (SV**)NULL;
10148 HEK *hvname = NULL;
10150 if (HvARRAY((HV*)sstr)) {
10152 const bool sharekeys = !!HvSHAREKEYS(sstr);
10153 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10154 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10156 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10157 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10159 HvARRAY(dstr) = (HE**)darray;
10160 while (i <= sxhv->xhv_max) {
10161 const HE *source = HvARRAY(sstr)[i];
10162 HvARRAY(dstr)[i] = source
10163 ? he_dup(source, sharekeys, param) : 0;
10167 struct xpvhv_aux * const saux = HvAUX(sstr);
10168 struct xpvhv_aux * const daux = HvAUX(dstr);
10169 /* This flag isn't copied. */
10170 /* SvOOK_on(hv) attacks the IV flags. */
10171 SvFLAGS(dstr) |= SVf_OOK;
10173 hvname = saux->xhv_name;
10175 = hvname ? hek_dup(hvname, param) : hvname;
10177 daux->xhv_riter = saux->xhv_riter;
10178 daux->xhv_eiter = saux->xhv_eiter
10179 ? he_dup(saux->xhv_eiter,
10180 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10181 daux->xhv_backreferences = saux->xhv_backreferences
10182 ? (AV*) SvREFCNT_inc(
10184 xhv_backreferences,
10190 SvPV_set(dstr, NULL);
10192 /* Record stashes for possible cloning in Perl_clone(). */
10194 av_push(param->stashes, dstr);
10198 if (!(param->flags & CLONEf_COPY_STACKS)) {
10202 /* NOTE: not refcounted */
10203 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10205 if (!CvISXSUB(dstr))
10206 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10208 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10209 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10210 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10211 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10213 /* don't dup if copying back - CvGV isn't refcounted, so the
10214 * duped GV may never be freed. A bit of a hack! DAPM */
10215 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10216 NULL : gv_dup(CvGV(dstr), param) ;
10217 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10219 CvWEAKOUTSIDE(sstr)
10220 ? cv_dup( CvOUTSIDE(dstr), param)
10221 : cv_dup_inc(CvOUTSIDE(dstr), param);
10222 if (!CvISXSUB(dstr))
10223 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10229 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10235 /* duplicate a context */
10238 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10240 PERL_CONTEXT *ncxs;
10243 return (PERL_CONTEXT*)NULL;
10245 /* look for it in the table first */
10246 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10250 /* create anew and remember what it is */
10251 Newxz(ncxs, max + 1, PERL_CONTEXT);
10252 ptr_table_store(PL_ptr_table, cxs, ncxs);
10255 PERL_CONTEXT * const cx = &cxs[ix];
10256 PERL_CONTEXT * const ncx = &ncxs[ix];
10257 ncx->cx_type = cx->cx_type;
10258 if (CxTYPE(cx) == CXt_SUBST) {
10259 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10262 ncx->blk_oldsp = cx->blk_oldsp;
10263 ncx->blk_oldcop = cx->blk_oldcop;
10264 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10265 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10266 ncx->blk_oldpm = cx->blk_oldpm;
10267 ncx->blk_gimme = cx->blk_gimme;
10268 switch (CxTYPE(cx)) {
10270 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10271 ? cv_dup_inc(cx->blk_sub.cv, param)
10272 : cv_dup(cx->blk_sub.cv,param));
10273 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10274 ? av_dup_inc(cx->blk_sub.argarray, param)
10276 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10277 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10278 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10279 ncx->blk_sub.lval = cx->blk_sub.lval;
10280 ncx->blk_sub.retop = cx->blk_sub.retop;
10283 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10284 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10285 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10286 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10287 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10288 ncx->blk_eval.retop = cx->blk_eval.retop;
10291 ncx->blk_loop.label = cx->blk_loop.label;
10292 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10293 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10294 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10295 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10296 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10297 ? cx->blk_loop.iterdata
10298 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10299 ncx->blk_loop.oldcomppad
10300 = (PAD*)ptr_table_fetch(PL_ptr_table,
10301 cx->blk_loop.oldcomppad);
10302 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10303 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10304 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10305 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10306 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10309 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10310 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10311 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10312 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10313 ncx->blk_sub.retop = cx->blk_sub.retop;
10325 /* duplicate a stack info structure */
10328 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10333 return (PERL_SI*)NULL;
10335 /* look for it in the table first */
10336 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10340 /* create anew and remember what it is */
10341 Newxz(nsi, 1, PERL_SI);
10342 ptr_table_store(PL_ptr_table, si, nsi);
10344 nsi->si_stack = av_dup_inc(si->si_stack, param);
10345 nsi->si_cxix = si->si_cxix;
10346 nsi->si_cxmax = si->si_cxmax;
10347 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10348 nsi->si_type = si->si_type;
10349 nsi->si_prev = si_dup(si->si_prev, param);
10350 nsi->si_next = si_dup(si->si_next, param);
10351 nsi->si_markoff = si->si_markoff;
10356 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10357 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10358 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10359 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10360 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10361 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10362 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10363 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10364 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10365 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10366 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10367 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10368 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10369 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10372 #define pv_dup_inc(p) SAVEPV(p)
10373 #define pv_dup(p) SAVEPV(p)
10374 #define svp_dup_inc(p,pp) any_dup(p,pp)
10376 /* map any object to the new equivent - either something in the
10377 * ptr table, or something in the interpreter structure
10381 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10386 return (void*)NULL;
10388 /* look for it in the table first */
10389 ret = ptr_table_fetch(PL_ptr_table, v);
10393 /* see if it is part of the interpreter structure */
10394 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10395 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10403 /* duplicate the save stack */
10406 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10408 ANY * const ss = proto_perl->Tsavestack;
10409 const I32 max = proto_perl->Tsavestack_max;
10410 I32 ix = proto_perl->Tsavestack_ix;
10422 void (*dptr) (void*);
10423 void (*dxptr) (pTHX_ void*);
10425 Newxz(nss, max, ANY);
10428 I32 i = POPINT(ss,ix);
10429 TOPINT(nss,ix) = i;
10431 case SAVEt_ITEM: /* normal string */
10432 case SAVEt_SV: /* scalar reference */
10433 sv = (SV*)POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10435 sv = (SV*)POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10438 case SAVEt_SHARED_PVREF: /* char* in shared space */
10439 c = (char*)POPPTR(ss,ix);
10440 TOPPTR(nss,ix) = savesharedpv(c);
10441 ptr = POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10444 case SAVEt_GENERIC_SVREF: /* generic sv */
10445 case SAVEt_SVREF: /* scalar reference */
10446 sv = (SV*)POPPTR(ss,ix);
10447 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10448 ptr = POPPTR(ss,ix);
10449 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10451 case SAVEt_HV: /* hash reference */
10452 case SAVEt_AV: /* array reference */
10453 sv = POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10455 gv = (GV*)POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = gv_dup(gv, param);
10458 case SAVEt_INT: /* int reference */
10459 ptr = POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 intval = (int)POPINT(ss,ix);
10462 TOPINT(nss,ix) = intval;
10464 case SAVEt_LONG: /* long reference */
10465 ptr = POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10467 longval = (long)POPLONG(ss,ix);
10468 TOPLONG(nss,ix) = longval;
10470 case SAVEt_I32: /* I32 reference */
10471 case SAVEt_I16: /* I16 reference */
10472 case SAVEt_I8: /* I8 reference */
10473 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10474 ptr = POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 TOPINT(nss,ix) = i;
10479 case SAVEt_IV: /* IV reference */
10480 ptr = POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10483 TOPIV(nss,ix) = iv;
10485 case SAVEt_HPTR: /* HV* reference */
10486 case SAVEt_APTR: /* AV* reference */
10487 case SAVEt_SPTR: /* SV* reference */
10488 ptr = POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10490 sv = (SV*)POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = sv_dup(sv, param);
10493 case SAVEt_VPTR: /* random* reference */
10494 ptr = POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10496 ptr = POPPTR(ss,ix);
10497 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10499 case SAVEt_GENERIC_PVREF: /* generic char* */
10500 case SAVEt_PPTR: /* char* reference */
10501 ptr = POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10503 c = (char*)POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = pv_dup(c);
10507 gv = (GV*)POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = gv_dup(gv, param);
10510 case SAVEt_GP: /* scalar reference */
10511 gp = (GP*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10513 (void)GpREFCNT_inc(gp);
10514 gv = (GV*)POPPTR(ss,ix);
10515 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10516 c = (char*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = pv_dup(c);
10519 TOPIV(nss,ix) = iv;
10521 TOPIV(nss,ix) = iv;
10524 case SAVEt_MORTALIZESV:
10525 sv = (SV*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10529 ptr = POPPTR(ss,ix);
10530 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10531 /* these are assumed to be refcounted properly */
10533 switch (((OP*)ptr)->op_type) {
10535 case OP_LEAVESUBLV:
10539 case OP_LEAVEWRITE:
10540 TOPPTR(nss,ix) = ptr;
10545 TOPPTR(nss,ix) = NULL;
10550 TOPPTR(nss,ix) = NULL;
10553 c = (char*)POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = pv_dup_inc(c);
10556 case SAVEt_CLEARSV:
10557 longval = POPLONG(ss,ix);
10558 TOPLONG(nss,ix) = longval;
10561 hv = (HV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10563 c = (char*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = pv_dup_inc(c);
10566 TOPINT(nss,ix) = i;
10568 case SAVEt_DESTRUCTOR:
10569 ptr = POPPTR(ss,ix);
10570 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10571 dptr = POPDPTR(ss,ix);
10572 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10573 any_dup(FPTR2DPTR(void *, dptr),
10576 case SAVEt_DESTRUCTOR_X:
10577 ptr = POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10579 dxptr = POPDXPTR(ss,ix);
10580 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10581 any_dup(FPTR2DPTR(void *, dxptr),
10584 case SAVEt_REGCONTEXT:
10587 TOPINT(nss,ix) = i;
10590 case SAVEt_STACK_POS: /* Position on Perl stack */
10592 TOPINT(nss,ix) = i;
10594 case SAVEt_AELEM: /* array element */
10595 sv = (SV*)POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10598 TOPINT(nss,ix) = i;
10599 av = (AV*)POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = av_dup_inc(av, param);
10602 case SAVEt_HELEM: /* hash element */
10603 sv = (SV*)POPPTR(ss,ix);
10604 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10605 sv = (SV*)POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10607 hv = (HV*)POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10611 ptr = POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = ptr;
10616 TOPINT(nss,ix) = i;
10617 ptr = POPPTR(ss,ix);
10620 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10621 HINTS_REFCNT_UNLOCK;
10623 TOPPTR(nss,ix) = ptr;
10624 if (i & HINT_LOCALIZE_HH) {
10625 hv = (HV*)POPPTR(ss,ix);
10626 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10629 case SAVEt_COMPPAD:
10630 av = (AV*)POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = av_dup(av, param);
10634 longval = (long)POPLONG(ss,ix);
10635 TOPLONG(nss,ix) = longval;
10636 ptr = POPPTR(ss,ix);
10637 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10638 sv = (SV*)POPPTR(ss,ix);
10639 TOPPTR(nss,ix) = sv_dup(sv, param);
10642 ptr = POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10644 longval = (long)POPBOOL(ss,ix);
10645 TOPBOOL(nss,ix) = (bool)longval;
10647 case SAVEt_SET_SVFLAGS:
10649 TOPINT(nss,ix) = i;
10651 TOPINT(nss,ix) = i;
10652 sv = (SV*)POPPTR(ss,ix);
10653 TOPPTR(nss,ix) = sv_dup(sv, param);
10655 case SAVEt_RE_STATE:
10657 const struct re_save_state *const old_state
10658 = (struct re_save_state *)
10659 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10660 struct re_save_state *const new_state
10661 = (struct re_save_state *)
10662 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10664 Copy(old_state, new_state, 1, struct re_save_state);
10665 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10667 new_state->re_state_bostr
10668 = pv_dup(old_state->re_state_bostr);
10669 new_state->re_state_reginput
10670 = pv_dup(old_state->re_state_reginput);
10671 new_state->re_state_regeol
10672 = pv_dup(old_state->re_state_regeol);
10673 new_state->re_state_regstartp
10674 = any_dup(old_state->re_state_regstartp, proto_perl);
10675 new_state->re_state_regendp
10676 = any_dup(old_state->re_state_regendp, proto_perl);
10677 new_state->re_state_reglastparen
10678 = any_dup(old_state->re_state_reglastparen, proto_perl);
10679 new_state->re_state_reglastcloseparen
10680 = any_dup(old_state->re_state_reglastcloseparen,
10682 /* XXX This just has to be broken. The old save_re_context
10683 code did SAVEGENERICPV(PL_reg_start_tmp);
10684 PL_reg_start_tmp is char **.
10685 Look above to what the dup code does for
10686 SAVEt_GENERIC_PVREF
10687 It can never have worked.
10688 So this is merely a faithful copy of the exiting bug: */
10689 new_state->re_state_reg_start_tmp
10690 = (char **) pv_dup((char *)
10691 old_state->re_state_reg_start_tmp);
10692 /* I assume that it only ever "worked" because no-one called
10693 (pseudo)fork while the regexp engine had re-entered itself.
10695 #ifdef PERL_OLD_COPY_ON_WRITE
10696 new_state->re_state_nrs
10697 = sv_dup(old_state->re_state_nrs, param);
10699 new_state->re_state_reg_magic
10700 = any_dup(old_state->re_state_reg_magic, proto_perl);
10701 new_state->re_state_reg_oldcurpm
10702 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10703 new_state->re_state_reg_curpm
10704 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10705 new_state->re_state_reg_oldsaved
10706 = pv_dup(old_state->re_state_reg_oldsaved);
10707 new_state->re_state_reg_poscache
10708 = pv_dup(old_state->re_state_reg_poscache);
10709 new_state->re_state_reg_starttry
10710 = pv_dup(old_state->re_state_reg_starttry);
10713 case SAVEt_COMPILE_WARNINGS:
10714 ptr = POPPTR(ss,ix);
10715 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10718 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10726 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10727 * flag to the result. This is done for each stash before cloning starts,
10728 * so we know which stashes want their objects cloned */
10731 do_mark_cloneable_stash(pTHX_ SV *sv)
10733 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10735 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10736 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10737 if (cloner && GvCV(cloner)) {
10744 XPUSHs(sv_2mortal(newSVhek(hvname)));
10746 call_sv((SV*)GvCV(cloner), G_SCALAR);
10753 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10761 =for apidoc perl_clone
10763 Create and return a new interpreter by cloning the current one.
10765 perl_clone takes these flags as parameters:
10767 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10768 without it we only clone the data and zero the stacks,
10769 with it we copy the stacks and the new perl interpreter is
10770 ready to run at the exact same point as the previous one.
10771 The pseudo-fork code uses COPY_STACKS while the
10772 threads->new doesn't.
10774 CLONEf_KEEP_PTR_TABLE
10775 perl_clone keeps a ptr_table with the pointer of the old
10776 variable as a key and the new variable as a value,
10777 this allows it to check if something has been cloned and not
10778 clone it again but rather just use the value and increase the
10779 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10780 the ptr_table using the function
10781 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10782 reason to keep it around is if you want to dup some of your own
10783 variable who are outside the graph perl scans, example of this
10784 code is in threads.xs create
10787 This is a win32 thing, it is ignored on unix, it tells perls
10788 win32host code (which is c++) to clone itself, this is needed on
10789 win32 if you want to run two threads at the same time,
10790 if you just want to do some stuff in a separate perl interpreter
10791 and then throw it away and return to the original one,
10792 you don't need to do anything.
10797 /* XXX the above needs expanding by someone who actually understands it ! */
10798 EXTERN_C PerlInterpreter *
10799 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10802 perl_clone(PerlInterpreter *proto_perl, UV flags)
10805 #ifdef PERL_IMPLICIT_SYS
10807 /* perlhost.h so we need to call into it
10808 to clone the host, CPerlHost should have a c interface, sky */
10810 if (flags & CLONEf_CLONE_HOST) {
10811 return perl_clone_host(proto_perl,flags);
10813 return perl_clone_using(proto_perl, flags,
10815 proto_perl->IMemShared,
10816 proto_perl->IMemParse,
10818 proto_perl->IStdIO,
10822 proto_perl->IProc);
10826 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10827 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10828 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10829 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10830 struct IPerlDir* ipD, struct IPerlSock* ipS,
10831 struct IPerlProc* ipP)
10833 /* XXX many of the string copies here can be optimized if they're
10834 * constants; they need to be allocated as common memory and just
10835 * their pointers copied. */
10838 CLONE_PARAMS clone_params;
10839 CLONE_PARAMS* const param = &clone_params;
10841 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10842 /* for each stash, determine whether its objects should be cloned */
10843 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10844 PERL_SET_THX(my_perl);
10847 PoisonNew(my_perl, 1, PerlInterpreter);
10853 PL_savestack_ix = 0;
10854 PL_savestack_max = -1;
10855 PL_sig_pending = 0;
10856 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10857 # else /* !DEBUGGING */
10858 Zero(my_perl, 1, PerlInterpreter);
10859 # endif /* DEBUGGING */
10861 /* host pointers */
10863 PL_MemShared = ipMS;
10864 PL_MemParse = ipMP;
10871 #else /* !PERL_IMPLICIT_SYS */
10873 CLONE_PARAMS clone_params;
10874 CLONE_PARAMS* param = &clone_params;
10875 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10876 /* for each stash, determine whether its objects should be cloned */
10877 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10878 PERL_SET_THX(my_perl);
10881 PoisonNew(my_perl, 1, PerlInterpreter);
10887 PL_savestack_ix = 0;
10888 PL_savestack_max = -1;
10889 PL_sig_pending = 0;
10890 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10891 # else /* !DEBUGGING */
10892 Zero(my_perl, 1, PerlInterpreter);
10893 # endif /* DEBUGGING */
10894 #endif /* PERL_IMPLICIT_SYS */
10895 param->flags = flags;
10896 param->proto_perl = proto_perl;
10898 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10900 PL_body_arenas = NULL;
10901 Zero(&PL_body_roots, 1, PL_body_roots);
10903 PL_nice_chunk = NULL;
10904 PL_nice_chunk_size = 0;
10906 PL_sv_objcount = 0;
10908 PL_sv_arenaroot = NULL;
10910 PL_debug = proto_perl->Idebug;
10912 PL_hash_seed = proto_perl->Ihash_seed;
10913 PL_rehash_seed = proto_perl->Irehash_seed;
10915 #ifdef USE_REENTRANT_API
10916 /* XXX: things like -Dm will segfault here in perlio, but doing
10917 * PERL_SET_CONTEXT(proto_perl);
10918 * breaks too many other things
10920 Perl_reentrant_init(aTHX);
10923 /* create SV map for pointer relocation */
10924 PL_ptr_table = ptr_table_new();
10926 /* initialize these special pointers as early as possible */
10927 SvANY(&PL_sv_undef) = NULL;
10928 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10929 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10930 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10932 SvANY(&PL_sv_no) = new_XPVNV();
10933 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10934 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10935 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10936 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10937 SvCUR_set(&PL_sv_no, 0);
10938 SvLEN_set(&PL_sv_no, 1);
10939 SvIV_set(&PL_sv_no, 0);
10940 SvNV_set(&PL_sv_no, 0);
10941 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10943 SvANY(&PL_sv_yes) = new_XPVNV();
10944 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10945 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10946 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10947 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10948 SvCUR_set(&PL_sv_yes, 1);
10949 SvLEN_set(&PL_sv_yes, 2);
10950 SvIV_set(&PL_sv_yes, 1);
10951 SvNV_set(&PL_sv_yes, 1);
10952 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10954 /* create (a non-shared!) shared string table */
10955 PL_strtab = newHV();
10956 HvSHAREKEYS_off(PL_strtab);
10957 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10958 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10960 PL_compiling = proto_perl->Icompiling;
10962 /* These two PVs will be free'd special way so must set them same way op.c does */
10963 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10964 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10966 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10967 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10969 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10970 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10971 if (!specialCopIO(PL_compiling.cop_io))
10972 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10973 if (PL_compiling.cop_hints) {
10975 PL_compiling.cop_hints->refcounted_he_refcnt++;
10976 HINTS_REFCNT_UNLOCK;
10978 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10980 /* pseudo environmental stuff */
10981 PL_origargc = proto_perl->Iorigargc;
10982 PL_origargv = proto_perl->Iorigargv;
10984 param->stashes = newAV(); /* Setup array of objects to call clone on */
10986 /* Set tainting stuff before PerlIO_debug can possibly get called */
10987 PL_tainting = proto_perl->Itainting;
10988 PL_taint_warn = proto_perl->Itaint_warn;
10990 #ifdef PERLIO_LAYERS
10991 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10992 PerlIO_clone(aTHX_ proto_perl, param);
10995 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10996 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10997 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10998 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10999 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11000 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11003 PL_minus_c = proto_perl->Iminus_c;
11004 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11005 PL_localpatches = proto_perl->Ilocalpatches;
11006 PL_splitstr = proto_perl->Isplitstr;
11007 PL_preprocess = proto_perl->Ipreprocess;
11008 PL_minus_n = proto_perl->Iminus_n;
11009 PL_minus_p = proto_perl->Iminus_p;
11010 PL_minus_l = proto_perl->Iminus_l;
11011 PL_minus_a = proto_perl->Iminus_a;
11012 PL_minus_E = proto_perl->Iminus_E;
11013 PL_minus_F = proto_perl->Iminus_F;
11014 PL_doswitches = proto_perl->Idoswitches;
11015 PL_dowarn = proto_perl->Idowarn;
11016 PL_doextract = proto_perl->Idoextract;
11017 PL_sawampersand = proto_perl->Isawampersand;
11018 PL_unsafe = proto_perl->Iunsafe;
11019 PL_inplace = SAVEPV(proto_perl->Iinplace);
11020 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11021 PL_perldb = proto_perl->Iperldb;
11022 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11023 PL_exit_flags = proto_perl->Iexit_flags;
11025 /* magical thingies */
11026 /* XXX time(&PL_basetime) when asked for? */
11027 PL_basetime = proto_perl->Ibasetime;
11028 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11030 PL_maxsysfd = proto_perl->Imaxsysfd;
11031 PL_statusvalue = proto_perl->Istatusvalue;
11033 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11035 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11037 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11039 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11040 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11041 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11043 /* Clone the regex array */
11044 PL_regex_padav = newAV();
11046 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11047 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11049 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11050 for(i = 1; i <= len; i++) {
11051 const SV * const regex = regexen[i];
11054 ? sv_dup_inc(regex, param)
11056 newSViv(PTR2IV(re_dup(
11057 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11059 av_push(PL_regex_padav, sv);
11062 PL_regex_pad = AvARRAY(PL_regex_padav);
11064 /* shortcuts to various I/O objects */
11065 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11066 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11067 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11068 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11069 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11070 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11072 /* shortcuts to regexp stuff */
11073 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11075 /* shortcuts to misc objects */
11076 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11078 /* shortcuts to debugging objects */
11079 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11080 PL_DBline = gv_dup(proto_perl->IDBline, param);
11081 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11082 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11083 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11084 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11085 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11086 PL_lineary = av_dup(proto_perl->Ilineary, param);
11087 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11089 /* symbol tables */
11090 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11091 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11092 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11093 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11094 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11096 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11097 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11098 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11099 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11100 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11101 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11103 PL_sub_generation = proto_perl->Isub_generation;
11105 /* funky return mechanisms */
11106 PL_forkprocess = proto_perl->Iforkprocess;
11108 /* subprocess state */
11109 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11111 /* internal state */
11112 PL_maxo = proto_perl->Imaxo;
11113 if (proto_perl->Iop_mask)
11114 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11117 /* PL_asserting = proto_perl->Iasserting; */
11119 /* current interpreter roots */
11120 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11121 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11122 PL_main_start = proto_perl->Imain_start;
11123 PL_eval_root = proto_perl->Ieval_root;
11124 PL_eval_start = proto_perl->Ieval_start;
11126 /* runtime control stuff */
11127 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11128 PL_copline = proto_perl->Icopline;
11130 PL_filemode = proto_perl->Ifilemode;
11131 PL_lastfd = proto_perl->Ilastfd;
11132 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11135 PL_gensym = proto_perl->Igensym;
11136 PL_preambled = proto_perl->Ipreambled;
11137 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11138 PL_laststatval = proto_perl->Ilaststatval;
11139 PL_laststype = proto_perl->Ilaststype;
11142 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11144 /* interpreter atexit processing */
11145 PL_exitlistlen = proto_perl->Iexitlistlen;
11146 if (PL_exitlistlen) {
11147 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11148 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11151 PL_exitlist = (PerlExitListEntry*)NULL;
11153 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11154 if (PL_my_cxt_size) {
11155 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11156 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11159 PL_my_cxt_list = (void**)NULL;
11160 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11161 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11162 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11164 PL_profiledata = NULL;
11165 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11166 /* PL_rsfp_filters entries have fake IoDIRP() */
11167 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11169 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11171 PAD_CLONE_VARS(proto_perl, param);
11173 #ifdef HAVE_INTERP_INTERN
11174 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11177 /* more statics moved here */
11178 PL_generation = proto_perl->Igeneration;
11179 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11181 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11182 PL_in_clean_all = proto_perl->Iin_clean_all;
11184 PL_uid = proto_perl->Iuid;
11185 PL_euid = proto_perl->Ieuid;
11186 PL_gid = proto_perl->Igid;
11187 PL_egid = proto_perl->Iegid;
11188 PL_nomemok = proto_perl->Inomemok;
11189 PL_an = proto_perl->Ian;
11190 PL_evalseq = proto_perl->Ievalseq;
11191 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11192 PL_origalen = proto_perl->Iorigalen;
11193 #ifdef PERL_USES_PL_PIDSTATUS
11194 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11196 PL_osname = SAVEPV(proto_perl->Iosname);
11197 PL_sighandlerp = proto_perl->Isighandlerp;
11199 PL_runops = proto_perl->Irunops;
11201 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11204 PL_cshlen = proto_perl->Icshlen;
11205 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11208 PL_lex_state = proto_perl->Ilex_state;
11209 PL_lex_defer = proto_perl->Ilex_defer;
11210 PL_lex_expect = proto_perl->Ilex_expect;
11211 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11212 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11213 PL_lex_starts = proto_perl->Ilex_starts;
11214 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11215 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11216 PL_lex_op = proto_perl->Ilex_op;
11217 PL_lex_inpat = proto_perl->Ilex_inpat;
11218 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11219 PL_lex_brackets = proto_perl->Ilex_brackets;
11220 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11221 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11222 PL_lex_casemods = proto_perl->Ilex_casemods;
11223 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11224 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11227 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11228 PL_lasttoke = proto_perl->Ilasttoke;
11229 PL_realtokenstart = proto_perl->Irealtokenstart;
11230 PL_faketokens = proto_perl->Ifaketokens;
11231 PL_thismad = proto_perl->Ithismad;
11232 PL_thistoken = proto_perl->Ithistoken;
11233 PL_thisopen = proto_perl->Ithisopen;
11234 PL_thisstuff = proto_perl->Ithisstuff;
11235 PL_thisclose = proto_perl->Ithisclose;
11236 PL_thiswhite = proto_perl->Ithiswhite;
11237 PL_nextwhite = proto_perl->Inextwhite;
11238 PL_skipwhite = proto_perl->Iskipwhite;
11239 PL_endwhite = proto_perl->Iendwhite;
11240 PL_curforce = proto_perl->Icurforce;
11242 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11243 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11244 PL_nexttoke = proto_perl->Inexttoke;
11247 /* XXX This is probably masking the deeper issue of why
11248 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11249 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11250 * (A little debugging with a watchpoint on it may help.)
11252 if (SvANY(proto_perl->Ilinestr)) {
11253 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11254 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11255 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11256 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11257 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11258 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11259 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11260 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11261 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11264 PL_linestr = newSV(79);
11265 sv_upgrade(PL_linestr,SVt_PVIV);
11266 sv_setpvn(PL_linestr,"",0);
11267 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11269 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11270 PL_pending_ident = proto_perl->Ipending_ident;
11271 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11273 PL_expect = proto_perl->Iexpect;
11275 PL_multi_start = proto_perl->Imulti_start;
11276 PL_multi_end = proto_perl->Imulti_end;
11277 PL_multi_open = proto_perl->Imulti_open;
11278 PL_multi_close = proto_perl->Imulti_close;
11280 PL_error_count = proto_perl->Ierror_count;
11281 PL_subline = proto_perl->Isubline;
11282 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11284 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11285 if (SvANY(proto_perl->Ilinestr)) {
11286 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11287 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11288 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11289 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11290 PL_last_lop_op = proto_perl->Ilast_lop_op;
11293 PL_last_uni = SvPVX(PL_linestr);
11294 PL_last_lop = SvPVX(PL_linestr);
11295 PL_last_lop_op = 0;
11297 PL_in_my = proto_perl->Iin_my;
11298 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11300 PL_cryptseen = proto_perl->Icryptseen;
11303 PL_hints = proto_perl->Ihints;
11305 PL_amagic_generation = proto_perl->Iamagic_generation;
11307 #ifdef USE_LOCALE_COLLATE
11308 PL_collation_ix = proto_perl->Icollation_ix;
11309 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11310 PL_collation_standard = proto_perl->Icollation_standard;
11311 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11312 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11313 #endif /* USE_LOCALE_COLLATE */
11315 #ifdef USE_LOCALE_NUMERIC
11316 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11317 PL_numeric_standard = proto_perl->Inumeric_standard;
11318 PL_numeric_local = proto_perl->Inumeric_local;
11319 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11320 #endif /* !USE_LOCALE_NUMERIC */
11322 /* utf8 character classes */
11323 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11324 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11325 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11326 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11327 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11328 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11329 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11330 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11331 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11332 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11333 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11334 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11335 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11336 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11337 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11338 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11339 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11340 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11341 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11342 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11344 /* Did the locale setup indicate UTF-8? */
11345 PL_utf8locale = proto_perl->Iutf8locale;
11346 /* Unicode features (see perlrun/-C) */
11347 PL_unicode = proto_perl->Iunicode;
11349 /* Pre-5.8 signals control */
11350 PL_signals = proto_perl->Isignals;
11352 /* times() ticks per second */
11353 PL_clocktick = proto_perl->Iclocktick;
11355 /* Recursion stopper for PerlIO_find_layer */
11356 PL_in_load_module = proto_perl->Iin_load_module;
11358 /* sort() routine */
11359 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11361 /* Not really needed/useful since the reenrant_retint is "volatile",
11362 * but do it for consistency's sake. */
11363 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11365 /* Hooks to shared SVs and locks. */
11366 PL_sharehook = proto_perl->Isharehook;
11367 PL_lockhook = proto_perl->Ilockhook;
11368 PL_unlockhook = proto_perl->Iunlockhook;
11369 PL_threadhook = proto_perl->Ithreadhook;
11371 PL_runops_std = proto_perl->Irunops_std;
11372 PL_runops_dbg = proto_perl->Irunops_dbg;
11374 #ifdef THREADS_HAVE_PIDS
11375 PL_ppid = proto_perl->Ippid;
11379 PL_last_swash_hv = NULL; /* reinits on demand */
11380 PL_last_swash_klen = 0;
11381 PL_last_swash_key[0]= '\0';
11382 PL_last_swash_tmps = (U8*)NULL;
11383 PL_last_swash_slen = 0;
11385 PL_glob_index = proto_perl->Iglob_index;
11386 PL_srand_called = proto_perl->Isrand_called;
11387 PL_uudmap['M'] = 0; /* reinits on demand */
11388 PL_bitcount = NULL; /* reinits on demand */
11390 if (proto_perl->Ipsig_pend) {
11391 Newxz(PL_psig_pend, SIG_SIZE, int);
11394 PL_psig_pend = (int*)NULL;
11397 if (proto_perl->Ipsig_ptr) {
11398 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11399 Newxz(PL_psig_name, SIG_SIZE, SV*);
11400 for (i = 1; i < SIG_SIZE; i++) {
11401 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11402 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11406 PL_psig_ptr = (SV**)NULL;
11407 PL_psig_name = (SV**)NULL;
11410 /* thrdvar.h stuff */
11412 if (flags & CLONEf_COPY_STACKS) {
11413 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11414 PL_tmps_ix = proto_perl->Ttmps_ix;
11415 PL_tmps_max = proto_perl->Ttmps_max;
11416 PL_tmps_floor = proto_perl->Ttmps_floor;
11417 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11419 while (i <= PL_tmps_ix) {
11420 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11424 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11425 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11426 Newxz(PL_markstack, i, I32);
11427 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11428 - proto_perl->Tmarkstack);
11429 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11430 - proto_perl->Tmarkstack);
11431 Copy(proto_perl->Tmarkstack, PL_markstack,
11432 PL_markstack_ptr - PL_markstack + 1, I32);
11434 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11435 * NOTE: unlike the others! */
11436 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11437 PL_scopestack_max = proto_perl->Tscopestack_max;
11438 Newxz(PL_scopestack, PL_scopestack_max, I32);
11439 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11441 /* NOTE: si_dup() looks at PL_markstack */
11442 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11444 /* PL_curstack = PL_curstackinfo->si_stack; */
11445 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11446 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11448 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11449 PL_stack_base = AvARRAY(PL_curstack);
11450 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11451 - proto_perl->Tstack_base);
11452 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11454 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11455 * NOTE: unlike the others! */
11456 PL_savestack_ix = proto_perl->Tsavestack_ix;
11457 PL_savestack_max = proto_perl->Tsavestack_max;
11458 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11459 PL_savestack = ss_dup(proto_perl, param);
11463 ENTER; /* perl_destruct() wants to LEAVE; */
11465 /* although we're not duplicating the tmps stack, we should still
11466 * add entries for any SVs on the tmps stack that got cloned by a
11467 * non-refcount means (eg a temp in @_); otherwise they will be
11470 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11471 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11472 proto_perl->Ttmps_stack[i]);
11473 if (nsv && !SvREFCNT(nsv)) {
11475 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11480 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11481 PL_top_env = &PL_start_env;
11483 PL_op = proto_perl->Top;
11486 PL_Xpv = (XPV*)NULL;
11487 PL_na = proto_perl->Tna;
11489 PL_statbuf = proto_perl->Tstatbuf;
11490 PL_statcache = proto_perl->Tstatcache;
11491 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11492 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11494 PL_timesbuf = proto_perl->Ttimesbuf;
11497 PL_tainted = proto_perl->Ttainted;
11498 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11499 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11500 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11501 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11502 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11503 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11504 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11505 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11506 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11508 PL_restartop = proto_perl->Trestartop;
11509 PL_in_eval = proto_perl->Tin_eval;
11510 PL_delaymagic = proto_perl->Tdelaymagic;
11511 PL_dirty = proto_perl->Tdirty;
11512 PL_localizing = proto_perl->Tlocalizing;
11514 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11515 PL_hv_fetch_ent_mh = NULL;
11516 PL_modcount = proto_perl->Tmodcount;
11517 PL_lastgotoprobe = NULL;
11518 PL_dumpindent = proto_perl->Tdumpindent;
11520 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11521 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11522 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11523 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11524 PL_efloatbuf = NULL; /* reinits on demand */
11525 PL_efloatsize = 0; /* reinits on demand */
11529 PL_screamfirst = NULL;
11530 PL_screamnext = NULL;
11531 PL_maxscream = -1; /* reinits on demand */
11532 PL_lastscream = NULL;
11534 PL_watchaddr = NULL;
11537 PL_regdummy = proto_perl->Tregdummy;
11538 PL_colorset = 0; /* reinits PL_colors[] */
11539 /*PL_colors[6] = {0,0,0,0,0,0};*/
11541 /* RE engine - function pointers */
11542 PL_regcompp = proto_perl->Tregcompp;
11543 PL_regexecp = proto_perl->Tregexecp;
11544 PL_regint_start = proto_perl->Tregint_start;
11545 PL_regint_string = proto_perl->Tregint_string;
11546 PL_regfree = proto_perl->Tregfree;
11547 Zero(&PL_reg_state, 1, struct re_save_state);
11548 PL_reginterp_cnt = 0;
11549 PL_regmatch_slab = NULL;
11551 /* Pluggable optimizer */
11552 PL_peepp = proto_perl->Tpeepp;
11554 PL_stashcache = newHV();
11556 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11557 ptr_table_free(PL_ptr_table);
11558 PL_ptr_table = NULL;
11561 /* Call the ->CLONE method, if it exists, for each of the stashes
11562 identified by sv_dup() above.
11564 while(av_len(param->stashes) != -1) {
11565 HV* const stash = (HV*) av_shift(param->stashes);
11566 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11567 if (cloner && GvCV(cloner)) {
11572 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11574 call_sv((SV*)GvCV(cloner), G_DISCARD);
11580 SvREFCNT_dec(param->stashes);
11582 /* orphaned? eg threads->new inside BEGIN or use */
11583 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11584 SvREFCNT_inc_simple_void(PL_compcv);
11585 SAVEFREESV(PL_compcv);
11591 #endif /* USE_ITHREADS */
11594 =head1 Unicode Support
11596 =for apidoc sv_recode_to_utf8
11598 The encoding is assumed to be an Encode object, on entry the PV
11599 of the sv is assumed to be octets in that encoding, and the sv
11600 will be converted into Unicode (and UTF-8).
11602 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11603 is not a reference, nothing is done to the sv. If the encoding is not
11604 an C<Encode::XS> Encoding object, bad things will happen.
11605 (See F<lib/encoding.pm> and L<Encode>).
11607 The PV of the sv is returned.
11612 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11615 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11629 Passing sv_yes is wrong - it needs to be or'ed set of constants
11630 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11631 remove converted chars from source.
11633 Both will default the value - let them.
11635 XPUSHs(&PL_sv_yes);
11638 call_method("decode", G_SCALAR);
11642 s = SvPV_const(uni, len);
11643 if (s != SvPVX_const(sv)) {
11644 SvGROW(sv, len + 1);
11645 Move(s, SvPVX(sv), len + 1, char);
11646 SvCUR_set(sv, len);
11653 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11657 =for apidoc sv_cat_decode
11659 The encoding is assumed to be an Encode object, the PV of the ssv is
11660 assumed to be octets in that encoding and decoding the input starts
11661 from the position which (PV + *offset) pointed to. The dsv will be
11662 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11663 when the string tstr appears in decoding output or the input ends on
11664 the PV of the ssv. The value which the offset points will be modified
11665 to the last input position on the ssv.
11667 Returns TRUE if the terminator was found, else returns FALSE.
11672 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11673 SV *ssv, int *offset, char *tstr, int tlen)
11677 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11688 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11689 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11691 call_method("cat_decode", G_SCALAR);
11693 ret = SvTRUE(TOPs);
11694 *offset = SvIV(offsv);
11700 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11705 /* ---------------------------------------------------------------------
11707 * support functions for report_uninit()
11710 /* the maxiumum size of array or hash where we will scan looking
11711 * for the undefined element that triggered the warning */
11713 #define FUV_MAX_SEARCH_SIZE 1000
11715 /* Look for an entry in the hash whose value has the same SV as val;
11716 * If so, return a mortal copy of the key. */
11719 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11722 register HE **array;
11725 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11726 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11729 array = HvARRAY(hv);
11731 for (i=HvMAX(hv); i>0; i--) {
11732 register HE *entry;
11733 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11734 if (HeVAL(entry) != val)
11736 if ( HeVAL(entry) == &PL_sv_undef ||
11737 HeVAL(entry) == &PL_sv_placeholder)
11741 if (HeKLEN(entry) == HEf_SVKEY)
11742 return sv_mortalcopy(HeKEY_sv(entry));
11743 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11749 /* Look for an entry in the array whose value has the same SV as val;
11750 * If so, return the index, otherwise return -1. */
11753 S_find_array_subscript(pTHX_ AV *av, SV* val)
11758 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11759 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11763 for (i=AvFILLp(av); i>=0; i--) {
11764 if (svp[i] == val && svp[i] != &PL_sv_undef)
11770 /* S_varname(): return the name of a variable, optionally with a subscript.
11771 * If gv is non-zero, use the name of that global, along with gvtype (one
11772 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11773 * targ. Depending on the value of the subscript_type flag, return:
11776 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11777 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11778 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11779 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11782 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11783 SV* keyname, I32 aindex, int subscript_type)
11786 SV * const name = sv_newmortal();
11789 buffer[0] = gvtype;
11792 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11794 gv_fullname4(name, gv, buffer, 0);
11796 if ((unsigned int)SvPVX(name)[1] <= 26) {
11798 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11800 /* Swap the 1 unprintable control character for the 2 byte pretty
11801 version - ie substr($name, 1, 1) = $buffer; */
11802 sv_insert(name, 1, 1, buffer, 2);
11807 CV * const cv = find_runcv(&unused);
11811 if (!cv || !CvPADLIST(cv))
11813 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11814 sv = *av_fetch(av, targ, FALSE);
11815 /* SvLEN in a pad name is not to be trusted */
11816 sv_setpv(name, SvPV_nolen_const(sv));
11819 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11820 SV * const sv = newSV(0);
11821 *SvPVX(name) = '$';
11822 Perl_sv_catpvf(aTHX_ name, "{%s}",
11823 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11826 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11827 *SvPVX(name) = '$';
11828 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11830 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11831 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11838 =for apidoc find_uninit_var
11840 Find the name of the undefined variable (if any) that caused the operator o
11841 to issue a "Use of uninitialized value" warning.
11842 If match is true, only return a name if it's value matches uninit_sv.
11843 So roughly speaking, if a unary operator (such as OP_COS) generates a
11844 warning, then following the direct child of the op may yield an
11845 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11846 other hand, with OP_ADD there are two branches to follow, so we only print
11847 the variable name if we get an exact match.
11849 The name is returned as a mortal SV.
11851 Assumes that PL_op is the op that originally triggered the error, and that
11852 PL_comppad/PL_curpad points to the currently executing pad.
11858 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11866 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11867 uninit_sv == &PL_sv_placeholder)))
11870 switch (obase->op_type) {
11877 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11878 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11881 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11883 if (pad) { /* @lex, %lex */
11884 sv = PAD_SVl(obase->op_targ);
11888 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11889 /* @global, %global */
11890 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11893 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11895 else /* @{expr}, %{expr} */
11896 return find_uninit_var(cUNOPx(obase)->op_first,
11900 /* attempt to find a match within the aggregate */
11902 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11904 subscript_type = FUV_SUBSCRIPT_HASH;
11907 index = find_array_subscript((AV*)sv, uninit_sv);
11909 subscript_type = FUV_SUBSCRIPT_ARRAY;
11912 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11915 return varname(gv, hash ? '%' : '@', obase->op_targ,
11916 keysv, index, subscript_type);
11920 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11922 return varname(NULL, '$', obase->op_targ,
11923 NULL, 0, FUV_SUBSCRIPT_NONE);
11926 gv = cGVOPx_gv(obase);
11927 if (!gv || (match && GvSV(gv) != uninit_sv))
11929 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11932 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11935 av = (AV*)PAD_SV(obase->op_targ);
11936 if (!av || SvRMAGICAL(av))
11938 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11939 if (!svp || *svp != uninit_sv)
11942 return varname(NULL, '$', obase->op_targ,
11943 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11946 gv = cGVOPx_gv(obase);
11952 if (!av || SvRMAGICAL(av))
11954 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11955 if (!svp || *svp != uninit_sv)
11958 return varname(gv, '$', 0,
11959 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11964 o = cUNOPx(obase)->op_first;
11965 if (!o || o->op_type != OP_NULL ||
11966 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11968 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11972 if (PL_op == obase)
11973 /* $a[uninit_expr] or $h{uninit_expr} */
11974 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11977 o = cBINOPx(obase)->op_first;
11978 kid = cBINOPx(obase)->op_last;
11980 /* get the av or hv, and optionally the gv */
11982 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11983 sv = PAD_SV(o->op_targ);
11985 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11986 && cUNOPo->op_first->op_type == OP_GV)
11988 gv = cGVOPx_gv(cUNOPo->op_first);
11991 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11996 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11997 /* index is constant */
12001 if (obase->op_type == OP_HELEM) {
12002 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12003 if (!he || HeVAL(he) != uninit_sv)
12007 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12008 if (!svp || *svp != uninit_sv)
12012 if (obase->op_type == OP_HELEM)
12013 return varname(gv, '%', o->op_targ,
12014 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12016 return varname(gv, '@', o->op_targ, NULL,
12017 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12020 /* index is an expression;
12021 * attempt to find a match within the aggregate */
12022 if (obase->op_type == OP_HELEM) {
12023 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12025 return varname(gv, '%', o->op_targ,
12026 keysv, 0, FUV_SUBSCRIPT_HASH);
12029 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12031 return varname(gv, '@', o->op_targ,
12032 NULL, index, FUV_SUBSCRIPT_ARRAY);
12037 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12039 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12044 /* only examine RHS */
12045 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12048 o = cUNOPx(obase)->op_first;
12049 if (o->op_type == OP_PUSHMARK)
12052 if (!o->op_sibling) {
12053 /* one-arg version of open is highly magical */
12055 if (o->op_type == OP_GV) { /* open FOO; */
12057 if (match && GvSV(gv) != uninit_sv)
12059 return varname(gv, '$', 0,
12060 NULL, 0, FUV_SUBSCRIPT_NONE);
12062 /* other possibilities not handled are:
12063 * open $x; or open my $x; should return '${*$x}'
12064 * open expr; should return '$'.expr ideally
12070 /* ops where $_ may be an implicit arg */
12074 if ( !(obase->op_flags & OPf_STACKED)) {
12075 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12076 ? PAD_SVl(obase->op_targ)
12079 sv = sv_newmortal();
12080 sv_setpvn(sv, "$_", 2);
12088 /* skip filehandle as it can't produce 'undef' warning */
12089 o = cUNOPx(obase)->op_first;
12090 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12091 o = o->op_sibling->op_sibling;
12098 match = 1; /* XS or custom code could trigger random warnings */
12103 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12104 return sv_2mortal(newSVpvs("${$/}"));
12109 if (!(obase->op_flags & OPf_KIDS))
12111 o = cUNOPx(obase)->op_first;
12117 /* if all except one arg are constant, or have no side-effects,
12118 * or are optimized away, then it's unambiguous */
12120 for (kid=o; kid; kid = kid->op_sibling) {
12122 const OPCODE type = kid->op_type;
12123 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12124 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12125 || (type == OP_PUSHMARK)
12129 if (o2) { /* more than one found */
12136 return find_uninit_var(o2, uninit_sv, match);
12138 /* scan all args */
12140 sv = find_uninit_var(o, uninit_sv, 1);
12152 =for apidoc report_uninit
12154 Print appropriate "Use of uninitialized variable" warning
12160 Perl_report_uninit(pTHX_ SV* uninit_sv)
12164 SV* varname = NULL;
12166 varname = find_uninit_var(PL_op, uninit_sv,0);
12168 sv_insert(varname, 0, 0, " ", 1);
12170 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12171 varname ? SvPV_nolen_const(varname) : "",
12172 " in ", OP_DESC(PL_op));
12175 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12181 * c-indentation-style: bsd
12182 * c-basic-offset: 4
12183 * indent-tabs-mode: t
12186 * ex: set ts=8 sts=4 sw=4 noet: