3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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)
448 SV * const target = SvRV(ref);
449 if (SvOBJECT(target)) {
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
451 if (SvWEAKREF(ref)) {
452 sv_del_backref(target, ref);
458 SvREFCNT_dec(target);
463 /* XXX Might want to check arrays, etc. */
466 /* called by sv_clean_objs() for each live SV */
468 #ifndef DISABLE_DESTRUCTOR_KLUDGE
470 do_clean_named_objs(pTHX_ SV *sv)
473 assert(SvTYPE(sv) == SVt_PVGV);
474 assert(isGV_with_GP(sv));
477 #ifdef PERL_DONT_CREATE_GVSV
480 SvOBJECT(GvSV(sv))) ||
481 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
482 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
483 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
484 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
486 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
487 SvFLAGS(sv) |= SVf_BREAK;
495 =for apidoc sv_clean_objs
497 Attempt to destroy all objects not yet freed
503 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
545 PL_in_clean_all = TRUE;
546 cleaned = visit(do_clean_all, 0,0);
547 PL_in_clean_all = FALSE;
552 ARENASETS: a meta-arena implementation which separates arena-info
553 into struct arena_set, which contains an array of struct
554 arena_descs, each holding info for a single arena. By separating
555 the meta-info from the arena, we recover the 1st slot, formerly
556 borrowed for list management. The arena_set is about the size of an
557 arena, avoiding the needless malloc overhead of a naive linked-list
559 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
560 memory in the last arena-set (1/2 on average). In trade, we get
561 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
562 smaller types). The recovery of the wasted space allows use of
563 small arenas for large, rare body types,
566 char *arena; /* the raw storage, allocated aligned */
567 size_t size; /* its size ~4k typ */
568 int unit_type; /* useful for arena audits */
569 /* info for sv-heads (eventually)
576 /* Get the maximum number of elements in set[] such that struct arena_set
577 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
578 therefore likely to be 1 aligned memory page. */
580 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
581 - 2 * sizeof(int)) / sizeof (struct arena_desc))
584 struct arena_set* next;
585 int set_size; /* ie ARENAS_PER_SET */
586 int curr; /* index of next available arena-desc */
587 struct arena_desc set[ARENAS_PER_SET];
591 =for apidoc sv_free_arenas
593 Deallocate the memory used by all arenas. Note that all the individual SV
594 heads and bodies within the arenas must already have been freed.
599 Perl_sv_free_arenas(pTHX)
606 /* Free arenas here, but be careful about fake ones. (We assume
607 contiguity of the fake ones with the corresponding real ones.) */
609 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
610 svanext = (SV*) SvANY(sva);
611 while (svanext && SvFAKE(svanext))
612 svanext = (SV*) SvANY(svanext);
619 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
621 for (; aroot; aroot = next) {
622 const int max = aroot->curr;
623 for (i=0; i<max; i++) {
624 assert(aroot->set[i].arena);
625 Safefree(aroot->set[i].arena);
633 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
634 PL_body_roots[i] = 0;
636 Safefree(PL_nice_chunk);
637 PL_nice_chunk = NULL;
638 PL_nice_chunk_size = 0;
644 Here are mid-level routines that manage the allocation of bodies out
645 of the various arenas. There are 5 kinds of arenas:
647 1. SV-head arenas, which are discussed and handled above
648 2. regular body arenas
649 3. arenas for reduced-size bodies
651 5. pte arenas (thread related)
653 Arena types 2 & 3 are chained by body-type off an array of
654 arena-root pointers, which is indexed by svtype. Some of the
655 larger/less used body types are malloced singly, since a large
656 unused block of them is wasteful. Also, several svtypes dont have
657 bodies; the data fits into the sv-head itself. The arena-root
658 pointer thus has a few unused root-pointers (which may be hijacked
659 later for arena types 4,5)
661 3 differs from 2 as an optimization; some body types have several
662 unused fields in the front of the structure (which are kept in-place
663 for consistency). These bodies can be allocated in smaller chunks,
664 because the leading fields arent accessed. Pointers to such bodies
665 are decremented to point at the unused 'ghost' memory, knowing that
666 the pointers are used with offsets to the real memory.
668 HE, HEK arenas are managed separately, with separate code, but may
669 be merge-able later..
671 PTE arenas are not sv-bodies, but they share these mid-level
672 mechanics, so are considered here. The new mid-level mechanics rely
673 on the sv_type of the body being allocated, so we just reserve one
674 of the unused body-slots for PTEs, then use it in those (2) PTE
675 contexts below (line ~10k)
678 /* get_arena(size): this creates custom-sized arenas
679 TBD: export properly for hv.c: S_more_he().
682 Perl_get_arena(pTHX_ int arena_size)
685 struct arena_desc* adesc;
686 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
689 /* shouldnt need this
690 if (!arena_size) arena_size = PERL_ARENA_SIZE;
693 /* may need new arena-set to hold new arena */
694 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
695 Newxz(newroot, 1, struct arena_set);
696 newroot->set_size = ARENAS_PER_SET;
697 newroot->next = *aroot;
699 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
702 /* ok, now have arena-set with at least 1 empty/available arena-desc */
703 curr = (*aroot)->curr++;
704 adesc = &((*aroot)->set[curr]);
705 assert(!adesc->arena);
707 Newxz(adesc->arena, arena_size, char);
708 adesc->size = arena_size;
709 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
710 curr, (void*)adesc->arena, arena_size));
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
729 =head1 SV-Body Allocation
731 Allocation of SV-bodies is similar to SV-heads, differing as follows;
732 the allocation mechanism is used for many body types, so is somewhat
733 more complicated, it uses arena-sets, and has no need for still-live
736 At the outermost level, (new|del)_X*V macros return bodies of the
737 appropriate type. These macros call either (new|del)_body_type or
738 (new|del)_body_allocated macro pairs, depending on specifics of the
739 type. Most body types use the former pair, the latter pair is used to
740 allocate body types with "ghost fields".
742 "ghost fields" are fields that are unused in certain types, and
743 consequently dont need to actually exist. They are declared because
744 they're part of a "base type", which allows use of functions as
745 methods. The simplest examples are AVs and HVs, 2 aggregate types
746 which don't use the fields which support SCALAR semantics.
748 For these types, the arenas are carved up into *_allocated size
749 chunks, we thus avoid wasted memory for those unaccessed members.
750 When bodies are allocated, we adjust the pointer back in memory by the
751 size of the bit not allocated, so it's as if we allocated the full
752 structure. (But things will all go boom if you write to the part that
753 is "not there", because you'll be overwriting the last members of the
754 preceding structure in memory.)
756 We calculate the correction using the STRUCT_OFFSET macro. For
757 example, if xpv_allocated is the same structure as XPV then the two
758 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
759 structure is smaller (no initial NV actually allocated) then the net
760 effect is to subtract the size of the NV from the pointer, to return a
761 new pointer as if an initial NV were actually allocated.
763 This is the same trick as was used for NV and IV bodies. Ironically it
764 doesn't need to be used for NV bodies any more, because NV is now at
765 the start of the structure. IV bodies don't need it either, because
766 they are no longer allocated.
768 In turn, the new_body_* allocators call S_new_body(), which invokes
769 new_body_inline macro, which takes a lock, and takes a body off the
770 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
771 necessary to refresh an empty list. Then the lock is released, and
772 the body is returned.
774 S_more_bodies calls get_arena(), and carves it up into an array of N
775 bodies, which it strings into a linked list. It looks up arena-size
776 and body-size from the body_details table described below, thus
777 supporting the multiple body-types.
779 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
780 the (new|del)_X*V macros are mapped directly to malloc/free.
786 For each sv-type, struct body_details bodies_by_type[] carries
787 parameters which control these aspects of SV handling:
789 Arena_size determines whether arenas are used for this body type, and if
790 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
791 zero, forcing individual mallocs and frees.
793 Body_size determines how big a body is, and therefore how many fit into
794 each arena. Offset carries the body-pointer adjustment needed for
795 *_allocated body types, and is used in *_allocated macros.
797 But its main purpose is to parameterize info needed in
798 Perl_sv_upgrade(). The info here dramatically simplifies the function
799 vs the implementation in 5.8.7, making it table-driven. All fields
800 are used for this, except for arena_size.
802 For the sv-types that have no bodies, arenas are not used, so those
803 PL_body_roots[sv_type] are unused, and can be overloaded. In
804 something of a special case, SVt_NULL is borrowed for HE arenas;
805 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
806 bodies_by_type[SVt_NULL] slot is not used, as the table is not
809 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
810 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
811 they can just use the same allocation semantics. At first, PTEs were
812 also overloaded to a non-body sv-type, but this yielded hard-to-find
813 malloc bugs, so was simplified by claiming a new slot. This choice
814 has no consequence at this time.
818 struct body_details {
819 U8 body_size; /* Size to allocate */
820 U8 copy; /* Size of structure to copy (may be shorter) */
822 unsigned int type : 4; /* We have space for a sanity check. */
823 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
824 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
825 unsigned int arena : 1; /* Allocated from an arena */
826 size_t arena_size; /* Size of arena to allocate */
834 /* With -DPURFIY we allocate everything directly, and don't use arenas.
835 This seems a rather elegant way to simplify some of the code below. */
836 #define HASARENA FALSE
838 #define HASARENA TRUE
840 #define NOARENA FALSE
842 /* Size the arenas to exactly fit a given number of bodies. A count
843 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
844 simplifying the default. If count > 0, the arena is sized to fit
845 only that many bodies, allowing arenas to be used for large, rare
846 bodies (XPVFM, XPVIO) without undue waste. The arena size is
847 limited by PERL_ARENA_SIZE, so we can safely oversize the
850 #define FIT_ARENA0(body_size) \
851 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
852 #define FIT_ARENAn(count,body_size) \
853 ( count * body_size <= PERL_ARENA_SIZE) \
854 ? count * body_size \
855 : FIT_ARENA0 (body_size)
856 #define FIT_ARENA(count,body_size) \
858 ? FIT_ARENAn (count, body_size) \
859 : FIT_ARENA0 (body_size)
861 /* A macro to work out the offset needed to subtract from a pointer to (say)
868 to make its members accessible via a pointer to (say)
878 #define relative_STRUCT_OFFSET(longer, shorter, member) \
879 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
881 /* Calculate the length to copy. Specifically work out the length less any
882 final padding the compiler needed to add. See the comment in sv_upgrade
883 for why copying the padding proved to be a bug. */
885 #define copy_length(type, last_member) \
886 STRUCT_OFFSET(type, last_member) \
887 + sizeof (((type*)SvANY((SV*)0))->last_member)
889 static const struct body_details bodies_by_type[] = {
890 { sizeof(HE), 0, 0, SVt_NULL,
891 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
893 /* The bind placeholder pretends to be an RV for now.
894 Also it's marked as "can't upgrade" top stop anyone using it before it's
896 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
898 /* IVs are in the head, so the allocation size is 0.
899 However, the slot is overloaded for PTEs. */
900 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
901 sizeof(IV), /* This is used to copy out the IV body. */
902 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
903 NOARENA /* IVS don't need an arena */,
904 /* But PTEs need to know the size of their arena */
905 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
908 /* 8 bytes on most ILP32 with IEEE doubles */
909 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
910 FIT_ARENA(0, sizeof(NV)) },
912 /* RVs are in the head now. */
913 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
915 /* 8 bytes on most ILP32 with IEEE doubles */
916 { sizeof(xpv_allocated),
917 copy_length(XPV, xpv_len)
918 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
919 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
920 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
923 { sizeof(xpviv_allocated),
924 copy_length(XPVIV, xiv_u)
925 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
926 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
927 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
930 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
934 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
938 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
942 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
943 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
945 { sizeof(xpvav_allocated),
946 copy_length(XPVAV, xmg_stash)
947 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
948 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
949 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
951 { sizeof(xpvhv_allocated),
952 copy_length(XPVHV, xmg_stash)
953 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
954 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
955 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
958 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
959 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
960 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
962 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
963 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
964 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
966 /* XPVIO is 84 bytes, fits 48x */
967 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
968 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
971 #define new_body_type(sv_type) \
972 (void *)((char *)S_new_body(aTHX_ sv_type))
974 #define del_body_type(p, sv_type) \
975 del_body(p, &PL_body_roots[sv_type])
978 #define new_body_allocated(sv_type) \
979 (void *)((char *)S_new_body(aTHX_ sv_type) \
980 - bodies_by_type[sv_type].offset)
982 #define del_body_allocated(p, sv_type) \
983 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
986 #define my_safemalloc(s) (void*)safemalloc(s)
987 #define my_safecalloc(s) (void*)safecalloc(s, 1)
988 #define my_safefree(p) safefree((char*)p)
992 #define new_XNV() my_safemalloc(sizeof(XPVNV))
993 #define del_XNV(p) my_safefree(p)
995 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XPVNV(p) my_safefree(p)
998 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
999 #define del_XPVAV(p) my_safefree(p)
1001 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1002 #define del_XPVHV(p) my_safefree(p)
1004 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1005 #define del_XPVMG(p) my_safefree(p)
1007 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1008 #define del_XPVGV(p) my_safefree(p)
1012 #define new_XNV() new_body_type(SVt_NV)
1013 #define del_XNV(p) del_body_type(p, SVt_NV)
1015 #define new_XPVNV() new_body_type(SVt_PVNV)
1016 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1018 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1019 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1021 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1022 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1024 #define new_XPVMG() new_body_type(SVt_PVMG)
1025 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1027 #define new_XPVGV() new_body_type(SVt_PVGV)
1028 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1032 /* no arena for you! */
1034 #define new_NOARENA(details) \
1035 my_safemalloc((details)->body_size + (details)->offset)
1036 #define new_NOARENAZ(details) \
1037 my_safecalloc((details)->body_size + (details)->offset)
1039 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1040 static bool done_sanity_check;
1044 S_more_bodies (pTHX_ svtype sv_type)
1047 void ** const root = &PL_body_roots[sv_type];
1048 const struct body_details * const bdp = &bodies_by_type[sv_type];
1049 const size_t body_size = bdp->body_size;
1053 assert(bdp->arena_size);
1055 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1056 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1057 * variables like done_sanity_check. */
1058 if (!done_sanity_check) {
1059 unsigned int i = SVt_LAST;
1061 done_sanity_check = TRUE;
1064 assert (bodies_by_type[i].type == i);
1068 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1070 end = start + bdp->arena_size - body_size;
1072 /* computed count doesnt reflect the 1st slot reservation */
1073 DEBUG_m(PerlIO_printf(Perl_debug_log,
1074 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1075 (void*)start, (void*)end,
1076 (int)bdp->arena_size, sv_type, (int)body_size,
1077 (int)bdp->arena_size / (int)body_size));
1079 *root = (void *)start;
1081 while (start < end) {
1082 char * const next = start + body_size;
1083 *(void**) start = (void *)next;
1086 *(void **)start = 0;
1091 /* grab a new thing from the free list, allocating more if necessary.
1092 The inline version is used for speed in hot routines, and the
1093 function using it serves the rest (unless PURIFY).
1095 #define new_body_inline(xpv, sv_type) \
1097 void ** const r3wt = &PL_body_roots[sv_type]; \
1099 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1100 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1101 *(r3wt) = *(void**)(xpv); \
1108 S_new_body(pTHX_ svtype sv_type)
1112 new_body_inline(xpv, sv_type);
1119 =for apidoc sv_upgrade
1121 Upgrade an SV to a more complex form. Generally adds a new body type to the
1122 SV, then copies across as much information as possible from the old body.
1123 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1129 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1134 const svtype old_type = SvTYPE(sv);
1135 const struct body_details *new_type_details;
1136 const struct body_details *const old_type_details
1137 = bodies_by_type + old_type;
1139 if (new_type != SVt_PV && SvIsCOW(sv)) {
1140 sv_force_normal_flags(sv, 0);
1143 if (old_type == new_type)
1146 if (old_type > new_type)
1147 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1148 (int)old_type, (int)new_type);
1151 old_body = SvANY(sv);
1153 /* Copying structures onto other structures that have been neatly zeroed
1154 has a subtle gotcha. Consider XPVMG
1156 +------+------+------+------+------+-------+-------+
1157 | NV | CUR | LEN | IV | MAGIC | STASH |
1158 +------+------+------+------+------+-------+-------+
1159 0 4 8 12 16 20 24 28
1161 where NVs are aligned to 8 bytes, so that sizeof that structure is
1162 actually 32 bytes long, with 4 bytes of padding at the end:
1164 +------+------+------+------+------+-------+-------+------+
1165 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1166 +------+------+------+------+------+-------+-------+------+
1167 0 4 8 12 16 20 24 28 32
1169 so what happens if you allocate memory for this structure:
1171 +------+------+------+------+------+-------+-------+------+------+...
1172 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1173 +------+------+------+------+------+-------+-------+------+------+...
1174 0 4 8 12 16 20 24 28 32 36
1176 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1177 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1178 started out as zero once, but it's quite possible that it isn't. So now,
1179 rather than a nicely zeroed GP, you have it pointing somewhere random.
1182 (In fact, GP ends up pointing at a previous GP structure, because the
1183 principle cause of the padding in XPVMG getting garbage is a copy of
1184 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1185 this happens to be moot because XPVGV has been re-ordered, with GP
1186 no longer after STASH)
1188 So we are careful and work out the size of used parts of all the
1195 if (new_type < SVt_PVIV) {
1196 new_type = (new_type == SVt_NV)
1197 ? SVt_PVNV : SVt_PVIV;
1201 if (new_type < SVt_PVNV) {
1202 new_type = SVt_PVNV;
1208 assert(new_type > SVt_PV);
1209 assert(SVt_IV < SVt_PV);
1210 assert(SVt_NV < SVt_PV);
1217 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1218 there's no way that it can be safely upgraded, because perl.c
1219 expects to Safefree(SvANY(PL_mess_sv)) */
1220 assert(sv != PL_mess_sv);
1221 /* This flag bit is used to mean other things in other scalar types.
1222 Given that it only has meaning inside the pad, it shouldn't be set
1223 on anything that can get upgraded. */
1224 assert(!SvPAD_TYPED(sv));
1227 if (old_type_details->cant_upgrade)
1228 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1229 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1231 new_type_details = bodies_by_type + new_type;
1233 SvFLAGS(sv) &= ~SVTYPEMASK;
1234 SvFLAGS(sv) |= new_type;
1236 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1237 the return statements above will have triggered. */
1238 assert (new_type != SVt_NULL);
1241 assert(old_type == SVt_NULL);
1242 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1246 assert(old_type == SVt_NULL);
1247 SvANY(sv) = new_XNV();
1251 assert(old_type == SVt_NULL);
1252 SvANY(sv) = &sv->sv_u.svu_rv;
1257 assert(new_type_details->body_size);
1260 assert(new_type_details->arena);
1261 assert(new_type_details->arena_size);
1262 /* This points to the start of the allocated area. */
1263 new_body_inline(new_body, new_type);
1264 Zero(new_body, new_type_details->body_size, char);
1265 new_body = ((char *)new_body) - new_type_details->offset;
1267 /* We always allocated the full length item with PURIFY. To do this
1268 we fake things so that arena is false for all 16 types.. */
1269 new_body = new_NOARENAZ(new_type_details);
1271 SvANY(sv) = new_body;
1272 if (new_type == SVt_PVAV) {
1278 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1279 The target created by newSVrv also is, and it can have magic.
1280 However, it never has SvPVX set.
1282 if (old_type >= SVt_RV) {
1283 assert(SvPVX_const(sv) == 0);
1286 if (old_type >= SVt_PVMG) {
1287 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1288 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1290 sv->sv_u.svu_array = NULL; /* or svu_hash */
1296 /* XXX Is this still needed? Was it ever needed? Surely as there is
1297 no route from NV to PVIV, NOK can never be true */
1298 assert(!SvNOKp(sv));
1309 assert(new_type_details->body_size);
1310 /* We always allocated the full length item with PURIFY. To do this
1311 we fake things so that arena is false for all 16 types.. */
1312 if(new_type_details->arena) {
1313 /* This points to the start of the allocated area. */
1314 new_body_inline(new_body, new_type);
1315 Zero(new_body, new_type_details->body_size, char);
1316 new_body = ((char *)new_body) - new_type_details->offset;
1318 new_body = new_NOARENAZ(new_type_details);
1320 SvANY(sv) = new_body;
1322 if (old_type_details->copy) {
1323 /* There is now the potential for an upgrade from something without
1324 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1325 int offset = old_type_details->offset;
1326 int length = old_type_details->copy;
1328 if (new_type_details->offset > old_type_details->offset) {
1329 const int difference
1330 = new_type_details->offset - old_type_details->offset;
1331 offset += difference;
1332 length -= difference;
1334 assert (length >= 0);
1336 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1340 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1341 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1342 * correct 0.0 for us. Otherwise, if the old body didn't have an
1343 * NV slot, but the new one does, then we need to initialise the
1344 * freshly created NV slot with whatever the correct bit pattern is
1346 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1350 if (new_type == SVt_PVIO)
1351 IoPAGE_LEN(sv) = 60;
1352 if (old_type < SVt_RV)
1356 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1357 (unsigned long)new_type);
1360 if (old_type_details->arena) {
1361 /* If there was an old body, then we need to free it.
1362 Note that there is an assumption that all bodies of types that
1363 can be upgraded came from arenas. Only the more complex non-
1364 upgradable types are allowed to be directly malloc()ed. */
1366 my_safefree(old_body);
1368 del_body((void*)((char*)old_body + old_type_details->offset),
1369 &PL_body_roots[old_type]);
1375 =for apidoc sv_backoff
1377 Remove any string offset. You should normally use the C<SvOOK_off> macro
1384 Perl_sv_backoff(pTHX_ register SV *sv)
1386 PERL_UNUSED_CONTEXT;
1388 assert(SvTYPE(sv) != SVt_PVHV);
1389 assert(SvTYPE(sv) != SVt_PVAV);
1391 const char * const s = SvPVX_const(sv);
1392 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1393 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1395 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1397 SvFLAGS(sv) &= ~SVf_OOK;
1404 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1405 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1406 Use the C<SvGROW> wrapper instead.
1412 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1416 if (PL_madskills && newlen >= 0x100000) {
1417 PerlIO_printf(Perl_debug_log,
1418 "Allocation too large: %"UVxf"\n", (UV)newlen);
1420 #ifdef HAS_64K_LIMIT
1421 if (newlen >= 0x10000) {
1422 PerlIO_printf(Perl_debug_log,
1423 "Allocation too large: %"UVxf"\n", (UV)newlen);
1426 #endif /* HAS_64K_LIMIT */
1429 if (SvTYPE(sv) < SVt_PV) {
1430 sv_upgrade(sv, SVt_PV);
1431 s = SvPVX_mutable(sv);
1433 else if (SvOOK(sv)) { /* pv is offset? */
1435 s = SvPVX_mutable(sv);
1436 if (newlen > SvLEN(sv))
1437 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1438 #ifdef HAS_64K_LIMIT
1439 if (newlen >= 0x10000)
1444 s = SvPVX_mutable(sv);
1446 if (newlen > SvLEN(sv)) { /* need more room? */
1447 newlen = PERL_STRLEN_ROUNDUP(newlen);
1448 if (SvLEN(sv) && s) {
1450 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1456 s = (char*)saferealloc(s, newlen);
1459 s = (char*)safemalloc(newlen);
1460 if (SvPVX_const(sv) && SvCUR(sv)) {
1461 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1465 SvLEN_set(sv, newlen);
1471 =for apidoc sv_setiv
1473 Copies an integer into the given SV, upgrading first if necessary.
1474 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1480 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1483 SV_CHECK_THINKFIRST_COW_DROP(sv);
1484 switch (SvTYPE(sv)) {
1486 sv_upgrade(sv, SVt_IV);
1489 sv_upgrade(sv, SVt_PVNV);
1493 sv_upgrade(sv, SVt_PVIV);
1502 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1506 (void)SvIOK_only(sv); /* validate number */
1512 =for apidoc sv_setiv_mg
1514 Like C<sv_setiv>, but also handles 'set' magic.
1520 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1527 =for apidoc sv_setuv
1529 Copies an unsigned integer into the given SV, upgrading first if necessary.
1530 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1536 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1538 /* With these two if statements:
1539 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1542 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1544 If you wish to remove them, please benchmark to see what the effect is
1546 if (u <= (UV)IV_MAX) {
1547 sv_setiv(sv, (IV)u);
1556 =for apidoc sv_setuv_mg
1558 Like C<sv_setuv>, but also handles 'set' magic.
1564 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1571 =for apidoc sv_setnv
1573 Copies a double into the given SV, upgrading first if necessary.
1574 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1580 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1583 SV_CHECK_THINKFIRST_COW_DROP(sv);
1584 switch (SvTYPE(sv)) {
1587 sv_upgrade(sv, SVt_NV);
1592 sv_upgrade(sv, SVt_PVNV);
1601 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1606 (void)SvNOK_only(sv); /* validate number */
1611 =for apidoc sv_setnv_mg
1613 Like C<sv_setnv>, but also handles 'set' magic.
1619 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1625 /* Print an "isn't numeric" warning, using a cleaned-up,
1626 * printable version of the offending string
1630 S_not_a_number(pTHX_ SV *sv)
1638 dsv = sv_2mortal(newSVpvs(""));
1639 pv = sv_uni_display(dsv, sv, 10, 0);
1642 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1643 /* each *s can expand to 4 chars + "...\0",
1644 i.e. need room for 8 chars */
1646 const char *s = SvPVX_const(sv);
1647 const char * const end = s + SvCUR(sv);
1648 for ( ; s < end && d < limit; s++ ) {
1650 if (ch & 128 && !isPRINT_LC(ch)) {
1659 else if (ch == '\r') {
1663 else if (ch == '\f') {
1667 else if (ch == '\\') {
1671 else if (ch == '\0') {
1675 else if (isPRINT_LC(ch))
1692 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1693 "Argument \"%s\" isn't numeric in %s", pv,
1696 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1697 "Argument \"%s\" isn't numeric", pv);
1701 =for apidoc looks_like_number
1703 Test if the content of an SV looks like a number (or is a number).
1704 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1705 non-numeric warning), even if your atof() doesn't grok them.
1711 Perl_looks_like_number(pTHX_ SV *sv)
1713 register const char *sbegin;
1717 sbegin = SvPVX_const(sv);
1720 else if (SvPOKp(sv))
1721 sbegin = SvPV_const(sv, len);
1723 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1724 return grok_number(sbegin, len, NULL);
1728 S_glob_2number(pTHX_ GV * const gv)
1730 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1731 SV *const buffer = sv_newmortal();
1733 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1736 gv_efullname3(buffer, gv, "*");
1737 SvFLAGS(gv) |= wasfake;
1739 /* We know that all GVs stringify to something that is not-a-number,
1740 so no need to test that. */
1741 if (ckWARN(WARN_NUMERIC))
1742 not_a_number(buffer);
1743 /* We just want something true to return, so that S_sv_2iuv_common
1744 can tail call us and return true. */
1749 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1751 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1752 SV *const buffer = sv_newmortal();
1754 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1757 gv_efullname3(buffer, gv, "*");
1758 SvFLAGS(gv) |= wasfake;
1760 assert(SvPOK(buffer));
1762 *len = SvCUR(buffer);
1764 return SvPVX(buffer);
1767 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1768 until proven guilty, assume that things are not that bad... */
1773 As 64 bit platforms often have an NV that doesn't preserve all bits of
1774 an IV (an assumption perl has been based on to date) it becomes necessary
1775 to remove the assumption that the NV always carries enough precision to
1776 recreate the IV whenever needed, and that the NV is the canonical form.
1777 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1778 precision as a side effect of conversion (which would lead to insanity
1779 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1780 1) to distinguish between IV/UV/NV slots that have cached a valid
1781 conversion where precision was lost and IV/UV/NV slots that have a
1782 valid conversion which has lost no precision
1783 2) to ensure that if a numeric conversion to one form is requested that
1784 would lose precision, the precise conversion (or differently
1785 imprecise conversion) is also performed and cached, to prevent
1786 requests for different numeric formats on the same SV causing
1787 lossy conversion chains. (lossless conversion chains are perfectly
1792 SvIOKp is true if the IV slot contains a valid value
1793 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1794 SvNOKp is true if the NV slot contains a valid value
1795 SvNOK is true only if the NV value is accurate
1798 while converting from PV to NV, check to see if converting that NV to an
1799 IV(or UV) would lose accuracy over a direct conversion from PV to
1800 IV(or UV). If it would, cache both conversions, return NV, but mark
1801 SV as IOK NOKp (ie not NOK).
1803 While converting from PV to IV, check to see if converting that IV to an
1804 NV would lose accuracy over a direct conversion from PV to NV. If it
1805 would, cache both conversions, flag similarly.
1807 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1808 correctly because if IV & NV were set NV *always* overruled.
1809 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1810 changes - now IV and NV together means that the two are interchangeable:
1811 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1813 The benefit of this is that operations such as pp_add know that if
1814 SvIOK is true for both left and right operands, then integer addition
1815 can be used instead of floating point (for cases where the result won't
1816 overflow). Before, floating point was always used, which could lead to
1817 loss of precision compared with integer addition.
1819 * making IV and NV equal status should make maths accurate on 64 bit
1821 * may speed up maths somewhat if pp_add and friends start to use
1822 integers when possible instead of fp. (Hopefully the overhead in
1823 looking for SvIOK and checking for overflow will not outweigh the
1824 fp to integer speedup)
1825 * will slow down integer operations (callers of SvIV) on "inaccurate"
1826 values, as the change from SvIOK to SvIOKp will cause a call into
1827 sv_2iv each time rather than a macro access direct to the IV slot
1828 * should speed up number->string conversion on integers as IV is
1829 favoured when IV and NV are equally accurate
1831 ####################################################################
1832 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1833 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1834 On the other hand, SvUOK is true iff UV.
1835 ####################################################################
1837 Your mileage will vary depending your CPU's relative fp to integer
1841 #ifndef NV_PRESERVES_UV
1842 # define IS_NUMBER_UNDERFLOW_IV 1
1843 # define IS_NUMBER_UNDERFLOW_UV 2
1844 # define IS_NUMBER_IV_AND_UV 2
1845 # define IS_NUMBER_OVERFLOW_IV 4
1846 # define IS_NUMBER_OVERFLOW_UV 5
1848 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1850 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1852 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1855 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1856 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));
1857 if (SvNVX(sv) < (NV)IV_MIN) {
1858 (void)SvIOKp_on(sv);
1860 SvIV_set(sv, IV_MIN);
1861 return IS_NUMBER_UNDERFLOW_IV;
1863 if (SvNVX(sv) > (NV)UV_MAX) {
1864 (void)SvIOKp_on(sv);
1867 SvUV_set(sv, UV_MAX);
1868 return IS_NUMBER_OVERFLOW_UV;
1870 (void)SvIOKp_on(sv);
1872 /* Can't use strtol etc to convert this string. (See truth table in
1874 if (SvNVX(sv) <= (UV)IV_MAX) {
1875 SvIV_set(sv, I_V(SvNVX(sv)));
1876 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1877 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1879 /* Integer is imprecise. NOK, IOKp */
1881 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1884 SvUV_set(sv, U_V(SvNVX(sv)));
1885 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1886 if (SvUVX(sv) == UV_MAX) {
1887 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1888 possibly be preserved by NV. Hence, it must be overflow.
1890 return IS_NUMBER_OVERFLOW_UV;
1892 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1894 /* Integer is imprecise. NOK, IOKp */
1896 return IS_NUMBER_OVERFLOW_IV;
1898 #endif /* !NV_PRESERVES_UV*/
1901 S_sv_2iuv_common(pTHX_ SV *sv) {
1904 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1905 * without also getting a cached IV/UV from it at the same time
1906 * (ie PV->NV conversion should detect loss of accuracy and cache
1907 * IV or UV at same time to avoid this. */
1908 /* IV-over-UV optimisation - choose to cache IV if possible */
1910 if (SvTYPE(sv) == SVt_NV)
1911 sv_upgrade(sv, SVt_PVNV);
1913 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1914 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1915 certainly cast into the IV range at IV_MAX, whereas the correct
1916 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1918 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1919 if (Perl_isnan(SvNVX(sv))) {
1925 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1926 SvIV_set(sv, I_V(SvNVX(sv)));
1927 if (SvNVX(sv) == (NV) SvIVX(sv)
1928 #ifndef NV_PRESERVES_UV
1929 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1930 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1931 /* Don't flag it as "accurately an integer" if the number
1932 came from a (by definition imprecise) NV operation, and
1933 we're outside the range of NV integer precision */
1936 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1937 DEBUG_c(PerlIO_printf(Perl_debug_log,
1938 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1944 /* IV not precise. No need to convert from PV, as NV
1945 conversion would already have cached IV if it detected
1946 that PV->IV would be better than PV->NV->IV
1947 flags already correct - don't set public IOK. */
1948 DEBUG_c(PerlIO_printf(Perl_debug_log,
1949 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1954 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1955 but the cast (NV)IV_MIN rounds to a the value less (more
1956 negative) than IV_MIN which happens to be equal to SvNVX ??
1957 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1958 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1959 (NV)UVX == NVX are both true, but the values differ. :-(
1960 Hopefully for 2s complement IV_MIN is something like
1961 0x8000000000000000 which will be exact. NWC */
1964 SvUV_set(sv, U_V(SvNVX(sv)));
1966 (SvNVX(sv) == (NV) SvUVX(sv))
1967 #ifndef NV_PRESERVES_UV
1968 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1969 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1970 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1971 /* Don't flag it as "accurately an integer" if the number
1972 came from a (by definition imprecise) NV operation, and
1973 we're outside the range of NV integer precision */
1978 DEBUG_c(PerlIO_printf(Perl_debug_log,
1979 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1985 else if (SvPOKp(sv) && SvLEN(sv)) {
1987 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1988 /* We want to avoid a possible problem when we cache an IV/ a UV which
1989 may be later translated to an NV, and the resulting NV is not
1990 the same as the direct translation of the initial string
1991 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1992 be careful to ensure that the value with the .456 is around if the
1993 NV value is requested in the future).
1995 This means that if we cache such an IV/a UV, we need to cache the
1996 NV as well. Moreover, we trade speed for space, and do not
1997 cache the NV if we are sure it's not needed.
2000 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2001 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2002 == IS_NUMBER_IN_UV) {
2003 /* It's definitely an integer, only upgrade to PVIV */
2004 if (SvTYPE(sv) < SVt_PVIV)
2005 sv_upgrade(sv, SVt_PVIV);
2007 } else if (SvTYPE(sv) < SVt_PVNV)
2008 sv_upgrade(sv, SVt_PVNV);
2010 /* If NVs preserve UVs then we only use the UV value if we know that
2011 we aren't going to call atof() below. If NVs don't preserve UVs
2012 then the value returned may have more precision than atof() will
2013 return, even though value isn't perfectly accurate. */
2014 if ((numtype & (IS_NUMBER_IN_UV
2015 #ifdef NV_PRESERVES_UV
2018 )) == IS_NUMBER_IN_UV) {
2019 /* This won't turn off the public IOK flag if it was set above */
2020 (void)SvIOKp_on(sv);
2022 if (!(numtype & IS_NUMBER_NEG)) {
2024 if (value <= (UV)IV_MAX) {
2025 SvIV_set(sv, (IV)value);
2027 /* it didn't overflow, and it was positive. */
2028 SvUV_set(sv, value);
2032 /* 2s complement assumption */
2033 if (value <= (UV)IV_MIN) {
2034 SvIV_set(sv, -(IV)value);
2036 /* Too negative for an IV. This is a double upgrade, but
2037 I'm assuming it will be rare. */
2038 if (SvTYPE(sv) < SVt_PVNV)
2039 sv_upgrade(sv, SVt_PVNV);
2043 SvNV_set(sv, -(NV)value);
2044 SvIV_set(sv, IV_MIN);
2048 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2049 will be in the previous block to set the IV slot, and the next
2050 block to set the NV slot. So no else here. */
2052 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2053 != IS_NUMBER_IN_UV) {
2054 /* It wasn't an (integer that doesn't overflow the UV). */
2055 SvNV_set(sv, Atof(SvPVX_const(sv)));
2057 if (! numtype && ckWARN(WARN_NUMERIC))
2060 #if defined(USE_LONG_DOUBLE)
2061 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2062 PTR2UV(sv), SvNVX(sv)));
2064 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2065 PTR2UV(sv), SvNVX(sv)));
2068 #ifdef NV_PRESERVES_UV
2069 (void)SvIOKp_on(sv);
2071 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2072 SvIV_set(sv, I_V(SvNVX(sv)));
2073 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2076 NOOP; /* Integer is imprecise. NOK, IOKp */
2078 /* UV will not work better than IV */
2080 if (SvNVX(sv) > (NV)UV_MAX) {
2082 /* Integer is inaccurate. NOK, IOKp, is UV */
2083 SvUV_set(sv, UV_MAX);
2085 SvUV_set(sv, U_V(SvNVX(sv)));
2086 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2087 NV preservse UV so can do correct comparison. */
2088 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2091 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2096 #else /* NV_PRESERVES_UV */
2097 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2098 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2099 /* The IV/UV slot will have been set from value returned by
2100 grok_number above. The NV slot has just been set using
2103 assert (SvIOKp(sv));
2105 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2106 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2107 /* Small enough to preserve all bits. */
2108 (void)SvIOKp_on(sv);
2110 SvIV_set(sv, I_V(SvNVX(sv)));
2111 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2113 /* Assumption: first non-preserved integer is < IV_MAX,
2114 this NV is in the preserved range, therefore: */
2115 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2117 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);
2121 0 0 already failed to read UV.
2122 0 1 already failed to read UV.
2123 1 0 you won't get here in this case. IV/UV
2124 slot set, public IOK, Atof() unneeded.
2125 1 1 already read UV.
2126 so there's no point in sv_2iuv_non_preserve() attempting
2127 to use atol, strtol, strtoul etc. */
2128 sv_2iuv_non_preserve (sv, numtype);
2131 #endif /* NV_PRESERVES_UV */
2135 if (isGV_with_GP(sv))
2136 return glob_2number((GV *)sv);
2138 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2139 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2142 if (SvTYPE(sv) < SVt_IV)
2143 /* Typically the caller expects that sv_any is not NULL now. */
2144 sv_upgrade(sv, SVt_IV);
2145 /* Return 0 from the caller. */
2152 =for apidoc sv_2iv_flags
2154 Return the integer value of an SV, doing any necessary string
2155 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2156 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2162 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2167 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2168 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2169 cache IVs just in case. In practice it seems that they never
2170 actually anywhere accessible by user Perl code, let alone get used
2171 in anything other than a string context. */
2172 if (flags & SV_GMAGIC)
2177 return I_V(SvNVX(sv));
2179 if (SvPOKp(sv) && SvLEN(sv)) {
2182 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2184 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2185 == IS_NUMBER_IN_UV) {
2186 /* It's definitely an integer */
2187 if (numtype & IS_NUMBER_NEG) {
2188 if (value < (UV)IV_MIN)
2191 if (value < (UV)IV_MAX)
2196 if (ckWARN(WARN_NUMERIC))
2199 return I_V(Atof(SvPVX_const(sv)));
2204 assert(SvTYPE(sv) >= SVt_PVMG);
2205 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2206 } else if (SvTHINKFIRST(sv)) {
2210 SV * const tmpstr=AMG_CALLun(sv,numer);
2211 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2212 return SvIV(tmpstr);
2215 return PTR2IV(SvRV(sv));
2218 sv_force_normal_flags(sv, 0);
2220 if (SvREADONLY(sv) && !SvOK(sv)) {
2221 if (ckWARN(WARN_UNINITIALIZED))
2227 if (S_sv_2iuv_common(aTHX_ sv))
2230 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2231 PTR2UV(sv),SvIVX(sv)));
2232 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2236 =for apidoc sv_2uv_flags
2238 Return the unsigned integer value of an SV, doing any necessary string
2239 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2240 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2246 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2251 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2252 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2253 cache IVs just in case. */
2254 if (flags & SV_GMAGIC)
2259 return U_V(SvNVX(sv));
2260 if (SvPOKp(sv) && SvLEN(sv)) {
2263 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2265 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2266 == IS_NUMBER_IN_UV) {
2267 /* It's definitely an integer */
2268 if (!(numtype & IS_NUMBER_NEG))
2272 if (ckWARN(WARN_NUMERIC))
2275 return U_V(Atof(SvPVX_const(sv)));
2280 assert(SvTYPE(sv) >= SVt_PVMG);
2281 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2282 } else if (SvTHINKFIRST(sv)) {
2286 SV *const tmpstr = AMG_CALLun(sv,numer);
2287 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2288 return SvUV(tmpstr);
2291 return PTR2UV(SvRV(sv));
2294 sv_force_normal_flags(sv, 0);
2296 if (SvREADONLY(sv) && !SvOK(sv)) {
2297 if (ckWARN(WARN_UNINITIALIZED))
2303 if (S_sv_2iuv_common(aTHX_ sv))
2307 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2308 PTR2UV(sv),SvUVX(sv)));
2309 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2315 Return the num value of an SV, doing any necessary string or integer
2316 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2323 Perl_sv_2nv(pTHX_ register SV *sv)
2328 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2329 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2330 cache IVs just in case. */
2334 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2335 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2336 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2338 return Atof(SvPVX_const(sv));
2342 return (NV)SvUVX(sv);
2344 return (NV)SvIVX(sv);
2349 assert(SvTYPE(sv) >= SVt_PVMG);
2350 /* This falls through to the report_uninit near the end of the
2352 } else if (SvTHINKFIRST(sv)) {
2356 SV *const tmpstr = AMG_CALLun(sv,numer);
2357 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2358 return SvNV(tmpstr);
2361 return PTR2NV(SvRV(sv));
2364 sv_force_normal_flags(sv, 0);
2366 if (SvREADONLY(sv) && !SvOK(sv)) {
2367 if (ckWARN(WARN_UNINITIALIZED))
2372 if (SvTYPE(sv) < SVt_NV) {
2373 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2374 sv_upgrade(sv, SVt_NV);
2375 #ifdef USE_LONG_DOUBLE
2377 STORE_NUMERIC_LOCAL_SET_STANDARD();
2378 PerlIO_printf(Perl_debug_log,
2379 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2380 PTR2UV(sv), SvNVX(sv));
2381 RESTORE_NUMERIC_LOCAL();
2385 STORE_NUMERIC_LOCAL_SET_STANDARD();
2386 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2387 PTR2UV(sv), SvNVX(sv));
2388 RESTORE_NUMERIC_LOCAL();
2392 else if (SvTYPE(sv) < SVt_PVNV)
2393 sv_upgrade(sv, SVt_PVNV);
2398 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2399 #ifdef NV_PRESERVES_UV
2402 /* Only set the public NV OK flag if this NV preserves the IV */
2403 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2404 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2405 : (SvIVX(sv) == I_V(SvNVX(sv))))
2411 else if (SvPOKp(sv) && SvLEN(sv)) {
2413 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2414 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2416 #ifdef NV_PRESERVES_UV
2417 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2418 == IS_NUMBER_IN_UV) {
2419 /* It's definitely an integer */
2420 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2422 SvNV_set(sv, Atof(SvPVX_const(sv)));
2425 SvNV_set(sv, Atof(SvPVX_const(sv)));
2426 /* Only set the public NV OK flag if this NV preserves the value in
2427 the PV at least as well as an IV/UV would.
2428 Not sure how to do this 100% reliably. */
2429 /* if that shift count is out of range then Configure's test is
2430 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2432 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2433 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2434 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2435 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2436 /* Can't use strtol etc to convert this string, so don't try.
2437 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2440 /* value has been set. It may not be precise. */
2441 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2442 /* 2s complement assumption for (UV)IV_MIN */
2443 SvNOK_on(sv); /* Integer is too negative. */
2448 if (numtype & IS_NUMBER_NEG) {
2449 SvIV_set(sv, -(IV)value);
2450 } else if (value <= (UV)IV_MAX) {
2451 SvIV_set(sv, (IV)value);
2453 SvUV_set(sv, value);
2457 if (numtype & IS_NUMBER_NOT_INT) {
2458 /* I believe that even if the original PV had decimals,
2459 they are lost beyond the limit of the FP precision.
2460 However, neither is canonical, so both only get p
2461 flags. NWC, 2000/11/25 */
2462 /* Both already have p flags, so do nothing */
2464 const NV nv = SvNVX(sv);
2465 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2466 if (SvIVX(sv) == I_V(nv)) {
2469 /* It had no "." so it must be integer. */
2473 /* between IV_MAX and NV(UV_MAX).
2474 Could be slightly > UV_MAX */
2476 if (numtype & IS_NUMBER_NOT_INT) {
2477 /* UV and NV both imprecise. */
2479 const UV nv_as_uv = U_V(nv);
2481 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2490 #endif /* NV_PRESERVES_UV */
2493 if (isGV_with_GP(sv)) {
2494 glob_2number((GV *)sv);
2498 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2500 assert (SvTYPE(sv) >= SVt_NV);
2501 /* Typically the caller expects that sv_any is not NULL now. */
2502 /* XXX Ilya implies that this is a bug in callers that assume this
2503 and ideally should be fixed. */
2506 #if defined(USE_LONG_DOUBLE)
2508 STORE_NUMERIC_LOCAL_SET_STANDARD();
2509 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2510 PTR2UV(sv), SvNVX(sv));
2511 RESTORE_NUMERIC_LOCAL();
2515 STORE_NUMERIC_LOCAL_SET_STANDARD();
2516 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2517 PTR2UV(sv), SvNVX(sv));
2518 RESTORE_NUMERIC_LOCAL();
2524 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2525 * UV as a string towards the end of buf, and return pointers to start and
2528 * We assume that buf is at least TYPE_CHARS(UV) long.
2532 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2534 char *ptr = buf + TYPE_CHARS(UV);
2535 char * const ebuf = ptr;
2548 *--ptr = '0' + (char)(uv % 10);
2557 =for apidoc sv_2pv_flags
2559 Returns a pointer to the string value of an SV, and sets *lp to its length.
2560 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2562 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2563 usually end up here too.
2569 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2579 if (SvGMAGICAL(sv)) {
2580 if (flags & SV_GMAGIC)
2585 if (flags & SV_MUTABLE_RETURN)
2586 return SvPVX_mutable(sv);
2587 if (flags & SV_CONST_RETURN)
2588 return (char *)SvPVX_const(sv);
2591 if (SvIOKp(sv) || SvNOKp(sv)) {
2592 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2597 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2598 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2600 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2607 #ifdef FIXNEGATIVEZERO
2608 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2614 SvUPGRADE(sv, SVt_PV);
2617 s = SvGROW_mutable(sv, len + 1);
2620 return (char*)memcpy(s, tbuf, len + 1);
2626 assert(SvTYPE(sv) >= SVt_PVMG);
2627 /* This falls through to the report_uninit near the end of the
2629 } else if (SvTHINKFIRST(sv)) {
2633 SV *const tmpstr = AMG_CALLun(sv,string);
2634 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2636 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2640 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2641 if (flags & SV_CONST_RETURN) {
2642 pv = (char *) SvPVX_const(tmpstr);
2644 pv = (flags & SV_MUTABLE_RETURN)
2645 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2648 *lp = SvCUR(tmpstr);
2650 pv = sv_2pv_flags(tmpstr, lp, flags);
2664 const SV *const referent = (SV*)SvRV(sv);
2668 retval = buffer = savepvn("NULLREF", len);
2669 } else if (SvTYPE(referent) == SVt_PVMG
2670 && ((SvFLAGS(referent) &
2671 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2672 == (SVs_OBJECT|SVs_SMG))
2673 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2678 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2683 PL_reginterp_cnt += haseval;
2686 const char *const typestr = sv_reftype(referent, 0);
2687 const STRLEN typelen = strlen(typestr);
2688 UV addr = PTR2UV(referent);
2689 const char *stashname = NULL;
2690 STRLEN stashnamelen = 0; /* hush, gcc */
2691 const char *buffer_end;
2693 if (SvOBJECT(referent)) {
2694 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2697 stashname = HEK_KEY(name);
2698 stashnamelen = HEK_LEN(name);
2700 if (HEK_UTF8(name)) {
2706 stashname = "__ANON__";
2709 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2710 + 2 * sizeof(UV) + 2 /* )\0 */;
2712 len = typelen + 3 /* (0x */
2713 + 2 * sizeof(UV) + 2 /* )\0 */;
2716 Newx(buffer, len, char);
2717 buffer_end = retval = buffer + len;
2719 /* Working backwards */
2723 *--retval = PL_hexdigit[addr & 15];
2724 } while (addr >>= 4);
2730 memcpy(retval, typestr, typelen);
2734 retval -= stashnamelen;
2735 memcpy(retval, stashname, stashnamelen);
2737 /* retval may not neccesarily have reached the start of the
2739 assert (retval >= buffer);
2741 len = buffer_end - retval - 1; /* -1 for that \0 */
2749 if (SvREADONLY(sv) && !SvOK(sv)) {
2750 if (ckWARN(WARN_UNINITIALIZED))
2757 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2758 /* I'm assuming that if both IV and NV are equally valid then
2759 converting the IV is going to be more efficient */
2760 const U32 isUIOK = SvIsUV(sv);
2761 char buf[TYPE_CHARS(UV)];
2764 if (SvTYPE(sv) < SVt_PVIV)
2765 sv_upgrade(sv, SVt_PVIV);
2766 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2767 /* inlined from sv_setpvn */
2768 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2769 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2770 SvCUR_set(sv, ebuf - ptr);
2774 else if (SvNOKp(sv)) {
2775 const int olderrno = errno;
2776 if (SvTYPE(sv) < SVt_PVNV)
2777 sv_upgrade(sv, SVt_PVNV);
2778 /* The +20 is pure guesswork. Configure test needed. --jhi */
2779 s = SvGROW_mutable(sv, NV_DIG + 20);
2780 /* some Xenix systems wipe out errno here */
2782 if (SvNVX(sv) == 0.0)
2783 my_strlcpy(s, "0", SvLEN(sv));
2787 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2790 #ifdef FIXNEGATIVEZERO
2791 if (*s == '-' && s[1] == '0' && !s[2])
2792 my_strlcpy(s, "0", SvLEN(s));
2801 if (isGV_with_GP(sv))
2802 return glob_2pv((GV *)sv, lp);
2804 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2808 if (SvTYPE(sv) < SVt_PV)
2809 /* Typically the caller expects that sv_any is not NULL now. */
2810 sv_upgrade(sv, SVt_PV);
2814 const STRLEN len = s - SvPVX_const(sv);
2820 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2821 PTR2UV(sv),SvPVX_const(sv)));
2822 if (flags & SV_CONST_RETURN)
2823 return (char *)SvPVX_const(sv);
2824 if (flags & SV_MUTABLE_RETURN)
2825 return SvPVX_mutable(sv);
2830 =for apidoc sv_copypv
2832 Copies a stringified representation of the source SV into the
2833 destination SV. Automatically performs any necessary mg_get and
2834 coercion of numeric values into strings. Guaranteed to preserve
2835 UTF-8 flag even from overloaded objects. Similar in nature to
2836 sv_2pv[_flags] but operates directly on an SV instead of just the
2837 string. Mostly uses sv_2pv_flags to do its work, except when that
2838 would lose the UTF-8'ness of the PV.
2844 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2847 const char * const s = SvPV_const(ssv,len);
2848 sv_setpvn(dsv,s,len);
2856 =for apidoc sv_2pvbyte
2858 Return a pointer to the byte-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be downgraded from UTF-8 as a
2862 Usually accessed via the C<SvPVbyte> macro.
2868 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2870 sv_utf8_downgrade(sv,0);
2871 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2pvutf8
2877 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2878 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2880 Usually accessed via the C<SvPVutf8> macro.
2886 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2888 sv_utf8_upgrade(sv);
2889 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2894 =for apidoc sv_2bool
2896 This function is only called on magical items, and is only used by
2897 sv_true() or its macro equivalent.
2903 Perl_sv_2bool(pTHX_ register SV *sv)
2912 SV * const tmpsv = AMG_CALLun(sv,bool_);
2913 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2914 return (bool)SvTRUE(tmpsv);
2916 return SvRV(sv) != 0;
2919 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2921 (*sv->sv_u.svu_pv > '0' ||
2922 Xpvtmp->xpv_cur > 1 ||
2923 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2930 return SvIVX(sv) != 0;
2933 return SvNVX(sv) != 0.0;
2935 if (isGV_with_GP(sv))
2945 =for apidoc sv_utf8_upgrade
2947 Converts the PV of an SV to its UTF-8-encoded form.
2948 Forces the SV to string form if it is not already.
2949 Always sets the SvUTF8 flag to avoid future validity checks even
2950 if all the bytes have hibit clear.
2952 This is not as a general purpose byte encoding to Unicode interface:
2953 use the Encode extension for that.
2955 =for apidoc sv_utf8_upgrade_flags
2957 Converts the PV of an SV to its UTF-8-encoded form.
2958 Forces the SV to string form if it is not already.
2959 Always sets the SvUTF8 flag to avoid future validity checks even
2960 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2961 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2962 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2964 This is not as a general purpose byte encoding to Unicode interface:
2965 use the Encode extension for that.
2971 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2974 if (sv == &PL_sv_undef)
2978 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2979 (void) sv_2pv_flags(sv,&len, flags);
2983 (void) SvPV_force(sv,len);
2992 sv_force_normal_flags(sv, 0);
2995 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2996 sv_recode_to_utf8(sv, PL_encoding);
2997 else { /* Assume Latin-1/EBCDIC */
2998 /* This function could be much more efficient if we
2999 * had a FLAG in SVs to signal if there are any hibit
3000 * chars in the PV. Given that there isn't such a flag
3001 * make the loop as fast as possible. */
3002 const U8 * const s = (U8 *) SvPVX_const(sv);
3003 const U8 * const e = (U8 *) SvEND(sv);
3008 /* Check for hi bit */
3009 if (!NATIVE_IS_INVARIANT(ch)) {
3010 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3011 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3013 SvPV_free(sv); /* No longer using what was there before. */
3014 SvPV_set(sv, (char*)recoded);
3015 SvCUR_set(sv, len - 1);
3016 SvLEN_set(sv, len); /* No longer know the real size. */
3020 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3027 =for apidoc sv_utf8_downgrade
3029 Attempts to convert the PV of an SV from characters to bytes.
3030 If the PV contains a character beyond byte, this conversion will fail;
3031 in this case, either returns false or, if C<fail_ok> is not
3034 This is not as a general purpose Unicode to byte encoding interface:
3035 use the Encode extension for that.
3041 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3044 if (SvPOKp(sv) && SvUTF8(sv)) {
3050 sv_force_normal_flags(sv, 0);
3052 s = (U8 *) SvPV(sv, len);
3053 if (!utf8_to_bytes(s, &len)) {
3058 Perl_croak(aTHX_ "Wide character in %s",
3061 Perl_croak(aTHX_ "Wide character");
3072 =for apidoc sv_utf8_encode
3074 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3075 flag off so that it looks like octets again.
3081 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3084 sv_force_normal_flags(sv, 0);
3086 if (SvREADONLY(sv)) {
3087 Perl_croak(aTHX_ PL_no_modify);
3089 (void) sv_utf8_upgrade(sv);
3094 =for apidoc sv_utf8_decode
3096 If the PV of the SV is an octet sequence in UTF-8
3097 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3098 so that it looks like a character. If the PV contains only single-byte
3099 characters, the C<SvUTF8> flag stays being off.
3100 Scans PV for validity and returns false if the PV is invalid UTF-8.
3106 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3112 /* The octets may have got themselves encoded - get them back as
3115 if (!sv_utf8_downgrade(sv, TRUE))
3118 /* it is actually just a matter of turning the utf8 flag on, but
3119 * we want to make sure everything inside is valid utf8 first.
3121 c = (const U8 *) SvPVX_const(sv);
3122 if (!is_utf8_string(c, SvCUR(sv)+1))
3124 e = (const U8 *) SvEND(sv);
3127 if (!UTF8_IS_INVARIANT(ch)) {
3137 =for apidoc sv_setsv
3139 Copies the contents of the source SV C<ssv> into the destination SV
3140 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3141 function if the source SV needs to be reused. Does not handle 'set' magic.
3142 Loosely speaking, it performs a copy-by-value, obliterating any previous
3143 content of the destination.
3145 You probably want to use one of the assortment of wrappers, such as
3146 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3147 C<SvSetMagicSV_nosteal>.
3149 =for apidoc sv_setsv_flags
3151 Copies the contents of the source SV C<ssv> into the destination SV
3152 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3153 function if the source SV needs to be reused. Does not handle 'set' magic.
3154 Loosely speaking, it performs a copy-by-value, obliterating any previous
3155 content of the destination.
3156 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3157 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3158 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3159 and C<sv_setsv_nomg> are implemented in terms of this function.
3161 You probably want to use one of the assortment of wrappers, such as
3162 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3163 C<SvSetMagicSV_nosteal>.
3165 This is the primary function for copying scalars, and most other
3166 copy-ish functions and macros use this underneath.
3172 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3174 if (dtype != SVt_PVGV) {
3175 const char * const name = GvNAME(sstr);
3176 const STRLEN len = GvNAMELEN(sstr);
3178 if (dtype >= SVt_PV) {
3184 SvUPGRADE(dstr, SVt_PVGV);
3185 (void)SvOK_off(dstr);
3186 /* FIXME - why are we doing this, then turning it off and on again
3188 isGV_with_GP_on(dstr);
3190 GvSTASH(dstr) = GvSTASH(sstr);
3192 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3193 gv_name_set((GV *)dstr, name, len, GV_ADD);
3194 SvFAKE_on(dstr); /* can coerce to non-glob */
3197 #ifdef GV_UNIQUE_CHECK
3198 if (GvUNIQUE((GV*)dstr)) {
3199 Perl_croak(aTHX_ PL_no_modify);
3204 isGV_with_GP_off(dstr);
3205 (void)SvOK_off(dstr);
3206 isGV_with_GP_on(dstr);
3207 GvINTRO_off(dstr); /* one-shot flag */
3208 GvGP(dstr) = gp_ref(GvGP(sstr));
3209 if (SvTAINTED(sstr))
3211 if (GvIMPORTED(dstr) != GVf_IMPORTED
3212 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3214 GvIMPORTED_on(dstr);
3221 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3222 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3224 const int intro = GvINTRO(dstr);
3227 const U32 stype = SvTYPE(sref);
3230 #ifdef GV_UNIQUE_CHECK
3231 if (GvUNIQUE((GV*)dstr)) {
3232 Perl_croak(aTHX_ PL_no_modify);
3237 GvINTRO_off(dstr); /* one-shot flag */
3238 GvLINE(dstr) = CopLINE(PL_curcop);
3239 GvEGV(dstr) = (GV*)dstr;
3244 location = (SV **) &GvCV(dstr);
3245 import_flag = GVf_IMPORTED_CV;
3248 location = (SV **) &GvHV(dstr);
3249 import_flag = GVf_IMPORTED_HV;
3252 location = (SV **) &GvAV(dstr);
3253 import_flag = GVf_IMPORTED_AV;
3256 location = (SV **) &GvIOp(dstr);
3259 location = (SV **) &GvFORM(dstr);
3261 location = &GvSV(dstr);
3262 import_flag = GVf_IMPORTED_SV;
3265 if (stype == SVt_PVCV) {
3266 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3267 SvREFCNT_dec(GvCV(dstr));
3269 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3270 PL_sub_generation++;
3273 SAVEGENERICSV(*location);
3277 if (stype == SVt_PVCV && *location != sref) {
3278 CV* const cv = (CV*)*location;
3280 if (!GvCVGEN((GV*)dstr) &&
3281 (CvROOT(cv) || CvXSUB(cv)))
3283 /* Redefining a sub - warning is mandatory if
3284 it was a const and its value changed. */
3285 if (CvCONST(cv) && CvCONST((CV*)sref)
3286 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3288 /* They are 2 constant subroutines generated from
3289 the same constant. This probably means that
3290 they are really the "same" proxy subroutine
3291 instantiated in 2 places. Most likely this is
3292 when a constant is exported twice. Don't warn.
3295 else if (ckWARN(WARN_REDEFINE)
3297 && (!CvCONST((CV*)sref)
3298 || sv_cmp(cv_const_sv(cv),
3299 cv_const_sv((CV*)sref))))) {
3300 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3303 ? "Constant subroutine %s::%s redefined"
3304 : "Subroutine %s::%s redefined"),
3305 HvNAME_get(GvSTASH((GV*)dstr)),
3306 GvENAME((GV*)dstr));
3310 cv_ckproto_len(cv, (GV*)dstr,
3311 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3312 SvPOK(sref) ? SvCUR(sref) : 0);
3314 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3315 GvASSUMECV_on(dstr);
3316 PL_sub_generation++;
3319 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3320 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3321 GvFLAGS(dstr) |= import_flag;
3326 if (SvTAINTED(sstr))
3332 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3335 register U32 sflags;
3337 register svtype stype;
3342 if (SvIS_FREED(dstr)) {
3343 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3344 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3346 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3348 sstr = &PL_sv_undef;
3349 if (SvIS_FREED(sstr)) {
3350 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3351 (void*)sstr, (void*)dstr);
3353 stype = SvTYPE(sstr);
3354 dtype = SvTYPE(dstr);
3359 /* need to nuke the magic */
3361 SvRMAGICAL_off(dstr);
3364 /* There's a lot of redundancy below but we're going for speed here */
3369 if (dtype != SVt_PVGV) {
3370 (void)SvOK_off(dstr);
3378 sv_upgrade(dstr, SVt_IV);
3383 sv_upgrade(dstr, SVt_PVIV);
3386 goto end_of_first_switch;
3388 (void)SvIOK_only(dstr);
3389 SvIV_set(dstr, SvIVX(sstr));
3392 /* SvTAINTED can only be true if the SV has taint magic, which in
3393 turn means that the SV type is PVMG (or greater). This is the
3394 case statement for SVt_IV, so this cannot be true (whatever gcov
3396 assert(!SvTAINTED(sstr));
3406 sv_upgrade(dstr, SVt_NV);
3411 sv_upgrade(dstr, SVt_PVNV);
3414 goto end_of_first_switch;
3416 SvNV_set(dstr, SvNVX(sstr));
3417 (void)SvNOK_only(dstr);
3418 /* SvTAINTED can only be true if the SV has taint magic, which in
3419 turn means that the SV type is PVMG (or greater). This is the
3420 case statement for SVt_NV, so this cannot be true (whatever gcov
3422 assert(!SvTAINTED(sstr));
3429 sv_upgrade(dstr, SVt_RV);
3432 #ifdef PERL_OLD_COPY_ON_WRITE
3433 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3434 if (dtype < SVt_PVIV)
3435 sv_upgrade(dstr, SVt_PVIV);
3442 sv_upgrade(dstr, SVt_PV);
3445 if (dtype < SVt_PVIV)
3446 sv_upgrade(dstr, SVt_PVIV);
3449 if (dtype < SVt_PVNV)
3450 sv_upgrade(dstr, SVt_PVNV);
3454 const char * const type = sv_reftype(sstr,0);
3456 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3458 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3462 /* case SVt_BIND: */
3465 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3466 glob_assign_glob(dstr, sstr, dtype);
3469 /* SvVALID means that this PVGV is playing at being an FBM. */
3473 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3475 if (SvTYPE(sstr) != stype) {
3476 stype = SvTYPE(sstr);
3477 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3478 glob_assign_glob(dstr, sstr, dtype);
3483 if (stype == SVt_PVLV)
3484 SvUPGRADE(dstr, SVt_PVNV);
3486 SvUPGRADE(dstr, (svtype)stype);
3488 end_of_first_switch:
3490 /* dstr may have been upgraded. */
3491 dtype = SvTYPE(dstr);
3492 sflags = SvFLAGS(sstr);
3494 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3495 /* Assigning to a subroutine sets the prototype. */
3498 const char *const ptr = SvPV_const(sstr, len);
3500 SvGROW(dstr, len + 1);
3501 Copy(ptr, SvPVX(dstr), len + 1, char);
3502 SvCUR_set(dstr, len);
3504 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3508 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3509 const char * const type = sv_reftype(dstr,0);
3511 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3513 Perl_croak(aTHX_ "Cannot copy to %s", type);
3514 } else if (sflags & SVf_ROK) {
3515 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3516 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3519 if (GvIMPORTED(dstr) != GVf_IMPORTED
3520 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3522 GvIMPORTED_on(dstr);
3527 glob_assign_glob(dstr, sstr, dtype);
3531 if (dtype >= SVt_PV) {
3532 if (dtype == SVt_PVGV) {
3533 glob_assign_ref(dstr, sstr);
3536 if (SvPVX_const(dstr)) {
3542 (void)SvOK_off(dstr);
3543 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3544 SvFLAGS(dstr) |= sflags & SVf_ROK;
3545 assert(!(sflags & SVp_NOK));
3546 assert(!(sflags & SVp_IOK));
3547 assert(!(sflags & SVf_NOK));
3548 assert(!(sflags & SVf_IOK));
3550 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3551 if (!(sflags & SVf_OK)) {
3552 if (ckWARN(WARN_MISC))
3553 Perl_warner(aTHX_ packWARN(WARN_MISC),
3554 "Undefined value assigned to typeglob");
3557 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3558 if (dstr != (SV*)gv) {
3561 GvGP(dstr) = gp_ref(GvGP(gv));
3565 else if (sflags & SVp_POK) {
3569 * Check to see if we can just swipe the string. If so, it's a
3570 * possible small lose on short strings, but a big win on long ones.
3571 * It might even be a win on short strings if SvPVX_const(dstr)
3572 * has to be allocated and SvPVX_const(sstr) has to be freed.
3573 * Likewise if we can set up COW rather than doing an actual copy, we
3574 * drop to the else clause, as the swipe code and the COW setup code
3575 * have much in common.
3578 /* Whichever path we take through the next code, we want this true,
3579 and doing it now facilitates the COW check. */
3580 (void)SvPOK_only(dstr);
3583 /* If we're already COW then this clause is not true, and if COW
3584 is allowed then we drop down to the else and make dest COW
3585 with us. If caller hasn't said that we're allowed to COW
3586 shared hash keys then we don't do the COW setup, even if the
3587 source scalar is a shared hash key scalar. */
3588 (((flags & SV_COW_SHARED_HASH_KEYS)
3589 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3590 : 1 /* If making a COW copy is forbidden then the behaviour we
3591 desire is as if the source SV isn't actually already
3592 COW, even if it is. So we act as if the source flags
3593 are not COW, rather than actually testing them. */
3595 #ifndef PERL_OLD_COPY_ON_WRITE
3596 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3597 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3598 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3599 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3600 but in turn, it's somewhat dead code, never expected to go
3601 live, but more kept as a placeholder on how to do it better
3602 in a newer implementation. */
3603 /* If we are COW and dstr is a suitable target then we drop down
3604 into the else and make dest a COW of us. */
3605 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3610 (sflags & SVs_TEMP) && /* slated for free anyway? */
3611 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3612 (!(flags & SV_NOSTEAL)) &&
3613 /* and we're allowed to steal temps */
3614 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3615 SvLEN(sstr) && /* and really is a string */
3616 /* and won't be needed again, potentially */
3617 !(PL_op && PL_op->op_type == OP_AASSIGN))
3618 #ifdef PERL_OLD_COPY_ON_WRITE
3619 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3620 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3621 && SvTYPE(sstr) >= SVt_PVIV)
3624 /* Failed the swipe test, and it's not a shared hash key either.
3625 Have to copy the string. */
3626 STRLEN len = SvCUR(sstr);
3627 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3628 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3629 SvCUR_set(dstr, len);
3630 *SvEND(dstr) = '\0';
3632 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3634 /* Either it's a shared hash key, or it's suitable for
3635 copy-on-write or we can swipe the string. */
3637 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3641 #ifdef PERL_OLD_COPY_ON_WRITE
3643 /* I believe I should acquire a global SV mutex if
3644 it's a COW sv (not a shared hash key) to stop
3645 it going un copy-on-write.
3646 If the source SV has gone un copy on write between up there
3647 and down here, then (assert() that) it is of the correct
3648 form to make it copy on write again */
3649 if ((sflags & (SVf_FAKE | SVf_READONLY))
3650 != (SVf_FAKE | SVf_READONLY)) {
3651 SvREADONLY_on(sstr);
3653 /* Make the source SV into a loop of 1.
3654 (about to become 2) */
3655 SV_COW_NEXT_SV_SET(sstr, sstr);
3659 /* Initial code is common. */
3660 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3665 /* making another shared SV. */
3666 STRLEN cur = SvCUR(sstr);
3667 STRLEN len = SvLEN(sstr);
3668 #ifdef PERL_OLD_COPY_ON_WRITE
3670 assert (SvTYPE(dstr) >= SVt_PVIV);
3671 /* SvIsCOW_normal */
3672 /* splice us in between source and next-after-source. */
3673 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3674 SV_COW_NEXT_SV_SET(sstr, dstr);
3675 SvPV_set(dstr, SvPVX_mutable(sstr));
3679 /* SvIsCOW_shared_hash */
3680 DEBUG_C(PerlIO_printf(Perl_debug_log,
3681 "Copy on write: Sharing hash\n"));
3683 assert (SvTYPE(dstr) >= SVt_PV);
3685 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3687 SvLEN_set(dstr, len);
3688 SvCUR_set(dstr, cur);
3689 SvREADONLY_on(dstr);
3691 /* Relesase a global SV mutex. */
3694 { /* Passes the swipe test. */
3695 SvPV_set(dstr, SvPVX_mutable(sstr));
3696 SvLEN_set(dstr, SvLEN(sstr));
3697 SvCUR_set(dstr, SvCUR(sstr));
3700 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3701 SvPV_set(sstr, NULL);
3707 if (sflags & SVp_NOK) {
3708 SvNV_set(dstr, SvNVX(sstr));
3710 if (sflags & SVp_IOK) {
3712 SvIV_set(dstr, SvIVX(sstr));
3713 /* Must do this otherwise some other overloaded use of 0x80000000
3714 gets confused. I guess SVpbm_VALID */
3715 if (sflags & SVf_IVisUV)
3718 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3720 const MAGIC * const smg = SvVSTRING_mg(sstr);
3722 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3723 smg->mg_ptr, smg->mg_len);
3724 SvRMAGICAL_on(dstr);
3728 else if (sflags & (SVp_IOK|SVp_NOK)) {
3729 (void)SvOK_off(dstr);
3730 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3731 if (sflags & SVp_IOK) {
3732 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3733 SvIV_set(dstr, SvIVX(sstr));
3735 if (sflags & SVp_NOK) {
3736 SvNV_set(dstr, SvNVX(sstr));
3740 if (isGV_with_GP(sstr)) {
3741 /* This stringification rule for globs is spread in 3 places.
3742 This feels bad. FIXME. */
3743 const U32 wasfake = sflags & SVf_FAKE;
3745 /* FAKE globs can get coerced, so need to turn this off
3746 temporarily if it is on. */
3748 gv_efullname3(dstr, (GV *)sstr, "*");
3749 SvFLAGS(sstr) |= wasfake;
3752 (void)SvOK_off(dstr);
3754 if (SvTAINTED(sstr))
3759 =for apidoc sv_setsv_mg
3761 Like C<sv_setsv>, but also handles 'set' magic.
3767 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3769 sv_setsv(dstr,sstr);
3773 #ifdef PERL_OLD_COPY_ON_WRITE
3775 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3777 STRLEN cur = SvCUR(sstr);
3778 STRLEN len = SvLEN(sstr);
3779 register char *new_pv;
3782 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3783 (void*)sstr, (void*)dstr);
3790 if (SvTHINKFIRST(dstr))
3791 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3792 else if (SvPVX_const(dstr))
3793 Safefree(SvPVX_const(dstr));
3797 SvUPGRADE(dstr, SVt_PVIV);
3799 assert (SvPOK(sstr));
3800 assert (SvPOKp(sstr));
3801 assert (!SvIOK(sstr));
3802 assert (!SvIOKp(sstr));
3803 assert (!SvNOK(sstr));
3804 assert (!SvNOKp(sstr));
3806 if (SvIsCOW(sstr)) {
3808 if (SvLEN(sstr) == 0) {
3809 /* source is a COW shared hash key. */
3810 DEBUG_C(PerlIO_printf(Perl_debug_log,
3811 "Fast copy on write: Sharing hash\n"));
3812 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3815 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3817 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3818 SvUPGRADE(sstr, SVt_PVIV);
3819 SvREADONLY_on(sstr);
3821 DEBUG_C(PerlIO_printf(Perl_debug_log,
3822 "Fast copy on write: Converting sstr to COW\n"));
3823 SV_COW_NEXT_SV_SET(dstr, sstr);
3825 SV_COW_NEXT_SV_SET(sstr, dstr);
3826 new_pv = SvPVX_mutable(sstr);
3829 SvPV_set(dstr, new_pv);
3830 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3833 SvLEN_set(dstr, len);
3834 SvCUR_set(dstr, cur);
3843 =for apidoc sv_setpvn
3845 Copies a string into an SV. The C<len> parameter indicates the number of
3846 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3847 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3853 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3856 register char *dptr;
3858 SV_CHECK_THINKFIRST_COW_DROP(sv);
3864 /* len is STRLEN which is unsigned, need to copy to signed */
3867 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3869 SvUPGRADE(sv, SVt_PV);
3871 dptr = SvGROW(sv, len + 1);
3872 Move(ptr,dptr,len,char);
3875 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3880 =for apidoc sv_setpvn_mg
3882 Like C<sv_setpvn>, but also handles 'set' magic.
3888 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3890 sv_setpvn(sv,ptr,len);
3895 =for apidoc sv_setpv
3897 Copies a string into an SV. The string must be null-terminated. Does not
3898 handle 'set' magic. See C<sv_setpv_mg>.
3904 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3907 register STRLEN len;
3909 SV_CHECK_THINKFIRST_COW_DROP(sv);
3915 SvUPGRADE(sv, SVt_PV);
3917 SvGROW(sv, len + 1);
3918 Move(ptr,SvPVX(sv),len+1,char);
3920 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3925 =for apidoc sv_setpv_mg
3927 Like C<sv_setpv>, but also handles 'set' magic.
3933 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3940 =for apidoc sv_usepvn_flags
3942 Tells an SV to use C<ptr> to find its string value. Normally the
3943 string is stored inside the SV but sv_usepvn allows the SV to use an
3944 outside string. The C<ptr> should point to memory that was allocated
3945 by C<malloc>. The string length, C<len>, must be supplied. By default
3946 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3947 so that pointer should not be freed or used by the programmer after
3948 giving it to sv_usepvn, and neither should any pointers from "behind"
3949 that pointer (e.g. ptr + 1) be used.
3951 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3952 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3953 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3954 C<len>, and already meets the requirements for storing in C<SvPVX>)
3960 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3964 SV_CHECK_THINKFIRST_COW_DROP(sv);
3965 SvUPGRADE(sv, SVt_PV);
3968 if (flags & SV_SMAGIC)
3972 if (SvPVX_const(sv))
3976 if (flags & SV_HAS_TRAILING_NUL)
3977 assert(ptr[len] == '\0');
3980 allocate = (flags & SV_HAS_TRAILING_NUL)
3981 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3982 if (flags & SV_HAS_TRAILING_NUL) {
3983 /* It's long enough - do nothing.
3984 Specfically Perl_newCONSTSUB is relying on this. */
3987 /* Force a move to shake out bugs in callers. */
3988 char *new_ptr = (char*)safemalloc(allocate);
3989 Copy(ptr, new_ptr, len, char);
3990 PoisonFree(ptr,len,char);
3994 ptr = (char*) saferealloc (ptr, allocate);
3999 SvLEN_set(sv, allocate);
4000 if (!(flags & SV_HAS_TRAILING_NUL)) {
4003 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4005 if (flags & SV_SMAGIC)
4009 #ifdef PERL_OLD_COPY_ON_WRITE
4010 /* Need to do this *after* making the SV normal, as we need the buffer
4011 pointer to remain valid until after we've copied it. If we let go too early,
4012 another thread could invalidate it by unsharing last of the same hash key
4013 (which it can do by means other than releasing copy-on-write Svs)
4014 or by changing the other copy-on-write SVs in the loop. */
4016 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4018 { /* this SV was SvIsCOW_normal(sv) */
4019 /* we need to find the SV pointing to us. */
4020 SV *current = SV_COW_NEXT_SV(after);
4022 if (current == sv) {
4023 /* The SV we point to points back to us (there were only two of us
4025 Hence other SV is no longer copy on write either. */
4027 SvREADONLY_off(after);
4029 /* We need to follow the pointers around the loop. */
4031 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4034 /* don't loop forever if the structure is bust, and we have
4035 a pointer into a closed loop. */
4036 assert (current != after);
4037 assert (SvPVX_const(current) == pvx);
4039 /* Make the SV before us point to the SV after us. */
4040 SV_COW_NEXT_SV_SET(current, after);
4046 =for apidoc sv_force_normal_flags
4048 Undo various types of fakery on an SV: if the PV is a shared string, make
4049 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4050 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4051 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4052 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4053 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4054 set to some other value.) In addition, the C<flags> parameter gets passed to
4055 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4056 with flags set to 0.
4062 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4065 #ifdef PERL_OLD_COPY_ON_WRITE
4066 if (SvREADONLY(sv)) {
4067 /* At this point I believe I should acquire a global SV mutex. */
4069 const char * const pvx = SvPVX_const(sv);
4070 const STRLEN len = SvLEN(sv);
4071 const STRLEN cur = SvCUR(sv);
4072 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4073 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4074 we'll fail an assertion. */
4075 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4078 PerlIO_printf(Perl_debug_log,
4079 "Copy on write: Force normal %ld\n",
4085 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4088 if (flags & SV_COW_DROP_PV) {
4089 /* OK, so we don't need to copy our buffer. */
4092 SvGROW(sv, cur + 1);
4093 Move(pvx,SvPVX(sv),cur,char);
4098 sv_release_COW(sv, pvx, next);
4100 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4106 else if (IN_PERL_RUNTIME)
4107 Perl_croak(aTHX_ PL_no_modify);
4108 /* At this point I believe that I can drop the global SV mutex. */
4111 if (SvREADONLY(sv)) {
4113 const char * const pvx = SvPVX_const(sv);
4114 const STRLEN len = SvCUR(sv);
4119 SvGROW(sv, len + 1);
4120 Move(pvx,SvPVX(sv),len,char);
4122 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4124 else if (IN_PERL_RUNTIME)
4125 Perl_croak(aTHX_ PL_no_modify);
4129 sv_unref_flags(sv, flags);
4130 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4137 Efficient removal of characters from the beginning of the string buffer.
4138 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4139 the string buffer. The C<ptr> becomes the first character of the adjusted
4140 string. Uses the "OOK hack".
4141 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4142 refer to the same chunk of data.
4148 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4150 register STRLEN delta;
4151 if (!ptr || !SvPOKp(sv))
4153 delta = ptr - SvPVX_const(sv);
4154 SV_CHECK_THINKFIRST(sv);
4155 if (SvTYPE(sv) < SVt_PVIV)
4156 sv_upgrade(sv,SVt_PVIV);
4159 if (!SvLEN(sv)) { /* make copy of shared string */
4160 const char *pvx = SvPVX_const(sv);
4161 const STRLEN len = SvCUR(sv);
4162 SvGROW(sv, len + 1);
4163 Move(pvx,SvPVX(sv),len,char);
4167 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4168 and we do that anyway inside the SvNIOK_off
4170 SvFLAGS(sv) |= SVf_OOK;
4173 SvLEN_set(sv, SvLEN(sv) - delta);
4174 SvCUR_set(sv, SvCUR(sv) - delta);
4175 SvPV_set(sv, SvPVX(sv) + delta);
4176 SvIV_set(sv, SvIVX(sv) + delta);
4180 =for apidoc sv_catpvn
4182 Concatenates the string onto the end of the string which is in the SV. The
4183 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4184 status set, then the bytes appended should be valid UTF-8.
4185 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4187 =for apidoc sv_catpvn_flags
4189 Concatenates the string onto the end of the string which is in the SV. The
4190 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4191 status set, then the bytes appended should be valid UTF-8.
4192 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4193 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4194 in terms of this function.
4200 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4204 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4206 SvGROW(dsv, dlen + slen + 1);
4208 sstr = SvPVX_const(dsv);
4209 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4210 SvCUR_set(dsv, SvCUR(dsv) + slen);
4212 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4214 if (flags & SV_SMAGIC)
4219 =for apidoc sv_catsv
4221 Concatenates the string from SV C<ssv> onto the end of the string in
4222 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4223 not 'set' magic. See C<sv_catsv_mg>.
4225 =for apidoc sv_catsv_flags
4227 Concatenates the string from SV C<ssv> onto the end of the string in
4228 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4229 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4230 and C<sv_catsv_nomg> are implemented in terms of this function.
4235 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4240 const char *spv = SvPV_const(ssv, slen);
4242 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4243 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4244 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4245 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4246 dsv->sv_flags doesn't have that bit set.
4247 Andy Dougherty 12 Oct 2001
4249 const I32 sutf8 = DO_UTF8(ssv);
4252 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4254 dutf8 = DO_UTF8(dsv);
4256 if (dutf8 != sutf8) {
4258 /* Not modifying source SV, so taking a temporary copy. */
4259 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4261 sv_utf8_upgrade(csv);
4262 spv = SvPV_const(csv, slen);
4265 sv_utf8_upgrade_nomg(dsv);
4267 sv_catpvn_nomg(dsv, spv, slen);
4270 if (flags & SV_SMAGIC)
4275 =for apidoc sv_catpv
4277 Concatenates the string onto the end of the string which is in the SV.
4278 If the SV has the UTF-8 status set, then the bytes appended should be
4279 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4284 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4287 register STRLEN len;
4293 junk = SvPV_force(sv, tlen);
4295 SvGROW(sv, tlen + len + 1);
4297 ptr = SvPVX_const(sv);
4298 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4299 SvCUR_set(sv, SvCUR(sv) + len);
4300 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4305 =for apidoc sv_catpv_mg
4307 Like C<sv_catpv>, but also handles 'set' magic.
4313 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4322 Creates a new SV. A non-zero C<len> parameter indicates the number of
4323 bytes of preallocated string space the SV should have. An extra byte for a
4324 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4325 space is allocated.) The reference count for the new SV is set to 1.
4327 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4328 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4329 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4330 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4331 modules supporting older perls.
4337 Perl_newSV(pTHX_ STRLEN len)
4344 sv_upgrade(sv, SVt_PV);
4345 SvGROW(sv, len + 1);
4350 =for apidoc sv_magicext
4352 Adds magic to an SV, upgrading it if necessary. Applies the
4353 supplied vtable and returns a pointer to the magic added.
4355 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4356 In particular, you can add magic to SvREADONLY SVs, and add more than
4357 one instance of the same 'how'.
4359 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4360 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4361 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4362 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4364 (This is now used as a subroutine by C<sv_magic>.)
4369 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4370 const char* name, I32 namlen)
4375 if (SvTYPE(sv) < SVt_PVMG) {
4376 SvUPGRADE(sv, SVt_PVMG);
4378 Newxz(mg, 1, MAGIC);
4379 mg->mg_moremagic = SvMAGIC(sv);
4380 SvMAGIC_set(sv, mg);
4382 /* Sometimes a magic contains a reference loop, where the sv and
4383 object refer to each other. To prevent a reference loop that
4384 would prevent such objects being freed, we look for such loops
4385 and if we find one we avoid incrementing the object refcount.
4387 Note we cannot do this to avoid self-tie loops as intervening RV must
4388 have its REFCNT incremented to keep it in existence.
4391 if (!obj || obj == sv ||
4392 how == PERL_MAGIC_arylen ||
4393 how == PERL_MAGIC_qr ||
4394 how == PERL_MAGIC_symtab ||
4395 (SvTYPE(obj) == SVt_PVGV &&
4396 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4397 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4398 GvFORM(obj) == (CV*)sv)))
4403 mg->mg_obj = SvREFCNT_inc_simple(obj);
4404 mg->mg_flags |= MGf_REFCOUNTED;
4407 /* Normal self-ties simply pass a null object, and instead of
4408 using mg_obj directly, use the SvTIED_obj macro to produce a
4409 new RV as needed. For glob "self-ties", we are tieing the PVIO
4410 with an RV obj pointing to the glob containing the PVIO. In
4411 this case, to avoid a reference loop, we need to weaken the
4415 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4416 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4422 mg->mg_len = namlen;
4425 mg->mg_ptr = savepvn(name, namlen);
4426 else if (namlen == HEf_SVKEY)
4427 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4429 mg->mg_ptr = (char *) name;
4431 mg->mg_virtual = (MGVTBL *) vtable;
4435 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4440 =for apidoc sv_magic
4442 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4443 then adds a new magic item of type C<how> to the head of the magic list.
4445 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4446 handling of the C<name> and C<namlen> arguments.
4448 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4449 to add more than one instance of the same 'how'.
4455 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4458 const MGVTBL *vtable;
4461 #ifdef PERL_OLD_COPY_ON_WRITE
4463 sv_force_normal_flags(sv, 0);
4465 if (SvREADONLY(sv)) {
4467 /* its okay to attach magic to shared strings; the subsequent
4468 * upgrade to PVMG will unshare the string */
4469 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4472 && how != PERL_MAGIC_regex_global
4473 && how != PERL_MAGIC_bm
4474 && how != PERL_MAGIC_fm
4475 && how != PERL_MAGIC_sv
4476 && how != PERL_MAGIC_backref
4479 Perl_croak(aTHX_ PL_no_modify);
4482 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4483 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4484 /* sv_magic() refuses to add a magic of the same 'how' as an
4487 if (how == PERL_MAGIC_taint) {
4489 /* Any scalar which already had taint magic on which someone
4490 (erroneously?) did SvIOK_on() or similar will now be
4491 incorrectly sporting public "OK" flags. */
4492 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4500 vtable = &PL_vtbl_sv;
4502 case PERL_MAGIC_overload:
4503 vtable = &PL_vtbl_amagic;
4505 case PERL_MAGIC_overload_elem:
4506 vtable = &PL_vtbl_amagicelem;
4508 case PERL_MAGIC_overload_table:
4509 vtable = &PL_vtbl_ovrld;
4512 vtable = &PL_vtbl_bm;
4514 case PERL_MAGIC_regdata:
4515 vtable = &PL_vtbl_regdata;
4517 case PERL_MAGIC_regdatum:
4518 vtable = &PL_vtbl_regdatum;
4520 case PERL_MAGIC_env:
4521 vtable = &PL_vtbl_env;
4524 vtable = &PL_vtbl_fm;
4526 case PERL_MAGIC_envelem:
4527 vtable = &PL_vtbl_envelem;
4529 case PERL_MAGIC_regex_global:
4530 vtable = &PL_vtbl_mglob;
4532 case PERL_MAGIC_isa:
4533 vtable = &PL_vtbl_isa;
4535 case PERL_MAGIC_isaelem:
4536 vtable = &PL_vtbl_isaelem;
4538 case PERL_MAGIC_nkeys:
4539 vtable = &PL_vtbl_nkeys;
4541 case PERL_MAGIC_dbfile:
4544 case PERL_MAGIC_dbline:
4545 vtable = &PL_vtbl_dbline;
4547 #ifdef USE_LOCALE_COLLATE
4548 case PERL_MAGIC_collxfrm:
4549 vtable = &PL_vtbl_collxfrm;
4551 #endif /* USE_LOCALE_COLLATE */
4552 case PERL_MAGIC_tied:
4553 vtable = &PL_vtbl_pack;
4555 case PERL_MAGIC_tiedelem:
4556 case PERL_MAGIC_tiedscalar:
4557 vtable = &PL_vtbl_packelem;
4560 vtable = &PL_vtbl_regexp;
4562 case PERL_MAGIC_hints:
4563 /* As this vtable is all NULL, we can reuse it. */
4564 case PERL_MAGIC_sig:
4565 vtable = &PL_vtbl_sig;
4567 case PERL_MAGIC_sigelem:
4568 vtable = &PL_vtbl_sigelem;
4570 case PERL_MAGIC_taint:
4571 vtable = &PL_vtbl_taint;
4573 case PERL_MAGIC_uvar:
4574 vtable = &PL_vtbl_uvar;
4576 case PERL_MAGIC_vec:
4577 vtable = &PL_vtbl_vec;
4579 case PERL_MAGIC_arylen_p:
4580 case PERL_MAGIC_rhash:
4581 case PERL_MAGIC_symtab:
4582 case PERL_MAGIC_vstring:
4585 case PERL_MAGIC_utf8:
4586 vtable = &PL_vtbl_utf8;
4588 case PERL_MAGIC_substr:
4589 vtable = &PL_vtbl_substr;
4591 case PERL_MAGIC_defelem:
4592 vtable = &PL_vtbl_defelem;
4594 case PERL_MAGIC_arylen:
4595 vtable = &PL_vtbl_arylen;
4597 case PERL_MAGIC_pos:
4598 vtable = &PL_vtbl_pos;
4600 case PERL_MAGIC_backref:
4601 vtable = &PL_vtbl_backref;
4603 case PERL_MAGIC_hintselem:
4604 vtable = &PL_vtbl_hintselem;
4606 case PERL_MAGIC_ext:
4607 /* Reserved for use by extensions not perl internals. */
4608 /* Useful for attaching extension internal data to perl vars. */
4609 /* Note that multiple extensions may clash if magical scalars */
4610 /* etc holding private data from one are passed to another. */
4614 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4617 /* Rest of work is done else where */
4618 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4621 case PERL_MAGIC_taint:
4624 case PERL_MAGIC_ext:
4625 case PERL_MAGIC_dbfile:
4632 =for apidoc sv_unmagic
4634 Removes all magic of type C<type> from an SV.
4640 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4644 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4646 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4647 for (mg = *mgp; mg; mg = *mgp) {
4648 if (mg->mg_type == type) {
4649 const MGVTBL* const vtbl = mg->mg_virtual;
4650 *mgp = mg->mg_moremagic;
4651 if (vtbl && vtbl->svt_free)
4652 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4653 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4655 Safefree(mg->mg_ptr);
4656 else if (mg->mg_len == HEf_SVKEY)
4657 SvREFCNT_dec((SV*)mg->mg_ptr);
4658 else if (mg->mg_type == PERL_MAGIC_utf8)
4659 Safefree(mg->mg_ptr);
4661 if (mg->mg_flags & MGf_REFCOUNTED)
4662 SvREFCNT_dec(mg->mg_obj);
4666 mgp = &mg->mg_moremagic;
4670 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4671 SvMAGIC_set(sv, NULL);
4678 =for apidoc sv_rvweaken
4680 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4681 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4682 push a back-reference to this RV onto the array of backreferences
4683 associated with that magic. If the RV is magical, set magic will be
4684 called after the RV is cleared.
4690 Perl_sv_rvweaken(pTHX_ SV *sv)
4693 if (!SvOK(sv)) /* let undefs pass */
4696 Perl_croak(aTHX_ "Can't weaken a nonreference");
4697 else if (SvWEAKREF(sv)) {
4698 if (ckWARN(WARN_MISC))
4699 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4703 Perl_sv_add_backref(aTHX_ tsv, sv);
4709 /* Give tsv backref magic if it hasn't already got it, then push a
4710 * back-reference to sv onto the array associated with the backref magic.
4714 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4719 if (SvTYPE(tsv) == SVt_PVHV) {
4720 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4724 /* There is no AV in the offical place - try a fixup. */
4725 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4728 /* Aha. They've got it stowed in magic. Bring it back. */
4729 av = (AV*)mg->mg_obj;
4730 /* Stop mg_free decreasing the refernce count. */
4732 /* Stop mg_free even calling the destructor, given that
4733 there's no AV to free up. */
4735 sv_unmagic(tsv, PERL_MAGIC_backref);
4739 SvREFCNT_inc_simple_void(av);
4744 const MAGIC *const mg
4745 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4747 av = (AV*)mg->mg_obj;
4751 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4752 /* av now has a refcnt of 2, which avoids it getting freed
4753 * before us during global cleanup. The extra ref is removed
4754 * by magic_killbackrefs() when tsv is being freed */
4757 if (AvFILLp(av) >= AvMAX(av)) {
4758 av_extend(av, AvFILLp(av)+1);
4760 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4763 /* delete a back-reference to ourselves from the backref magic associated
4764 * with the SV we point to.
4768 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4775 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4776 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4777 /* We mustn't attempt to "fix up" the hash here by moving the
4778 backreference array back to the hv_aux structure, as that is stored
4779 in the main HvARRAY(), and hfreentries assumes that no-one
4780 reallocates HvARRAY() while it is running. */
4783 const MAGIC *const mg
4784 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4786 av = (AV *)mg->mg_obj;
4789 if (PL_in_clean_all)
4791 Perl_croak(aTHX_ "panic: del_backref");
4798 /* We shouldn't be in here more than once, but for paranoia reasons lets
4800 for (i = AvFILLp(av); i >= 0; i--) {
4802 const SSize_t fill = AvFILLp(av);
4804 /* We weren't the last entry.
4805 An unordered list has this property that you can take the
4806 last element off the end to fill the hole, and it's still
4807 an unordered list :-)
4812 AvFILLp(av) = fill - 1;
4818 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4820 SV **svp = AvARRAY(av);
4822 PERL_UNUSED_ARG(sv);
4824 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4825 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4826 if (svp && !SvIS_FREED(av)) {
4827 SV *const *const last = svp + AvFILLp(av);
4829 while (svp <= last) {
4831 SV *const referrer = *svp;
4832 if (SvWEAKREF(referrer)) {
4833 /* XXX Should we check that it hasn't changed? */
4834 SvRV_set(referrer, 0);
4836 SvWEAKREF_off(referrer);
4837 SvSETMAGIC(referrer);
4838 } else if (SvTYPE(referrer) == SVt_PVGV ||
4839 SvTYPE(referrer) == SVt_PVLV) {
4840 /* You lookin' at me? */
4841 assert(GvSTASH(referrer));
4842 assert(GvSTASH(referrer) == (HV*)sv);
4843 GvSTASH(referrer) = 0;
4846 "panic: magic_killbackrefs (flags=%"UVxf")",
4847 (UV)SvFLAGS(referrer));
4855 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4860 =for apidoc sv_insert
4862 Inserts a string at the specified offset/length within the SV. Similar to
4863 the Perl substr() function.
4869 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4874 register char *midend;
4875 register char *bigend;
4881 Perl_croak(aTHX_ "Can't modify non-existent substring");
4882 SvPV_force(bigstr, curlen);
4883 (void)SvPOK_only_UTF8(bigstr);
4884 if (offset + len > curlen) {
4885 SvGROW(bigstr, offset+len+1);
4886 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4887 SvCUR_set(bigstr, offset+len);
4891 i = littlelen - len;
4892 if (i > 0) { /* string might grow */
4893 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4894 mid = big + offset + len;
4895 midend = bigend = big + SvCUR(bigstr);
4898 while (midend > mid) /* shove everything down */
4899 *--bigend = *--midend;
4900 Move(little,big+offset,littlelen,char);
4901 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4906 Move(little,SvPVX(bigstr)+offset,len,char);
4911 big = SvPVX(bigstr);
4914 bigend = big + SvCUR(bigstr);
4916 if (midend > bigend)
4917 Perl_croak(aTHX_ "panic: sv_insert");
4919 if (mid - big > bigend - midend) { /* faster to shorten from end */
4921 Move(little, mid, littlelen,char);
4924 i = bigend - midend;
4926 Move(midend, mid, i,char);
4930 SvCUR_set(bigstr, mid - big);
4932 else if ((i = mid - big)) { /* faster from front */
4933 midend -= littlelen;
4935 sv_chop(bigstr,midend-i);
4940 Move(little, mid, littlelen,char);
4942 else if (littlelen) {
4943 midend -= littlelen;
4944 sv_chop(bigstr,midend);
4945 Move(little,midend,littlelen,char);
4948 sv_chop(bigstr,midend);
4954 =for apidoc sv_replace
4956 Make the first argument a copy of the second, then delete the original.
4957 The target SV physically takes over ownership of the body of the source SV
4958 and inherits its flags; however, the target keeps any magic it owns,
4959 and any magic in the source is discarded.
4960 Note that this is a rather specialist SV copying operation; most of the
4961 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4967 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4970 const U32 refcnt = SvREFCNT(sv);
4971 SV_CHECK_THINKFIRST_COW_DROP(sv);
4972 if (SvREFCNT(nsv) != 1) {
4973 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4974 UVuf " != 1)", (UV) SvREFCNT(nsv));
4976 if (SvMAGICAL(sv)) {
4980 sv_upgrade(nsv, SVt_PVMG);
4981 SvMAGIC_set(nsv, SvMAGIC(sv));
4982 SvFLAGS(nsv) |= SvMAGICAL(sv);
4984 SvMAGIC_set(sv, NULL);
4988 assert(!SvREFCNT(sv));
4989 #ifdef DEBUG_LEAKING_SCALARS
4990 sv->sv_flags = nsv->sv_flags;
4991 sv->sv_any = nsv->sv_any;
4992 sv->sv_refcnt = nsv->sv_refcnt;
4993 sv->sv_u = nsv->sv_u;
4995 StructCopy(nsv,sv,SV);
4997 /* Currently could join these into one piece of pointer arithmetic, but
4998 it would be unclear. */
4999 if(SvTYPE(sv) == SVt_IV)
5001 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5002 else if (SvTYPE(sv) == SVt_RV) {
5003 SvANY(sv) = &sv->sv_u.svu_rv;
5007 #ifdef PERL_OLD_COPY_ON_WRITE
5008 if (SvIsCOW_normal(nsv)) {
5009 /* We need to follow the pointers around the loop to make the
5010 previous SV point to sv, rather than nsv. */
5013 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5016 assert(SvPVX_const(current) == SvPVX_const(nsv));
5018 /* Make the SV before us point to the SV after us. */
5020 PerlIO_printf(Perl_debug_log, "previous is\n");
5022 PerlIO_printf(Perl_debug_log,
5023 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5024 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5026 SV_COW_NEXT_SV_SET(current, sv);
5029 SvREFCNT(sv) = refcnt;
5030 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5036 =for apidoc sv_clear
5038 Clear an SV: call any destructors, free up any memory used by the body,
5039 and free the body itself. The SV's head is I<not> freed, although
5040 its type is set to all 1's so that it won't inadvertently be assumed
5041 to be live during global destruction etc.
5042 This function should only be called when REFCNT is zero. Most of the time
5043 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5050 Perl_sv_clear(pTHX_ register SV *sv)
5053 const U32 type = SvTYPE(sv);
5054 const struct body_details *const sv_type_details
5055 = bodies_by_type + type;
5058 assert(SvREFCNT(sv) == 0);
5060 if (type <= SVt_IV) {
5061 /* See the comment in sv.h about the collusion between this early
5062 return and the overloading of the NULL and IV slots in the size
5068 if (PL_defstash) { /* Still have a symbol table? */
5073 stash = SvSTASH(sv);
5074 destructor = StashHANDLER(stash,DESTROY);
5076 SV* const tmpref = newRV(sv);
5077 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5079 PUSHSTACKi(PERLSI_DESTROY);
5084 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5090 if(SvREFCNT(tmpref) < 2) {
5091 /* tmpref is not kept alive! */
5093 SvRV_set(tmpref, NULL);
5096 SvREFCNT_dec(tmpref);
5098 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5102 if (PL_in_clean_objs)
5103 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5105 /* DESTROY gave object new lease on life */
5111 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5112 SvOBJECT_off(sv); /* Curse the object. */
5113 if (type != SVt_PVIO)
5114 --PL_sv_objcount; /* XXX Might want something more general */
5117 if (type >= SVt_PVMG) {
5118 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5119 SvREFCNT_dec(SvOURSTASH(sv));
5120 } else if (SvMAGIC(sv))
5122 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5123 SvREFCNT_dec(SvSTASH(sv));
5126 /* case SVt_BIND: */
5129 IoIFP(sv) != PerlIO_stdin() &&
5130 IoIFP(sv) != PerlIO_stdout() &&
5131 IoIFP(sv) != PerlIO_stderr())
5133 io_close((IO*)sv, FALSE);
5135 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5136 PerlDir_close(IoDIRP(sv));
5137 IoDIRP(sv) = (DIR*)NULL;
5138 Safefree(IoTOP_NAME(sv));
5139 Safefree(IoFMT_NAME(sv));
5140 Safefree(IoBOTTOM_NAME(sv));
5147 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5154 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5155 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5156 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5157 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5159 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5160 SvREFCNT_dec(LvTARG(sv));
5162 if (isGV_with_GP(sv)) {
5165 unshare_hek(GvNAME_HEK(sv));
5166 /* If we're in a stash, we don't own a reference to it. However it does
5167 have a back reference to us, which needs to be cleared. */
5168 if (!SvVALID(sv) && GvSTASH(sv))
5169 sv_del_backref((SV*)GvSTASH(sv), sv);
5175 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5177 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5178 /* Don't even bother with turning off the OOK flag. */
5183 SV * const target = SvRV(sv);
5185 sv_del_backref(target, sv);
5187 SvREFCNT_dec(target);
5189 #ifdef PERL_OLD_COPY_ON_WRITE
5190 else if (SvPVX_const(sv)) {
5192 /* I believe I need to grab the global SV mutex here and
5193 then recheck the COW status. */
5195 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5199 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5201 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5204 /* And drop it here. */
5206 } else if (SvLEN(sv)) {
5207 Safefree(SvPVX_const(sv));
5211 else if (SvPVX_const(sv) && SvLEN(sv))
5212 Safefree(SvPVX_mutable(sv));
5213 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5214 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5223 SvFLAGS(sv) &= SVf_BREAK;
5224 SvFLAGS(sv) |= SVTYPEMASK;
5226 if (sv_type_details->arena) {
5227 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5228 &PL_body_roots[type]);
5230 else if (sv_type_details->body_size) {
5231 my_safefree(SvANY(sv));
5236 =for apidoc sv_newref
5238 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5245 Perl_sv_newref(pTHX_ SV *sv)
5247 PERL_UNUSED_CONTEXT;
5256 Decrement an SV's reference count, and if it drops to zero, call
5257 C<sv_clear> to invoke destructors and free up any memory used by
5258 the body; finally, deallocate the SV's head itself.
5259 Normally called via a wrapper macro C<SvREFCNT_dec>.
5265 Perl_sv_free(pTHX_ SV *sv)
5270 if (SvREFCNT(sv) == 0) {
5271 if (SvFLAGS(sv) & SVf_BREAK)
5272 /* this SV's refcnt has been artificially decremented to
5273 * trigger cleanup */
5275 if (PL_in_clean_all) /* All is fair */
5277 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5278 /* make sure SvREFCNT(sv)==0 happens very seldom */
5279 SvREFCNT(sv) = (~(U32)0)/2;
5282 if (ckWARN_d(WARN_INTERNAL)) {
5283 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5284 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5285 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5286 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5287 Perl_dump_sv_child(aTHX_ sv);
5292 if (--(SvREFCNT(sv)) > 0)
5294 Perl_sv_free2(aTHX_ sv);
5298 Perl_sv_free2(pTHX_ SV *sv)
5303 if (ckWARN_d(WARN_DEBUGGING))
5304 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5305 "Attempt to free temp prematurely: SV 0x%"UVxf
5306 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5310 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5311 /* make sure SvREFCNT(sv)==0 happens very seldom */
5312 SvREFCNT(sv) = (~(U32)0)/2;
5323 Returns the length of the string in the SV. Handles magic and type
5324 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5330 Perl_sv_len(pTHX_ register SV *sv)
5338 len = mg_length(sv);
5340 (void)SvPV_const(sv, len);
5345 =for apidoc sv_len_utf8
5347 Returns the number of characters in the string in an SV, counting wide
5348 UTF-8 bytes as a single character. Handles magic and type coercion.
5354 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5355 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5356 * (Note that the mg_len is not the length of the mg_ptr field.
5357 * This allows the cache to store the character length of the string without
5358 * needing to malloc() extra storage to attach to the mg_ptr.)
5363 Perl_sv_len_utf8(pTHX_ register SV *sv)
5369 return mg_length(sv);
5373 const U8 *s = (U8*)SvPV_const(sv, len);
5377 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5379 if (mg && mg->mg_len != -1) {
5381 if (PL_utf8cache < 0) {
5382 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5384 /* Need to turn the assertions off otherwise we may
5385 recurse infinitely while printing error messages.
5387 SAVEI8(PL_utf8cache);
5389 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5390 " real %"UVuf" for %"SVf,
5391 (UV) ulen, (UV) real, SVfARG(sv));
5396 ulen = Perl_utf8_length(aTHX_ s, s + len);
5397 if (!SvREADONLY(sv)) {
5399 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5400 &PL_vtbl_utf8, 0, 0);
5408 return Perl_utf8_length(aTHX_ s, s + len);
5412 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5415 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5418 const U8 *s = start;
5420 while (s < send && uoffset--)
5423 /* This is the existing behaviour. Possibly it should be a croak, as
5424 it's actually a bounds error */
5430 /* Given the length of the string in both bytes and UTF-8 characters, decide
5431 whether to walk forwards or backwards to find the byte corresponding to
5432 the passed in UTF-8 offset. */
5434 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5435 STRLEN uoffset, STRLEN uend)
5437 STRLEN backw = uend - uoffset;
5438 if (uoffset < 2 * backw) {
5439 /* The assumption is that going forwards is twice the speed of going
5440 forward (that's where the 2 * backw comes from).
5441 (The real figure of course depends on the UTF-8 data.) */
5442 return sv_pos_u2b_forwards(start, send, uoffset);
5447 while (UTF8_IS_CONTINUATION(*send))
5450 return send - start;
5453 /* For the string representation of the given scalar, find the byte
5454 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5455 give another position in the string, *before* the sought offset, which
5456 (which is always true, as 0, 0 is a valid pair of positions), which should
5457 help reduce the amount of linear searching.
5458 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5459 will be used to reduce the amount of linear searching. The cache will be
5460 created if necessary, and the found value offered to it for update. */
5462 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5463 const U8 *const send, STRLEN uoffset,
5464 STRLEN uoffset0, STRLEN boffset0) {
5465 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5468 assert (uoffset >= uoffset0);
5470 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5471 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5472 if ((*mgp)->mg_ptr) {
5473 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5474 if (cache[0] == uoffset) {
5475 /* An exact match. */
5478 if (cache[2] == uoffset) {
5479 /* An exact match. */
5483 if (cache[0] < uoffset) {
5484 /* The cache already knows part of the way. */
5485 if (cache[0] > uoffset0) {
5486 /* The cache knows more than the passed in pair */
5487 uoffset0 = cache[0];
5488 boffset0 = cache[1];
5490 if ((*mgp)->mg_len != -1) {
5491 /* And we know the end too. */
5493 + sv_pos_u2b_midway(start + boffset0, send,
5495 (*mgp)->mg_len - uoffset0);
5498 + sv_pos_u2b_forwards(start + boffset0,
5499 send, uoffset - uoffset0);
5502 else if (cache[2] < uoffset) {
5503 /* We're between the two cache entries. */
5504 if (cache[2] > uoffset0) {
5505 /* and the cache knows more than the passed in pair */
5506 uoffset0 = cache[2];
5507 boffset0 = cache[3];
5511 + sv_pos_u2b_midway(start + boffset0,
5514 cache[0] - uoffset0);
5517 + sv_pos_u2b_midway(start + boffset0,
5520 cache[2] - uoffset0);
5524 else if ((*mgp)->mg_len != -1) {
5525 /* If we can take advantage of a passed in offset, do so. */
5526 /* In fact, offset0 is either 0, or less than offset, so don't
5527 need to worry about the other possibility. */
5529 + sv_pos_u2b_midway(start + boffset0, send,
5531 (*mgp)->mg_len - uoffset0);
5536 if (!found || PL_utf8cache < 0) {
5537 const STRLEN real_boffset
5538 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5539 send, uoffset - uoffset0);
5541 if (found && PL_utf8cache < 0) {
5542 if (real_boffset != boffset) {
5543 /* Need to turn the assertions off otherwise we may recurse
5544 infinitely while printing error messages. */
5545 SAVEI8(PL_utf8cache);
5547 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5548 " real %"UVuf" for %"SVf,
5549 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5552 boffset = real_boffset;
5555 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5561 =for apidoc sv_pos_u2b
5563 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5564 the start of the string, to a count of the equivalent number of bytes; if
5565 lenp is non-zero, it does the same to lenp, but this time starting from
5566 the offset, rather than from the start of the string. Handles magic and
5573 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5574 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5575 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5580 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5588 start = (U8*)SvPV_const(sv, len);
5590 STRLEN uoffset = (STRLEN) *offsetp;
5591 const U8 * const send = start + len;
5593 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5596 *offsetp = (I32) boffset;
5599 /* Convert the relative offset to absolute. */
5600 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5601 const STRLEN boffset2
5602 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5603 uoffset, boffset) - boffset;
5617 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5618 byte length pairing. The (byte) length of the total SV is passed in too,
5619 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5620 may not have updated SvCUR, so we can't rely on reading it directly.
5622 The proffered utf8/byte length pairing isn't used if the cache already has
5623 two pairs, and swapping either for the proffered pair would increase the
5624 RMS of the intervals between known byte offsets.
5626 The cache itself consists of 4 STRLEN values
5627 0: larger UTF-8 offset
5628 1: corresponding byte offset
5629 2: smaller UTF-8 offset
5630 3: corresponding byte offset
5632 Unused cache pairs have the value 0, 0.
5633 Keeping the cache "backwards" means that the invariant of
5634 cache[0] >= cache[2] is maintained even with empty slots, which means that
5635 the code that uses it doesn't need to worry if only 1 entry has actually
5636 been set to non-zero. It also makes the "position beyond the end of the
5637 cache" logic much simpler, as the first slot is always the one to start
5641 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5649 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5651 (*mgp)->mg_len = -1;
5655 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5656 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5657 (*mgp)->mg_ptr = (char *) cache;
5661 if (PL_utf8cache < 0) {
5662 const U8 *start = (const U8 *) SvPVX_const(sv);
5663 const STRLEN realutf8 = utf8_length(start, start + byte);
5665 if (realutf8 != utf8) {
5666 /* Need to turn the assertions off otherwise we may recurse
5667 infinitely while printing error messages. */
5668 SAVEI8(PL_utf8cache);
5670 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5671 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5675 /* Cache is held with the later position first, to simplify the code
5676 that deals with unbounded ends. */
5678 ASSERT_UTF8_CACHE(cache);
5679 if (cache[1] == 0) {
5680 /* Cache is totally empty */
5683 } else if (cache[3] == 0) {
5684 if (byte > cache[1]) {
5685 /* New one is larger, so goes first. */
5686 cache[2] = cache[0];
5687 cache[3] = cache[1];
5695 #define THREEWAY_SQUARE(a,b,c,d) \
5696 ((float)((d) - (c))) * ((float)((d) - (c))) \
5697 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5698 + ((float)((b) - (a))) * ((float)((b) - (a)))
5700 /* Cache has 2 slots in use, and we know three potential pairs.
5701 Keep the two that give the lowest RMS distance. Do the
5702 calcualation in bytes simply because we always know the byte
5703 length. squareroot has the same ordering as the positive value,
5704 so don't bother with the actual square root. */
5705 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5706 if (byte > cache[1]) {
5707 /* New position is after the existing pair of pairs. */
5708 const float keep_earlier
5709 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5710 const float keep_later
5711 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5713 if (keep_later < keep_earlier) {
5714 if (keep_later < existing) {
5715 cache[2] = cache[0];
5716 cache[3] = cache[1];
5722 if (keep_earlier < existing) {
5728 else if (byte > cache[3]) {
5729 /* New position is between the existing pair of pairs. */
5730 const float keep_earlier
5731 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5732 const float keep_later
5733 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5735 if (keep_later < keep_earlier) {
5736 if (keep_later < existing) {
5742 if (keep_earlier < existing) {
5749 /* New position is before the existing pair of pairs. */
5750 const float keep_earlier
5751 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5752 const float keep_later
5753 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5755 if (keep_later < keep_earlier) {
5756 if (keep_later < existing) {
5762 if (keep_earlier < existing) {
5763 cache[0] = cache[2];
5764 cache[1] = cache[3];
5771 ASSERT_UTF8_CACHE(cache);
5774 /* We already know all of the way, now we may be able to walk back. The same
5775 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5776 backward is half the speed of walking forward. */
5778 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5781 const STRLEN forw = target - s;
5782 STRLEN backw = end - target;
5784 if (forw < 2 * backw) {
5785 return utf8_length(s, target);
5788 while (end > target) {
5790 while (UTF8_IS_CONTINUATION(*end)) {
5799 =for apidoc sv_pos_b2u
5801 Converts the value pointed to by offsetp from a count of bytes from the
5802 start of the string, to a count of the equivalent number of UTF-8 chars.
5803 Handles magic and type coercion.
5809 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5810 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5815 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5818 const STRLEN byte = *offsetp;
5819 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5828 s = (const U8*)SvPV_const(sv, blen);
5831 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5835 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5836 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5838 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5839 if (cache[1] == byte) {
5840 /* An exact match. */
5841 *offsetp = cache[0];
5844 if (cache[3] == byte) {
5845 /* An exact match. */
5846 *offsetp = cache[2];
5850 if (cache[1] < byte) {
5851 /* We already know part of the way. */
5852 if (mg->mg_len != -1) {
5853 /* Actually, we know the end too. */
5855 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5856 s + blen, mg->mg_len - cache[0]);
5858 len = cache[0] + utf8_length(s + cache[1], send);
5861 else if (cache[3] < byte) {
5862 /* We're between the two cached pairs, so we do the calculation
5863 offset by the byte/utf-8 positions for the earlier pair,
5864 then add the utf-8 characters from the string start to
5866 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5867 s + cache[1], cache[0] - cache[2])
5871 else { /* cache[3] > byte */
5872 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5876 ASSERT_UTF8_CACHE(cache);
5878 } else if (mg->mg_len != -1) {
5879 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5883 if (!found || PL_utf8cache < 0) {
5884 const STRLEN real_len = utf8_length(s, send);
5886 if (found && PL_utf8cache < 0) {
5887 if (len != real_len) {
5888 /* Need to turn the assertions off otherwise we may recurse
5889 infinitely while printing error messages. */
5890 SAVEI8(PL_utf8cache);
5892 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5893 " real %"UVuf" for %"SVf,
5894 (UV) len, (UV) real_len, SVfARG(sv));
5901 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5907 Returns a boolean indicating whether the strings in the two SVs are
5908 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5909 coerce its args to strings if necessary.
5915 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5924 SV* svrecode = NULL;
5931 /* if pv1 and pv2 are the same, second SvPV_const call may
5932 * invalidate pv1, so we may need to make a copy */
5933 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5934 pv1 = SvPV_const(sv1, cur1);
5935 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5936 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5938 pv1 = SvPV_const(sv1, cur1);
5946 pv2 = SvPV_const(sv2, cur2);
5948 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5949 /* Differing utf8ness.
5950 * Do not UTF8size the comparands as a side-effect. */
5953 svrecode = newSVpvn(pv2, cur2);
5954 sv_recode_to_utf8(svrecode, PL_encoding);
5955 pv2 = SvPV_const(svrecode, cur2);
5958 svrecode = newSVpvn(pv1, cur1);
5959 sv_recode_to_utf8(svrecode, PL_encoding);
5960 pv1 = SvPV_const(svrecode, cur1);
5962 /* Now both are in UTF-8. */
5964 SvREFCNT_dec(svrecode);
5969 bool is_utf8 = TRUE;
5972 /* sv1 is the UTF-8 one,
5973 * if is equal it must be downgrade-able */
5974 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5980 /* sv2 is the UTF-8 one,
5981 * if is equal it must be downgrade-able */
5982 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5988 /* Downgrade not possible - cannot be eq */
5996 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5998 SvREFCNT_dec(svrecode);
6008 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6009 string in C<sv1> is less than, equal to, or greater than the string in
6010 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6011 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6017 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6021 const char *pv1, *pv2;
6024 SV *svrecode = NULL;
6031 pv1 = SvPV_const(sv1, cur1);
6038 pv2 = SvPV_const(sv2, cur2);
6040 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6041 /* Differing utf8ness.
6042 * Do not UTF8size the comparands as a side-effect. */
6045 svrecode = newSVpvn(pv2, cur2);
6046 sv_recode_to_utf8(svrecode, PL_encoding);
6047 pv2 = SvPV_const(svrecode, cur2);
6050 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6055 svrecode = newSVpvn(pv1, cur1);
6056 sv_recode_to_utf8(svrecode, PL_encoding);
6057 pv1 = SvPV_const(svrecode, cur1);
6060 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6066 cmp = cur2 ? -1 : 0;
6070 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6073 cmp = retval < 0 ? -1 : 1;
6074 } else if (cur1 == cur2) {
6077 cmp = cur1 < cur2 ? -1 : 1;
6081 SvREFCNT_dec(svrecode);
6089 =for apidoc sv_cmp_locale
6091 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6092 'use bytes' aware, handles get magic, and will coerce its args to strings
6093 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6099 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6102 #ifdef USE_LOCALE_COLLATE
6108 if (PL_collation_standard)
6112 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6114 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6116 if (!pv1 || !len1) {
6127 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6130 return retval < 0 ? -1 : 1;
6133 * When the result of collation is equality, that doesn't mean
6134 * that there are no differences -- some locales exclude some
6135 * characters from consideration. So to avoid false equalities,
6136 * we use the raw string as a tiebreaker.
6142 #endif /* USE_LOCALE_COLLATE */
6144 return sv_cmp(sv1, sv2);
6148 #ifdef USE_LOCALE_COLLATE
6151 =for apidoc sv_collxfrm
6153 Add Collate Transform magic to an SV if it doesn't already have it.
6155 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6156 scalar data of the variable, but transformed to such a format that a normal
6157 memory comparison can be used to compare the data according to the locale
6164 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6169 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6170 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6176 Safefree(mg->mg_ptr);
6177 s = SvPV_const(sv, len);
6178 if ((xf = mem_collxfrm(s, len, &xlen))) {
6179 if (SvREADONLY(sv)) {
6182 return xf + sizeof(PL_collation_ix);
6185 #ifdef PERL_OLD_COPY_ON_WRITE
6187 sv_force_normal_flags(sv, 0);
6189 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6203 if (mg && mg->mg_ptr) {
6205 return mg->mg_ptr + sizeof(PL_collation_ix);
6213 #endif /* USE_LOCALE_COLLATE */
6218 Get a line from the filehandle and store it into the SV, optionally
6219 appending to the currently-stored string.
6225 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6230 register STDCHAR rslast;
6231 register STDCHAR *bp;
6236 if (SvTHINKFIRST(sv))
6237 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6238 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6240 However, perlbench says it's slower, because the existing swipe code
6241 is faster than copy on write.
6242 Swings and roundabouts. */
6243 SvUPGRADE(sv, SVt_PV);
6248 if (PerlIO_isutf8(fp)) {
6250 sv_utf8_upgrade_nomg(sv);
6251 sv_pos_u2b(sv,&append,0);
6253 } else if (SvUTF8(sv)) {
6254 SV * const tsv = newSV(0);
6255 sv_gets(tsv, fp, 0);
6256 sv_utf8_upgrade_nomg(tsv);
6257 SvCUR_set(sv,append);
6260 goto return_string_or_null;
6265 if (PerlIO_isutf8(fp))
6268 if (IN_PERL_COMPILETIME) {
6269 /* we always read code in line mode */
6273 else if (RsSNARF(PL_rs)) {
6274 /* If it is a regular disk file use size from stat() as estimate
6275 of amount we are going to read -- may result in mallocing
6276 more memory than we really need if the layers below reduce
6277 the size we read (e.g. CRLF or a gzip layer).
6280 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6281 const Off_t offset = PerlIO_tell(fp);
6282 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6283 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6289 else if (RsRECORD(PL_rs)) {
6294 /* Grab the size of the record we're getting */
6295 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6296 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6299 /* VMS wants read instead of fread, because fread doesn't respect */
6300 /* RMS record boundaries. This is not necessarily a good thing to be */
6301 /* doing, but we've got no other real choice - except avoid stdio
6302 as implementation - perhaps write a :vms layer ?
6304 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6306 bytesread = PerlIO_read(fp, buffer, recsize);
6310 SvCUR_set(sv, bytesread += append);
6311 buffer[bytesread] = '\0';
6312 goto return_string_or_null;
6314 else if (RsPARA(PL_rs)) {
6320 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6321 if (PerlIO_isutf8(fp)) {
6322 rsptr = SvPVutf8(PL_rs, rslen);
6325 if (SvUTF8(PL_rs)) {
6326 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6327 Perl_croak(aTHX_ "Wide character in $/");
6330 rsptr = SvPV_const(PL_rs, rslen);
6334 rslast = rslen ? rsptr[rslen - 1] : '\0';
6336 if (rspara) { /* have to do this both before and after */
6337 do { /* to make sure file boundaries work right */
6340 i = PerlIO_getc(fp);
6344 PerlIO_ungetc(fp,i);
6350 /* See if we know enough about I/O mechanism to cheat it ! */
6352 /* This used to be #ifdef test - it is made run-time test for ease
6353 of abstracting out stdio interface. One call should be cheap
6354 enough here - and may even be a macro allowing compile
6358 if (PerlIO_fast_gets(fp)) {
6361 * We're going to steal some values from the stdio struct
6362 * and put EVERYTHING in the innermost loop into registers.
6364 register STDCHAR *ptr;
6368 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6369 /* An ungetc()d char is handled separately from the regular
6370 * buffer, so we getc() it back out and stuff it in the buffer.
6372 i = PerlIO_getc(fp);
6373 if (i == EOF) return 0;
6374 *(--((*fp)->_ptr)) = (unsigned char) i;
6378 /* Here is some breathtakingly efficient cheating */
6380 cnt = PerlIO_get_cnt(fp); /* get count into register */
6381 /* make sure we have the room */
6382 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6383 /* Not room for all of it
6384 if we are looking for a separator and room for some
6386 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6387 /* just process what we have room for */
6388 shortbuffered = cnt - SvLEN(sv) + append + 1;
6389 cnt -= shortbuffered;
6393 /* remember that cnt can be negative */
6394 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6399 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6400 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6401 DEBUG_P(PerlIO_printf(Perl_debug_log,
6402 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6403 DEBUG_P(PerlIO_printf(Perl_debug_log,
6404 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6405 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6406 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6411 while (cnt > 0) { /* this | eat */
6413 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6414 goto thats_all_folks; /* screams | sed :-) */
6418 Copy(ptr, bp, cnt, char); /* this | eat */
6419 bp += cnt; /* screams | dust */
6420 ptr += cnt; /* louder | sed :-) */
6425 if (shortbuffered) { /* oh well, must extend */
6426 cnt = shortbuffered;
6428 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6430 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6431 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6435 DEBUG_P(PerlIO_printf(Perl_debug_log,
6436 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6437 PTR2UV(ptr),(long)cnt));
6438 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6440 DEBUG_P(PerlIO_printf(Perl_debug_log,
6441 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6442 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6443 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6445 /* This used to call 'filbuf' in stdio form, but as that behaves like
6446 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6447 another abstraction. */
6448 i = PerlIO_getc(fp); /* get more characters */
6450 DEBUG_P(PerlIO_printf(Perl_debug_log,
6451 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6452 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6453 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6455 cnt = PerlIO_get_cnt(fp);
6456 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6457 DEBUG_P(PerlIO_printf(Perl_debug_log,
6458 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6460 if (i == EOF) /* all done for ever? */
6461 goto thats_really_all_folks;
6463 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6465 SvGROW(sv, bpx + cnt + 2);
6466 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6468 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6470 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6471 goto thats_all_folks;
6475 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6476 memNE((char*)bp - rslen, rsptr, rslen))
6477 goto screamer; /* go back to the fray */
6478 thats_really_all_folks:
6480 cnt += shortbuffered;
6481 DEBUG_P(PerlIO_printf(Perl_debug_log,
6482 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6483 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6484 DEBUG_P(PerlIO_printf(Perl_debug_log,
6485 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6486 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6487 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6489 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6490 DEBUG_P(PerlIO_printf(Perl_debug_log,
6491 "Screamer: done, len=%ld, string=|%.*s|\n",
6492 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6496 /*The big, slow, and stupid way. */
6497 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6498 STDCHAR *buf = NULL;
6499 Newx(buf, 8192, STDCHAR);
6507 register const STDCHAR * const bpe = buf + sizeof(buf);
6509 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6510 ; /* keep reading */
6514 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6515 /* Accomodate broken VAXC compiler, which applies U8 cast to
6516 * both args of ?: operator, causing EOF to change into 255
6519 i = (U8)buf[cnt - 1];
6525 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6527 sv_catpvn(sv, (char *) buf, cnt);
6529 sv_setpvn(sv, (char *) buf, cnt);
6531 if (i != EOF && /* joy */
6533 SvCUR(sv) < rslen ||
6534 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6538 * If we're reading from a TTY and we get a short read,
6539 * indicating that the user hit his EOF character, we need
6540 * to notice it now, because if we try to read from the TTY
6541 * again, the EOF condition will disappear.
6543 * The comparison of cnt to sizeof(buf) is an optimization
6544 * that prevents unnecessary calls to feof().
6548 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6552 #ifdef USE_HEAP_INSTEAD_OF_STACK
6557 if (rspara) { /* have to do this both before and after */
6558 while (i != EOF) { /* to make sure file boundaries work right */
6559 i = PerlIO_getc(fp);
6561 PerlIO_ungetc(fp,i);
6567 return_string_or_null:
6568 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6574 Auto-increment of the value in the SV, doing string to numeric conversion
6575 if necessary. Handles 'get' magic.
6581 Perl_sv_inc(pTHX_ register SV *sv)
6590 if (SvTHINKFIRST(sv)) {
6592 sv_force_normal_flags(sv, 0);
6593 if (SvREADONLY(sv)) {
6594 if (IN_PERL_RUNTIME)
6595 Perl_croak(aTHX_ PL_no_modify);
6599 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6601 i = PTR2IV(SvRV(sv));
6606 flags = SvFLAGS(sv);
6607 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6608 /* It's (privately or publicly) a float, but not tested as an
6609 integer, so test it to see. */
6611 flags = SvFLAGS(sv);
6613 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6614 /* It's publicly an integer, or privately an integer-not-float */
6615 #ifdef PERL_PRESERVE_IVUV
6619 if (SvUVX(sv) == UV_MAX)
6620 sv_setnv(sv, UV_MAX_P1);
6622 (void)SvIOK_only_UV(sv);
6623 SvUV_set(sv, SvUVX(sv) + 1);
6625 if (SvIVX(sv) == IV_MAX)
6626 sv_setuv(sv, (UV)IV_MAX + 1);
6628 (void)SvIOK_only(sv);
6629 SvIV_set(sv, SvIVX(sv) + 1);
6634 if (flags & SVp_NOK) {
6635 (void)SvNOK_only(sv);
6636 SvNV_set(sv, SvNVX(sv) + 1.0);
6640 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6641 if ((flags & SVTYPEMASK) < SVt_PVIV)
6642 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6643 (void)SvIOK_only(sv);
6648 while (isALPHA(*d)) d++;
6649 while (isDIGIT(*d)) d++;
6651 #ifdef PERL_PRESERVE_IVUV
6652 /* Got to punt this as an integer if needs be, but we don't issue
6653 warnings. Probably ought to make the sv_iv_please() that does
6654 the conversion if possible, and silently. */
6655 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6656 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6657 /* Need to try really hard to see if it's an integer.
6658 9.22337203685478e+18 is an integer.
6659 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6660 so $a="9.22337203685478e+18"; $a+0; $a++
6661 needs to be the same as $a="9.22337203685478e+18"; $a++
6668 /* sv_2iv *should* have made this an NV */
6669 if (flags & SVp_NOK) {
6670 (void)SvNOK_only(sv);
6671 SvNV_set(sv, SvNVX(sv) + 1.0);
6674 /* I don't think we can get here. Maybe I should assert this
6675 And if we do get here I suspect that sv_setnv will croak. NWC
6677 #if defined(USE_LONG_DOUBLE)
6678 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",
6679 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6681 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6682 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6685 #endif /* PERL_PRESERVE_IVUV */
6686 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6690 while (d >= SvPVX_const(sv)) {
6698 /* MKS: The original code here died if letters weren't consecutive.
6699 * at least it didn't have to worry about non-C locales. The
6700 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6701 * arranged in order (although not consecutively) and that only
6702 * [A-Za-z] are accepted by isALPHA in the C locale.
6704 if (*d != 'z' && *d != 'Z') {
6705 do { ++*d; } while (!isALPHA(*d));
6708 *(d--) -= 'z' - 'a';
6713 *(d--) -= 'z' - 'a' + 1;
6717 /* oh,oh, the number grew */
6718 SvGROW(sv, SvCUR(sv) + 2);
6719 SvCUR_set(sv, SvCUR(sv) + 1);
6720 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6731 Auto-decrement of the value in the SV, doing string to numeric conversion
6732 if necessary. Handles 'get' magic.
6738 Perl_sv_dec(pTHX_ register SV *sv)
6746 if (SvTHINKFIRST(sv)) {
6748 sv_force_normal_flags(sv, 0);
6749 if (SvREADONLY(sv)) {
6750 if (IN_PERL_RUNTIME)
6751 Perl_croak(aTHX_ PL_no_modify);
6755 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6757 i = PTR2IV(SvRV(sv));
6762 /* Unlike sv_inc we don't have to worry about string-never-numbers
6763 and keeping them magic. But we mustn't warn on punting */
6764 flags = SvFLAGS(sv);
6765 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6766 /* It's publicly an integer, or privately an integer-not-float */
6767 #ifdef PERL_PRESERVE_IVUV
6771 if (SvUVX(sv) == 0) {
6772 (void)SvIOK_only(sv);
6776 (void)SvIOK_only_UV(sv);
6777 SvUV_set(sv, SvUVX(sv) - 1);
6780 if (SvIVX(sv) == IV_MIN)
6781 sv_setnv(sv, (NV)IV_MIN - 1.0);
6783 (void)SvIOK_only(sv);
6784 SvIV_set(sv, SvIVX(sv) - 1);
6789 if (flags & SVp_NOK) {
6790 SvNV_set(sv, SvNVX(sv) - 1.0);
6791 (void)SvNOK_only(sv);
6794 if (!(flags & SVp_POK)) {
6795 if ((flags & SVTYPEMASK) < SVt_PVIV)
6796 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6798 (void)SvIOK_only(sv);
6801 #ifdef PERL_PRESERVE_IVUV
6803 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6804 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6805 /* Need to try really hard to see if it's an integer.
6806 9.22337203685478e+18 is an integer.
6807 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6808 so $a="9.22337203685478e+18"; $a+0; $a--
6809 needs to be the same as $a="9.22337203685478e+18"; $a--
6816 /* sv_2iv *should* have made this an NV */
6817 if (flags & SVp_NOK) {
6818 (void)SvNOK_only(sv);
6819 SvNV_set(sv, SvNVX(sv) - 1.0);
6822 /* I don't think we can get here. Maybe I should assert this
6823 And if we do get here I suspect that sv_setnv will croak. NWC
6825 #if defined(USE_LONG_DOUBLE)
6826 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",
6827 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6829 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6830 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6834 #endif /* PERL_PRESERVE_IVUV */
6835 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6839 =for apidoc sv_mortalcopy
6841 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6842 The new SV is marked as mortal. It will be destroyed "soon", either by an
6843 explicit call to FREETMPS, or by an implicit call at places such as
6844 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6849 /* Make a string that will exist for the duration of the expression
6850 * evaluation. Actually, it may have to last longer than that, but
6851 * hopefully we won't free it until it has been assigned to a
6852 * permanent location. */
6855 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6861 sv_setsv(sv,oldstr);
6863 PL_tmps_stack[++PL_tmps_ix] = sv;
6869 =for apidoc sv_newmortal
6871 Creates a new null SV which is mortal. The reference count of the SV is
6872 set to 1. It will be destroyed "soon", either by an explicit call to
6873 FREETMPS, or by an implicit call at places such as statement boundaries.
6874 See also C<sv_mortalcopy> and C<sv_2mortal>.
6880 Perl_sv_newmortal(pTHX)
6886 SvFLAGS(sv) = SVs_TEMP;
6888 PL_tmps_stack[++PL_tmps_ix] = sv;
6893 =for apidoc sv_2mortal
6895 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6896 by an explicit call to FREETMPS, or by an implicit call at places such as
6897 statement boundaries. SvTEMP() is turned on which means that the SV's
6898 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6899 and C<sv_mortalcopy>.
6905 Perl_sv_2mortal(pTHX_ register SV *sv)
6910 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6913 PL_tmps_stack[++PL_tmps_ix] = sv;
6921 Creates a new SV and copies a string into it. The reference count for the
6922 SV is set to 1. If C<len> is zero, Perl will compute the length using
6923 strlen(). For efficiency, consider using C<newSVpvn> instead.
6929 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6935 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6940 =for apidoc newSVpvn
6942 Creates a new SV and copies a string into it. The reference count for the
6943 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6944 string. You are responsible for ensuring that the source string is at least
6945 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6951 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6957 sv_setpvn(sv,s,len);
6963 =for apidoc newSVhek
6965 Creates a new SV from the hash key structure. It will generate scalars that
6966 point to the shared string table where possible. Returns a new (undefined)
6967 SV if the hek is NULL.
6973 Perl_newSVhek(pTHX_ const HEK *hek)
6983 if (HEK_LEN(hek) == HEf_SVKEY) {
6984 return newSVsv(*(SV**)HEK_KEY(hek));
6986 const int flags = HEK_FLAGS(hek);
6987 if (flags & HVhek_WASUTF8) {
6989 Andreas would like keys he put in as utf8 to come back as utf8
6991 STRLEN utf8_len = HEK_LEN(hek);
6992 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6993 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6996 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6998 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6999 /* We don't have a pointer to the hv, so we have to replicate the
7000 flag into every HEK. This hv is using custom a hasing
7001 algorithm. Hence we can't return a shared string scalar, as
7002 that would contain the (wrong) hash value, and might get passed
7003 into an hv routine with a regular hash.
7004 Similarly, a hash that isn't using shared hash keys has to have
7005 the flag in every key so that we know not to try to call
7006 share_hek_kek on it. */
7008 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7013 /* This will be overwhelminly the most common case. */
7015 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7016 more efficient than sharepvn(). */
7020 sv_upgrade(sv, SVt_PV);
7021 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7022 SvCUR_set(sv, HEK_LEN(hek));
7035 =for apidoc newSVpvn_share
7037 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7038 table. If the string does not already exist in the table, it is created
7039 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7040 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7041 otherwise the hash is computed. The idea here is that as the string table
7042 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7043 hash lookup will avoid string compare.
7049 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7053 bool is_utf8 = FALSE;
7054 const char *const orig_src = src;
7057 STRLEN tmplen = -len;
7059 /* See the note in hv.c:hv_fetch() --jhi */
7060 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7064 PERL_HASH(hash, src, len);
7066 sv_upgrade(sv, SVt_PV);
7067 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7075 if (src != orig_src)
7081 #if defined(PERL_IMPLICIT_CONTEXT)
7083 /* pTHX_ magic can't cope with varargs, so this is a no-context
7084 * version of the main function, (which may itself be aliased to us).
7085 * Don't access this version directly.
7089 Perl_newSVpvf_nocontext(const char* pat, ...)
7094 va_start(args, pat);
7095 sv = vnewSVpvf(pat, &args);
7102 =for apidoc newSVpvf
7104 Creates a new SV and initializes it with the string formatted like
7111 Perl_newSVpvf(pTHX_ const char* pat, ...)
7115 va_start(args, pat);
7116 sv = vnewSVpvf(pat, &args);
7121 /* backend for newSVpvf() and newSVpvf_nocontext() */
7124 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7129 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7136 Creates a new SV and copies a floating point value into it.
7137 The reference count for the SV is set to 1.
7143 Perl_newSVnv(pTHX_ NV n)
7156 Creates a new SV and copies an integer into it. The reference count for the
7163 Perl_newSViv(pTHX_ IV i)
7176 Creates a new SV and copies an unsigned integer into it.
7177 The reference count for the SV is set to 1.
7183 Perl_newSVuv(pTHX_ UV u)
7194 =for apidoc newRV_noinc
7196 Creates an RV wrapper for an SV. The reference count for the original
7197 SV is B<not> incremented.
7203 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7209 sv_upgrade(sv, SVt_RV);
7211 SvRV_set(sv, tmpRef);
7216 /* newRV_inc is the official function name to use now.
7217 * newRV_inc is in fact #defined to newRV in sv.h
7221 Perl_newRV(pTHX_ SV *sv)
7224 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7230 Creates a new SV which is an exact duplicate of the original SV.
7237 Perl_newSVsv(pTHX_ register SV *old)
7244 if (SvTYPE(old) == SVTYPEMASK) {
7245 if (ckWARN_d(WARN_INTERNAL))
7246 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7250 /* SV_GMAGIC is the default for sv_setv()
7251 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7252 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7253 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7258 =for apidoc sv_reset
7260 Underlying implementation for the C<reset> Perl function.
7261 Note that the perl-level function is vaguely deprecated.
7267 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7270 char todo[PERL_UCHAR_MAX+1];
7275 if (!*s) { /* reset ?? searches */
7276 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7278 PMOP *pm = (PMOP *) mg->mg_obj;
7280 pm->op_pmdynflags &= ~PMdf_USED;
7287 /* reset variables */
7289 if (!HvARRAY(stash))
7292 Zero(todo, 256, char);
7295 I32 i = (unsigned char)*s;
7299 max = (unsigned char)*s++;
7300 for ( ; i <= max; i++) {
7303 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7305 for (entry = HvARRAY(stash)[i];
7307 entry = HeNEXT(entry))
7312 if (!todo[(U8)*HeKEY(entry)])
7314 gv = (GV*)HeVAL(entry);
7317 if (SvTHINKFIRST(sv)) {
7318 if (!SvREADONLY(sv) && SvROK(sv))
7320 /* XXX Is this continue a bug? Why should THINKFIRST
7321 exempt us from resetting arrays and hashes? */
7325 if (SvTYPE(sv) >= SVt_PV) {
7327 if (SvPVX_const(sv) != NULL)
7335 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7337 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7340 # if defined(USE_ENVIRON_ARRAY)
7343 # endif /* USE_ENVIRON_ARRAY */
7354 Using various gambits, try to get an IO from an SV: the IO slot if its a
7355 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7356 named after the PV if we're a string.
7362 Perl_sv_2io(pTHX_ SV *sv)
7367 switch (SvTYPE(sv)) {
7375 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7379 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7381 return sv_2io(SvRV(sv));
7382 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7388 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7397 Using various gambits, try to get a CV from an SV; in addition, try if
7398 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7399 The flags in C<lref> are passed to sv_fetchsv.
7405 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7416 switch (SvTYPE(sv)) {
7435 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7436 tryAMAGICunDEREF(to_cv);
7439 if (SvTYPE(sv) == SVt_PVCV) {
7448 Perl_croak(aTHX_ "Not a subroutine reference");
7453 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7459 /* Some flags to gv_fetchsv mean don't really create the GV */
7460 if (SvTYPE(gv) != SVt_PVGV) {
7466 if (lref && !GvCVu(gv)) {
7470 gv_efullname3(tmpsv, gv, NULL);
7471 /* XXX this is probably not what they think they're getting.
7472 * It has the same effect as "sub name;", i.e. just a forward
7474 newSUB(start_subparse(FALSE, 0),
7475 newSVOP(OP_CONST, 0, tmpsv),
7479 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7489 Returns true if the SV has a true value by Perl's rules.
7490 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7491 instead use an in-line version.
7497 Perl_sv_true(pTHX_ register SV *sv)
7502 register const XPV* const tXpv = (XPV*)SvANY(sv);
7504 (tXpv->xpv_cur > 1 ||
7505 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7512 return SvIVX(sv) != 0;
7515 return SvNVX(sv) != 0.0;
7517 return sv_2bool(sv);
7523 =for apidoc sv_pvn_force
7525 Get a sensible string out of the SV somehow.
7526 A private implementation of the C<SvPV_force> macro for compilers which
7527 can't cope with complex macro expressions. Always use the macro instead.
7529 =for apidoc sv_pvn_force_flags
7531 Get a sensible string out of the SV somehow.
7532 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7533 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7534 implemented in terms of this function.
7535 You normally want to use the various wrapper macros instead: see
7536 C<SvPV_force> and C<SvPV_force_nomg>
7542 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7545 if (SvTHINKFIRST(sv) && !SvROK(sv))
7546 sv_force_normal_flags(sv, 0);
7556 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7557 const char * const ref = sv_reftype(sv,0);
7559 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7560 ref, OP_NAME(PL_op));
7562 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7564 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7565 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7567 s = sv_2pv_flags(sv, &len, flags);
7571 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7574 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7575 SvGROW(sv, len + 1);
7576 Move(s,SvPVX(sv),len,char);
7581 SvPOK_on(sv); /* validate pointer */
7583 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7584 PTR2UV(sv),SvPVX_const(sv)));
7587 return SvPVX_mutable(sv);
7591 =for apidoc sv_pvbyten_force
7593 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7599 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7601 sv_pvn_force(sv,lp);
7602 sv_utf8_downgrade(sv,0);
7608 =for apidoc sv_pvutf8n_force
7610 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7616 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7618 sv_pvn_force(sv,lp);
7619 sv_utf8_upgrade(sv);
7625 =for apidoc sv_reftype
7627 Returns a string describing what the SV is a reference to.
7633 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7635 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7636 inside return suggests a const propagation bug in g++. */
7637 if (ob && SvOBJECT(sv)) {
7638 char * const name = HvNAME_get(SvSTASH(sv));
7639 return name ? name : (char *) "__ANON__";
7642 switch (SvTYPE(sv)) {
7658 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7659 /* tied lvalues should appear to be
7660 * scalars for backwards compatitbility */
7661 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7662 ? "SCALAR" : "LVALUE");
7663 case SVt_PVAV: return "ARRAY";
7664 case SVt_PVHV: return "HASH";
7665 case SVt_PVCV: return "CODE";
7666 case SVt_PVGV: return "GLOB";
7667 case SVt_PVFM: return "FORMAT";
7668 case SVt_PVIO: return "IO";
7669 case SVt_BIND: return "BIND";
7670 default: return "UNKNOWN";
7676 =for apidoc sv_isobject
7678 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7679 object. If the SV is not an RV, or if the object is not blessed, then this
7686 Perl_sv_isobject(pTHX_ SV *sv)
7702 Returns a boolean indicating whether the SV is blessed into the specified
7703 class. This does not check for subtypes; use C<sv_derived_from> to verify
7704 an inheritance relationship.
7710 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7721 hvname = HvNAME_get(SvSTASH(sv));
7725 return strEQ(hvname, name);
7731 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7732 it will be upgraded to one. If C<classname> is non-null then the new SV will
7733 be blessed in the specified package. The new SV is returned and its
7734 reference count is 1.
7740 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7747 SV_CHECK_THINKFIRST_COW_DROP(rv);
7750 if (SvTYPE(rv) >= SVt_PVMG) {
7751 const U32 refcnt = SvREFCNT(rv);
7755 SvREFCNT(rv) = refcnt;
7757 sv_upgrade(rv, SVt_RV);
7758 } else if (SvROK(rv)) {
7759 SvREFCNT_dec(SvRV(rv));
7760 } else if (SvTYPE(rv) < SVt_RV)
7761 sv_upgrade(rv, SVt_RV);
7762 else if (SvTYPE(rv) > SVt_RV) {
7773 HV* const stash = gv_stashpv(classname, TRUE);
7774 (void)sv_bless(rv, stash);
7780 =for apidoc sv_setref_pv
7782 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7783 argument will be upgraded to an RV. That RV will be modified to point to
7784 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7785 into the SV. The C<classname> argument indicates the package for the
7786 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7787 will have a reference count of 1, and the RV will be returned.
7789 Do not use with other Perl types such as HV, AV, SV, CV, because those
7790 objects will become corrupted by the pointer copy process.
7792 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7798 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7802 sv_setsv(rv, &PL_sv_undef);
7806 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7811 =for apidoc sv_setref_iv
7813 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7814 argument will be upgraded to an RV. That RV will be modified to point to
7815 the new SV. The C<classname> argument indicates the package for the
7816 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7817 will have a reference count of 1, and the RV will be returned.
7823 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7825 sv_setiv(newSVrv(rv,classname), iv);
7830 =for apidoc sv_setref_uv
7832 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7833 argument will be upgraded to an RV. That RV will be modified to point to
7834 the new SV. The C<classname> argument indicates the package for the
7835 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7836 will have a reference count of 1, and the RV will be returned.
7842 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7844 sv_setuv(newSVrv(rv,classname), uv);
7849 =for apidoc sv_setref_nv
7851 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7852 argument will be upgraded to an RV. That RV will be modified to point to
7853 the new SV. The C<classname> argument indicates the package for the
7854 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7855 will have a reference count of 1, and the RV will be returned.
7861 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7863 sv_setnv(newSVrv(rv,classname), nv);
7868 =for apidoc sv_setref_pvn
7870 Copies a string into a new SV, optionally blessing the SV. The length of the
7871 string must be specified with C<n>. The C<rv> argument will be upgraded to
7872 an RV. That RV will be modified to point to the new SV. The C<classname>
7873 argument indicates the package for the blessing. Set C<classname> to
7874 C<NULL> to avoid the blessing. The new SV will have a reference count
7875 of 1, and the RV will be returned.
7877 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7883 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7885 sv_setpvn(newSVrv(rv,classname), pv, n);
7890 =for apidoc sv_bless
7892 Blesses an SV into a specified package. The SV must be an RV. The package
7893 must be designated by its stash (see C<gv_stashpv()>). The reference count
7894 of the SV is unaffected.
7900 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7905 Perl_croak(aTHX_ "Can't bless non-reference value");
7907 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7908 if (SvREADONLY(tmpRef))
7909 Perl_croak(aTHX_ PL_no_modify);
7910 if (SvOBJECT(tmpRef)) {
7911 if (SvTYPE(tmpRef) != SVt_PVIO)
7913 SvREFCNT_dec(SvSTASH(tmpRef));
7916 SvOBJECT_on(tmpRef);
7917 if (SvTYPE(tmpRef) != SVt_PVIO)
7919 SvUPGRADE(tmpRef, SVt_PVMG);
7920 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7927 if(SvSMAGICAL(tmpRef))
7928 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7936 /* Downgrades a PVGV to a PVMG.
7940 S_sv_unglob(pTHX_ SV *sv)
7944 SV * const temp = sv_newmortal();
7946 assert(SvTYPE(sv) == SVt_PVGV);
7948 gv_efullname3(temp, (GV *) sv, "*");
7954 sv_del_backref((SV*)GvSTASH(sv), sv);
7958 if (GvNAME_HEK(sv)) {
7959 unshare_hek(GvNAME_HEK(sv));
7961 isGV_with_GP_off(sv);
7963 /* need to keep SvANY(sv) in the right arena */
7964 xpvmg = new_XPVMG();
7965 StructCopy(SvANY(sv), xpvmg, XPVMG);
7966 del_XPVGV(SvANY(sv));
7969 SvFLAGS(sv) &= ~SVTYPEMASK;
7970 SvFLAGS(sv) |= SVt_PVMG;
7972 /* Intentionally not calling any local SET magic, as this isn't so much a
7973 set operation as merely an internal storage change. */
7974 sv_setsv_flags(sv, temp, 0);
7978 =for apidoc sv_unref_flags
7980 Unsets the RV status of the SV, and decrements the reference count of
7981 whatever was being referenced by the RV. This can almost be thought of
7982 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7983 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7984 (otherwise the decrementing is conditional on the reference count being
7985 different from one or the reference being a readonly SV).
7992 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7994 SV* const target = SvRV(ref);
7996 if (SvWEAKREF(ref)) {
7997 sv_del_backref(target, ref);
7999 SvRV_set(ref, NULL);
8002 SvRV_set(ref, NULL);
8004 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8005 assigned to as BEGIN {$a = \"Foo"} will fail. */
8006 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8007 SvREFCNT_dec(target);
8008 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8009 sv_2mortal(target); /* Schedule for freeing later */
8013 =for apidoc sv_untaint
8015 Untaint an SV. Use C<SvTAINTED_off> instead.
8020 Perl_sv_untaint(pTHX_ SV *sv)
8022 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8023 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8030 =for apidoc sv_tainted
8032 Test an SV for taintedness. Use C<SvTAINTED> instead.
8037 Perl_sv_tainted(pTHX_ SV *sv)
8039 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8040 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8041 if (mg && (mg->mg_len & 1) )
8048 =for apidoc sv_setpviv
8050 Copies an integer into the given SV, also updating its string value.
8051 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8057 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8059 char buf[TYPE_CHARS(UV)];
8061 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8063 sv_setpvn(sv, ptr, ebuf - ptr);
8067 =for apidoc sv_setpviv_mg
8069 Like C<sv_setpviv>, but also handles 'set' magic.
8075 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8081 #if defined(PERL_IMPLICIT_CONTEXT)
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_nocontext(SV *sv, const char* pat, ...)
8093 va_start(args, pat);
8094 sv_vsetpvf(sv, pat, &args);
8098 /* pTHX_ magic can't cope with varargs, so this is a no-context
8099 * version of the main function, (which may itself be aliased to us).
8100 * Don't access this version directly.
8104 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8108 va_start(args, pat);
8109 sv_vsetpvf_mg(sv, pat, &args);
8115 =for apidoc sv_setpvf
8117 Works like C<sv_catpvf> but copies the text into the SV instead of
8118 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8124 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8127 va_start(args, pat);
8128 sv_vsetpvf(sv, pat, &args);
8133 =for apidoc sv_vsetpvf
8135 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8136 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8138 Usually used via its frontend C<sv_setpvf>.
8144 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8146 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8150 =for apidoc sv_setpvf_mg
8152 Like C<sv_setpvf>, but also handles 'set' magic.
8158 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8161 va_start(args, pat);
8162 sv_vsetpvf_mg(sv, pat, &args);
8167 =for apidoc sv_vsetpvf_mg
8169 Like C<sv_vsetpvf>, but also handles 'set' magic.
8171 Usually used via its frontend C<sv_setpvf_mg>.
8177 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8179 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8183 #if defined(PERL_IMPLICIT_CONTEXT)
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_nocontext(SV *sv, const char* pat, ...)
8195 va_start(args, pat);
8196 sv_vcatpvf(sv, pat, &args);
8200 /* pTHX_ magic can't cope with varargs, so this is a no-context
8201 * version of the main function, (which may itself be aliased to us).
8202 * Don't access this version directly.
8206 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8210 va_start(args, pat);
8211 sv_vcatpvf_mg(sv, pat, &args);
8217 =for apidoc sv_catpvf
8219 Processes its arguments like C<sprintf> and appends the formatted
8220 output to an SV. If the appended data contains "wide" characters
8221 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8222 and characters >255 formatted with %c), the original SV might get
8223 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8224 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8225 valid UTF-8; if the original SV was bytes, the pattern should be too.
8230 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8233 va_start(args, pat);
8234 sv_vcatpvf(sv, pat, &args);
8239 =for apidoc sv_vcatpvf
8241 Processes its arguments like C<vsprintf> and appends the formatted output
8242 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8244 Usually used via its frontend C<sv_catpvf>.
8250 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8252 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8256 =for apidoc sv_catpvf_mg
8258 Like C<sv_catpvf>, but also handles 'set' magic.
8264 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8267 va_start(args, pat);
8268 sv_vcatpvf_mg(sv, pat, &args);
8273 =for apidoc sv_vcatpvf_mg
8275 Like C<sv_vcatpvf>, but also handles 'set' magic.
8277 Usually used via its frontend C<sv_catpvf_mg>.
8283 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8285 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8290 =for apidoc sv_vsetpvfn
8292 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8295 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8301 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8303 sv_setpvn(sv, "", 0);
8304 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8308 S_expect_number(pTHX_ char** pattern)
8312 switch (**pattern) {
8313 case '1': case '2': case '3':
8314 case '4': case '5': case '6':
8315 case '7': case '8': case '9':
8316 var = *(*pattern)++ - '0';
8317 while (isDIGIT(**pattern)) {
8318 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8320 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8328 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8330 const int neg = nv < 0;
8339 if (uv & 1 && uv == nv)
8340 uv--; /* Round to even */
8342 const unsigned dig = uv % 10;
8355 =for apidoc sv_vcatpvfn
8357 Processes its arguments like C<vsprintf> and appends the formatted output
8358 to an SV. Uses an array of SVs if the C style variable argument list is
8359 missing (NULL). When running with taint checks enabled, indicates via
8360 C<maybe_tainted> if results are untrustworthy (often due to the use of
8363 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8369 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8370 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8371 vec_utf8 = DO_UTF8(vecsv);
8373 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8376 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8384 static const char nullstr[] = "(null)";
8386 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8387 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8389 /* Times 4: a decimal digit takes more than 3 binary digits.
8390 * NV_DIG: mantissa takes than many decimal digits.
8391 * Plus 32: Playing safe. */
8392 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8393 /* large enough for "%#.#f" --chip */
8394 /* what about long double NVs? --jhi */
8396 PERL_UNUSED_ARG(maybe_tainted);
8398 /* no matter what, this is a string now */
8399 (void)SvPV_force(sv, origlen);
8401 /* special-case "", "%s", and "%-p" (SVf - see below) */
8404 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8406 const char * const s = va_arg(*args, char*);
8407 sv_catpv(sv, s ? s : nullstr);
8409 else if (svix < svmax) {
8410 sv_catsv(sv, *svargs);
8414 if (args && patlen == 3 && pat[0] == '%' &&
8415 pat[1] == '-' && pat[2] == 'p') {
8416 argsv = (SV*)va_arg(*args, void*);
8417 sv_catsv(sv, argsv);
8421 #ifndef USE_LONG_DOUBLE
8422 /* special-case "%.<number>[gf]" */
8423 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8424 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8425 unsigned digits = 0;
8429 while (*pp >= '0' && *pp <= '9')
8430 digits = 10 * digits + (*pp++ - '0');
8431 if (pp - pat == (int)patlen - 1) {
8439 /* Add check for digits != 0 because it seems that some
8440 gconverts are buggy in this case, and we don't yet have
8441 a Configure test for this. */
8442 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8443 /* 0, point, slack */
8444 Gconvert(nv, (int)digits, 0, ebuf);
8446 if (*ebuf) /* May return an empty string for digits==0 */
8449 } else if (!digits) {
8452 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8453 sv_catpvn(sv, p, l);
8459 #endif /* !USE_LONG_DOUBLE */
8461 if (!args && svix < svmax && DO_UTF8(*svargs))
8464 patend = (char*)pat + patlen;
8465 for (p = (char*)pat; p < patend; p = q) {
8468 bool vectorize = FALSE;
8469 bool vectorarg = FALSE;
8470 bool vec_utf8 = FALSE;
8476 bool has_precis = FALSE;
8478 const I32 osvix = svix;
8479 bool is_utf8 = FALSE; /* is this item utf8? */
8480 #ifdef HAS_LDBL_SPRINTF_BUG
8481 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8482 with sfio - Allen <allens@cpan.org> */
8483 bool fix_ldbl_sprintf_bug = FALSE;
8487 U8 utf8buf[UTF8_MAXBYTES+1];
8488 STRLEN esignlen = 0;
8490 const char *eptr = NULL;
8493 const U8 *vecstr = NULL;
8500 /* we need a long double target in case HAS_LONG_DOUBLE but
8503 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8511 const char *dotstr = ".";
8512 STRLEN dotstrlen = 1;
8513 I32 efix = 0; /* explicit format parameter index */
8514 I32 ewix = 0; /* explicit width index */
8515 I32 epix = 0; /* explicit precision index */
8516 I32 evix = 0; /* explicit vector index */
8517 bool asterisk = FALSE;
8519 /* echo everything up to the next format specification */
8520 for (q = p; q < patend && *q != '%'; ++q) ;
8522 if (has_utf8 && !pat_utf8)
8523 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8525 sv_catpvn(sv, p, q - p);
8532 We allow format specification elements in this order:
8533 \d+\$ explicit format parameter index
8535 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8536 0 flag (as above): repeated to allow "v02"
8537 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8538 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8540 [%bcdefginopsuxDFOUX] format (mandatory)
8545 As of perl5.9.3, printf format checking is on by default.
8546 Internally, perl uses %p formats to provide an escape to
8547 some extended formatting. This block deals with those
8548 extensions: if it does not match, (char*)q is reset and
8549 the normal format processing code is used.
8551 Currently defined extensions are:
8552 %p include pointer address (standard)
8553 %-p (SVf) include an SV (previously %_)
8554 %-<num>p include an SV with precision <num>
8555 %1p (VDf) include a v-string (as %vd)
8556 %<num>p reserved for future extensions
8558 Robin Barker 2005-07-14
8565 n = expect_number(&q);
8572 argsv = (SV*)va_arg(*args, void*);
8573 eptr = SvPVx_const(argsv, elen);
8579 else if (n == vdNUMBER) { /* VDf */
8586 if (ckWARN_d(WARN_INTERNAL))
8587 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8588 "internal %%<num>p might conflict with future printf extensions");
8594 if ( (width = expect_number(&q)) ) {
8609 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8638 if ( (ewix = expect_number(&q)) )
8647 if ((vectorarg = asterisk)) {
8660 width = expect_number(&q);
8666 vecsv = va_arg(*args, SV*);
8668 vecsv = (evix > 0 && evix <= svmax)
8669 ? svargs[evix-1] : &PL_sv_undef;
8671 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8673 dotstr = SvPV_const(vecsv, dotstrlen);
8674 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8675 bad with tied or overloaded values that return UTF8. */
8678 else if (has_utf8) {
8679 vecsv = sv_mortalcopy(vecsv);
8680 sv_utf8_upgrade(vecsv);
8681 dotstr = SvPV_const(vecsv, dotstrlen);
8688 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8689 vecsv = svargs[efix ? efix-1 : svix++];
8690 vecstr = (U8*)SvPV_const(vecsv,veclen);
8691 vec_utf8 = DO_UTF8(vecsv);
8693 /* if this is a version object, we need to convert
8694 * back into v-string notation and then let the
8695 * vectorize happen normally
8697 if (sv_derived_from(vecsv, "version")) {
8698 char *version = savesvpv(vecsv);
8699 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8700 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8701 "vector argument not supported with alpha versions");
8704 vecsv = sv_newmortal();
8705 /* scan_vstring is expected to be called during
8706 * tokenization, so we need to fake up the end
8707 * of the buffer for it
8709 PL_bufend = version + veclen;
8710 scan_vstring(version, vecsv);
8711 vecstr = (U8*)SvPV_const(vecsv, veclen);
8712 vec_utf8 = DO_UTF8(vecsv);
8724 i = va_arg(*args, int);
8726 i = (ewix ? ewix <= svmax : svix < svmax) ?
8727 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8729 width = (i < 0) ? -i : i;
8739 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8741 /* XXX: todo, support specified precision parameter */
8745 i = va_arg(*args, int);
8747 i = (ewix ? ewix <= svmax : svix < svmax)
8748 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8750 has_precis = !(i < 0);
8755 precis = precis * 10 + (*q++ - '0');
8764 case 'I': /* Ix, I32x, and I64x */
8766 if (q[1] == '6' && q[2] == '4') {
8772 if (q[1] == '3' && q[2] == '2') {
8782 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8793 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8794 if (*(q + 1) == 'l') { /* lld, llf */
8820 if (!vectorize && !args) {
8822 const I32 i = efix-1;
8823 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8825 argsv = (svix >= 0 && svix < svmax)
8826 ? svargs[svix++] : &PL_sv_undef;
8837 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8839 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8841 eptr = (char*)utf8buf;
8842 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8856 eptr = va_arg(*args, char*);
8858 #ifdef MACOS_TRADITIONAL
8859 /* On MacOS, %#s format is used for Pascal strings */
8864 elen = strlen(eptr);
8866 eptr = (char *)nullstr;
8867 elen = sizeof nullstr - 1;
8871 eptr = SvPVx_const(argsv, elen);
8872 if (DO_UTF8(argsv)) {
8873 I32 old_precis = precis;
8874 if (has_precis && precis < elen) {
8876 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8879 if (width) { /* fudge width (can't fudge elen) */
8880 if (has_precis && precis < elen)
8881 width += precis - old_precis;
8883 width += elen - sv_len_utf8(argsv);
8890 if (has_precis && elen > precis)
8897 if (alt || vectorize)
8899 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8920 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8929 esignbuf[esignlen++] = plus;
8933 case 'h': iv = (short)va_arg(*args, int); break;
8934 case 'l': iv = va_arg(*args, long); break;
8935 case 'V': iv = va_arg(*args, IV); break;
8936 default: iv = va_arg(*args, int); break;
8938 case 'q': iv = va_arg(*args, Quad_t); break;
8943 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8945 case 'h': iv = (short)tiv; break;
8946 case 'l': iv = (long)tiv; break;
8948 default: iv = tiv; break;
8950 case 'q': iv = (Quad_t)tiv; break;
8954 if ( !vectorize ) /* we already set uv above */
8959 esignbuf[esignlen++] = plus;
8963 esignbuf[esignlen++] = '-';
9007 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9018 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9019 case 'l': uv = va_arg(*args, unsigned long); break;
9020 case 'V': uv = va_arg(*args, UV); break;
9021 default: uv = va_arg(*args, unsigned); break;
9023 case 'q': uv = va_arg(*args, Uquad_t); break;
9028 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9030 case 'h': uv = (unsigned short)tuv; break;
9031 case 'l': uv = (unsigned long)tuv; break;
9033 default: uv = tuv; break;
9035 case 'q': uv = (Uquad_t)tuv; break;
9042 char *ptr = ebuf + sizeof ebuf;
9043 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9049 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9055 esignbuf[esignlen++] = '0';
9056 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9064 if (alt && *ptr != '0')
9073 esignbuf[esignlen++] = '0';
9074 esignbuf[esignlen++] = c;
9077 default: /* it had better be ten or less */
9081 } while (uv /= base);
9084 elen = (ebuf + sizeof ebuf) - ptr;
9088 zeros = precis - elen;
9089 else if (precis == 0 && elen == 1 && *eptr == '0'
9090 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9093 /* a precision nullifies the 0 flag. */
9100 /* FLOATING POINT */
9103 c = 'f'; /* maybe %F isn't supported here */
9111 /* This is evil, but floating point is even more evil */
9113 /* for SV-style calling, we can only get NV
9114 for C-style calling, we assume %f is double;
9115 for simplicity we allow any of %Lf, %llf, %qf for long double
9119 #if defined(USE_LONG_DOUBLE)
9123 /* [perl #20339] - we should accept and ignore %lf rather than die */
9127 #if defined(USE_LONG_DOUBLE)
9128 intsize = args ? 0 : 'q';
9132 #if defined(HAS_LONG_DOUBLE)
9141 /* now we need (long double) if intsize == 'q', else (double) */
9143 #if LONG_DOUBLESIZE > DOUBLESIZE
9145 va_arg(*args, long double) :
9146 va_arg(*args, double)
9148 va_arg(*args, double)
9153 if (c != 'e' && c != 'E') {
9155 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9156 will cast our (long double) to (double) */
9157 (void)Perl_frexp(nv, &i);
9158 if (i == PERL_INT_MIN)
9159 Perl_die(aTHX_ "panic: frexp");
9161 need = BIT_DIGITS(i);
9163 need += has_precis ? precis : 6; /* known default */
9168 #ifdef HAS_LDBL_SPRINTF_BUG
9169 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9170 with sfio - Allen <allens@cpan.org> */
9173 # define MY_DBL_MAX DBL_MAX
9174 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9175 # if DOUBLESIZE >= 8
9176 # define MY_DBL_MAX 1.7976931348623157E+308L
9178 # define MY_DBL_MAX 3.40282347E+38L
9182 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9183 # define MY_DBL_MAX_BUG 1L
9185 # define MY_DBL_MAX_BUG MY_DBL_MAX
9189 # define MY_DBL_MIN DBL_MIN
9190 # else /* XXX guessing! -Allen */
9191 # if DOUBLESIZE >= 8
9192 # define MY_DBL_MIN 2.2250738585072014E-308L
9194 # define MY_DBL_MIN 1.17549435E-38L
9198 if ((intsize == 'q') && (c == 'f') &&
9199 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9201 /* it's going to be short enough that
9202 * long double precision is not needed */
9204 if ((nv <= 0L) && (nv >= -0L))
9205 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9207 /* would use Perl_fp_class as a double-check but not
9208 * functional on IRIX - see perl.h comments */
9210 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9211 /* It's within the range that a double can represent */
9212 #if defined(DBL_MAX) && !defined(DBL_MIN)
9213 if ((nv >= ((long double)1/DBL_MAX)) ||
9214 (nv <= (-(long double)1/DBL_MAX)))
9216 fix_ldbl_sprintf_bug = TRUE;
9219 if (fix_ldbl_sprintf_bug == TRUE) {
9229 # undef MY_DBL_MAX_BUG
9232 #endif /* HAS_LDBL_SPRINTF_BUG */
9234 need += 20; /* fudge factor */
9235 if (PL_efloatsize < need) {
9236 Safefree(PL_efloatbuf);
9237 PL_efloatsize = need + 20; /* more fudge */
9238 Newx(PL_efloatbuf, PL_efloatsize, char);
9239 PL_efloatbuf[0] = '\0';
9242 if ( !(width || left || plus || alt) && fill != '0'
9243 && has_precis && intsize != 'q' ) { /* Shortcuts */
9244 /* See earlier comment about buggy Gconvert when digits,
9246 if ( c == 'g' && precis) {
9247 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9248 /* May return an empty string for digits==0 */
9249 if (*PL_efloatbuf) {
9250 elen = strlen(PL_efloatbuf);
9251 goto float_converted;
9253 } else if ( c == 'f' && !precis) {
9254 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9259 char *ptr = ebuf + sizeof ebuf;
9262 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9263 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9264 if (intsize == 'q') {
9265 /* Copy the one or more characters in a long double
9266 * format before the 'base' ([efgEFG]) character to
9267 * the format string. */
9268 static char const prifldbl[] = PERL_PRIfldbl;
9269 char const *p = prifldbl + sizeof(prifldbl) - 3;
9270 while (p >= prifldbl) { *--ptr = *p--; }
9275 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9280 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9292 /* No taint. Otherwise we are in the strange situation
9293 * where printf() taints but print($float) doesn't.
9295 #if defined(HAS_LONG_DOUBLE)
9296 elen = ((intsize == 'q')
9297 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9298 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9300 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9304 eptr = PL_efloatbuf;
9312 i = SvCUR(sv) - origlen;
9315 case 'h': *(va_arg(*args, short*)) = i; break;
9316 default: *(va_arg(*args, int*)) = i; break;
9317 case 'l': *(va_arg(*args, long*)) = i; break;
9318 case 'V': *(va_arg(*args, IV*)) = i; break;
9320 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9325 sv_setuv_mg(argsv, (UV)i);
9326 continue; /* not "break" */
9333 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9334 && ckWARN(WARN_PRINTF))
9336 SV * const msg = sv_newmortal();
9337 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9338 (PL_op->op_type == OP_PRTF) ? "" : "s");
9341 Perl_sv_catpvf(aTHX_ msg,
9342 "\"%%%c\"", c & 0xFF);
9344 Perl_sv_catpvf(aTHX_ msg,
9345 "\"%%\\%03"UVof"\"",
9348 sv_catpvs(msg, "end of string");
9349 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9352 /* output mangled stuff ... */
9358 /* ... right here, because formatting flags should not apply */
9359 SvGROW(sv, SvCUR(sv) + elen + 1);
9361 Copy(eptr, p, elen, char);
9364 SvCUR_set(sv, p - SvPVX_const(sv));
9366 continue; /* not "break" */
9369 if (is_utf8 != has_utf8) {
9372 sv_utf8_upgrade(sv);
9375 const STRLEN old_elen = elen;
9376 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9377 sv_utf8_upgrade(nsv);
9378 eptr = SvPVX_const(nsv);
9381 if (width) { /* fudge width (can't fudge elen) */
9382 width += elen - old_elen;
9388 have = esignlen + zeros + elen;
9390 Perl_croak_nocontext(PL_memory_wrap);
9392 need = (have > width ? have : width);
9395 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9396 Perl_croak_nocontext(PL_memory_wrap);
9397 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9399 if (esignlen && fill == '0') {
9401 for (i = 0; i < (int)esignlen; i++)
9405 memset(p, fill, gap);
9408 if (esignlen && fill != '0') {
9410 for (i = 0; i < (int)esignlen; i++)
9415 for (i = zeros; i; i--)
9419 Copy(eptr, p, elen, char);
9423 memset(p, ' ', gap);
9428 Copy(dotstr, p, dotstrlen, char);
9432 vectorize = FALSE; /* done iterating over vecstr */
9439 SvCUR_set(sv, p - SvPVX_const(sv));
9447 /* =========================================================================
9449 =head1 Cloning an interpreter
9451 All the macros and functions in this section are for the private use of
9452 the main function, perl_clone().
9454 The foo_dup() functions make an exact copy of an existing foo thinngy.
9455 During the course of a cloning, a hash table is used to map old addresses
9456 to new addresses. The table is created and manipulated with the
9457 ptr_table_* functions.
9461 ============================================================================*/
9464 #if defined(USE_ITHREADS)
9466 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9467 #ifndef GpREFCNT_inc
9468 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9472 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9473 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9474 If this changes, please unmerge ss_dup. */
9475 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9476 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9477 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9478 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9479 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9480 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9481 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9482 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9483 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9484 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9485 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9486 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9487 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9488 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9490 /* clone a parser */
9493 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9500 /* look for it in the table first */
9501 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9505 /* create anew and remember what it is */
9506 Newxz(parser, 1, yy_parser);
9507 ptr_table_store(PL_ptr_table, proto, parser);
9509 parser->yyerrstatus = 0;
9510 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9512 /* XXX these not yet duped */
9513 parser->old_parser = NULL;
9514 parser->stack = NULL;
9516 parser->stack_size = 0;
9517 /* XXX parser->stack->state = 0; */
9519 /* XXX eventually, just Copy() most of the parser struct ? */
9521 parser->lex_brackets = proto->lex_brackets;
9522 parser->lex_casemods = proto->lex_casemods;
9523 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9524 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9525 parser->lex_casestack = savepvn(proto->lex_casestack,
9526 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9527 parser->lex_defer = proto->lex_defer;
9528 parser->lex_dojoin = proto->lex_dojoin;
9529 parser->lex_expect = proto->lex_expect;
9530 parser->lex_formbrack = proto->lex_formbrack;
9531 parser->lex_inpat = proto->lex_inpat;
9532 parser->lex_inwhat = proto->lex_inwhat;
9533 parser->lex_op = proto->lex_op;
9534 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9535 parser->lex_starts = proto->lex_starts;
9536 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9537 parser->multi_close = proto->multi_close;
9538 parser->multi_open = proto->multi_open;
9539 parser->multi_start = proto->multi_start;
9540 parser->pending_ident = proto->pending_ident;
9541 parser->preambled = proto->preambled;
9542 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9545 parser->endwhite = proto->endwhite;
9546 parser->faketokens = proto->faketokens;
9547 parser->lasttoke = proto->lasttoke;
9548 parser->nextwhite = proto->nextwhite;
9549 parser->realtokenstart = proto->realtokenstart;
9550 parser->skipwhite = proto->skipwhite;
9551 parser->thisclose = proto->thisclose;
9552 parser->thismad = proto->thismad;
9553 parser->thisopen = proto->thisopen;
9554 parser->thisstuff = proto->thisstuff;
9555 parser->thistoken = proto->thistoken;
9556 parser->thiswhite = proto->thiswhite;
9562 /* duplicate a file handle */
9565 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9569 PERL_UNUSED_ARG(type);
9572 return (PerlIO*)NULL;
9574 /* look for it in the table first */
9575 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9579 /* create anew and remember what it is */
9580 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9581 ptr_table_store(PL_ptr_table, fp, ret);
9585 /* duplicate a directory handle */
9588 Perl_dirp_dup(pTHX_ DIR *dp)
9590 PERL_UNUSED_CONTEXT;
9597 /* duplicate a typeglob */
9600 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9606 /* look for it in the table first */
9607 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9611 /* create anew and remember what it is */
9613 ptr_table_store(PL_ptr_table, gp, ret);
9616 ret->gp_refcnt = 0; /* must be before any other dups! */
9617 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9618 ret->gp_io = io_dup_inc(gp->gp_io, param);
9619 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9620 ret->gp_av = av_dup_inc(gp->gp_av, param);
9621 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9622 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9623 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9624 ret->gp_cvgen = gp->gp_cvgen;
9625 ret->gp_line = gp->gp_line;
9626 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9630 /* duplicate a chain of magic */
9633 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9635 MAGIC *mgprev = (MAGIC*)NULL;
9638 return (MAGIC*)NULL;
9639 /* look for it in the table first */
9640 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9644 for (; mg; mg = mg->mg_moremagic) {
9646 Newxz(nmg, 1, MAGIC);
9648 mgprev->mg_moremagic = nmg;
9651 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9652 nmg->mg_private = mg->mg_private;
9653 nmg->mg_type = mg->mg_type;
9654 nmg->mg_flags = mg->mg_flags;
9655 if (mg->mg_type == PERL_MAGIC_qr) {
9656 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9658 else if(mg->mg_type == PERL_MAGIC_backref) {
9659 /* The backref AV has its reference count deliberately bumped by
9661 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9663 else if (mg->mg_type == PERL_MAGIC_symtab) {
9664 nmg->mg_obj = mg->mg_obj;
9667 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9668 ? sv_dup_inc(mg->mg_obj, param)
9669 : sv_dup(mg->mg_obj, param);
9671 nmg->mg_len = mg->mg_len;
9672 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9673 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9674 if (mg->mg_len > 0) {
9675 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9676 if (mg->mg_type == PERL_MAGIC_overload_table &&
9677 AMT_AMAGIC((AMT*)mg->mg_ptr))
9679 const AMT * const amtp = (AMT*)mg->mg_ptr;
9680 AMT * const namtp = (AMT*)nmg->mg_ptr;
9682 for (i = 1; i < NofAMmeth; i++) {
9683 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9687 else if (mg->mg_len == HEf_SVKEY)
9688 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9690 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9691 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9698 #endif /* USE_ITHREADS */
9700 /* create a new pointer-mapping table */
9703 Perl_ptr_table_new(pTHX)
9706 PERL_UNUSED_CONTEXT;
9708 Newxz(tbl, 1, PTR_TBL_t);
9711 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9715 #define PTR_TABLE_HASH(ptr) \
9716 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9719 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9720 following define) and at call to new_body_inline made below in
9721 Perl_ptr_table_store()
9724 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9726 /* map an existing pointer using a table */
9728 STATIC PTR_TBL_ENT_t *
9729 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9730 PTR_TBL_ENT_t *tblent;
9731 const UV hash = PTR_TABLE_HASH(sv);
9733 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9734 for (; tblent; tblent = tblent->next) {
9735 if (tblent->oldval == sv)
9742 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9744 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9745 PERL_UNUSED_CONTEXT;
9746 return tblent ? tblent->newval : NULL;
9749 /* add a new entry to a pointer-mapping table */
9752 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9754 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9755 PERL_UNUSED_CONTEXT;
9758 tblent->newval = newsv;
9760 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9762 new_body_inline(tblent, PTE_SVSLOT);
9764 tblent->oldval = oldsv;
9765 tblent->newval = newsv;
9766 tblent->next = tbl->tbl_ary[entry];
9767 tbl->tbl_ary[entry] = tblent;
9769 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9770 ptr_table_split(tbl);
9774 /* double the hash bucket size of an existing ptr table */
9777 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9779 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9780 const UV oldsize = tbl->tbl_max + 1;
9781 UV newsize = oldsize * 2;
9783 PERL_UNUSED_CONTEXT;
9785 Renew(ary, newsize, PTR_TBL_ENT_t*);
9786 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9787 tbl->tbl_max = --newsize;
9789 for (i=0; i < oldsize; i++, ary++) {
9790 PTR_TBL_ENT_t **curentp, **entp, *ent;
9793 curentp = ary + oldsize;
9794 for (entp = ary, ent = *ary; ent; ent = *entp) {
9795 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9797 ent->next = *curentp;
9807 /* remove all the entries from a ptr table */
9810 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9812 if (tbl && tbl->tbl_items) {
9813 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9814 UV riter = tbl->tbl_max;
9817 PTR_TBL_ENT_t *entry = array[riter];
9820 PTR_TBL_ENT_t * const oentry = entry;
9821 entry = entry->next;
9830 /* clear and free a ptr table */
9833 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9838 ptr_table_clear(tbl);
9839 Safefree(tbl->tbl_ary);
9843 #if defined(USE_ITHREADS)
9846 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9849 SvRV_set(dstr, SvWEAKREF(sstr)
9850 ? sv_dup(SvRV(sstr), param)
9851 : sv_dup_inc(SvRV(sstr), param));
9854 else if (SvPVX_const(sstr)) {
9855 /* Has something there */
9857 /* Normal PV - clone whole allocated space */
9858 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9859 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9860 /* Not that normal - actually sstr is copy on write.
9861 But we are a true, independant SV, so: */
9862 SvREADONLY_off(dstr);
9867 /* Special case - not normally malloced for some reason */
9868 if (isGV_with_GP(sstr)) {
9869 /* Don't need to do anything here. */
9871 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9872 /* A "shared" PV - clone it as "shared" PV */
9874 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9878 /* Some other special case - random pointer */
9879 SvPV_set(dstr, SvPVX(sstr));
9885 if (SvTYPE(dstr) == SVt_RV)
9886 SvRV_set(dstr, NULL);
9888 SvPV_set(dstr, NULL);
9892 /* duplicate an SV of any type (including AV, HV etc) */
9895 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9900 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9902 /* look for it in the table first */
9903 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9907 if(param->flags & CLONEf_JOIN_IN) {
9908 /** We are joining here so we don't want do clone
9909 something that is bad **/
9910 if (SvTYPE(sstr) == SVt_PVHV) {
9911 const char * const hvname = HvNAME_get(sstr);
9913 /** don't clone stashes if they already exist **/
9914 return (SV*)gv_stashpv(hvname,0);
9918 /* create anew and remember what it is */
9921 #ifdef DEBUG_LEAKING_SCALARS
9922 dstr->sv_debug_optype = sstr->sv_debug_optype;
9923 dstr->sv_debug_line = sstr->sv_debug_line;
9924 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9925 dstr->sv_debug_cloned = 1;
9926 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9929 ptr_table_store(PL_ptr_table, sstr, dstr);
9932 SvFLAGS(dstr) = SvFLAGS(sstr);
9933 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9934 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9937 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9938 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9939 (void*)PL_watch_pvx, SvPVX_const(sstr));
9942 /* don't clone objects whose class has asked us not to */
9943 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9944 SvFLAGS(dstr) &= ~SVTYPEMASK;
9949 switch (SvTYPE(sstr)) {
9954 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9955 SvIV_set(dstr, SvIVX(sstr));
9958 SvANY(dstr) = new_XNV();
9959 SvNV_set(dstr, SvNVX(sstr));
9962 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9963 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9965 /* case SVt_BIND: */
9968 /* These are all the types that need complex bodies allocating. */
9970 const svtype sv_type = SvTYPE(sstr);
9971 const struct body_details *const sv_type_details
9972 = bodies_by_type + sv_type;
9976 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9980 if (GvUNIQUE((GV*)sstr)) {
9981 NOOP; /* Do sharing here, and fall through */
9993 assert(sv_type_details->body_size);
9994 if (sv_type_details->arena) {
9995 new_body_inline(new_body, sv_type);
9997 = (void*)((char*)new_body - sv_type_details->offset);
9999 new_body = new_NOARENA(sv_type_details);
10003 SvANY(dstr) = new_body;
10006 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10007 ((char*)SvANY(dstr)) + sv_type_details->offset,
10008 sv_type_details->copy, char);
10010 Copy(((char*)SvANY(sstr)),
10011 ((char*)SvANY(dstr)),
10012 sv_type_details->body_size + sv_type_details->offset, char);
10015 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10016 && !isGV_with_GP(dstr))
10017 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10019 /* The Copy above means that all the source (unduplicated) pointers
10020 are now in the destination. We can check the flags and the
10021 pointers in either, but it's possible that there's less cache
10022 missing by always going for the destination.
10023 FIXME - instrument and check that assumption */
10024 if (sv_type >= SVt_PVMG) {
10025 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10026 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10027 } else if (SvMAGIC(dstr))
10028 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10030 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10033 /* The cast silences a GCC warning about unhandled types. */
10034 switch ((int)sv_type) {
10044 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10045 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10046 LvTARG(dstr) = dstr;
10047 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10048 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10050 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10052 if(isGV_with_GP(sstr)) {
10053 if (GvNAME_HEK(dstr))
10054 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10055 /* Don't call sv_add_backref here as it's going to be
10056 created as part of the magic cloning of the symbol
10058 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10059 at the point of this comment. */
10060 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10061 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10062 (void)GpREFCNT_inc(GvGP(dstr));
10064 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10067 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10068 if (IoOFP(dstr) == IoIFP(sstr))
10069 IoOFP(dstr) = IoIFP(dstr);
10071 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10072 /* PL_rsfp_filters entries have fake IoDIRP() */
10073 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10074 /* I have no idea why fake dirp (rsfps)
10075 should be treated differently but otherwise
10076 we end up with leaks -- sky*/
10077 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10078 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10079 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10081 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10082 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10083 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10084 if (IoDIRP(dstr)) {
10085 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10088 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10091 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10092 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10093 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10096 if (AvARRAY((AV*)sstr)) {
10097 SV **dst_ary, **src_ary;
10098 SSize_t items = AvFILLp((AV*)sstr) + 1;
10100 src_ary = AvARRAY((AV*)sstr);
10101 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10102 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10103 AvARRAY((AV*)dstr) = dst_ary;
10104 AvALLOC((AV*)dstr) = dst_ary;
10105 if (AvREAL((AV*)sstr)) {
10106 while (items-- > 0)
10107 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10110 while (items-- > 0)
10111 *dst_ary++ = sv_dup(*src_ary++, param);
10113 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10114 while (items-- > 0) {
10115 *dst_ary++ = &PL_sv_undef;
10119 AvARRAY((AV*)dstr) = NULL;
10120 AvALLOC((AV*)dstr) = (SV**)NULL;
10124 if (HvARRAY((HV*)sstr)) {
10126 const bool sharekeys = !!HvSHAREKEYS(sstr);
10127 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10128 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10130 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10131 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10133 HvARRAY(dstr) = (HE**)darray;
10134 while (i <= sxhv->xhv_max) {
10135 const HE * const source = HvARRAY(sstr)[i];
10136 HvARRAY(dstr)[i] = source
10137 ? he_dup(source, sharekeys, param) : 0;
10142 const struct xpvhv_aux * const saux = HvAUX(sstr);
10143 struct xpvhv_aux * const daux = HvAUX(dstr);
10144 /* This flag isn't copied. */
10145 /* SvOOK_on(hv) attacks the IV flags. */
10146 SvFLAGS(dstr) |= SVf_OOK;
10148 hvname = saux->xhv_name;
10149 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10151 daux->xhv_riter = saux->xhv_riter;
10152 daux->xhv_eiter = saux->xhv_eiter
10153 ? he_dup(saux->xhv_eiter,
10154 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10155 daux->xhv_backreferences =
10156 saux->xhv_backreferences
10157 ? (AV*) SvREFCNT_inc(
10158 sv_dup((SV*)saux->xhv_backreferences, param))
10160 /* Record stashes for possible cloning in Perl_clone(). */
10162 av_push(param->stashes, dstr);
10166 HvARRAY((HV*)dstr) = NULL;
10169 if (!(param->flags & CLONEf_COPY_STACKS)) {
10173 /* NOTE: not refcounted */
10174 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10176 if (!CvISXSUB(dstr))
10177 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10179 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10180 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10181 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10182 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10184 /* don't dup if copying back - CvGV isn't refcounted, so the
10185 * duped GV may never be freed. A bit of a hack! DAPM */
10186 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10187 NULL : gv_dup(CvGV(dstr), param) ;
10188 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10190 CvWEAKOUTSIDE(sstr)
10191 ? cv_dup( CvOUTSIDE(dstr), param)
10192 : cv_dup_inc(CvOUTSIDE(dstr), param);
10193 if (!CvISXSUB(dstr))
10194 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10200 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10206 /* duplicate a context */
10209 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10211 PERL_CONTEXT *ncxs;
10214 return (PERL_CONTEXT*)NULL;
10216 /* look for it in the table first */
10217 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10221 /* create anew and remember what it is */
10222 Newxz(ncxs, max + 1, PERL_CONTEXT);
10223 ptr_table_store(PL_ptr_table, cxs, ncxs);
10226 PERL_CONTEXT * const cx = &cxs[ix];
10227 PERL_CONTEXT * const ncx = &ncxs[ix];
10228 ncx->cx_type = cx->cx_type;
10229 if (CxTYPE(cx) == CXt_SUBST) {
10230 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10233 ncx->blk_oldsp = cx->blk_oldsp;
10234 ncx->blk_oldcop = cx->blk_oldcop;
10235 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10236 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10237 ncx->blk_oldpm = cx->blk_oldpm;
10238 ncx->blk_gimme = cx->blk_gimme;
10239 switch (CxTYPE(cx)) {
10241 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10242 ? cv_dup_inc(cx->blk_sub.cv, param)
10243 : cv_dup(cx->blk_sub.cv,param));
10244 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10245 ? av_dup_inc(cx->blk_sub.argarray, param)
10247 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10248 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10249 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10250 ncx->blk_sub.lval = cx->blk_sub.lval;
10251 ncx->blk_sub.retop = cx->blk_sub.retop;
10252 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10253 cx->blk_sub.oldcomppad);
10256 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10257 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10258 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10259 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10260 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10261 ncx->blk_eval.retop = cx->blk_eval.retop;
10264 ncx->blk_loop.label = cx->blk_loop.label;
10265 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10266 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10267 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10268 ? cx->blk_loop.iterdata
10269 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10270 ncx->blk_loop.oldcomppad
10271 = (PAD*)ptr_table_fetch(PL_ptr_table,
10272 cx->blk_loop.oldcomppad);
10273 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10274 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10275 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10276 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10277 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10280 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10281 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10282 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10283 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10284 ncx->blk_sub.retop = cx->blk_sub.retop;
10296 /* duplicate a stack info structure */
10299 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10304 return (PERL_SI*)NULL;
10306 /* look for it in the table first */
10307 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10311 /* create anew and remember what it is */
10312 Newxz(nsi, 1, PERL_SI);
10313 ptr_table_store(PL_ptr_table, si, nsi);
10315 nsi->si_stack = av_dup_inc(si->si_stack, param);
10316 nsi->si_cxix = si->si_cxix;
10317 nsi->si_cxmax = si->si_cxmax;
10318 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10319 nsi->si_type = si->si_type;
10320 nsi->si_prev = si_dup(si->si_prev, param);
10321 nsi->si_next = si_dup(si->si_next, param);
10322 nsi->si_markoff = si->si_markoff;
10327 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10328 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10329 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10330 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10331 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10332 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10333 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10334 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10335 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10336 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10337 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10338 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10339 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10340 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10343 #define pv_dup_inc(p) SAVEPV(p)
10344 #define pv_dup(p) SAVEPV(p)
10345 #define svp_dup_inc(p,pp) any_dup(p,pp)
10347 /* map any object to the new equivent - either something in the
10348 * ptr table, or something in the interpreter structure
10352 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10357 return (void*)NULL;
10359 /* look for it in the table first */
10360 ret = ptr_table_fetch(PL_ptr_table, v);
10364 /* see if it is part of the interpreter structure */
10365 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10366 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10374 /* duplicate the save stack */
10377 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10380 ANY * const ss = proto_perl->Tsavestack;
10381 const I32 max = proto_perl->Tsavestack_max;
10382 I32 ix = proto_perl->Tsavestack_ix;
10395 void (*dptr) (void*);
10396 void (*dxptr) (pTHX_ void*);
10398 Newxz(nss, max, ANY);
10401 const I32 type = POPINT(ss,ix);
10402 TOPINT(nss,ix) = type;
10404 case SAVEt_HELEM: /* hash element */
10405 sv = (SV*)POPPTR(ss,ix);
10406 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10408 case SAVEt_ITEM: /* normal string */
10409 case SAVEt_SV: /* scalar reference */
10410 sv = (SV*)POPPTR(ss,ix);
10411 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10414 case SAVEt_MORTALIZESV:
10415 sv = (SV*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10418 case SAVEt_SHARED_PVREF: /* char* in shared space */
10419 c = (char*)POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = savesharedpv(c);
10421 ptr = POPPTR(ss,ix);
10422 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10424 case SAVEt_GENERIC_SVREF: /* generic sv */
10425 case SAVEt_SVREF: /* scalar reference */
10426 sv = (SV*)POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10428 ptr = POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10431 case SAVEt_HV: /* hash reference */
10432 case SAVEt_AV: /* array reference */
10433 sv = (SV*) POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10436 case SAVEt_COMPPAD:
10438 sv = (SV*) POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = sv_dup(sv, param);
10441 case SAVEt_INT: /* int reference */
10442 ptr = POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10444 intval = (int)POPINT(ss,ix);
10445 TOPINT(nss,ix) = intval;
10447 case SAVEt_LONG: /* long reference */
10448 ptr = POPPTR(ss,ix);
10449 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10451 case SAVEt_CLEARSV:
10452 longval = (long)POPLONG(ss,ix);
10453 TOPLONG(nss,ix) = longval;
10455 case SAVEt_I32: /* I32 reference */
10456 case SAVEt_I16: /* I16 reference */
10457 case SAVEt_I8: /* I8 reference */
10458 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10459 ptr = POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10462 TOPINT(nss,ix) = i;
10464 case SAVEt_IV: /* IV reference */
10465 ptr = POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10468 TOPIV(nss,ix) = iv;
10470 case SAVEt_HPTR: /* HV* reference */
10471 case SAVEt_APTR: /* AV* reference */
10472 case SAVEt_SPTR: /* SV* reference */
10473 ptr = POPPTR(ss,ix);
10474 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10475 sv = (SV*)POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = sv_dup(sv, param);
10478 case SAVEt_VPTR: /* random* reference */
10479 ptr = POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10481 ptr = POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10484 case SAVEt_GENERIC_PVREF: /* generic char* */
10485 case SAVEt_PPTR: /* char* reference */
10486 ptr = POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10488 c = (char*)POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = pv_dup(c);
10491 case SAVEt_GP: /* scalar reference */
10492 gp = (GP*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10494 (void)GpREFCNT_inc(gp);
10495 gv = (GV*)POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10499 ptr = POPPTR(ss,ix);
10500 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10501 /* these are assumed to be refcounted properly */
10503 switch (((OP*)ptr)->op_type) {
10505 case OP_LEAVESUBLV:
10509 case OP_LEAVEWRITE:
10510 TOPPTR(nss,ix) = ptr;
10517 TOPPTR(nss,ix) = NULL;
10522 TOPPTR(nss,ix) = NULL;
10525 c = (char*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = pv_dup_inc(c);
10529 hv = (HV*)POPPTR(ss,ix);
10530 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10531 c = (char*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = pv_dup_inc(c);
10534 case SAVEt_STACK_POS: /* Position on Perl stack */
10536 TOPINT(nss,ix) = i;
10538 case SAVEt_DESTRUCTOR:
10539 ptr = POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10541 dptr = POPDPTR(ss,ix);
10542 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10543 any_dup(FPTR2DPTR(void *, dptr),
10546 case SAVEt_DESTRUCTOR_X:
10547 ptr = POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10549 dxptr = POPDXPTR(ss,ix);
10550 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10551 any_dup(FPTR2DPTR(void *, dxptr),
10554 case SAVEt_REGCONTEXT:
10557 TOPINT(nss,ix) = i;
10560 case SAVEt_AELEM: /* array element */
10561 sv = (SV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10564 TOPINT(nss,ix) = i;
10565 av = (AV*)POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = av_dup_inc(av, param);
10569 ptr = POPPTR(ss,ix);
10570 TOPPTR(nss,ix) = ptr;
10574 TOPINT(nss,ix) = i;
10575 ptr = POPPTR(ss,ix);
10578 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10579 HINTS_REFCNT_UNLOCK;
10581 TOPPTR(nss,ix) = ptr;
10582 if (i & HINT_LOCALIZE_HH) {
10583 hv = (HV*)POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10588 longval = (long)POPLONG(ss,ix);
10589 TOPLONG(nss,ix) = longval;
10590 ptr = POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10592 sv = (SV*)POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = sv_dup(sv, param);
10596 ptr = POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10598 longval = (long)POPBOOL(ss,ix);
10599 TOPBOOL(nss,ix) = (bool)longval;
10601 case SAVEt_SET_SVFLAGS:
10603 TOPINT(nss,ix) = i;
10605 TOPINT(nss,ix) = i;
10606 sv = (SV*)POPPTR(ss,ix);
10607 TOPPTR(nss,ix) = sv_dup(sv, param);
10609 case SAVEt_RE_STATE:
10611 const struct re_save_state *const old_state
10612 = (struct re_save_state *)
10613 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10614 struct re_save_state *const new_state
10615 = (struct re_save_state *)
10616 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10618 Copy(old_state, new_state, 1, struct re_save_state);
10619 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10621 new_state->re_state_bostr
10622 = pv_dup(old_state->re_state_bostr);
10623 new_state->re_state_reginput
10624 = pv_dup(old_state->re_state_reginput);
10625 new_state->re_state_regeol
10626 = pv_dup(old_state->re_state_regeol);
10627 new_state->re_state_regstartp
10628 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10629 new_state->re_state_regendp
10630 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10631 new_state->re_state_reglastparen
10632 = (U32*) any_dup(old_state->re_state_reglastparen,
10634 new_state->re_state_reglastcloseparen
10635 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10637 /* XXX This just has to be broken. The old save_re_context
10638 code did SAVEGENERICPV(PL_reg_start_tmp);
10639 PL_reg_start_tmp is char **.
10640 Look above to what the dup code does for
10641 SAVEt_GENERIC_PVREF
10642 It can never have worked.
10643 So this is merely a faithful copy of the exiting bug: */
10644 new_state->re_state_reg_start_tmp
10645 = (char **) pv_dup((char *)
10646 old_state->re_state_reg_start_tmp);
10647 /* I assume that it only ever "worked" because no-one called
10648 (pseudo)fork while the regexp engine had re-entered itself.
10650 #ifdef PERL_OLD_COPY_ON_WRITE
10651 new_state->re_state_nrs
10652 = sv_dup(old_state->re_state_nrs, param);
10654 new_state->re_state_reg_magic
10655 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10657 new_state->re_state_reg_oldcurpm
10658 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10660 new_state->re_state_reg_curpm
10661 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10663 new_state->re_state_reg_oldsaved
10664 = pv_dup(old_state->re_state_reg_oldsaved);
10665 new_state->re_state_reg_poscache
10666 = pv_dup(old_state->re_state_reg_poscache);
10667 new_state->re_state_reg_starttry
10668 = pv_dup(old_state->re_state_reg_starttry);
10671 case SAVEt_COMPILE_WARNINGS:
10672 ptr = POPPTR(ss,ix);
10673 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10676 ptr = POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = parser_dup(ptr, param);
10681 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10689 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10690 * flag to the result. This is done for each stash before cloning starts,
10691 * so we know which stashes want their objects cloned */
10694 do_mark_cloneable_stash(pTHX_ SV *sv)
10696 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10698 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10699 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10700 if (cloner && GvCV(cloner)) {
10707 XPUSHs(sv_2mortal(newSVhek(hvname)));
10709 call_sv((SV*)GvCV(cloner), G_SCALAR);
10716 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10724 =for apidoc perl_clone
10726 Create and return a new interpreter by cloning the current one.
10728 perl_clone takes these flags as parameters:
10730 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10731 without it we only clone the data and zero the stacks,
10732 with it we copy the stacks and the new perl interpreter is
10733 ready to run at the exact same point as the previous one.
10734 The pseudo-fork code uses COPY_STACKS while the
10735 threads->new doesn't.
10737 CLONEf_KEEP_PTR_TABLE
10738 perl_clone keeps a ptr_table with the pointer of the old
10739 variable as a key and the new variable as a value,
10740 this allows it to check if something has been cloned and not
10741 clone it again but rather just use the value and increase the
10742 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10743 the ptr_table using the function
10744 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10745 reason to keep it around is if you want to dup some of your own
10746 variable who are outside the graph perl scans, example of this
10747 code is in threads.xs create
10750 This is a win32 thing, it is ignored on unix, it tells perls
10751 win32host code (which is c++) to clone itself, this is needed on
10752 win32 if you want to run two threads at the same time,
10753 if you just want to do some stuff in a separate perl interpreter
10754 and then throw it away and return to the original one,
10755 you don't need to do anything.
10760 /* XXX the above needs expanding by someone who actually understands it ! */
10761 EXTERN_C PerlInterpreter *
10762 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10765 perl_clone(PerlInterpreter *proto_perl, UV flags)
10768 #ifdef PERL_IMPLICIT_SYS
10770 /* perlhost.h so we need to call into it
10771 to clone the host, CPerlHost should have a c interface, sky */
10773 if (flags & CLONEf_CLONE_HOST) {
10774 return perl_clone_host(proto_perl,flags);
10776 return perl_clone_using(proto_perl, flags,
10778 proto_perl->IMemShared,
10779 proto_perl->IMemParse,
10781 proto_perl->IStdIO,
10785 proto_perl->IProc);
10789 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10790 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10791 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10792 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10793 struct IPerlDir* ipD, struct IPerlSock* ipS,
10794 struct IPerlProc* ipP)
10796 /* XXX many of the string copies here can be optimized if they're
10797 * constants; they need to be allocated as common memory and just
10798 * their pointers copied. */
10801 CLONE_PARAMS clone_params;
10802 CLONE_PARAMS* const param = &clone_params;
10804 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10805 /* for each stash, determine whether its objects should be cloned */
10806 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10807 PERL_SET_THX(my_perl);
10810 PoisonNew(my_perl, 1, PerlInterpreter);
10816 PL_savestack_ix = 0;
10817 PL_savestack_max = -1;
10818 PL_sig_pending = 0;
10819 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10820 # else /* !DEBUGGING */
10821 Zero(my_perl, 1, PerlInterpreter);
10822 # endif /* DEBUGGING */
10824 /* host pointers */
10826 PL_MemShared = ipMS;
10827 PL_MemParse = ipMP;
10834 #else /* !PERL_IMPLICIT_SYS */
10836 CLONE_PARAMS clone_params;
10837 CLONE_PARAMS* param = &clone_params;
10838 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10839 /* for each stash, determine whether its objects should be cloned */
10840 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10841 PERL_SET_THX(my_perl);
10844 PoisonNew(my_perl, 1, PerlInterpreter);
10850 PL_savestack_ix = 0;
10851 PL_savestack_max = -1;
10852 PL_sig_pending = 0;
10853 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10854 # else /* !DEBUGGING */
10855 Zero(my_perl, 1, PerlInterpreter);
10856 # endif /* DEBUGGING */
10857 #endif /* PERL_IMPLICIT_SYS */
10858 param->flags = flags;
10859 param->proto_perl = proto_perl;
10861 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10863 PL_body_arenas = NULL;
10864 Zero(&PL_body_roots, 1, PL_body_roots);
10866 PL_nice_chunk = NULL;
10867 PL_nice_chunk_size = 0;
10869 PL_sv_objcount = 0;
10871 PL_sv_arenaroot = NULL;
10873 PL_debug = proto_perl->Idebug;
10875 PL_hash_seed = proto_perl->Ihash_seed;
10876 PL_rehash_seed = proto_perl->Irehash_seed;
10878 #ifdef USE_REENTRANT_API
10879 /* XXX: things like -Dm will segfault here in perlio, but doing
10880 * PERL_SET_CONTEXT(proto_perl);
10881 * breaks too many other things
10883 Perl_reentrant_init(aTHX);
10886 /* create SV map for pointer relocation */
10887 PL_ptr_table = ptr_table_new();
10889 /* initialize these special pointers as early as possible */
10890 SvANY(&PL_sv_undef) = NULL;
10891 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10892 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10893 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10895 SvANY(&PL_sv_no) = new_XPVNV();
10896 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10897 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10898 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10899 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10900 SvCUR_set(&PL_sv_no, 0);
10901 SvLEN_set(&PL_sv_no, 1);
10902 SvIV_set(&PL_sv_no, 0);
10903 SvNV_set(&PL_sv_no, 0);
10904 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10906 SvANY(&PL_sv_yes) = new_XPVNV();
10907 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10908 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10909 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10910 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10911 SvCUR_set(&PL_sv_yes, 1);
10912 SvLEN_set(&PL_sv_yes, 2);
10913 SvIV_set(&PL_sv_yes, 1);
10914 SvNV_set(&PL_sv_yes, 1);
10915 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10917 /* create (a non-shared!) shared string table */
10918 PL_strtab = newHV();
10919 HvSHAREKEYS_off(PL_strtab);
10920 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10921 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10923 PL_compiling = proto_perl->Icompiling;
10925 /* These two PVs will be free'd special way so must set them same way op.c does */
10926 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10927 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10929 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10930 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10932 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10933 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10934 if (PL_compiling.cop_hints_hash) {
10936 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10937 HINTS_REFCNT_UNLOCK;
10939 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10941 /* pseudo environmental stuff */
10942 PL_origargc = proto_perl->Iorigargc;
10943 PL_origargv = proto_perl->Iorigargv;
10945 param->stashes = newAV(); /* Setup array of objects to call clone on */
10947 /* Set tainting stuff before PerlIO_debug can possibly get called */
10948 PL_tainting = proto_perl->Itainting;
10949 PL_taint_warn = proto_perl->Itaint_warn;
10951 #ifdef PERLIO_LAYERS
10952 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10953 PerlIO_clone(aTHX_ proto_perl, param);
10956 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10957 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10958 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10959 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10960 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10961 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10964 PL_minus_c = proto_perl->Iminus_c;
10965 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10966 PL_localpatches = proto_perl->Ilocalpatches;
10967 PL_splitstr = proto_perl->Isplitstr;
10968 PL_preprocess = proto_perl->Ipreprocess;
10969 PL_minus_n = proto_perl->Iminus_n;
10970 PL_minus_p = proto_perl->Iminus_p;
10971 PL_minus_l = proto_perl->Iminus_l;
10972 PL_minus_a = proto_perl->Iminus_a;
10973 PL_minus_E = proto_perl->Iminus_E;
10974 PL_minus_F = proto_perl->Iminus_F;
10975 PL_doswitches = proto_perl->Idoswitches;
10976 PL_dowarn = proto_perl->Idowarn;
10977 PL_doextract = proto_perl->Idoextract;
10978 PL_sawampersand = proto_perl->Isawampersand;
10979 PL_unsafe = proto_perl->Iunsafe;
10980 PL_inplace = SAVEPV(proto_perl->Iinplace);
10981 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10982 PL_perldb = proto_perl->Iperldb;
10983 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10984 PL_exit_flags = proto_perl->Iexit_flags;
10986 /* magical thingies */
10987 /* XXX time(&PL_basetime) when asked for? */
10988 PL_basetime = proto_perl->Ibasetime;
10989 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10991 PL_maxsysfd = proto_perl->Imaxsysfd;
10992 PL_statusvalue = proto_perl->Istatusvalue;
10994 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10996 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10998 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11000 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11001 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11002 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11005 /* RE engine related */
11006 Zero(&PL_reg_state, 1, struct re_save_state);
11007 PL_reginterp_cnt = 0;
11008 PL_regmatch_slab = NULL;
11010 /* Clone the regex array */
11011 PL_regex_padav = newAV();
11013 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11014 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11016 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11017 for(i = 1; i <= len; i++) {
11018 const SV * const regex = regexen[i];
11021 ? sv_dup_inc(regex, param)
11023 newSViv(PTR2IV(CALLREGDUPE(
11024 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11026 if (SvFLAGS(regex) & SVf_BREAK)
11027 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11028 av_push(PL_regex_padav, sv);
11031 PL_regex_pad = AvARRAY(PL_regex_padav);
11033 /* shortcuts to various I/O objects */
11034 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11035 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11036 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11037 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11038 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11039 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11041 /* shortcuts to regexp stuff */
11042 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11044 /* shortcuts to misc objects */
11045 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11047 /* shortcuts to debugging objects */
11048 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11049 PL_DBline = gv_dup(proto_perl->IDBline, param);
11050 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11051 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11052 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11053 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11054 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11055 PL_lineary = av_dup(proto_perl->Ilineary, param);
11056 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11058 /* symbol tables */
11059 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11060 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11061 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11062 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11063 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11065 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11066 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11067 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11068 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11069 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11070 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11071 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11072 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11074 PL_sub_generation = proto_perl->Isub_generation;
11076 /* funky return mechanisms */
11077 PL_forkprocess = proto_perl->Iforkprocess;
11079 /* subprocess state */
11080 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11082 /* internal state */
11083 PL_maxo = proto_perl->Imaxo;
11084 if (proto_perl->Iop_mask)
11085 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11088 /* PL_asserting = proto_perl->Iasserting; */
11090 /* current interpreter roots */
11091 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11093 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11095 PL_main_start = proto_perl->Imain_start;
11096 PL_eval_root = proto_perl->Ieval_root;
11097 PL_eval_start = proto_perl->Ieval_start;
11099 /* runtime control stuff */
11100 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11101 PL_copline = proto_perl->Icopline;
11103 PL_filemode = proto_perl->Ifilemode;
11104 PL_lastfd = proto_perl->Ilastfd;
11105 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11108 PL_gensym = proto_perl->Igensym;
11109 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11110 PL_laststatval = proto_perl->Ilaststatval;
11111 PL_laststype = proto_perl->Ilaststype;
11114 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11116 /* interpreter atexit processing */
11117 PL_exitlistlen = proto_perl->Iexitlistlen;
11118 if (PL_exitlistlen) {
11119 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11120 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11123 PL_exitlist = (PerlExitListEntry*)NULL;
11125 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11126 if (PL_my_cxt_size) {
11127 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11128 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11129 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11130 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11131 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11135 PL_my_cxt_list = (void**)NULL;
11136 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11137 PL_my_cxt_keys = (void**)NULL;
11140 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11141 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11142 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11144 PL_profiledata = NULL;
11145 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11146 /* PL_rsfp_filters entries have fake IoDIRP() */
11147 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11149 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11151 PAD_CLONE_VARS(proto_perl, param);
11153 #ifdef HAVE_INTERP_INTERN
11154 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11157 /* more statics moved here */
11158 PL_generation = proto_perl->Igeneration;
11159 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11161 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11162 PL_in_clean_all = proto_perl->Iin_clean_all;
11164 PL_uid = proto_perl->Iuid;
11165 PL_euid = proto_perl->Ieuid;
11166 PL_gid = proto_perl->Igid;
11167 PL_egid = proto_perl->Iegid;
11168 PL_nomemok = proto_perl->Inomemok;
11169 PL_an = proto_perl->Ian;
11170 PL_evalseq = proto_perl->Ievalseq;
11171 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11172 PL_origalen = proto_perl->Iorigalen;
11173 #ifdef PERL_USES_PL_PIDSTATUS
11174 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11176 PL_osname = SAVEPV(proto_perl->Iosname);
11177 PL_sighandlerp = proto_perl->Isighandlerp;
11179 PL_runops = proto_perl->Irunops;
11181 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11184 PL_cshlen = proto_perl->Icshlen;
11185 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11188 PL_parser = parser_dup(proto_perl->Iparser, param);
11190 PL_lex_state = proto_perl->Ilex_state;
11193 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11194 PL_curforce = proto_perl->Icurforce;
11196 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11197 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11198 PL_nexttoke = proto_perl->Inexttoke;
11201 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11202 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11203 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11204 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11205 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11206 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11207 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11208 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11209 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11210 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11212 PL_expect = proto_perl->Iexpect;
11214 PL_multi_end = proto_perl->Imulti_end;
11216 PL_error_count = proto_perl->Ierror_count;
11217 PL_subline = proto_perl->Isubline;
11218 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11220 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11221 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11222 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11223 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11224 PL_last_lop_op = proto_perl->Ilast_lop_op;
11225 PL_in_my = proto_perl->Iin_my;
11226 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11228 PL_cryptseen = proto_perl->Icryptseen;
11231 PL_hints = proto_perl->Ihints;
11233 PL_amagic_generation = proto_perl->Iamagic_generation;
11235 #ifdef USE_LOCALE_COLLATE
11236 PL_collation_ix = proto_perl->Icollation_ix;
11237 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11238 PL_collation_standard = proto_perl->Icollation_standard;
11239 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11240 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11241 #endif /* USE_LOCALE_COLLATE */
11243 #ifdef USE_LOCALE_NUMERIC
11244 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11245 PL_numeric_standard = proto_perl->Inumeric_standard;
11246 PL_numeric_local = proto_perl->Inumeric_local;
11247 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11248 #endif /* !USE_LOCALE_NUMERIC */
11250 /* utf8 character classes */
11251 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11252 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11253 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11254 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11255 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11256 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11257 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11258 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11259 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11260 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11261 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11262 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11263 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11264 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11265 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11266 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11267 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11268 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11269 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11270 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11272 /* Did the locale setup indicate UTF-8? */
11273 PL_utf8locale = proto_perl->Iutf8locale;
11274 /* Unicode features (see perlrun/-C) */
11275 PL_unicode = proto_perl->Iunicode;
11277 /* Pre-5.8 signals control */
11278 PL_signals = proto_perl->Isignals;
11280 /* times() ticks per second */
11281 PL_clocktick = proto_perl->Iclocktick;
11283 /* Recursion stopper for PerlIO_find_layer */
11284 PL_in_load_module = proto_perl->Iin_load_module;
11286 /* sort() routine */
11287 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11289 /* Not really needed/useful since the reenrant_retint is "volatile",
11290 * but do it for consistency's sake. */
11291 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11293 /* Hooks to shared SVs and locks. */
11294 PL_sharehook = proto_perl->Isharehook;
11295 PL_lockhook = proto_perl->Ilockhook;
11296 PL_unlockhook = proto_perl->Iunlockhook;
11297 PL_threadhook = proto_perl->Ithreadhook;
11299 PL_runops_std = proto_perl->Irunops_std;
11300 PL_runops_dbg = proto_perl->Irunops_dbg;
11302 #ifdef THREADS_HAVE_PIDS
11303 PL_ppid = proto_perl->Ippid;
11307 PL_last_swash_hv = NULL; /* reinits on demand */
11308 PL_last_swash_klen = 0;
11309 PL_last_swash_key[0]= '\0';
11310 PL_last_swash_tmps = (U8*)NULL;
11311 PL_last_swash_slen = 0;
11313 PL_glob_index = proto_perl->Iglob_index;
11314 PL_srand_called = proto_perl->Isrand_called;
11315 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11316 PL_bitcount = NULL; /* reinits on demand */
11318 if (proto_perl->Ipsig_pend) {
11319 Newxz(PL_psig_pend, SIG_SIZE, int);
11322 PL_psig_pend = (int*)NULL;
11325 if (proto_perl->Ipsig_ptr) {
11326 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11327 Newxz(PL_psig_name, SIG_SIZE, SV*);
11328 for (i = 1; i < SIG_SIZE; i++) {
11329 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11330 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11334 PL_psig_ptr = (SV**)NULL;
11335 PL_psig_name = (SV**)NULL;
11338 /* thrdvar.h stuff */
11340 if (flags & CLONEf_COPY_STACKS) {
11341 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11342 PL_tmps_ix = proto_perl->Ttmps_ix;
11343 PL_tmps_max = proto_perl->Ttmps_max;
11344 PL_tmps_floor = proto_perl->Ttmps_floor;
11345 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11347 while (i <= PL_tmps_ix) {
11348 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11352 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11353 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11354 Newxz(PL_markstack, i, I32);
11355 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11356 - proto_perl->Tmarkstack);
11357 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11358 - proto_perl->Tmarkstack);
11359 Copy(proto_perl->Tmarkstack, PL_markstack,
11360 PL_markstack_ptr - PL_markstack + 1, I32);
11362 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11363 * NOTE: unlike the others! */
11364 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11365 PL_scopestack_max = proto_perl->Tscopestack_max;
11366 Newxz(PL_scopestack, PL_scopestack_max, I32);
11367 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11369 /* NOTE: si_dup() looks at PL_markstack */
11370 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11372 /* PL_curstack = PL_curstackinfo->si_stack; */
11373 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11374 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11376 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11377 PL_stack_base = AvARRAY(PL_curstack);
11378 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11379 - proto_perl->Tstack_base);
11380 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11382 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11383 * NOTE: unlike the others! */
11384 PL_savestack_ix = proto_perl->Tsavestack_ix;
11385 PL_savestack_max = proto_perl->Tsavestack_max;
11386 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11387 PL_savestack = ss_dup(proto_perl, param);
11391 ENTER; /* perl_destruct() wants to LEAVE; */
11393 /* although we're not duplicating the tmps stack, we should still
11394 * add entries for any SVs on the tmps stack that got cloned by a
11395 * non-refcount means (eg a temp in @_); otherwise they will be
11398 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11399 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11400 proto_perl->Ttmps_stack[i]);
11401 if (nsv && !SvREFCNT(nsv)) {
11403 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11408 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11409 PL_top_env = &PL_start_env;
11411 PL_op = proto_perl->Top;
11414 PL_Xpv = (XPV*)NULL;
11415 PL_na = proto_perl->Tna;
11417 PL_statbuf = proto_perl->Tstatbuf;
11418 PL_statcache = proto_perl->Tstatcache;
11419 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11420 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11422 PL_timesbuf = proto_perl->Ttimesbuf;
11425 PL_tainted = proto_perl->Ttainted;
11426 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11427 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11428 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11429 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11430 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11431 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11432 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11433 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11434 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11436 PL_restartop = proto_perl->Trestartop;
11437 PL_in_eval = proto_perl->Tin_eval;
11438 PL_delaymagic = proto_perl->Tdelaymagic;
11439 PL_dirty = proto_perl->Tdirty;
11440 PL_localizing = proto_perl->Tlocalizing;
11442 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11443 PL_hv_fetch_ent_mh = NULL;
11444 PL_modcount = proto_perl->Tmodcount;
11445 PL_lastgotoprobe = NULL;
11446 PL_dumpindent = proto_perl->Tdumpindent;
11448 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11449 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11450 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11451 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11452 PL_efloatbuf = NULL; /* reinits on demand */
11453 PL_efloatsize = 0; /* reinits on demand */
11457 PL_screamfirst = NULL;
11458 PL_screamnext = NULL;
11459 PL_maxscream = -1; /* reinits on demand */
11460 PL_lastscream = NULL;
11462 PL_watchaddr = NULL;
11465 PL_regdummy = proto_perl->Tregdummy;
11466 PL_colorset = 0; /* reinits PL_colors[] */
11467 /*PL_colors[6] = {0,0,0,0,0,0};*/
11471 /* Pluggable optimizer */
11472 PL_peepp = proto_perl->Tpeepp;
11474 PL_stashcache = newHV();
11476 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11477 ptr_table_free(PL_ptr_table);
11478 PL_ptr_table = NULL;
11481 /* Call the ->CLONE method, if it exists, for each of the stashes
11482 identified by sv_dup() above.
11484 while(av_len(param->stashes) != -1) {
11485 HV* const stash = (HV*) av_shift(param->stashes);
11486 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11487 if (cloner && GvCV(cloner)) {
11492 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11494 call_sv((SV*)GvCV(cloner), G_DISCARD);
11500 SvREFCNT_dec(param->stashes);
11502 /* orphaned? eg threads->new inside BEGIN or use */
11503 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11504 SvREFCNT_inc_simple_void(PL_compcv);
11505 SAVEFREESV(PL_compcv);
11511 #endif /* USE_ITHREADS */
11514 =head1 Unicode Support
11516 =for apidoc sv_recode_to_utf8
11518 The encoding is assumed to be an Encode object, on entry the PV
11519 of the sv is assumed to be octets in that encoding, and the sv
11520 will be converted into Unicode (and UTF-8).
11522 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11523 is not a reference, nothing is done to the sv. If the encoding is not
11524 an C<Encode::XS> Encoding object, bad things will happen.
11525 (See F<lib/encoding.pm> and L<Encode>).
11527 The PV of the sv is returned.
11532 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11535 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11549 Passing sv_yes is wrong - it needs to be or'ed set of constants
11550 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11551 remove converted chars from source.
11553 Both will default the value - let them.
11555 XPUSHs(&PL_sv_yes);
11558 call_method("decode", G_SCALAR);
11562 s = SvPV_const(uni, len);
11563 if (s != SvPVX_const(sv)) {
11564 SvGROW(sv, len + 1);
11565 Move(s, SvPVX(sv), len + 1, char);
11566 SvCUR_set(sv, len);
11573 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11577 =for apidoc sv_cat_decode
11579 The encoding is assumed to be an Encode object, the PV of the ssv is
11580 assumed to be octets in that encoding and decoding the input starts
11581 from the position which (PV + *offset) pointed to. The dsv will be
11582 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11583 when the string tstr appears in decoding output or the input ends on
11584 the PV of the ssv. The value which the offset points will be modified
11585 to the last input position on the ssv.
11587 Returns TRUE if the terminator was found, else returns FALSE.
11592 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11593 SV *ssv, int *offset, char *tstr, int tlen)
11597 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11608 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11609 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11611 call_method("cat_decode", G_SCALAR);
11613 ret = SvTRUE(TOPs);
11614 *offset = SvIV(offsv);
11620 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11625 /* ---------------------------------------------------------------------
11627 * support functions for report_uninit()
11630 /* the maxiumum size of array or hash where we will scan looking
11631 * for the undefined element that triggered the warning */
11633 #define FUV_MAX_SEARCH_SIZE 1000
11635 /* Look for an entry in the hash whose value has the same SV as val;
11636 * If so, return a mortal copy of the key. */
11639 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11642 register HE **array;
11645 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11646 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11649 array = HvARRAY(hv);
11651 for (i=HvMAX(hv); i>0; i--) {
11652 register HE *entry;
11653 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11654 if (HeVAL(entry) != val)
11656 if ( HeVAL(entry) == &PL_sv_undef ||
11657 HeVAL(entry) == &PL_sv_placeholder)
11661 if (HeKLEN(entry) == HEf_SVKEY)
11662 return sv_mortalcopy(HeKEY_sv(entry));
11663 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11669 /* Look for an entry in the array whose value has the same SV as val;
11670 * If so, return the index, otherwise return -1. */
11673 S_find_array_subscript(pTHX_ AV *av, SV* val)
11676 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11677 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11680 if (val != &PL_sv_undef) {
11681 SV ** const svp = AvARRAY(av);
11684 for (i=AvFILLp(av); i>=0; i--)
11691 /* S_varname(): return the name of a variable, optionally with a subscript.
11692 * If gv is non-zero, use the name of that global, along with gvtype (one
11693 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11694 * targ. Depending on the value of the subscript_type flag, return:
11697 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11698 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11699 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11700 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11703 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11704 SV* keyname, I32 aindex, int subscript_type)
11707 SV * const name = sv_newmortal();
11710 buffer[0] = gvtype;
11713 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11715 gv_fullname4(name, gv, buffer, 0);
11717 if ((unsigned int)SvPVX(name)[1] <= 26) {
11719 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11721 /* Swap the 1 unprintable control character for the 2 byte pretty
11722 version - ie substr($name, 1, 1) = $buffer; */
11723 sv_insert(name, 1, 1, buffer, 2);
11728 CV * const cv = find_runcv(&unused);
11732 if (!cv || !CvPADLIST(cv))
11734 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11735 sv = *av_fetch(av, targ, FALSE);
11736 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11739 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11740 SV * const sv = newSV(0);
11741 *SvPVX(name) = '$';
11742 Perl_sv_catpvf(aTHX_ name, "{%s}",
11743 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11746 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11747 *SvPVX(name) = '$';
11748 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11750 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11751 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11758 =for apidoc find_uninit_var
11760 Find the name of the undefined variable (if any) that caused the operator o
11761 to issue a "Use of uninitialized value" warning.
11762 If match is true, only return a name if it's value matches uninit_sv.
11763 So roughly speaking, if a unary operator (such as OP_COS) generates a
11764 warning, then following the direct child of the op may yield an
11765 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11766 other hand, with OP_ADD there are two branches to follow, so we only print
11767 the variable name if we get an exact match.
11769 The name is returned as a mortal SV.
11771 Assumes that PL_op is the op that originally triggered the error, and that
11772 PL_comppad/PL_curpad points to the currently executing pad.
11778 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11786 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11787 uninit_sv == &PL_sv_placeholder)))
11790 switch (obase->op_type) {
11797 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11798 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11801 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11803 if (pad) { /* @lex, %lex */
11804 sv = PAD_SVl(obase->op_targ);
11808 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11809 /* @global, %global */
11810 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11813 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11815 else /* @{expr}, %{expr} */
11816 return find_uninit_var(cUNOPx(obase)->op_first,
11820 /* attempt to find a match within the aggregate */
11822 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11824 subscript_type = FUV_SUBSCRIPT_HASH;
11827 index = find_array_subscript((AV*)sv, uninit_sv);
11829 subscript_type = FUV_SUBSCRIPT_ARRAY;
11832 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11835 return varname(gv, hash ? '%' : '@', obase->op_targ,
11836 keysv, index, subscript_type);
11840 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11842 return varname(NULL, '$', obase->op_targ,
11843 NULL, 0, FUV_SUBSCRIPT_NONE);
11846 gv = cGVOPx_gv(obase);
11847 if (!gv || (match && GvSV(gv) != uninit_sv))
11849 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11852 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11855 av = (AV*)PAD_SV(obase->op_targ);
11856 if (!av || SvRMAGICAL(av))
11858 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11859 if (!svp || *svp != uninit_sv)
11862 return varname(NULL, '$', obase->op_targ,
11863 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11866 gv = cGVOPx_gv(obase);
11872 if (!av || SvRMAGICAL(av))
11874 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11875 if (!svp || *svp != uninit_sv)
11878 return varname(gv, '$', 0,
11879 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11884 o = cUNOPx(obase)->op_first;
11885 if (!o || o->op_type != OP_NULL ||
11886 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11888 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11892 if (PL_op == obase)
11893 /* $a[uninit_expr] or $h{uninit_expr} */
11894 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11897 o = cBINOPx(obase)->op_first;
11898 kid = cBINOPx(obase)->op_last;
11900 /* get the av or hv, and optionally the gv */
11902 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11903 sv = PAD_SV(o->op_targ);
11905 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11906 && cUNOPo->op_first->op_type == OP_GV)
11908 gv = cGVOPx_gv(cUNOPo->op_first);
11911 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11916 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11917 /* index is constant */
11921 if (obase->op_type == OP_HELEM) {
11922 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11923 if (!he || HeVAL(he) != uninit_sv)
11927 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11928 if (!svp || *svp != uninit_sv)
11932 if (obase->op_type == OP_HELEM)
11933 return varname(gv, '%', o->op_targ,
11934 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11936 return varname(gv, '@', o->op_targ, NULL,
11937 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11940 /* index is an expression;
11941 * attempt to find a match within the aggregate */
11942 if (obase->op_type == OP_HELEM) {
11943 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11945 return varname(gv, '%', o->op_targ,
11946 keysv, 0, FUV_SUBSCRIPT_HASH);
11949 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11951 return varname(gv, '@', o->op_targ,
11952 NULL, index, FUV_SUBSCRIPT_ARRAY);
11957 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11959 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11964 /* only examine RHS */
11965 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11968 o = cUNOPx(obase)->op_first;
11969 if (o->op_type == OP_PUSHMARK)
11972 if (!o->op_sibling) {
11973 /* one-arg version of open is highly magical */
11975 if (o->op_type == OP_GV) { /* open FOO; */
11977 if (match && GvSV(gv) != uninit_sv)
11979 return varname(gv, '$', 0,
11980 NULL, 0, FUV_SUBSCRIPT_NONE);
11982 /* other possibilities not handled are:
11983 * open $x; or open my $x; should return '${*$x}'
11984 * open expr; should return '$'.expr ideally
11990 /* ops where $_ may be an implicit arg */
11994 if ( !(obase->op_flags & OPf_STACKED)) {
11995 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11996 ? PAD_SVl(obase->op_targ)
11999 sv = sv_newmortal();
12000 sv_setpvn(sv, "$_", 2);
12008 /* skip filehandle as it can't produce 'undef' warning */
12009 o = cUNOPx(obase)->op_first;
12010 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12011 o = o->op_sibling->op_sibling;
12018 match = 1; /* XS or custom code could trigger random warnings */
12023 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12024 return sv_2mortal(newSVpvs("${$/}"));
12029 if (!(obase->op_flags & OPf_KIDS))
12031 o = cUNOPx(obase)->op_first;
12037 /* if all except one arg are constant, or have no side-effects,
12038 * or are optimized away, then it's unambiguous */
12040 for (kid=o; kid; kid = kid->op_sibling) {
12042 const OPCODE type = kid->op_type;
12043 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12044 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12045 || (type == OP_PUSHMARK)
12049 if (o2) { /* more than one found */
12056 return find_uninit_var(o2, uninit_sv, match);
12058 /* scan all args */
12060 sv = find_uninit_var(o, uninit_sv, 1);
12072 =for apidoc report_uninit
12074 Print appropriate "Use of uninitialized variable" warning
12080 Perl_report_uninit(pTHX_ SV* uninit_sv)
12084 SV* varname = NULL;
12086 varname = find_uninit_var(PL_op, uninit_sv,0);
12088 sv_insert(varname, 0, 0, " ", 1);
12090 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12091 varname ? SvPV_nolen_const(varname) : "",
12092 " in ", OP_DESC(PL_op));
12095 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12101 * c-indentation-style: bsd
12102 * c-basic-offset: 4
12103 * indent-tabs-mode: t
12106 * ex: set ts=8 sts=4 sw=4 noet: