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 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's awlays checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types,
550 char *arena; /* the raw storage, allocated aligned */
551 size_t size; /* its size ~4k typ */
552 U32 misc; /* type, and in future other things. */
557 /* Get the maximum number of elements in set[] such that struct arena_set
558 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
559 therefore likely to be 1 aligned memory page. */
561 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
562 - 2 * sizeof(int)) / sizeof (struct arena_desc))
565 struct arena_set* next;
566 unsigned int set_size; /* ie ARENAS_PER_SET */
567 unsigned int curr; /* index of next available arena-desc */
568 struct arena_desc set[ARENAS_PER_SET];
572 =for apidoc sv_free_arenas
574 Deallocate the memory used by all arenas. Note that all the individual SV
575 heads and bodies within the arenas must already have been freed.
580 Perl_sv_free_arenas(pTHX)
587 /* Free arenas here, but be careful about fake ones. (We assume
588 contiguity of the fake ones with the corresponding real ones.) */
590 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
591 svanext = (SV*) SvANY(sva);
592 while (svanext && SvFAKE(svanext))
593 svanext = (SV*) SvANY(svanext);
600 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
603 struct arena_set *current = aroot;
606 assert(aroot->set[i].arena);
607 Safefree(aroot->set[i].arena);
615 i = PERL_ARENA_ROOTS_SIZE;
617 PL_body_roots[i] = 0;
619 Safefree(PL_nice_chunk);
620 PL_nice_chunk = NULL;
621 PL_nice_chunk_size = 0;
627 Here are mid-level routines that manage the allocation of bodies out
628 of the various arenas. There are 5 kinds of arenas:
630 1. SV-head arenas, which are discussed and handled above
631 2. regular body arenas
632 3. arenas for reduced-size bodies
634 5. pte arenas (thread related)
636 Arena types 2 & 3 are chained by body-type off an array of
637 arena-root pointers, which is indexed by svtype. Some of the
638 larger/less used body types are malloced singly, since a large
639 unused block of them is wasteful. Also, several svtypes dont have
640 bodies; the data fits into the sv-head itself. The arena-root
641 pointer thus has a few unused root-pointers (which may be hijacked
642 later for arena types 4,5)
644 3 differs from 2 as an optimization; some body types have several
645 unused fields in the front of the structure (which are kept in-place
646 for consistency). These bodies can be allocated in smaller chunks,
647 because the leading fields arent accessed. Pointers to such bodies
648 are decremented to point at the unused 'ghost' memory, knowing that
649 the pointers are used with offsets to the real memory.
651 HE, HEK arenas are managed separately, with separate code, but may
652 be merge-able later..
654 PTE arenas are not sv-bodies, but they share these mid-level
655 mechanics, so are considered here. The new mid-level mechanics rely
656 on the sv_type of the body being allocated, so we just reserve one
657 of the unused body-slots for PTEs, then use it in those (2) PTE
658 contexts below (line ~10k)
661 /* get_arena(size): this creates custom-sized arenas
662 TBD: export properly for hv.c: S_more_he().
665 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
668 struct arena_desc* adesc;
669 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
672 /* shouldnt need this
673 if (!arena_size) arena_size = PERL_ARENA_SIZE;
676 /* may need new arena-set to hold new arena */
677 if (!aroot || aroot->curr >= aroot->set_size) {
678 struct arena_set *newroot;
679 Newxz(newroot, 1, struct arena_set);
680 newroot->set_size = ARENAS_PER_SET;
681 newroot->next = aroot;
683 PL_body_arenas = (void *) newroot;
684 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
687 /* ok, now have arena-set with at least 1 empty/available arena-desc */
688 curr = aroot->curr++;
689 adesc = &(aroot->set[curr]);
690 assert(!adesc->arena);
692 Newx(adesc->arena, arena_size, char);
693 adesc->size = arena_size;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
696 curr, (void*)adesc->arena, (UV)arena_size));
702 /* return a thing to the free list */
704 #define del_body(thing, root) \
706 void ** const thing_copy = (void **)thing;\
707 *thing_copy = *root; \
708 *root = (void*)thing_copy; \
713 =head1 SV-Body Allocation
715 Allocation of SV-bodies is similar to SV-heads, differing as follows;
716 the allocation mechanism is used for many body types, so is somewhat
717 more complicated, it uses arena-sets, and has no need for still-live
720 At the outermost level, (new|del)_X*V macros return bodies of the
721 appropriate type. These macros call either (new|del)_body_type or
722 (new|del)_body_allocated macro pairs, depending on specifics of the
723 type. Most body types use the former pair, the latter pair is used to
724 allocate body types with "ghost fields".
726 "ghost fields" are fields that are unused in certain types, and
727 consequently dont need to actually exist. They are declared because
728 they're part of a "base type", which allows use of functions as
729 methods. The simplest examples are AVs and HVs, 2 aggregate types
730 which don't use the fields which support SCALAR semantics.
732 For these types, the arenas are carved up into *_allocated size
733 chunks, we thus avoid wasted memory for those unaccessed members.
734 When bodies are allocated, we adjust the pointer back in memory by the
735 size of the bit not allocated, so it's as if we allocated the full
736 structure. (But things will all go boom if you write to the part that
737 is "not there", because you'll be overwriting the last members of the
738 preceding structure in memory.)
740 We calculate the correction using the STRUCT_OFFSET macro. For
741 example, if xpv_allocated is the same structure as XPV then the two
742 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
743 structure is smaller (no initial NV actually allocated) then the net
744 effect is to subtract the size of the NV from the pointer, to return a
745 new pointer as if an initial NV were actually allocated.
747 This is the same trick as was used for NV and IV bodies. Ironically it
748 doesn't need to be used for NV bodies any more, because NV is now at
749 the start of the structure. IV bodies don't need it either, because
750 they are no longer allocated.
752 In turn, the new_body_* allocators call S_new_body(), which invokes
753 new_body_inline macro, which takes a lock, and takes a body off the
754 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
755 necessary to refresh an empty list. Then the lock is released, and
756 the body is returned.
758 S_more_bodies calls get_arena(), and carves it up into an array of N
759 bodies, which it strings into a linked list. It looks up arena-size
760 and body-size from the body_details table described below, thus
761 supporting the multiple body-types.
763 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
764 the (new|del)_X*V macros are mapped directly to malloc/free.
770 For each sv-type, struct body_details bodies_by_type[] carries
771 parameters which control these aspects of SV handling:
773 Arena_size determines whether arenas are used for this body type, and if
774 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
775 zero, forcing individual mallocs and frees.
777 Body_size determines how big a body is, and therefore how many fit into
778 each arena. Offset carries the body-pointer adjustment needed for
779 *_allocated body types, and is used in *_allocated macros.
781 But its main purpose is to parameterize info needed in
782 Perl_sv_upgrade(). The info here dramatically simplifies the function
783 vs the implementation in 5.8.7, making it table-driven. All fields
784 are used for this, except for arena_size.
786 For the sv-types that have no bodies, arenas are not used, so those
787 PL_body_roots[sv_type] are unused, and can be overloaded. In
788 something of a special case, SVt_NULL is borrowed for HE arenas;
789 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
790 bodies_by_type[SVt_NULL] slot is not used, as the table is not
793 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
794 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
795 just use the same allocation semantics. At first, PTEs were also
796 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
797 bugs, so was simplified by claiming a new slot. This choice has no
798 consequence at this time.
802 struct body_details {
803 U8 body_size; /* Size to allocate */
804 U8 copy; /* Size of structure to copy (may be shorter) */
806 unsigned int type : 4; /* We have space for a sanity check. */
807 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
808 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
809 unsigned int arena : 1; /* Allocated from an arena */
810 size_t arena_size; /* Size of arena to allocate */
818 /* With -DPURFIY we allocate everything directly, and don't use arenas.
819 This seems a rather elegant way to simplify some of the code below. */
820 #define HASARENA FALSE
822 #define HASARENA TRUE
824 #define NOARENA FALSE
826 /* Size the arenas to exactly fit a given number of bodies. A count
827 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
828 simplifying the default. If count > 0, the arena is sized to fit
829 only that many bodies, allowing arenas to be used for large, rare
830 bodies (XPVFM, XPVIO) without undue waste. The arena size is
831 limited by PERL_ARENA_SIZE, so we can safely oversize the
834 #define FIT_ARENA0(body_size) \
835 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
836 #define FIT_ARENAn(count,body_size) \
837 ( count * body_size <= PERL_ARENA_SIZE) \
838 ? count * body_size \
839 : FIT_ARENA0 (body_size)
840 #define FIT_ARENA(count,body_size) \
842 ? FIT_ARENAn (count, body_size) \
843 : FIT_ARENA0 (body_size)
845 /* A macro to work out the offset needed to subtract from a pointer to (say)
852 to make its members accessible via a pointer to (say)
862 #define relative_STRUCT_OFFSET(longer, shorter, member) \
863 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
865 /* Calculate the length to copy. Specifically work out the length less any
866 final padding the compiler needed to add. See the comment in sv_upgrade
867 for why copying the padding proved to be a bug. */
869 #define copy_length(type, last_member) \
870 STRUCT_OFFSET(type, last_member) \
871 + sizeof (((type*)SvANY((SV*)0))->last_member)
873 static const struct body_details bodies_by_type[] = {
874 { sizeof(HE), 0, 0, SVt_NULL,
875 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
877 /* The bind placeholder pretends to be an RV for now.
878 Also it's marked as "can't upgrade" to stop anyone using it before it's
880 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
882 /* IVs are in the head, so the allocation size is 0.
883 However, the slot is overloaded for PTEs. */
884 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
885 sizeof(IV), /* This is used to copy out the IV body. */
886 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
887 NOARENA /* IVS don't need an arena */,
888 /* But PTEs need to know the size of their arena */
889 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
892 /* 8 bytes on most ILP32 with IEEE doubles */
893 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
894 FIT_ARENA(0, sizeof(NV)) },
896 /* RVs are in the head now. */
897 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(xpv_allocated),
901 copy_length(XPV, xpv_len)
902 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
903 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
907 { sizeof(xpviv_allocated),
908 copy_length(XPVIV, xiv_u)
909 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
914 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
915 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
918 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
919 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
922 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
926 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
929 { sizeof(xpvav_allocated),
930 copy_length(XPVAV, xmg_stash)
931 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
932 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
935 { sizeof(xpvhv_allocated),
936 copy_length(XPVHV, xmg_stash)
937 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
938 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
942 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
943 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
944 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
946 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
947 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
948 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
950 /* XPVIO is 84 bytes, fits 48x */
951 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
952 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
955 #define new_body_type(sv_type) \
956 (void *)((char *)S_new_body(aTHX_ sv_type))
958 #define del_body_type(p, sv_type) \
959 del_body(p, &PL_body_roots[sv_type])
962 #define new_body_allocated(sv_type) \
963 (void *)((char *)S_new_body(aTHX_ sv_type) \
964 - bodies_by_type[sv_type].offset)
966 #define del_body_allocated(p, sv_type) \
967 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
970 #define my_safemalloc(s) (void*)safemalloc(s)
971 #define my_safecalloc(s) (void*)safecalloc(s, 1)
972 #define my_safefree(p) safefree((char*)p)
976 #define new_XNV() my_safemalloc(sizeof(XPVNV))
977 #define del_XNV(p) my_safefree(p)
979 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
980 #define del_XPVNV(p) my_safefree(p)
982 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
983 #define del_XPVAV(p) my_safefree(p)
985 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
986 #define del_XPVHV(p) my_safefree(p)
988 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
989 #define del_XPVMG(p) my_safefree(p)
991 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
992 #define del_XPVGV(p) my_safefree(p)
996 #define new_XNV() new_body_type(SVt_NV)
997 #define del_XNV(p) del_body_type(p, SVt_NV)
999 #define new_XPVNV() new_body_type(SVt_PVNV)
1000 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1002 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1003 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1005 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1006 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1008 #define new_XPVMG() new_body_type(SVt_PVMG)
1009 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1011 #define new_XPVGV() new_body_type(SVt_PVGV)
1012 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1016 /* no arena for you! */
1018 #define new_NOARENA(details) \
1019 my_safemalloc((details)->body_size + (details)->offset)
1020 #define new_NOARENAZ(details) \
1021 my_safecalloc((details)->body_size + (details)->offset)
1024 S_more_bodies (pTHX_ svtype sv_type)
1027 void ** const root = &PL_body_roots[sv_type];
1028 const struct body_details * const bdp = &bodies_by_type[sv_type];
1029 const size_t body_size = bdp->body_size;
1032 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1033 static bool done_sanity_check;
1035 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1036 * variables like done_sanity_check. */
1037 if (!done_sanity_check) {
1038 unsigned int i = SVt_LAST;
1040 done_sanity_check = TRUE;
1043 assert (bodies_by_type[i].type == i);
1047 assert(bdp->arena_size);
1049 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1051 end = start + bdp->arena_size - body_size;
1053 /* computed count doesnt reflect the 1st slot reservation */
1054 DEBUG_m(PerlIO_printf(Perl_debug_log,
1055 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1056 (void*)start, (void*)end,
1057 (int)bdp->arena_size, sv_type, (int)body_size,
1058 (int)bdp->arena_size / (int)body_size));
1060 *root = (void *)start;
1062 while (start < end) {
1063 char * const next = start + body_size;
1064 *(void**) start = (void *)next;
1067 *(void **)start = 0;
1072 /* grab a new thing from the free list, allocating more if necessary.
1073 The inline version is used for speed in hot routines, and the
1074 function using it serves the rest (unless PURIFY).
1076 #define new_body_inline(xpv, sv_type) \
1078 void ** const r3wt = &PL_body_roots[sv_type]; \
1079 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1080 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1081 *(r3wt) = *(void**)(xpv); \
1087 S_new_body(pTHX_ svtype sv_type)
1091 new_body_inline(xpv, sv_type);
1098 =for apidoc sv_upgrade
1100 Upgrade an SV to a more complex form. Generally adds a new body type to the
1101 SV, then copies across as much information as possible from the old body.
1102 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1108 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1113 const svtype old_type = SvTYPE(sv);
1114 const struct body_details *new_type_details;
1115 const struct body_details *const old_type_details
1116 = bodies_by_type + old_type;
1118 if (new_type != SVt_PV && SvIsCOW(sv)) {
1119 sv_force_normal_flags(sv, 0);
1122 if (old_type == new_type)
1125 if (old_type > new_type)
1126 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1127 (int)old_type, (int)new_type);
1130 old_body = SvANY(sv);
1132 /* Copying structures onto other structures that have been neatly zeroed
1133 has a subtle gotcha. Consider XPVMG
1135 +------+------+------+------+------+-------+-------+
1136 | NV | CUR | LEN | IV | MAGIC | STASH |
1137 +------+------+------+------+------+-------+-------+
1138 0 4 8 12 16 20 24 28
1140 where NVs are aligned to 8 bytes, so that sizeof that structure is
1141 actually 32 bytes long, with 4 bytes of padding at the end:
1143 +------+------+------+------+------+-------+-------+------+
1144 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1145 +------+------+------+------+------+-------+-------+------+
1146 0 4 8 12 16 20 24 28 32
1148 so what happens if you allocate memory for this structure:
1150 +------+------+------+------+------+-------+-------+------+------+...
1151 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1152 +------+------+------+------+------+-------+-------+------+------+...
1153 0 4 8 12 16 20 24 28 32 36
1155 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1156 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1157 started out as zero once, but it's quite possible that it isn't. So now,
1158 rather than a nicely zeroed GP, you have it pointing somewhere random.
1161 (In fact, GP ends up pointing at a previous GP structure, because the
1162 principle cause of the padding in XPVMG getting garbage is a copy of
1163 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1164 this happens to be moot because XPVGV has been re-ordered, with GP
1165 no longer after STASH)
1167 So we are careful and work out the size of used parts of all the
1174 if (new_type < SVt_PVIV) {
1175 new_type = (new_type == SVt_NV)
1176 ? SVt_PVNV : SVt_PVIV;
1180 if (new_type < SVt_PVNV) {
1181 new_type = SVt_PVNV;
1187 assert(new_type > SVt_PV);
1188 assert(SVt_IV < SVt_PV);
1189 assert(SVt_NV < SVt_PV);
1196 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1197 there's no way that it can be safely upgraded, because perl.c
1198 expects to Safefree(SvANY(PL_mess_sv)) */
1199 assert(sv != PL_mess_sv);
1200 /* This flag bit is used to mean other things in other scalar types.
1201 Given that it only has meaning inside the pad, it shouldn't be set
1202 on anything that can get upgraded. */
1203 assert(!SvPAD_TYPED(sv));
1206 if (old_type_details->cant_upgrade)
1207 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1208 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1210 new_type_details = bodies_by_type + new_type;
1212 SvFLAGS(sv) &= ~SVTYPEMASK;
1213 SvFLAGS(sv) |= new_type;
1215 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1216 the return statements above will have triggered. */
1217 assert (new_type != SVt_NULL);
1220 assert(old_type == SVt_NULL);
1221 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1225 assert(old_type == SVt_NULL);
1226 SvANY(sv) = new_XNV();
1230 assert(old_type == SVt_NULL);
1231 SvANY(sv) = &sv->sv_u.svu_rv;
1236 assert(new_type_details->body_size);
1239 assert(new_type_details->arena);
1240 assert(new_type_details->arena_size);
1241 /* This points to the start of the allocated area. */
1242 new_body_inline(new_body, new_type);
1243 Zero(new_body, new_type_details->body_size, char);
1244 new_body = ((char *)new_body) - new_type_details->offset;
1246 /* We always allocated the full length item with PURIFY. To do this
1247 we fake things so that arena is false for all 16 types.. */
1248 new_body = new_NOARENAZ(new_type_details);
1250 SvANY(sv) = new_body;
1251 if (new_type == SVt_PVAV) {
1257 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1258 The target created by newSVrv also is, and it can have magic.
1259 However, it never has SvPVX set.
1261 if (old_type >= SVt_RV) {
1262 assert(SvPVX_const(sv) == 0);
1265 if (old_type >= SVt_PVMG) {
1266 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1267 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1269 sv->sv_u.svu_array = NULL; /* or svu_hash */
1275 /* XXX Is this still needed? Was it ever needed? Surely as there is
1276 no route from NV to PVIV, NOK can never be true */
1277 assert(!SvNOKp(sv));
1288 assert(new_type_details->body_size);
1289 /* We always allocated the full length item with PURIFY. To do this
1290 we fake things so that arena is false for all 16 types.. */
1291 if(new_type_details->arena) {
1292 /* This points to the start of the allocated area. */
1293 new_body_inline(new_body, new_type);
1294 Zero(new_body, new_type_details->body_size, char);
1295 new_body = ((char *)new_body) - new_type_details->offset;
1297 new_body = new_NOARENAZ(new_type_details);
1299 SvANY(sv) = new_body;
1301 if (old_type_details->copy) {
1302 /* There is now the potential for an upgrade from something without
1303 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1304 int offset = old_type_details->offset;
1305 int length = old_type_details->copy;
1307 if (new_type_details->offset > old_type_details->offset) {
1308 const int difference
1309 = new_type_details->offset - old_type_details->offset;
1310 offset += difference;
1311 length -= difference;
1313 assert (length >= 0);
1315 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1319 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1320 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1321 * correct 0.0 for us. Otherwise, if the old body didn't have an
1322 * NV slot, but the new one does, then we need to initialise the
1323 * freshly created NV slot with whatever the correct bit pattern is
1325 if (old_type_details->zero_nv && !new_type_details->zero_nv
1326 && !isGV_with_GP(sv))
1330 if (new_type == SVt_PVIO)
1331 IoPAGE_LEN(sv) = 60;
1332 if (old_type < SVt_RV)
1336 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1337 (unsigned long)new_type);
1340 if (old_type_details->arena) {
1341 /* If there was an old body, then we need to free it.
1342 Note that there is an assumption that all bodies of types that
1343 can be upgraded came from arenas. Only the more complex non-
1344 upgradable types are allowed to be directly malloc()ed. */
1346 my_safefree(old_body);
1348 del_body((void*)((char*)old_body + old_type_details->offset),
1349 &PL_body_roots[old_type]);
1355 =for apidoc sv_backoff
1357 Remove any string offset. You should normally use the C<SvOOK_off> macro
1364 Perl_sv_backoff(pTHX_ register SV *sv)
1366 PERL_UNUSED_CONTEXT;
1368 assert(SvTYPE(sv) != SVt_PVHV);
1369 assert(SvTYPE(sv) != SVt_PVAV);
1371 const char * const s = SvPVX_const(sv);
1372 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1373 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1375 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1377 SvFLAGS(sv) &= ~SVf_OOK;
1384 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1385 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1386 Use the C<SvGROW> wrapper instead.
1392 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1396 if (PL_madskills && newlen >= 0x100000) {
1397 PerlIO_printf(Perl_debug_log,
1398 "Allocation too large: %"UVxf"\n", (UV)newlen);
1400 #ifdef HAS_64K_LIMIT
1401 if (newlen >= 0x10000) {
1402 PerlIO_printf(Perl_debug_log,
1403 "Allocation too large: %"UVxf"\n", (UV)newlen);
1406 #endif /* HAS_64K_LIMIT */
1409 if (SvTYPE(sv) < SVt_PV) {
1410 sv_upgrade(sv, SVt_PV);
1411 s = SvPVX_mutable(sv);
1413 else if (SvOOK(sv)) { /* pv is offset? */
1415 s = SvPVX_mutable(sv);
1416 if (newlen > SvLEN(sv))
1417 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1418 #ifdef HAS_64K_LIMIT
1419 if (newlen >= 0x10000)
1424 s = SvPVX_mutable(sv);
1426 if (newlen > SvLEN(sv)) { /* need more room? */
1427 newlen = PERL_STRLEN_ROUNDUP(newlen);
1428 if (SvLEN(sv) && s) {
1430 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1436 s = (char*)saferealloc(s, newlen);
1439 s = (char*)safemalloc(newlen);
1440 if (SvPVX_const(sv) && SvCUR(sv)) {
1441 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1445 SvLEN_set(sv, newlen);
1451 =for apidoc sv_setiv
1453 Copies an integer into the given SV, upgrading first if necessary.
1454 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1460 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1463 SV_CHECK_THINKFIRST_COW_DROP(sv);
1464 switch (SvTYPE(sv)) {
1466 sv_upgrade(sv, SVt_IV);
1469 sv_upgrade(sv, SVt_PVNV);
1473 sv_upgrade(sv, SVt_PVIV);
1482 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1486 (void)SvIOK_only(sv); /* validate number */
1492 =for apidoc sv_setiv_mg
1494 Like C<sv_setiv>, but also handles 'set' magic.
1500 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1507 =for apidoc sv_setuv
1509 Copies an unsigned integer into the given SV, upgrading first if necessary.
1510 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1516 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1518 /* With these two if statements:
1519 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1522 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1524 If you wish to remove them, please benchmark to see what the effect is
1526 if (u <= (UV)IV_MAX) {
1527 sv_setiv(sv, (IV)u);
1536 =for apidoc sv_setuv_mg
1538 Like C<sv_setuv>, but also handles 'set' magic.
1544 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1551 =for apidoc sv_setnv
1553 Copies a double into the given SV, upgrading first if necessary.
1554 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1560 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1563 SV_CHECK_THINKFIRST_COW_DROP(sv);
1564 switch (SvTYPE(sv)) {
1567 sv_upgrade(sv, SVt_NV);
1572 sv_upgrade(sv, SVt_PVNV);
1581 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1586 (void)SvNOK_only(sv); /* validate number */
1591 =for apidoc sv_setnv_mg
1593 Like C<sv_setnv>, but also handles 'set' magic.
1599 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1605 /* Print an "isn't numeric" warning, using a cleaned-up,
1606 * printable version of the offending string
1610 S_not_a_number(pTHX_ SV *sv)
1618 dsv = sv_2mortal(newSVpvs(""));
1619 pv = sv_uni_display(dsv, sv, 10, 0);
1622 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1623 /* each *s can expand to 4 chars + "...\0",
1624 i.e. need room for 8 chars */
1626 const char *s = SvPVX_const(sv);
1627 const char * const end = s + SvCUR(sv);
1628 for ( ; s < end && d < limit; s++ ) {
1630 if (ch & 128 && !isPRINT_LC(ch)) {
1639 else if (ch == '\r') {
1643 else if (ch == '\f') {
1647 else if (ch == '\\') {
1651 else if (ch == '\0') {
1655 else if (isPRINT_LC(ch))
1672 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1673 "Argument \"%s\" isn't numeric in %s", pv,
1676 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1677 "Argument \"%s\" isn't numeric", pv);
1681 =for apidoc looks_like_number
1683 Test if the content of an SV looks like a number (or is a number).
1684 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1685 non-numeric warning), even if your atof() doesn't grok them.
1691 Perl_looks_like_number(pTHX_ SV *sv)
1693 register const char *sbegin;
1697 sbegin = SvPVX_const(sv);
1700 else if (SvPOKp(sv))
1701 sbegin = SvPV_const(sv, len);
1703 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1704 return grok_number(sbegin, len, NULL);
1708 S_glob_2number(pTHX_ GV * const gv)
1710 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1711 SV *const buffer = sv_newmortal();
1713 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1716 gv_efullname3(buffer, gv, "*");
1717 SvFLAGS(gv) |= wasfake;
1719 /* We know that all GVs stringify to something that is not-a-number,
1720 so no need to test that. */
1721 if (ckWARN(WARN_NUMERIC))
1722 not_a_number(buffer);
1723 /* We just want something true to return, so that S_sv_2iuv_common
1724 can tail call us and return true. */
1729 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1731 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1732 SV *const buffer = sv_newmortal();
1734 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1737 gv_efullname3(buffer, gv, "*");
1738 SvFLAGS(gv) |= wasfake;
1740 assert(SvPOK(buffer));
1742 *len = SvCUR(buffer);
1744 return SvPVX(buffer);
1747 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1748 until proven guilty, assume that things are not that bad... */
1753 As 64 bit platforms often have an NV that doesn't preserve all bits of
1754 an IV (an assumption perl has been based on to date) it becomes necessary
1755 to remove the assumption that the NV always carries enough precision to
1756 recreate the IV whenever needed, and that the NV is the canonical form.
1757 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1758 precision as a side effect of conversion (which would lead to insanity
1759 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1760 1) to distinguish between IV/UV/NV slots that have cached a valid
1761 conversion where precision was lost and IV/UV/NV slots that have a
1762 valid conversion which has lost no precision
1763 2) to ensure that if a numeric conversion to one form is requested that
1764 would lose precision, the precise conversion (or differently
1765 imprecise conversion) is also performed and cached, to prevent
1766 requests for different numeric formats on the same SV causing
1767 lossy conversion chains. (lossless conversion chains are perfectly
1772 SvIOKp is true if the IV slot contains a valid value
1773 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1774 SvNOKp is true if the NV slot contains a valid value
1775 SvNOK is true only if the NV value is accurate
1778 while converting from PV to NV, check to see if converting that NV to an
1779 IV(or UV) would lose accuracy over a direct conversion from PV to
1780 IV(or UV). If it would, cache both conversions, return NV, but mark
1781 SV as IOK NOKp (ie not NOK).
1783 While converting from PV to IV, check to see if converting that IV to an
1784 NV would lose accuracy over a direct conversion from PV to NV. If it
1785 would, cache both conversions, flag similarly.
1787 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1788 correctly because if IV & NV were set NV *always* overruled.
1789 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1790 changes - now IV and NV together means that the two are interchangeable:
1791 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1793 The benefit of this is that operations such as pp_add know that if
1794 SvIOK is true for both left and right operands, then integer addition
1795 can be used instead of floating point (for cases where the result won't
1796 overflow). Before, floating point was always used, which could lead to
1797 loss of precision compared with integer addition.
1799 * making IV and NV equal status should make maths accurate on 64 bit
1801 * may speed up maths somewhat if pp_add and friends start to use
1802 integers when possible instead of fp. (Hopefully the overhead in
1803 looking for SvIOK and checking for overflow will not outweigh the
1804 fp to integer speedup)
1805 * will slow down integer operations (callers of SvIV) on "inaccurate"
1806 values, as the change from SvIOK to SvIOKp will cause a call into
1807 sv_2iv each time rather than a macro access direct to the IV slot
1808 * should speed up number->string conversion on integers as IV is
1809 favoured when IV and NV are equally accurate
1811 ####################################################################
1812 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1813 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1814 On the other hand, SvUOK is true iff UV.
1815 ####################################################################
1817 Your mileage will vary depending your CPU's relative fp to integer
1821 #ifndef NV_PRESERVES_UV
1822 # define IS_NUMBER_UNDERFLOW_IV 1
1823 # define IS_NUMBER_UNDERFLOW_UV 2
1824 # define IS_NUMBER_IV_AND_UV 2
1825 # define IS_NUMBER_OVERFLOW_IV 4
1826 # define IS_NUMBER_OVERFLOW_UV 5
1828 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1830 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1832 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1835 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1836 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));
1837 if (SvNVX(sv) < (NV)IV_MIN) {
1838 (void)SvIOKp_on(sv);
1840 SvIV_set(sv, IV_MIN);
1841 return IS_NUMBER_UNDERFLOW_IV;
1843 if (SvNVX(sv) > (NV)UV_MAX) {
1844 (void)SvIOKp_on(sv);
1847 SvUV_set(sv, UV_MAX);
1848 return IS_NUMBER_OVERFLOW_UV;
1850 (void)SvIOKp_on(sv);
1852 /* Can't use strtol etc to convert this string. (See truth table in
1854 if (SvNVX(sv) <= (UV)IV_MAX) {
1855 SvIV_set(sv, I_V(SvNVX(sv)));
1856 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1857 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1859 /* Integer is imprecise. NOK, IOKp */
1861 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1864 SvUV_set(sv, U_V(SvNVX(sv)));
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866 if (SvUVX(sv) == UV_MAX) {
1867 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1868 possibly be preserved by NV. Hence, it must be overflow.
1870 return IS_NUMBER_OVERFLOW_UV;
1872 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return IS_NUMBER_OVERFLOW_IV;
1878 #endif /* !NV_PRESERVES_UV*/
1881 S_sv_2iuv_common(pTHX_ SV *sv) {
1884 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1885 * without also getting a cached IV/UV from it at the same time
1886 * (ie PV->NV conversion should detect loss of accuracy and cache
1887 * IV or UV at same time to avoid this. */
1888 /* IV-over-UV optimisation - choose to cache IV if possible */
1890 if (SvTYPE(sv) == SVt_NV)
1891 sv_upgrade(sv, SVt_PVNV);
1893 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1894 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1895 certainly cast into the IV range at IV_MAX, whereas the correct
1896 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1898 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1899 if (Perl_isnan(SvNVX(sv))) {
1905 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1906 SvIV_set(sv, I_V(SvNVX(sv)));
1907 if (SvNVX(sv) == (NV) SvIVX(sv)
1908 #ifndef NV_PRESERVES_UV
1909 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1910 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1911 /* Don't flag it as "accurately an integer" if the number
1912 came from a (by definition imprecise) NV operation, and
1913 we're outside the range of NV integer precision */
1916 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1917 DEBUG_c(PerlIO_printf(Perl_debug_log,
1918 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1924 /* IV not precise. No need to convert from PV, as NV
1925 conversion would already have cached IV if it detected
1926 that PV->IV would be better than PV->NV->IV
1927 flags already correct - don't set public IOK. */
1928 DEBUG_c(PerlIO_printf(Perl_debug_log,
1929 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1934 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1935 but the cast (NV)IV_MIN rounds to a the value less (more
1936 negative) than IV_MIN which happens to be equal to SvNVX ??
1937 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1938 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1939 (NV)UVX == NVX are both true, but the values differ. :-(
1940 Hopefully for 2s complement IV_MIN is something like
1941 0x8000000000000000 which will be exact. NWC */
1944 SvUV_set(sv, U_V(SvNVX(sv)));
1946 (SvNVX(sv) == (NV) SvUVX(sv))
1947 #ifndef NV_PRESERVES_UV
1948 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1949 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1950 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1951 /* Don't flag it as "accurately an integer" if the number
1952 came from a (by definition imprecise) NV operation, and
1953 we're outside the range of NV integer precision */
1958 DEBUG_c(PerlIO_printf(Perl_debug_log,
1959 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1965 else if (SvPOKp(sv) && SvLEN(sv)) {
1967 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1968 /* We want to avoid a possible problem when we cache an IV/ a UV which
1969 may be later translated to an NV, and the resulting NV is not
1970 the same as the direct translation of the initial string
1971 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1972 be careful to ensure that the value with the .456 is around if the
1973 NV value is requested in the future).
1975 This means that if we cache such an IV/a UV, we need to cache the
1976 NV as well. Moreover, we trade speed for space, and do not
1977 cache the NV if we are sure it's not needed.
1980 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1981 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1982 == IS_NUMBER_IN_UV) {
1983 /* It's definitely an integer, only upgrade to PVIV */
1984 if (SvTYPE(sv) < SVt_PVIV)
1985 sv_upgrade(sv, SVt_PVIV);
1987 } else if (SvTYPE(sv) < SVt_PVNV)
1988 sv_upgrade(sv, SVt_PVNV);
1990 /* If NVs preserve UVs then we only use the UV value if we know that
1991 we aren't going to call atof() below. If NVs don't preserve UVs
1992 then the value returned may have more precision than atof() will
1993 return, even though value isn't perfectly accurate. */
1994 if ((numtype & (IS_NUMBER_IN_UV
1995 #ifdef NV_PRESERVES_UV
1998 )) == IS_NUMBER_IN_UV) {
1999 /* This won't turn off the public IOK flag if it was set above */
2000 (void)SvIOKp_on(sv);
2002 if (!(numtype & IS_NUMBER_NEG)) {
2004 if (value <= (UV)IV_MAX) {
2005 SvIV_set(sv, (IV)value);
2007 /* it didn't overflow, and it was positive. */
2008 SvUV_set(sv, value);
2012 /* 2s complement assumption */
2013 if (value <= (UV)IV_MIN) {
2014 SvIV_set(sv, -(IV)value);
2016 /* Too negative for an IV. This is a double upgrade, but
2017 I'm assuming it will be rare. */
2018 if (SvTYPE(sv) < SVt_PVNV)
2019 sv_upgrade(sv, SVt_PVNV);
2023 SvNV_set(sv, -(NV)value);
2024 SvIV_set(sv, IV_MIN);
2028 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2029 will be in the previous block to set the IV slot, and the next
2030 block to set the NV slot. So no else here. */
2032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2033 != IS_NUMBER_IN_UV) {
2034 /* It wasn't an (integer that doesn't overflow the UV). */
2035 SvNV_set(sv, Atof(SvPVX_const(sv)));
2037 if (! numtype && ckWARN(WARN_NUMERIC))
2040 #if defined(USE_LONG_DOUBLE)
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2045 PTR2UV(sv), SvNVX(sv)));
2048 #ifdef NV_PRESERVES_UV
2049 (void)SvIOKp_on(sv);
2051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2052 SvIV_set(sv, I_V(SvNVX(sv)));
2053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 NOOP; /* Integer is imprecise. NOK, IOKp */
2058 /* UV will not work better than IV */
2060 if (SvNVX(sv) > (NV)UV_MAX) {
2062 /* Integer is inaccurate. NOK, IOKp, is UV */
2063 SvUV_set(sv, UV_MAX);
2065 SvUV_set(sv, U_V(SvNVX(sv)));
2066 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2067 NV preservse UV so can do correct comparison. */
2068 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2071 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2076 #else /* NV_PRESERVES_UV */
2077 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2078 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2079 /* The IV/UV slot will have been set from value returned by
2080 grok_number above. The NV slot has just been set using
2083 assert (SvIOKp(sv));
2085 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2086 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2087 /* Small enough to preserve all bits. */
2088 (void)SvIOKp_on(sv);
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2093 /* Assumption: first non-preserved integer is < IV_MAX,
2094 this NV is in the preserved range, therefore: */
2095 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2097 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);
2101 0 0 already failed to read UV.
2102 0 1 already failed to read UV.
2103 1 0 you won't get here in this case. IV/UV
2104 slot set, public IOK, Atof() unneeded.
2105 1 1 already read UV.
2106 so there's no point in sv_2iuv_non_preserve() attempting
2107 to use atol, strtol, strtoul etc. */
2108 sv_2iuv_non_preserve (sv, numtype);
2111 #endif /* NV_PRESERVES_UV */
2115 if (isGV_with_GP(sv))
2116 return glob_2number((GV *)sv);
2118 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2119 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2122 if (SvTYPE(sv) < SVt_IV)
2123 /* Typically the caller expects that sv_any is not NULL now. */
2124 sv_upgrade(sv, SVt_IV);
2125 /* Return 0 from the caller. */
2132 =for apidoc sv_2iv_flags
2134 Return the integer value of an SV, doing any necessary string
2135 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2136 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2142 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2147 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2148 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2149 cache IVs just in case. In practice it seems that they never
2150 actually anywhere accessible by user Perl code, let alone get used
2151 in anything other than a string context. */
2152 if (flags & SV_GMAGIC)
2157 return I_V(SvNVX(sv));
2159 if (SvPOKp(sv) && SvLEN(sv)) {
2162 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2164 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2165 == IS_NUMBER_IN_UV) {
2166 /* It's definitely an integer */
2167 if (numtype & IS_NUMBER_NEG) {
2168 if (value < (UV)IV_MIN)
2171 if (value < (UV)IV_MAX)
2176 if (ckWARN(WARN_NUMERIC))
2179 return I_V(Atof(SvPVX_const(sv)));
2184 assert(SvTYPE(sv) >= SVt_PVMG);
2185 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2186 } else if (SvTHINKFIRST(sv)) {
2190 SV * const tmpstr=AMG_CALLun(sv,numer);
2191 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2192 return SvIV(tmpstr);
2195 return PTR2IV(SvRV(sv));
2198 sv_force_normal_flags(sv, 0);
2200 if (SvREADONLY(sv) && !SvOK(sv)) {
2201 if (ckWARN(WARN_UNINITIALIZED))
2207 if (S_sv_2iuv_common(aTHX_ sv))
2210 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2211 PTR2UV(sv),SvIVX(sv)));
2212 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2216 =for apidoc sv_2uv_flags
2218 Return the unsigned integer value of an SV, doing any necessary string
2219 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2220 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2226 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2231 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2232 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2233 cache IVs just in case. */
2234 if (flags & SV_GMAGIC)
2239 return U_V(SvNVX(sv));
2240 if (SvPOKp(sv) && SvLEN(sv)) {
2243 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2245 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2246 == IS_NUMBER_IN_UV) {
2247 /* It's definitely an integer */
2248 if (!(numtype & IS_NUMBER_NEG))
2252 if (ckWARN(WARN_NUMERIC))
2255 return U_V(Atof(SvPVX_const(sv)));
2260 assert(SvTYPE(sv) >= SVt_PVMG);
2261 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2262 } else if (SvTHINKFIRST(sv)) {
2266 SV *const tmpstr = AMG_CALLun(sv,numer);
2267 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2268 return SvUV(tmpstr);
2271 return PTR2UV(SvRV(sv));
2274 sv_force_normal_flags(sv, 0);
2276 if (SvREADONLY(sv) && !SvOK(sv)) {
2277 if (ckWARN(WARN_UNINITIALIZED))
2283 if (S_sv_2iuv_common(aTHX_ sv))
2287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2288 PTR2UV(sv),SvUVX(sv)));
2289 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2295 Return the num value of an SV, doing any necessary string or integer
2296 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2303 Perl_sv_2nv(pTHX_ register SV *sv)
2308 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2309 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2310 cache IVs just in case. */
2314 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2315 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2316 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2318 return Atof(SvPVX_const(sv));
2322 return (NV)SvUVX(sv);
2324 return (NV)SvIVX(sv);
2329 assert(SvTYPE(sv) >= SVt_PVMG);
2330 /* This falls through to the report_uninit near the end of the
2332 } else if (SvTHINKFIRST(sv)) {
2336 SV *const tmpstr = AMG_CALLun(sv,numer);
2337 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2338 return SvNV(tmpstr);
2341 return PTR2NV(SvRV(sv));
2344 sv_force_normal_flags(sv, 0);
2346 if (SvREADONLY(sv) && !SvOK(sv)) {
2347 if (ckWARN(WARN_UNINITIALIZED))
2352 if (SvTYPE(sv) < SVt_NV) {
2353 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2354 sv_upgrade(sv, SVt_NV);
2355 #ifdef USE_LONG_DOUBLE
2357 STORE_NUMERIC_LOCAL_SET_STANDARD();
2358 PerlIO_printf(Perl_debug_log,
2359 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2360 PTR2UV(sv), SvNVX(sv));
2361 RESTORE_NUMERIC_LOCAL();
2365 STORE_NUMERIC_LOCAL_SET_STANDARD();
2366 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2367 PTR2UV(sv), SvNVX(sv));
2368 RESTORE_NUMERIC_LOCAL();
2372 else if (SvTYPE(sv) < SVt_PVNV)
2373 sv_upgrade(sv, SVt_PVNV);
2378 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2379 #ifdef NV_PRESERVES_UV
2382 /* Only set the public NV OK flag if this NV preserves the IV */
2383 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2384 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2385 : (SvIVX(sv) == I_V(SvNVX(sv))))
2391 else if (SvPOKp(sv) && SvLEN(sv)) {
2393 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2394 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2396 #ifdef NV_PRESERVES_UV
2397 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2398 == IS_NUMBER_IN_UV) {
2399 /* It's definitely an integer */
2400 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2402 SvNV_set(sv, Atof(SvPVX_const(sv)));
2405 SvNV_set(sv, Atof(SvPVX_const(sv)));
2406 /* Only set the public NV OK flag if this NV preserves the value in
2407 the PV at least as well as an IV/UV would.
2408 Not sure how to do this 100% reliably. */
2409 /* if that shift count is out of range then Configure's test is
2410 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2412 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2413 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2414 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2415 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2416 /* Can't use strtol etc to convert this string, so don't try.
2417 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2420 /* value has been set. It may not be precise. */
2421 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2422 /* 2s complement assumption for (UV)IV_MIN */
2423 SvNOK_on(sv); /* Integer is too negative. */
2428 if (numtype & IS_NUMBER_NEG) {
2429 SvIV_set(sv, -(IV)value);
2430 } else if (value <= (UV)IV_MAX) {
2431 SvIV_set(sv, (IV)value);
2433 SvUV_set(sv, value);
2437 if (numtype & IS_NUMBER_NOT_INT) {
2438 /* I believe that even if the original PV had decimals,
2439 they are lost beyond the limit of the FP precision.
2440 However, neither is canonical, so both only get p
2441 flags. NWC, 2000/11/25 */
2442 /* Both already have p flags, so do nothing */
2444 const NV nv = SvNVX(sv);
2445 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2446 if (SvIVX(sv) == I_V(nv)) {
2449 /* It had no "." so it must be integer. */
2453 /* between IV_MAX and NV(UV_MAX).
2454 Could be slightly > UV_MAX */
2456 if (numtype & IS_NUMBER_NOT_INT) {
2457 /* UV and NV both imprecise. */
2459 const UV nv_as_uv = U_V(nv);
2461 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2470 #endif /* NV_PRESERVES_UV */
2473 if (isGV_with_GP(sv)) {
2474 glob_2number((GV *)sv);
2478 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2480 assert (SvTYPE(sv) >= SVt_NV);
2481 /* Typically the caller expects that sv_any is not NULL now. */
2482 /* XXX Ilya implies that this is a bug in callers that assume this
2483 and ideally should be fixed. */
2486 #if defined(USE_LONG_DOUBLE)
2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
2489 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2490 PTR2UV(sv), SvNVX(sv));
2491 RESTORE_NUMERIC_LOCAL();
2495 STORE_NUMERIC_LOCAL_SET_STANDARD();
2496 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2497 PTR2UV(sv), SvNVX(sv));
2498 RESTORE_NUMERIC_LOCAL();
2504 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2505 * UV as a string towards the end of buf, and return pointers to start and
2508 * We assume that buf is at least TYPE_CHARS(UV) long.
2512 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2514 char *ptr = buf + TYPE_CHARS(UV);
2515 char * const ebuf = ptr;
2528 *--ptr = '0' + (char)(uv % 10);
2537 =for apidoc sv_2pv_flags
2539 Returns a pointer to the string value of an SV, and sets *lp to its length.
2540 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2542 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2543 usually end up here too.
2549 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2559 if (SvGMAGICAL(sv)) {
2560 if (flags & SV_GMAGIC)
2565 if (flags & SV_MUTABLE_RETURN)
2566 return SvPVX_mutable(sv);
2567 if (flags & SV_CONST_RETURN)
2568 return (char *)SvPVX_const(sv);
2571 if (SvIOKp(sv) || SvNOKp(sv)) {
2572 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2577 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2578 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2580 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2587 #ifdef FIXNEGATIVEZERO
2588 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2594 SvUPGRADE(sv, SVt_PV);
2597 s = SvGROW_mutable(sv, len + 1);
2600 return (char*)memcpy(s, tbuf, len + 1);
2606 assert(SvTYPE(sv) >= SVt_PVMG);
2607 /* This falls through to the report_uninit near the end of the
2609 } else if (SvTHINKFIRST(sv)) {
2613 SV *const tmpstr = AMG_CALLun(sv,string);
2614 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2616 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2620 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2621 if (flags & SV_CONST_RETURN) {
2622 pv = (char *) SvPVX_const(tmpstr);
2624 pv = (flags & SV_MUTABLE_RETURN)
2625 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2628 *lp = SvCUR(tmpstr);
2630 pv = sv_2pv_flags(tmpstr, lp, flags);
2644 const SV *const referent = (SV*)SvRV(sv);
2648 retval = buffer = savepvn("NULLREF", len);
2649 } else if (SvTYPE(referent) == SVt_PVMG
2650 && ((SvFLAGS(referent) &
2651 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2652 == (SVs_OBJECT|SVs_SMG))
2653 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2658 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2663 PL_reginterp_cnt += haseval;
2666 const char *const typestr = sv_reftype(referent, 0);
2667 const STRLEN typelen = strlen(typestr);
2668 UV addr = PTR2UV(referent);
2669 const char *stashname = NULL;
2670 STRLEN stashnamelen = 0; /* hush, gcc */
2671 const char *buffer_end;
2673 if (SvOBJECT(referent)) {
2674 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2677 stashname = HEK_KEY(name);
2678 stashnamelen = HEK_LEN(name);
2680 if (HEK_UTF8(name)) {
2686 stashname = "__ANON__";
2689 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2690 + 2 * sizeof(UV) + 2 /* )\0 */;
2692 len = typelen + 3 /* (0x */
2693 + 2 * sizeof(UV) + 2 /* )\0 */;
2696 Newx(buffer, len, char);
2697 buffer_end = retval = buffer + len;
2699 /* Working backwards */
2703 *--retval = PL_hexdigit[addr & 15];
2704 } while (addr >>= 4);
2710 memcpy(retval, typestr, typelen);
2714 retval -= stashnamelen;
2715 memcpy(retval, stashname, stashnamelen);
2717 /* retval may not neccesarily have reached the start of the
2719 assert (retval >= buffer);
2721 len = buffer_end - retval - 1; /* -1 for that \0 */
2729 if (SvREADONLY(sv) && !SvOK(sv)) {
2730 if (ckWARN(WARN_UNINITIALIZED))
2737 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2738 /* I'm assuming that if both IV and NV are equally valid then
2739 converting the IV is going to be more efficient */
2740 const U32 isUIOK = SvIsUV(sv);
2741 char buf[TYPE_CHARS(UV)];
2745 if (SvTYPE(sv) < SVt_PVIV)
2746 sv_upgrade(sv, SVt_PVIV);
2747 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2749 /* inlined from sv_setpvn */
2750 s = SvGROW_mutable(sv, len + 1);
2751 Move(ptr, s, len, char);
2755 else if (SvNOKp(sv)) {
2756 const int olderrno = errno;
2757 if (SvTYPE(sv) < SVt_PVNV)
2758 sv_upgrade(sv, SVt_PVNV);
2759 /* The +20 is pure guesswork. Configure test needed. --jhi */
2760 s = SvGROW_mutable(sv, NV_DIG + 20);
2761 /* some Xenix systems wipe out errno here */
2763 if (SvNVX(sv) == 0.0)
2764 my_strlcpy(s, "0", SvLEN(sv));
2768 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2771 #ifdef FIXNEGATIVEZERO
2772 if (*s == '-' && s[1] == '0' && !s[2])
2773 my_strlcpy(s, "0", SvLEN(s));
2782 if (isGV_with_GP(sv))
2783 return glob_2pv((GV *)sv, lp);
2785 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2789 if (SvTYPE(sv) < SVt_PV)
2790 /* Typically the caller expects that sv_any is not NULL now. */
2791 sv_upgrade(sv, SVt_PV);
2795 const STRLEN len = s - SvPVX_const(sv);
2801 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2802 PTR2UV(sv),SvPVX_const(sv)));
2803 if (flags & SV_CONST_RETURN)
2804 return (char *)SvPVX_const(sv);
2805 if (flags & SV_MUTABLE_RETURN)
2806 return SvPVX_mutable(sv);
2811 =for apidoc sv_copypv
2813 Copies a stringified representation of the source SV into the
2814 destination SV. Automatically performs any necessary mg_get and
2815 coercion of numeric values into strings. Guaranteed to preserve
2816 UTF8 flag even from overloaded objects. Similar in nature to
2817 sv_2pv[_flags] but operates directly on an SV instead of just the
2818 string. Mostly uses sv_2pv_flags to do its work, except when that
2819 would lose the UTF-8'ness of the PV.
2825 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2828 const char * const s = SvPV_const(ssv,len);
2829 sv_setpvn(dsv,s,len);
2837 =for apidoc sv_2pvbyte
2839 Return a pointer to the byte-encoded representation of the SV, and set *lp
2840 to its length. May cause the SV to be downgraded from UTF-8 as a
2843 Usually accessed via the C<SvPVbyte> macro.
2849 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2851 sv_utf8_downgrade(sv,0);
2852 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2856 =for apidoc sv_2pvutf8
2858 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2861 Usually accessed via the C<SvPVutf8> macro.
2867 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2869 sv_utf8_upgrade(sv);
2870 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2bool
2877 This function is only called on magical items, and is only used by
2878 sv_true() or its macro equivalent.
2884 Perl_sv_2bool(pTHX_ register SV *sv)
2893 SV * const tmpsv = AMG_CALLun(sv,bool_);
2894 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2895 return (bool)SvTRUE(tmpsv);
2897 return SvRV(sv) != 0;
2900 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2902 (*sv->sv_u.svu_pv > '0' ||
2903 Xpvtmp->xpv_cur > 1 ||
2904 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2911 return SvIVX(sv) != 0;
2914 return SvNVX(sv) != 0.0;
2916 if (isGV_with_GP(sv))
2926 =for apidoc sv_utf8_upgrade
2928 Converts the PV of an SV to its UTF-8-encoded form.
2929 Forces the SV to string form if it is not already.
2930 Always sets the SvUTF8 flag to avoid future validity checks even
2931 if all the bytes have hibit clear.
2933 This is not as a general purpose byte encoding to Unicode interface:
2934 use the Encode extension for that.
2936 =for apidoc sv_utf8_upgrade_flags
2938 Converts the PV of an SV to its UTF-8-encoded form.
2939 Forces the SV to string form if it is not already.
2940 Always sets the SvUTF8 flag to avoid future validity checks even
2941 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2942 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2943 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2945 This is not as a general purpose byte encoding to Unicode interface:
2946 use the Encode extension for that.
2952 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2955 if (sv == &PL_sv_undef)
2959 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2960 (void) sv_2pv_flags(sv,&len, flags);
2964 (void) SvPV_force(sv,len);
2973 sv_force_normal_flags(sv, 0);
2976 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2977 sv_recode_to_utf8(sv, PL_encoding);
2978 else { /* Assume Latin-1/EBCDIC */
2979 /* This function could be much more efficient if we
2980 * had a FLAG in SVs to signal if there are any hibit
2981 * chars in the PV. Given that there isn't such a flag
2982 * make the loop as fast as possible. */
2983 const U8 * const s = (U8 *) SvPVX_const(sv);
2984 const U8 * const e = (U8 *) SvEND(sv);
2989 /* Check for hi bit */
2990 if (!NATIVE_IS_INVARIANT(ch)) {
2991 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2992 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2994 SvPV_free(sv); /* No longer using what was there before. */
2995 SvPV_set(sv, (char*)recoded);
2996 SvCUR_set(sv, len - 1);
2997 SvLEN_set(sv, len); /* No longer know the real size. */
3001 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3008 =for apidoc sv_utf8_downgrade
3010 Attempts to convert the PV of an SV from characters to bytes.
3011 If the PV contains a character beyond byte, this conversion will fail;
3012 in this case, either returns false or, if C<fail_ok> is not
3015 This is not as a general purpose Unicode to byte encoding interface:
3016 use the Encode extension for that.
3022 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3025 if (SvPOKp(sv) && SvUTF8(sv)) {
3031 sv_force_normal_flags(sv, 0);
3033 s = (U8 *) SvPV(sv, len);
3034 if (!utf8_to_bytes(s, &len)) {
3039 Perl_croak(aTHX_ "Wide character in %s",
3042 Perl_croak(aTHX_ "Wide character");
3053 =for apidoc sv_utf8_encode
3055 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3056 flag off so that it looks like octets again.
3062 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3065 sv_force_normal_flags(sv, 0);
3067 if (SvREADONLY(sv)) {
3068 Perl_croak(aTHX_ PL_no_modify);
3070 (void) sv_utf8_upgrade(sv);
3075 =for apidoc sv_utf8_decode
3077 If the PV of the SV is an octet sequence in UTF-8
3078 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3079 so that it looks like a character. If the PV contains only single-byte
3080 characters, the C<SvUTF8> flag stays being off.
3081 Scans PV for validity and returns false if the PV is invalid UTF-8.
3087 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3093 /* The octets may have got themselves encoded - get them back as
3096 if (!sv_utf8_downgrade(sv, TRUE))
3099 /* it is actually just a matter of turning the utf8 flag on, but
3100 * we want to make sure everything inside is valid utf8 first.
3102 c = (const U8 *) SvPVX_const(sv);
3103 if (!is_utf8_string(c, SvCUR(sv)+1))
3105 e = (const U8 *) SvEND(sv);
3108 if (!UTF8_IS_INVARIANT(ch)) {
3118 =for apidoc sv_setsv
3120 Copies the contents of the source SV C<ssv> into the destination SV
3121 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3122 function if the source SV needs to be reused. Does not handle 'set' magic.
3123 Loosely speaking, it performs a copy-by-value, obliterating any previous
3124 content of the destination.
3126 You probably want to use one of the assortment of wrappers, such as
3127 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3128 C<SvSetMagicSV_nosteal>.
3130 =for apidoc sv_setsv_flags
3132 Copies the contents of the source SV C<ssv> into the destination SV
3133 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3134 function if the source SV needs to be reused. Does not handle 'set' magic.
3135 Loosely speaking, it performs a copy-by-value, obliterating any previous
3136 content of the destination.
3137 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3138 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3139 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3140 and C<sv_setsv_nomg> are implemented in terms of this function.
3142 You probably want to use one of the assortment of wrappers, such as
3143 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3144 C<SvSetMagicSV_nosteal>.
3146 This is the primary function for copying scalars, and most other
3147 copy-ish functions and macros use this underneath.
3153 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3155 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3157 if (dtype != SVt_PVGV) {
3158 const char * const name = GvNAME(sstr);
3159 const STRLEN len = GvNAMELEN(sstr);
3161 if (dtype >= SVt_PV) {
3167 SvUPGRADE(dstr, SVt_PVGV);
3168 (void)SvOK_off(dstr);
3169 /* FIXME - why are we doing this, then turning it off and on again
3171 isGV_with_GP_on(dstr);
3173 GvSTASH(dstr) = GvSTASH(sstr);
3175 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3176 gv_name_set((GV *)dstr, name, len, GV_ADD);
3177 SvFAKE_on(dstr); /* can coerce to non-glob */
3180 #ifdef GV_UNIQUE_CHECK
3181 if (GvUNIQUE((GV*)dstr)) {
3182 Perl_croak(aTHX_ PL_no_modify);
3186 if(GvGP((GV*)sstr)) {
3187 /* If source has method cache entry, clear it */
3189 SvREFCNT_dec(GvCV(sstr));
3193 /* If source has a real method, then a method is
3195 else if(GvCV((GV*)sstr)) {
3200 /* If dest already had a real method, that's a change as well */
3201 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3205 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3209 isGV_with_GP_off(dstr);
3210 (void)SvOK_off(dstr);
3211 isGV_with_GP_on(dstr);
3212 GvINTRO_off(dstr); /* one-shot flag */
3213 GvGP(dstr) = gp_ref(GvGP(sstr));
3214 if (SvTAINTED(sstr))
3216 if (GvIMPORTED(dstr) != GVf_IMPORTED
3217 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3219 GvIMPORTED_on(dstr);
3222 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3223 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3228 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3229 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3231 const int intro = GvINTRO(dstr);
3234 const U32 stype = SvTYPE(sref);
3237 #ifdef GV_UNIQUE_CHECK
3238 if (GvUNIQUE((GV*)dstr)) {
3239 Perl_croak(aTHX_ PL_no_modify);
3244 GvINTRO_off(dstr); /* one-shot flag */
3245 GvLINE(dstr) = CopLINE(PL_curcop);
3246 GvEGV(dstr) = (GV*)dstr;
3251 location = (SV **) &GvCV(dstr);
3252 import_flag = GVf_IMPORTED_CV;
3255 location = (SV **) &GvHV(dstr);
3256 import_flag = GVf_IMPORTED_HV;
3259 location = (SV **) &GvAV(dstr);
3260 import_flag = GVf_IMPORTED_AV;
3263 location = (SV **) &GvIOp(dstr);
3266 location = (SV **) &GvFORM(dstr);
3268 location = &GvSV(dstr);
3269 import_flag = GVf_IMPORTED_SV;
3272 if (stype == SVt_PVCV) {
3273 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3274 if (GvCVGEN(dstr)) {
3275 SvREFCNT_dec(GvCV(dstr));
3277 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280 SAVEGENERICSV(*location);
3284 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3285 CV* const cv = (CV*)*location;
3287 if (!GvCVGEN((GV*)dstr) &&
3288 (CvROOT(cv) || CvXSUB(cv)))
3290 /* Redefining a sub - warning is mandatory if
3291 it was a const and its value changed. */
3292 if (CvCONST(cv) && CvCONST((CV*)sref)
3293 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3295 /* They are 2 constant subroutines generated from
3296 the same constant. This probably means that
3297 they are really the "same" proxy subroutine
3298 instantiated in 2 places. Most likely this is
3299 when a constant is exported twice. Don't warn.
3302 else if (ckWARN(WARN_REDEFINE)
3304 && (!CvCONST((CV*)sref)
3305 || sv_cmp(cv_const_sv(cv),
3306 cv_const_sv((CV*)sref))))) {
3307 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3310 ? "Constant subroutine %s::%s redefined"
3311 : "Subroutine %s::%s redefined"),
3312 HvNAME_get(GvSTASH((GV*)dstr)),
3313 GvENAME((GV*)dstr));
3317 cv_ckproto_len(cv, (GV*)dstr,
3318 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3319 SvPOK(sref) ? SvCUR(sref) : 0);
3321 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3322 GvASSUMECV_on(dstr);
3323 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3326 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3327 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3328 GvFLAGS(dstr) |= import_flag;
3333 if (SvTAINTED(sstr))
3339 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3342 register U32 sflags;
3344 register svtype stype;
3349 if (SvIS_FREED(dstr)) {
3350 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3351 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3353 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3355 sstr = &PL_sv_undef;
3356 if (SvIS_FREED(sstr)) {
3357 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3358 (void*)sstr, (void*)dstr);
3360 stype = SvTYPE(sstr);
3361 dtype = SvTYPE(dstr);
3363 (void)SvAMAGIC_off(dstr);
3366 /* need to nuke the magic */
3368 SvRMAGICAL_off(dstr);
3371 /* There's a lot of redundancy below but we're going for speed here */
3376 if (dtype != SVt_PVGV) {
3377 (void)SvOK_off(dstr);
3385 sv_upgrade(dstr, SVt_IV);
3390 sv_upgrade(dstr, SVt_PVIV);
3393 goto end_of_first_switch;
3395 (void)SvIOK_only(dstr);
3396 SvIV_set(dstr, SvIVX(sstr));
3399 /* SvTAINTED can only be true if the SV has taint magic, which in
3400 turn means that the SV type is PVMG (or greater). This is the
3401 case statement for SVt_IV, so this cannot be true (whatever gcov
3403 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_NV);
3418 sv_upgrade(dstr, SVt_PVNV);
3421 goto end_of_first_switch;
3423 SvNV_set(dstr, SvNVX(sstr));
3424 (void)SvNOK_only(dstr);
3425 /* SvTAINTED can only be true if the SV has taint magic, which in
3426 turn means that the SV type is PVMG (or greater). This is the
3427 case statement for SVt_NV, so this cannot be true (whatever gcov
3429 assert(!SvTAINTED(sstr));
3436 sv_upgrade(dstr, SVt_RV);
3439 #ifdef PERL_OLD_COPY_ON_WRITE
3440 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3449 sv_upgrade(dstr, SVt_PV);
3452 if (dtype < SVt_PVIV)
3453 sv_upgrade(dstr, SVt_PVIV);
3456 if (dtype < SVt_PVNV)
3457 sv_upgrade(dstr, SVt_PVNV);
3461 const char * const type = sv_reftype(sstr,0);
3463 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3465 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3469 /* case SVt_BIND: */
3472 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3473 glob_assign_glob(dstr, sstr, dtype);
3476 /* SvVALID means that this PVGV is playing at being an FBM. */
3480 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3482 if (SvTYPE(sstr) != stype) {
3483 stype = SvTYPE(sstr);
3484 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3485 glob_assign_glob(dstr, sstr, dtype);
3490 if (stype == SVt_PVLV)
3491 SvUPGRADE(dstr, SVt_PVNV);
3493 SvUPGRADE(dstr, (svtype)stype);
3495 end_of_first_switch:
3497 /* dstr may have been upgraded. */
3498 dtype = SvTYPE(dstr);
3499 sflags = SvFLAGS(sstr);
3501 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3502 /* Assigning to a subroutine sets the prototype. */
3505 const char *const ptr = SvPV_const(sstr, len);
3507 SvGROW(dstr, len + 1);
3508 Copy(ptr, SvPVX(dstr), len + 1, char);
3509 SvCUR_set(dstr, len);
3511 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3515 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3516 const char * const type = sv_reftype(dstr,0);
3518 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3520 Perl_croak(aTHX_ "Cannot copy to %s", type);
3521 } else if (sflags & SVf_ROK) {
3522 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3523 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3526 if (GvIMPORTED(dstr) != GVf_IMPORTED
3527 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3529 GvIMPORTED_on(dstr);
3534 glob_assign_glob(dstr, sstr, dtype);
3538 if (dtype >= SVt_PV) {
3539 if (dtype == SVt_PVGV) {
3540 glob_assign_ref(dstr, sstr);
3543 if (SvPVX_const(dstr)) {
3549 (void)SvOK_off(dstr);
3550 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3551 SvFLAGS(dstr) |= sflags & SVf_ROK;
3552 assert(!(sflags & SVp_NOK));
3553 assert(!(sflags & SVp_IOK));
3554 assert(!(sflags & SVf_NOK));
3555 assert(!(sflags & SVf_IOK));
3557 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3558 if (!(sflags & SVf_OK)) {
3559 if (ckWARN(WARN_MISC))
3560 Perl_warner(aTHX_ packWARN(WARN_MISC),
3561 "Undefined value assigned to typeglob");
3564 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3565 if (dstr != (SV*)gv) {
3568 GvGP(dstr) = gp_ref(GvGP(gv));
3572 else if (sflags & SVp_POK) {
3576 * Check to see if we can just swipe the string. If so, it's a
3577 * possible small lose on short strings, but a big win on long ones.
3578 * It might even be a win on short strings if SvPVX_const(dstr)
3579 * has to be allocated and SvPVX_const(sstr) has to be freed.
3580 * Likewise if we can set up COW rather than doing an actual copy, we
3581 * drop to the else clause, as the swipe code and the COW setup code
3582 * have much in common.
3585 /* Whichever path we take through the next code, we want this true,
3586 and doing it now facilitates the COW check. */
3587 (void)SvPOK_only(dstr);
3590 /* If we're already COW then this clause is not true, and if COW
3591 is allowed then we drop down to the else and make dest COW
3592 with us. If caller hasn't said that we're allowed to COW
3593 shared hash keys then we don't do the COW setup, even if the
3594 source scalar is a shared hash key scalar. */
3595 (((flags & SV_COW_SHARED_HASH_KEYS)
3596 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3597 : 1 /* If making a COW copy is forbidden then the behaviour we
3598 desire is as if the source SV isn't actually already
3599 COW, even if it is. So we act as if the source flags
3600 are not COW, rather than actually testing them. */
3602 #ifndef PERL_OLD_COPY_ON_WRITE
3603 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3604 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3605 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3606 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3607 but in turn, it's somewhat dead code, never expected to go
3608 live, but more kept as a placeholder on how to do it better
3609 in a newer implementation. */
3610 /* If we are COW and dstr is a suitable target then we drop down
3611 into the else and make dest a COW of us. */
3612 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3617 (sflags & SVs_TEMP) && /* slated for free anyway? */
3618 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3619 (!(flags & SV_NOSTEAL)) &&
3620 /* and we're allowed to steal temps */
3621 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3622 SvLEN(sstr) && /* and really is a string */
3623 /* and won't be needed again, potentially */
3624 !(PL_op && PL_op->op_type == OP_AASSIGN))
3625 #ifdef PERL_OLD_COPY_ON_WRITE
3626 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3627 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3628 && SvTYPE(sstr) >= SVt_PVIV)
3631 /* Failed the swipe test, and it's not a shared hash key either.
3632 Have to copy the string. */
3633 STRLEN len = SvCUR(sstr);
3634 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3635 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3636 SvCUR_set(dstr, len);
3637 *SvEND(dstr) = '\0';
3639 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3641 /* Either it's a shared hash key, or it's suitable for
3642 copy-on-write or we can swipe the string. */
3644 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3648 #ifdef PERL_OLD_COPY_ON_WRITE
3650 /* I believe I should acquire a global SV mutex if
3651 it's a COW sv (not a shared hash key) to stop
3652 it going un copy-on-write.
3653 If the source SV has gone un copy on write between up there
3654 and down here, then (assert() that) it is of the correct
3655 form to make it copy on write again */
3656 if ((sflags & (SVf_FAKE | SVf_READONLY))
3657 != (SVf_FAKE | SVf_READONLY)) {
3658 SvREADONLY_on(sstr);
3660 /* Make the source SV into a loop of 1.
3661 (about to become 2) */
3662 SV_COW_NEXT_SV_SET(sstr, sstr);
3666 /* Initial code is common. */
3667 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3672 /* making another shared SV. */
3673 STRLEN cur = SvCUR(sstr);
3674 STRLEN len = SvLEN(sstr);
3675 #ifdef PERL_OLD_COPY_ON_WRITE
3677 assert (SvTYPE(dstr) >= SVt_PVIV);
3678 /* SvIsCOW_normal */
3679 /* splice us in between source and next-after-source. */
3680 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3681 SV_COW_NEXT_SV_SET(sstr, dstr);
3682 SvPV_set(dstr, SvPVX_mutable(sstr));
3686 /* SvIsCOW_shared_hash */
3687 DEBUG_C(PerlIO_printf(Perl_debug_log,
3688 "Copy on write: Sharing hash\n"));
3690 assert (SvTYPE(dstr) >= SVt_PV);
3692 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3694 SvLEN_set(dstr, len);
3695 SvCUR_set(dstr, cur);
3696 SvREADONLY_on(dstr);
3698 /* Relesase a global SV mutex. */
3701 { /* Passes the swipe test. */
3702 SvPV_set(dstr, SvPVX_mutable(sstr));
3703 SvLEN_set(dstr, SvLEN(sstr));
3704 SvCUR_set(dstr, SvCUR(sstr));
3707 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3708 SvPV_set(sstr, NULL);
3714 if (sflags & SVp_NOK) {
3715 SvNV_set(dstr, SvNVX(sstr));
3717 if (sflags & SVp_IOK) {
3719 SvIV_set(dstr, SvIVX(sstr));
3720 /* Must do this otherwise some other overloaded use of 0x80000000
3721 gets confused. I guess SVpbm_VALID */
3722 if (sflags & SVf_IVisUV)
3725 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3727 const MAGIC * const smg = SvVSTRING_mg(sstr);
3729 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3730 smg->mg_ptr, smg->mg_len);
3731 SvRMAGICAL_on(dstr);
3735 else if (sflags & (SVp_IOK|SVp_NOK)) {
3736 (void)SvOK_off(dstr);
3737 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3738 if (sflags & SVp_IOK) {
3739 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3740 SvIV_set(dstr, SvIVX(sstr));
3742 if (sflags & SVp_NOK) {
3743 SvNV_set(dstr, SvNVX(sstr));
3747 if (isGV_with_GP(sstr)) {
3748 /* This stringification rule for globs is spread in 3 places.
3749 This feels bad. FIXME. */
3750 const U32 wasfake = sflags & SVf_FAKE;
3752 /* FAKE globs can get coerced, so need to turn this off
3753 temporarily if it is on. */
3755 gv_efullname3(dstr, (GV *)sstr, "*");
3756 SvFLAGS(sstr) |= wasfake;
3759 (void)SvOK_off(dstr);
3761 if (SvTAINTED(sstr))
3766 =for apidoc sv_setsv_mg
3768 Like C<sv_setsv>, but also handles 'set' magic.
3774 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3776 sv_setsv(dstr,sstr);
3780 #ifdef PERL_OLD_COPY_ON_WRITE
3782 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3784 STRLEN cur = SvCUR(sstr);
3785 STRLEN len = SvLEN(sstr);
3786 register char *new_pv;
3789 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3790 (void*)sstr, (void*)dstr);
3797 if (SvTHINKFIRST(dstr))
3798 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3799 else if (SvPVX_const(dstr))
3800 Safefree(SvPVX_const(dstr));
3804 SvUPGRADE(dstr, SVt_PVIV);
3806 assert (SvPOK(sstr));
3807 assert (SvPOKp(sstr));
3808 assert (!SvIOK(sstr));
3809 assert (!SvIOKp(sstr));
3810 assert (!SvNOK(sstr));
3811 assert (!SvNOKp(sstr));
3813 if (SvIsCOW(sstr)) {
3815 if (SvLEN(sstr) == 0) {
3816 /* source is a COW shared hash key. */
3817 DEBUG_C(PerlIO_printf(Perl_debug_log,
3818 "Fast copy on write: Sharing hash\n"));
3819 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3822 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3824 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3825 SvUPGRADE(sstr, SVt_PVIV);
3826 SvREADONLY_on(sstr);
3828 DEBUG_C(PerlIO_printf(Perl_debug_log,
3829 "Fast copy on write: Converting sstr to COW\n"));
3830 SV_COW_NEXT_SV_SET(dstr, sstr);
3832 SV_COW_NEXT_SV_SET(sstr, dstr);
3833 new_pv = SvPVX_mutable(sstr);
3836 SvPV_set(dstr, new_pv);
3837 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3840 SvLEN_set(dstr, len);
3841 SvCUR_set(dstr, cur);
3850 =for apidoc sv_setpvn
3852 Copies a string into an SV. The C<len> parameter indicates the number of
3853 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3854 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3860 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3863 register char *dptr;
3865 SV_CHECK_THINKFIRST_COW_DROP(sv);
3871 /* len is STRLEN which is unsigned, need to copy to signed */
3874 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3876 SvUPGRADE(sv, SVt_PV);
3878 dptr = SvGROW(sv, len + 1);
3879 Move(ptr,dptr,len,char);
3882 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3887 =for apidoc sv_setpvn_mg
3889 Like C<sv_setpvn>, but also handles 'set' magic.
3895 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3897 sv_setpvn(sv,ptr,len);
3902 =for apidoc sv_setpv
3904 Copies a string into an SV. The string must be null-terminated. Does not
3905 handle 'set' magic. See C<sv_setpv_mg>.
3911 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3914 register STRLEN len;
3916 SV_CHECK_THINKFIRST_COW_DROP(sv);
3922 SvUPGRADE(sv, SVt_PV);
3924 SvGROW(sv, len + 1);
3925 Move(ptr,SvPVX(sv),len+1,char);
3927 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3932 =for apidoc sv_setpv_mg
3934 Like C<sv_setpv>, but also handles 'set' magic.
3940 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3947 =for apidoc sv_usepvn_flags
3949 Tells an SV to use C<ptr> to find its string value. Normally the
3950 string is stored inside the SV but sv_usepvn allows the SV to use an
3951 outside string. The C<ptr> should point to memory that was allocated
3952 by C<malloc>. The string length, C<len>, must be supplied. By default
3953 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3954 so that pointer should not be freed or used by the programmer after
3955 giving it to sv_usepvn, and neither should any pointers from "behind"
3956 that pointer (e.g. ptr + 1) be used.
3958 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3959 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3960 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3961 C<len>, and already meets the requirements for storing in C<SvPVX>)
3967 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3971 SV_CHECK_THINKFIRST_COW_DROP(sv);
3972 SvUPGRADE(sv, SVt_PV);
3975 if (flags & SV_SMAGIC)
3979 if (SvPVX_const(sv))
3983 if (flags & SV_HAS_TRAILING_NUL)
3984 assert(ptr[len] == '\0');
3987 allocate = (flags & SV_HAS_TRAILING_NUL)
3988 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3989 if (flags & SV_HAS_TRAILING_NUL) {
3990 /* It's long enough - do nothing.
3991 Specfically Perl_newCONSTSUB is relying on this. */
3994 /* Force a move to shake out bugs in callers. */
3995 char *new_ptr = (char*)safemalloc(allocate);
3996 Copy(ptr, new_ptr, len, char);
3997 PoisonFree(ptr,len,char);
4001 ptr = (char*) saferealloc (ptr, allocate);
4006 SvLEN_set(sv, allocate);
4007 if (!(flags & SV_HAS_TRAILING_NUL)) {
4010 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4012 if (flags & SV_SMAGIC)
4016 #ifdef PERL_OLD_COPY_ON_WRITE
4017 /* Need to do this *after* making the SV normal, as we need the buffer
4018 pointer to remain valid until after we've copied it. If we let go too early,
4019 another thread could invalidate it by unsharing last of the same hash key
4020 (which it can do by means other than releasing copy-on-write Svs)
4021 or by changing the other copy-on-write SVs in the loop. */
4023 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4025 { /* this SV was SvIsCOW_normal(sv) */
4026 /* we need to find the SV pointing to us. */
4027 SV *current = SV_COW_NEXT_SV(after);
4029 if (current == sv) {
4030 /* The SV we point to points back to us (there were only two of us
4032 Hence other SV is no longer copy on write either. */
4034 SvREADONLY_off(after);
4036 /* We need to follow the pointers around the loop. */
4038 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4041 /* don't loop forever if the structure is bust, and we have
4042 a pointer into a closed loop. */
4043 assert (current != after);
4044 assert (SvPVX_const(current) == pvx);
4046 /* Make the SV before us point to the SV after us. */
4047 SV_COW_NEXT_SV_SET(current, after);
4053 =for apidoc sv_force_normal_flags
4055 Undo various types of fakery on an SV: if the PV is a shared string, make
4056 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4057 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4058 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4059 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4060 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4061 set to some other value.) In addition, the C<flags> parameter gets passed to
4062 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4063 with flags set to 0.
4069 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4072 #ifdef PERL_OLD_COPY_ON_WRITE
4073 if (SvREADONLY(sv)) {
4074 /* At this point I believe I should acquire a global SV mutex. */
4076 const char * const pvx = SvPVX_const(sv);
4077 const STRLEN len = SvLEN(sv);
4078 const STRLEN cur = SvCUR(sv);
4079 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4080 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4081 we'll fail an assertion. */
4082 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4085 PerlIO_printf(Perl_debug_log,
4086 "Copy on write: Force normal %ld\n",
4092 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4095 if (flags & SV_COW_DROP_PV) {
4096 /* OK, so we don't need to copy our buffer. */
4099 SvGROW(sv, cur + 1);
4100 Move(pvx,SvPVX(sv),cur,char);
4105 sv_release_COW(sv, pvx, next);
4107 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4113 else if (IN_PERL_RUNTIME)
4114 Perl_croak(aTHX_ PL_no_modify);
4115 /* At this point I believe that I can drop the global SV mutex. */
4118 if (SvREADONLY(sv)) {
4120 const char * const pvx = SvPVX_const(sv);
4121 const STRLEN len = SvCUR(sv);
4126 SvGROW(sv, len + 1);
4127 Move(pvx,SvPVX(sv),len,char);
4129 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4131 else if (IN_PERL_RUNTIME)
4132 Perl_croak(aTHX_ PL_no_modify);
4136 sv_unref_flags(sv, flags);
4137 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4144 Efficient removal of characters from the beginning of the string buffer.
4145 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4146 the string buffer. The C<ptr> becomes the first character of the adjusted
4147 string. Uses the "OOK hack".
4148 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4149 refer to the same chunk of data.
4155 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4157 register STRLEN delta;
4158 if (!ptr || !SvPOKp(sv))
4160 delta = ptr - SvPVX_const(sv);
4161 SV_CHECK_THINKFIRST(sv);
4162 if (SvTYPE(sv) < SVt_PVIV)
4163 sv_upgrade(sv,SVt_PVIV);
4166 if (!SvLEN(sv)) { /* make copy of shared string */
4167 const char *pvx = SvPVX_const(sv);
4168 const STRLEN len = SvCUR(sv);
4169 SvGROW(sv, len + 1);
4170 Move(pvx,SvPVX(sv),len,char);
4174 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4175 and we do that anyway inside the SvNIOK_off
4177 SvFLAGS(sv) |= SVf_OOK;
4180 SvLEN_set(sv, SvLEN(sv) - delta);
4181 SvCUR_set(sv, SvCUR(sv) - delta);
4182 SvPV_set(sv, SvPVX(sv) + delta);
4183 SvIV_set(sv, SvIVX(sv) + delta);
4187 =for apidoc sv_catpvn
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 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4194 =for apidoc sv_catpvn_flags
4196 Concatenates the string onto the end of the string which is in the SV. The
4197 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4198 status set, then the bytes appended should be valid UTF-8.
4199 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4200 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4201 in terms of this function.
4207 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4211 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4213 SvGROW(dsv, dlen + slen + 1);
4215 sstr = SvPVX_const(dsv);
4216 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4217 SvCUR_set(dsv, SvCUR(dsv) + slen);
4219 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4221 if (flags & SV_SMAGIC)
4226 =for apidoc sv_catsv
4228 Concatenates the string from SV C<ssv> onto the end of the string in
4229 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4230 not 'set' magic. See C<sv_catsv_mg>.
4232 =for apidoc sv_catsv_flags
4234 Concatenates the string from SV C<ssv> onto the end of the string in
4235 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4236 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4237 and C<sv_catsv_nomg> are implemented in terms of this function.
4242 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4247 const char *spv = SvPV_const(ssv, slen);
4249 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4250 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4251 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4252 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4253 dsv->sv_flags doesn't have that bit set.
4254 Andy Dougherty 12 Oct 2001
4256 const I32 sutf8 = DO_UTF8(ssv);
4259 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4261 dutf8 = DO_UTF8(dsv);
4263 if (dutf8 != sutf8) {
4265 /* Not modifying source SV, so taking a temporary copy. */
4266 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4268 sv_utf8_upgrade(csv);
4269 spv = SvPV_const(csv, slen);
4272 sv_utf8_upgrade_nomg(dsv);
4274 sv_catpvn_nomg(dsv, spv, slen);
4277 if (flags & SV_SMAGIC)
4282 =for apidoc sv_catpv
4284 Concatenates the string onto the end of the string which is in the SV.
4285 If the SV has the UTF-8 status set, then the bytes appended should be
4286 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4291 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4294 register STRLEN len;
4300 junk = SvPV_force(sv, tlen);
4302 SvGROW(sv, tlen + len + 1);
4304 ptr = SvPVX_const(sv);
4305 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4306 SvCUR_set(sv, SvCUR(sv) + len);
4307 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4312 =for apidoc sv_catpv_mg
4314 Like C<sv_catpv>, but also handles 'set' magic.
4320 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4329 Creates a new SV. A non-zero C<len> parameter indicates the number of
4330 bytes of preallocated string space the SV should have. An extra byte for a
4331 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4332 space is allocated.) The reference count for the new SV is set to 1.
4334 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4335 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4336 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4337 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4338 modules supporting older perls.
4344 Perl_newSV(pTHX_ STRLEN len)
4351 sv_upgrade(sv, SVt_PV);
4352 SvGROW(sv, len + 1);
4357 =for apidoc sv_magicext
4359 Adds magic to an SV, upgrading it if necessary. Applies the
4360 supplied vtable and returns a pointer to the magic added.
4362 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4363 In particular, you can add magic to SvREADONLY SVs, and add more than
4364 one instance of the same 'how'.
4366 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4367 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4368 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4369 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4371 (This is now used as a subroutine by C<sv_magic>.)
4376 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4377 const char* name, I32 namlen)
4382 SvUPGRADE(sv, SVt_PVMG);
4383 Newxz(mg, 1, MAGIC);
4384 mg->mg_moremagic = SvMAGIC(sv);
4385 SvMAGIC_set(sv, mg);
4387 /* Sometimes a magic contains a reference loop, where the sv and
4388 object refer to each other. To prevent a reference loop that
4389 would prevent such objects being freed, we look for such loops
4390 and if we find one we avoid incrementing the object refcount.
4392 Note we cannot do this to avoid self-tie loops as intervening RV must
4393 have its REFCNT incremented to keep it in existence.
4396 if (!obj || obj == sv ||
4397 how == PERL_MAGIC_arylen ||
4398 how == PERL_MAGIC_qr ||
4399 how == PERL_MAGIC_symtab ||
4400 (SvTYPE(obj) == SVt_PVGV &&
4401 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4402 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4403 GvFORM(obj) == (CV*)sv)))
4408 mg->mg_obj = SvREFCNT_inc_simple(obj);
4409 mg->mg_flags |= MGf_REFCOUNTED;
4412 /* Normal self-ties simply pass a null object, and instead of
4413 using mg_obj directly, use the SvTIED_obj macro to produce a
4414 new RV as needed. For glob "self-ties", we are tieing the PVIO
4415 with an RV obj pointing to the glob containing the PVIO. In
4416 this case, to avoid a reference loop, we need to weaken the
4420 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4421 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4427 mg->mg_len = namlen;
4430 mg->mg_ptr = savepvn(name, namlen);
4431 else if (namlen == HEf_SVKEY)
4432 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4434 mg->mg_ptr = (char *) name;
4436 mg->mg_virtual = (MGVTBL *) vtable;
4440 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4445 =for apidoc sv_magic
4447 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4448 then adds a new magic item of type C<how> to the head of the magic list.
4450 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4451 handling of the C<name> and C<namlen> arguments.
4453 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4454 to add more than one instance of the same 'how'.
4460 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4463 const MGVTBL *vtable;
4466 #ifdef PERL_OLD_COPY_ON_WRITE
4468 sv_force_normal_flags(sv, 0);
4470 if (SvREADONLY(sv)) {
4472 /* its okay to attach magic to shared strings; the subsequent
4473 * upgrade to PVMG will unshare the string */
4474 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4477 && how != PERL_MAGIC_regex_global
4478 && how != PERL_MAGIC_bm
4479 && how != PERL_MAGIC_fm
4480 && how != PERL_MAGIC_sv
4481 && how != PERL_MAGIC_backref
4484 Perl_croak(aTHX_ PL_no_modify);
4487 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4488 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4489 /* sv_magic() refuses to add a magic of the same 'how' as an
4492 if (how == PERL_MAGIC_taint) {
4494 /* Any scalar which already had taint magic on which someone
4495 (erroneously?) did SvIOK_on() or similar will now be
4496 incorrectly sporting public "OK" flags. */
4497 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4505 vtable = &PL_vtbl_sv;
4507 case PERL_MAGIC_overload:
4508 vtable = &PL_vtbl_amagic;
4510 case PERL_MAGIC_overload_elem:
4511 vtable = &PL_vtbl_amagicelem;
4513 case PERL_MAGIC_overload_table:
4514 vtable = &PL_vtbl_ovrld;
4517 vtable = &PL_vtbl_bm;
4519 case PERL_MAGIC_regdata:
4520 vtable = &PL_vtbl_regdata;
4522 case PERL_MAGIC_regdatum:
4523 vtable = &PL_vtbl_regdatum;
4525 case PERL_MAGIC_env:
4526 vtable = &PL_vtbl_env;
4529 vtable = &PL_vtbl_fm;
4531 case PERL_MAGIC_envelem:
4532 vtable = &PL_vtbl_envelem;
4534 case PERL_MAGIC_regex_global:
4535 vtable = &PL_vtbl_mglob;
4537 case PERL_MAGIC_isa:
4538 vtable = &PL_vtbl_isa;
4540 case PERL_MAGIC_isaelem:
4541 vtable = &PL_vtbl_isaelem;
4543 case PERL_MAGIC_nkeys:
4544 vtable = &PL_vtbl_nkeys;
4546 case PERL_MAGIC_dbfile:
4549 case PERL_MAGIC_dbline:
4550 vtable = &PL_vtbl_dbline;
4552 #ifdef USE_LOCALE_COLLATE
4553 case PERL_MAGIC_collxfrm:
4554 vtable = &PL_vtbl_collxfrm;
4556 #endif /* USE_LOCALE_COLLATE */
4557 case PERL_MAGIC_tied:
4558 vtable = &PL_vtbl_pack;
4560 case PERL_MAGIC_tiedelem:
4561 case PERL_MAGIC_tiedscalar:
4562 vtable = &PL_vtbl_packelem;
4565 vtable = &PL_vtbl_regexp;
4567 case PERL_MAGIC_hints:
4568 /* As this vtable is all NULL, we can reuse it. */
4569 case PERL_MAGIC_sig:
4570 vtable = &PL_vtbl_sig;
4572 case PERL_MAGIC_sigelem:
4573 vtable = &PL_vtbl_sigelem;
4575 case PERL_MAGIC_taint:
4576 vtable = &PL_vtbl_taint;
4578 case PERL_MAGIC_uvar:
4579 vtable = &PL_vtbl_uvar;
4581 case PERL_MAGIC_vec:
4582 vtable = &PL_vtbl_vec;
4584 case PERL_MAGIC_arylen_p:
4585 case PERL_MAGIC_rhash:
4586 case PERL_MAGIC_symtab:
4587 case PERL_MAGIC_vstring:
4590 case PERL_MAGIC_utf8:
4591 vtable = &PL_vtbl_utf8;
4593 case PERL_MAGIC_substr:
4594 vtable = &PL_vtbl_substr;
4596 case PERL_MAGIC_defelem:
4597 vtable = &PL_vtbl_defelem;
4599 case PERL_MAGIC_arylen:
4600 vtable = &PL_vtbl_arylen;
4602 case PERL_MAGIC_pos:
4603 vtable = &PL_vtbl_pos;
4605 case PERL_MAGIC_backref:
4606 vtable = &PL_vtbl_backref;
4608 case PERL_MAGIC_hintselem:
4609 vtable = &PL_vtbl_hintselem;
4611 case PERL_MAGIC_ext:
4612 /* Reserved for use by extensions not perl internals. */
4613 /* Useful for attaching extension internal data to perl vars. */
4614 /* Note that multiple extensions may clash if magical scalars */
4615 /* etc holding private data from one are passed to another. */
4619 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4622 /* Rest of work is done else where */
4623 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4626 case PERL_MAGIC_taint:
4629 case PERL_MAGIC_ext:
4630 case PERL_MAGIC_dbfile:
4637 =for apidoc sv_unmagic
4639 Removes all magic of type C<type> from an SV.
4645 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4649 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4651 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4652 for (mg = *mgp; mg; mg = *mgp) {
4653 if (mg->mg_type == type) {
4654 const MGVTBL* const vtbl = mg->mg_virtual;
4655 *mgp = mg->mg_moremagic;
4656 if (vtbl && vtbl->svt_free)
4657 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4658 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4660 Safefree(mg->mg_ptr);
4661 else if (mg->mg_len == HEf_SVKEY)
4662 SvREFCNT_dec((SV*)mg->mg_ptr);
4663 else if (mg->mg_type == PERL_MAGIC_utf8)
4664 Safefree(mg->mg_ptr);
4666 if (mg->mg_flags & MGf_REFCOUNTED)
4667 SvREFCNT_dec(mg->mg_obj);
4671 mgp = &mg->mg_moremagic;
4675 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4676 SvMAGIC_set(sv, NULL);
4683 =for apidoc sv_rvweaken
4685 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4686 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4687 push a back-reference to this RV onto the array of backreferences
4688 associated with that magic. If the RV is magical, set magic will be
4689 called after the RV is cleared.
4695 Perl_sv_rvweaken(pTHX_ SV *sv)
4698 if (!SvOK(sv)) /* let undefs pass */
4701 Perl_croak(aTHX_ "Can't weaken a nonreference");
4702 else if (SvWEAKREF(sv)) {
4703 if (ckWARN(WARN_MISC))
4704 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4708 Perl_sv_add_backref(aTHX_ tsv, sv);
4714 /* Give tsv backref magic if it hasn't already got it, then push a
4715 * back-reference to sv onto the array associated with the backref magic.
4719 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4724 if (SvTYPE(tsv) == SVt_PVHV) {
4725 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4729 /* There is no AV in the offical place - try a fixup. */
4730 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4733 /* Aha. They've got it stowed in magic. Bring it back. */
4734 av = (AV*)mg->mg_obj;
4735 /* Stop mg_free decreasing the refernce count. */
4737 /* Stop mg_free even calling the destructor, given that
4738 there's no AV to free up. */
4740 sv_unmagic(tsv, PERL_MAGIC_backref);
4744 SvREFCNT_inc_simple_void(av);
4749 const MAGIC *const mg
4750 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4752 av = (AV*)mg->mg_obj;
4756 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4757 /* av now has a refcnt of 2, which avoids it getting freed
4758 * before us during global cleanup. The extra ref is removed
4759 * by magic_killbackrefs() when tsv is being freed */
4762 if (AvFILLp(av) >= AvMAX(av)) {
4763 av_extend(av, AvFILLp(av)+1);
4765 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4768 /* delete a back-reference to ourselves from the backref magic associated
4769 * with the SV we point to.
4773 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4780 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4781 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4782 /* We mustn't attempt to "fix up" the hash here by moving the
4783 backreference array back to the hv_aux structure, as that is stored
4784 in the main HvARRAY(), and hfreentries assumes that no-one
4785 reallocates HvARRAY() while it is running. */
4788 const MAGIC *const mg
4789 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4791 av = (AV *)mg->mg_obj;
4794 if (PL_in_clean_all)
4796 Perl_croak(aTHX_ "panic: del_backref");
4803 /* We shouldn't be in here more than once, but for paranoia reasons lets
4805 for (i = AvFILLp(av); i >= 0; i--) {
4807 const SSize_t fill = AvFILLp(av);
4809 /* We weren't the last entry.
4810 An unordered list has this property that you can take the
4811 last element off the end to fill the hole, and it's still
4812 an unordered list :-)
4817 AvFILLp(av) = fill - 1;
4823 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4825 SV **svp = AvARRAY(av);
4827 PERL_UNUSED_ARG(sv);
4829 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4830 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4831 if (svp && !SvIS_FREED(av)) {
4832 SV *const *const last = svp + AvFILLp(av);
4834 while (svp <= last) {
4836 SV *const referrer = *svp;
4837 if (SvWEAKREF(referrer)) {
4838 /* XXX Should we check that it hasn't changed? */
4839 SvRV_set(referrer, 0);
4841 SvWEAKREF_off(referrer);
4842 SvSETMAGIC(referrer);
4843 } else if (SvTYPE(referrer) == SVt_PVGV ||
4844 SvTYPE(referrer) == SVt_PVLV) {
4845 /* You lookin' at me? */
4846 assert(GvSTASH(referrer));
4847 assert(GvSTASH(referrer) == (HV*)sv);
4848 GvSTASH(referrer) = 0;
4851 "panic: magic_killbackrefs (flags=%"UVxf")",
4852 (UV)SvFLAGS(referrer));
4860 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4865 =for apidoc sv_insert
4867 Inserts a string at the specified offset/length within the SV. Similar to
4868 the Perl substr() function.
4874 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4879 register char *midend;
4880 register char *bigend;
4886 Perl_croak(aTHX_ "Can't modify non-existent substring");
4887 SvPV_force(bigstr, curlen);
4888 (void)SvPOK_only_UTF8(bigstr);
4889 if (offset + len > curlen) {
4890 SvGROW(bigstr, offset+len+1);
4891 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4892 SvCUR_set(bigstr, offset+len);
4896 i = littlelen - len;
4897 if (i > 0) { /* string might grow */
4898 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4899 mid = big + offset + len;
4900 midend = bigend = big + SvCUR(bigstr);
4903 while (midend > mid) /* shove everything down */
4904 *--bigend = *--midend;
4905 Move(little,big+offset,littlelen,char);
4906 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4911 Move(little,SvPVX(bigstr)+offset,len,char);
4916 big = SvPVX(bigstr);
4919 bigend = big + SvCUR(bigstr);
4921 if (midend > bigend)
4922 Perl_croak(aTHX_ "panic: sv_insert");
4924 if (mid - big > bigend - midend) { /* faster to shorten from end */
4926 Move(little, mid, littlelen,char);
4929 i = bigend - midend;
4931 Move(midend, mid, i,char);
4935 SvCUR_set(bigstr, mid - big);
4937 else if ((i = mid - big)) { /* faster from front */
4938 midend -= littlelen;
4940 sv_chop(bigstr,midend-i);
4945 Move(little, mid, littlelen,char);
4947 else if (littlelen) {
4948 midend -= littlelen;
4949 sv_chop(bigstr,midend);
4950 Move(little,midend,littlelen,char);
4953 sv_chop(bigstr,midend);
4959 =for apidoc sv_replace
4961 Make the first argument a copy of the second, then delete the original.
4962 The target SV physically takes over ownership of the body of the source SV
4963 and inherits its flags; however, the target keeps any magic it owns,
4964 and any magic in the source is discarded.
4965 Note that this is a rather specialist SV copying operation; most of the
4966 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4972 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4975 const U32 refcnt = SvREFCNT(sv);
4976 SV_CHECK_THINKFIRST_COW_DROP(sv);
4977 if (SvREFCNT(nsv) != 1) {
4978 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4979 UVuf " != 1)", (UV) SvREFCNT(nsv));
4981 if (SvMAGICAL(sv)) {
4985 sv_upgrade(nsv, SVt_PVMG);
4986 SvMAGIC_set(nsv, SvMAGIC(sv));
4987 SvFLAGS(nsv) |= SvMAGICAL(sv);
4989 SvMAGIC_set(sv, NULL);
4993 assert(!SvREFCNT(sv));
4994 #ifdef DEBUG_LEAKING_SCALARS
4995 sv->sv_flags = nsv->sv_flags;
4996 sv->sv_any = nsv->sv_any;
4997 sv->sv_refcnt = nsv->sv_refcnt;
4998 sv->sv_u = nsv->sv_u;
5000 StructCopy(nsv,sv,SV);
5002 /* Currently could join these into one piece of pointer arithmetic, but
5003 it would be unclear. */
5004 if(SvTYPE(sv) == SVt_IV)
5006 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5007 else if (SvTYPE(sv) == SVt_RV) {
5008 SvANY(sv) = &sv->sv_u.svu_rv;
5012 #ifdef PERL_OLD_COPY_ON_WRITE
5013 if (SvIsCOW_normal(nsv)) {
5014 /* We need to follow the pointers around the loop to make the
5015 previous SV point to sv, rather than nsv. */
5018 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5021 assert(SvPVX_const(current) == SvPVX_const(nsv));
5023 /* Make the SV before us point to the SV after us. */
5025 PerlIO_printf(Perl_debug_log, "previous is\n");
5027 PerlIO_printf(Perl_debug_log,
5028 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5029 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5031 SV_COW_NEXT_SV_SET(current, sv);
5034 SvREFCNT(sv) = refcnt;
5035 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5041 =for apidoc sv_clear
5043 Clear an SV: call any destructors, free up any memory used by the body,
5044 and free the body itself. The SV's head is I<not> freed, although
5045 its type is set to all 1's so that it won't inadvertently be assumed
5046 to be live during global destruction etc.
5047 This function should only be called when REFCNT is zero. Most of the time
5048 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5055 Perl_sv_clear(pTHX_ register SV *sv)
5058 const U32 type = SvTYPE(sv);
5059 const struct body_details *const sv_type_details
5060 = bodies_by_type + type;
5064 assert(SvREFCNT(sv) == 0);
5066 if (type <= SVt_IV) {
5067 /* See the comment in sv.h about the collusion between this early
5068 return and the overloading of the NULL and IV slots in the size
5074 if (PL_defstash) { /* Still have a symbol table? */
5079 stash = SvSTASH(sv);
5080 destructor = StashHANDLER(stash,DESTROY);
5082 SV* const tmpref = newRV(sv);
5083 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5085 PUSHSTACKi(PERLSI_DESTROY);
5090 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5096 if(SvREFCNT(tmpref) < 2) {
5097 /* tmpref is not kept alive! */
5099 SvRV_set(tmpref, NULL);
5102 SvREFCNT_dec(tmpref);
5104 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5108 if (PL_in_clean_objs)
5109 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5111 /* DESTROY gave object new lease on life */
5117 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5118 SvOBJECT_off(sv); /* Curse the object. */
5119 if (type != SVt_PVIO)
5120 --PL_sv_objcount; /* XXX Might want something more general */
5123 if (type >= SVt_PVMG) {
5124 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5125 SvREFCNT_dec(SvOURSTASH(sv));
5126 } else if (SvMAGIC(sv))
5128 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5129 SvREFCNT_dec(SvSTASH(sv));
5132 /* case SVt_BIND: */
5135 IoIFP(sv) != PerlIO_stdin() &&
5136 IoIFP(sv) != PerlIO_stdout() &&
5137 IoIFP(sv) != PerlIO_stderr())
5139 io_close((IO*)sv, FALSE);
5141 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5142 PerlDir_close(IoDIRP(sv));
5143 IoDIRP(sv) = (DIR*)NULL;
5144 Safefree(IoTOP_NAME(sv));
5145 Safefree(IoFMT_NAME(sv));
5146 Safefree(IoBOTTOM_NAME(sv));
5153 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5157 if (PL_comppad == (AV*)sv) {
5164 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5165 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5166 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5167 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5169 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5170 SvREFCNT_dec(LvTARG(sv));
5172 if (isGV_with_GP(sv)) {
5173 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5174 mro_method_changed_in(stash);
5177 unshare_hek(GvNAME_HEK(sv));
5178 /* If we're in a stash, we don't own a reference to it. However it does
5179 have a back reference to us, which needs to be cleared. */
5180 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5181 sv_del_backref((SV*)stash, sv);
5183 /* FIXME. There are probably more unreferenced pointers to SVs in the
5184 interpreter struct that we should check and tidy in a similar
5186 if ((GV*)sv == PL_last_in_gv)
5187 PL_last_in_gv = NULL;
5192 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5194 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5195 /* Don't even bother with turning off the OOK flag. */
5200 SV * const target = SvRV(sv);
5202 sv_del_backref(target, sv);
5204 SvREFCNT_dec(target);
5206 #ifdef PERL_OLD_COPY_ON_WRITE
5207 else if (SvPVX_const(sv)) {
5209 /* I believe I need to grab the global SV mutex here and
5210 then recheck the COW status. */
5212 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5216 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5218 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5221 /* And drop it here. */
5223 } else if (SvLEN(sv)) {
5224 Safefree(SvPVX_const(sv));
5228 else if (SvPVX_const(sv) && SvLEN(sv))
5229 Safefree(SvPVX_mutable(sv));
5230 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5231 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5240 SvFLAGS(sv) &= SVf_BREAK;
5241 SvFLAGS(sv) |= SVTYPEMASK;
5243 if (sv_type_details->arena) {
5244 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5245 &PL_body_roots[type]);
5247 else if (sv_type_details->body_size) {
5248 my_safefree(SvANY(sv));
5253 =for apidoc sv_newref
5255 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5262 Perl_sv_newref(pTHX_ SV *sv)
5264 PERL_UNUSED_CONTEXT;
5273 Decrement an SV's reference count, and if it drops to zero, call
5274 C<sv_clear> to invoke destructors and free up any memory used by
5275 the body; finally, deallocate the SV's head itself.
5276 Normally called via a wrapper macro C<SvREFCNT_dec>.
5282 Perl_sv_free(pTHX_ SV *sv)
5287 if (SvREFCNT(sv) == 0) {
5288 if (SvFLAGS(sv) & SVf_BREAK)
5289 /* this SV's refcnt has been artificially decremented to
5290 * trigger cleanup */
5292 if (PL_in_clean_all) /* All is fair */
5294 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5295 /* make sure SvREFCNT(sv)==0 happens very seldom */
5296 SvREFCNT(sv) = (~(U32)0)/2;
5299 if (ckWARN_d(WARN_INTERNAL)) {
5300 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5301 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5302 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5303 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5304 Perl_dump_sv_child(aTHX_ sv);
5306 #ifdef DEBUG_LEAKING_SCALARS
5313 if (--(SvREFCNT(sv)) > 0)
5315 Perl_sv_free2(aTHX_ sv);
5319 Perl_sv_free2(pTHX_ SV *sv)
5324 if (ckWARN_d(WARN_DEBUGGING))
5325 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5326 "Attempt to free temp prematurely: SV 0x%"UVxf
5327 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5331 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5332 /* make sure SvREFCNT(sv)==0 happens very seldom */
5333 SvREFCNT(sv) = (~(U32)0)/2;
5344 Returns the length of the string in the SV. Handles magic and type
5345 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5351 Perl_sv_len(pTHX_ register SV *sv)
5359 len = mg_length(sv);
5361 (void)SvPV_const(sv, len);
5366 =for apidoc sv_len_utf8
5368 Returns the number of characters in the string in an SV, counting wide
5369 UTF-8 bytes as a single character. Handles magic and type coercion.
5375 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5376 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5377 * (Note that the mg_len is not the length of the mg_ptr field.
5378 * This allows the cache to store the character length of the string without
5379 * needing to malloc() extra storage to attach to the mg_ptr.)
5384 Perl_sv_len_utf8(pTHX_ register SV *sv)
5390 return mg_length(sv);
5394 const U8 *s = (U8*)SvPV_const(sv, len);
5398 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5400 if (mg && mg->mg_len != -1) {
5402 if (PL_utf8cache < 0) {
5403 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5405 /* Need to turn the assertions off otherwise we may
5406 recurse infinitely while printing error messages.
5408 SAVEI8(PL_utf8cache);
5410 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5411 " real %"UVuf" for %"SVf,
5412 (UV) ulen, (UV) real, SVfARG(sv));
5417 ulen = Perl_utf8_length(aTHX_ s, s + len);
5418 if (!SvREADONLY(sv)) {
5420 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5421 &PL_vtbl_utf8, 0, 0);
5429 return Perl_utf8_length(aTHX_ s, s + len);
5433 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5436 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5439 const U8 *s = start;
5441 while (s < send && uoffset--)
5444 /* This is the existing behaviour. Possibly it should be a croak, as
5445 it's actually a bounds error */
5451 /* Given the length of the string in both bytes and UTF-8 characters, decide
5452 whether to walk forwards or backwards to find the byte corresponding to
5453 the passed in UTF-8 offset. */
5455 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5456 STRLEN uoffset, STRLEN uend)
5458 STRLEN backw = uend - uoffset;
5459 if (uoffset < 2 * backw) {
5460 /* The assumption is that going forwards is twice the speed of going
5461 forward (that's where the 2 * backw comes from).
5462 (The real figure of course depends on the UTF-8 data.) */
5463 return sv_pos_u2b_forwards(start, send, uoffset);
5468 while (UTF8_IS_CONTINUATION(*send))
5471 return send - start;
5474 /* For the string representation of the given scalar, find the byte
5475 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5476 give another position in the string, *before* the sought offset, which
5477 (which is always true, as 0, 0 is a valid pair of positions), which should
5478 help reduce the amount of linear searching.
5479 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5480 will be used to reduce the amount of linear searching. The cache will be
5481 created if necessary, and the found value offered to it for update. */
5483 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5484 const U8 *const send, STRLEN uoffset,
5485 STRLEN uoffset0, STRLEN boffset0) {
5486 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5489 assert (uoffset >= uoffset0);
5491 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5492 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5493 if ((*mgp)->mg_ptr) {
5494 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5495 if (cache[0] == uoffset) {
5496 /* An exact match. */
5499 if (cache[2] == uoffset) {
5500 /* An exact match. */
5504 if (cache[0] < uoffset) {
5505 /* The cache already knows part of the way. */
5506 if (cache[0] > uoffset0) {
5507 /* The cache knows more than the passed in pair */
5508 uoffset0 = cache[0];
5509 boffset0 = cache[1];
5511 if ((*mgp)->mg_len != -1) {
5512 /* And we know the end too. */
5514 + sv_pos_u2b_midway(start + boffset0, send,
5516 (*mgp)->mg_len - uoffset0);
5519 + sv_pos_u2b_forwards(start + boffset0,
5520 send, uoffset - uoffset0);
5523 else if (cache[2] < uoffset) {
5524 /* We're between the two cache entries. */
5525 if (cache[2] > uoffset0) {
5526 /* and the cache knows more than the passed in pair */
5527 uoffset0 = cache[2];
5528 boffset0 = cache[3];
5532 + sv_pos_u2b_midway(start + boffset0,
5535 cache[0] - uoffset0);
5538 + sv_pos_u2b_midway(start + boffset0,
5541 cache[2] - uoffset0);
5545 else if ((*mgp)->mg_len != -1) {
5546 /* If we can take advantage of a passed in offset, do so. */
5547 /* In fact, offset0 is either 0, or less than offset, so don't
5548 need to worry about the other possibility. */
5550 + sv_pos_u2b_midway(start + boffset0, send,
5552 (*mgp)->mg_len - uoffset0);
5557 if (!found || PL_utf8cache < 0) {
5558 const STRLEN real_boffset
5559 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5560 send, uoffset - uoffset0);
5562 if (found && PL_utf8cache < 0) {
5563 if (real_boffset != boffset) {
5564 /* Need to turn the assertions off otherwise we may recurse
5565 infinitely while printing error messages. */
5566 SAVEI8(PL_utf8cache);
5568 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5569 " real %"UVuf" for %"SVf,
5570 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5573 boffset = real_boffset;
5576 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5582 =for apidoc sv_pos_u2b
5584 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5585 the start of the string, to a count of the equivalent number of bytes; if
5586 lenp is non-zero, it does the same to lenp, but this time starting from
5587 the offset, rather than from the start of the string. Handles magic and
5594 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5595 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5596 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5601 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5609 start = (U8*)SvPV_const(sv, len);
5611 STRLEN uoffset = (STRLEN) *offsetp;
5612 const U8 * const send = start + len;
5614 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5617 *offsetp = (I32) boffset;
5620 /* Convert the relative offset to absolute. */
5621 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5622 const STRLEN boffset2
5623 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5624 uoffset, boffset) - boffset;
5638 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5639 byte length pairing. The (byte) length of the total SV is passed in too,
5640 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5641 may not have updated SvCUR, so we can't rely on reading it directly.
5643 The proffered utf8/byte length pairing isn't used if the cache already has
5644 two pairs, and swapping either for the proffered pair would increase the
5645 RMS of the intervals between known byte offsets.
5647 The cache itself consists of 4 STRLEN values
5648 0: larger UTF-8 offset
5649 1: corresponding byte offset
5650 2: smaller UTF-8 offset
5651 3: corresponding byte offset
5653 Unused cache pairs have the value 0, 0.
5654 Keeping the cache "backwards" means that the invariant of
5655 cache[0] >= cache[2] is maintained even with empty slots, which means that
5656 the code that uses it doesn't need to worry if only 1 entry has actually
5657 been set to non-zero. It also makes the "position beyond the end of the
5658 cache" logic much simpler, as the first slot is always the one to start
5662 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5670 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5672 (*mgp)->mg_len = -1;
5676 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5677 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5678 (*mgp)->mg_ptr = (char *) cache;
5682 if (PL_utf8cache < 0) {
5683 const U8 *start = (const U8 *) SvPVX_const(sv);
5684 const STRLEN realutf8 = utf8_length(start, start + byte);
5686 if (realutf8 != utf8) {
5687 /* Need to turn the assertions off otherwise we may recurse
5688 infinitely while printing error messages. */
5689 SAVEI8(PL_utf8cache);
5691 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5692 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5696 /* Cache is held with the later position first, to simplify the code
5697 that deals with unbounded ends. */
5699 ASSERT_UTF8_CACHE(cache);
5700 if (cache[1] == 0) {
5701 /* Cache is totally empty */
5704 } else if (cache[3] == 0) {
5705 if (byte > cache[1]) {
5706 /* New one is larger, so goes first. */
5707 cache[2] = cache[0];
5708 cache[3] = cache[1];
5716 #define THREEWAY_SQUARE(a,b,c,d) \
5717 ((float)((d) - (c))) * ((float)((d) - (c))) \
5718 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5719 + ((float)((b) - (a))) * ((float)((b) - (a)))
5721 /* Cache has 2 slots in use, and we know three potential pairs.
5722 Keep the two that give the lowest RMS distance. Do the
5723 calcualation in bytes simply because we always know the byte
5724 length. squareroot has the same ordering as the positive value,
5725 so don't bother with the actual square root. */
5726 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5727 if (byte > cache[1]) {
5728 /* New position is after the existing pair of pairs. */
5729 const float keep_earlier
5730 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5731 const float keep_later
5732 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5734 if (keep_later < keep_earlier) {
5735 if (keep_later < existing) {
5736 cache[2] = cache[0];
5737 cache[3] = cache[1];
5743 if (keep_earlier < existing) {
5749 else if (byte > cache[3]) {
5750 /* New position is between the existing pair of pairs. */
5751 const float keep_earlier
5752 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5753 const float keep_later
5754 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5756 if (keep_later < keep_earlier) {
5757 if (keep_later < existing) {
5763 if (keep_earlier < existing) {
5770 /* New position is before the existing pair of pairs. */
5771 const float keep_earlier
5772 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5773 const float keep_later
5774 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5776 if (keep_later < keep_earlier) {
5777 if (keep_later < existing) {
5783 if (keep_earlier < existing) {
5784 cache[0] = cache[2];
5785 cache[1] = cache[3];
5792 ASSERT_UTF8_CACHE(cache);
5795 /* We already know all of the way, now we may be able to walk back. The same
5796 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5797 backward is half the speed of walking forward. */
5799 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5802 const STRLEN forw = target - s;
5803 STRLEN backw = end - target;
5805 if (forw < 2 * backw) {
5806 return utf8_length(s, target);
5809 while (end > target) {
5811 while (UTF8_IS_CONTINUATION(*end)) {
5820 =for apidoc sv_pos_b2u
5822 Converts the value pointed to by offsetp from a count of bytes from the
5823 start of the string, to a count of the equivalent number of UTF-8 chars.
5824 Handles magic and type coercion.
5830 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5831 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5836 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5839 const STRLEN byte = *offsetp;
5840 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5849 s = (const U8*)SvPV_const(sv, blen);
5852 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5856 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5857 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5859 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5860 if (cache[1] == byte) {
5861 /* An exact match. */
5862 *offsetp = cache[0];
5865 if (cache[3] == byte) {
5866 /* An exact match. */
5867 *offsetp = cache[2];
5871 if (cache[1] < byte) {
5872 /* We already know part of the way. */
5873 if (mg->mg_len != -1) {
5874 /* Actually, we know the end too. */
5876 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5877 s + blen, mg->mg_len - cache[0]);
5879 len = cache[0] + utf8_length(s + cache[1], send);
5882 else if (cache[3] < byte) {
5883 /* We're between the two cached pairs, so we do the calculation
5884 offset by the byte/utf-8 positions for the earlier pair,
5885 then add the utf-8 characters from the string start to
5887 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5888 s + cache[1], cache[0] - cache[2])
5892 else { /* cache[3] > byte */
5893 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5897 ASSERT_UTF8_CACHE(cache);
5899 } else if (mg->mg_len != -1) {
5900 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5904 if (!found || PL_utf8cache < 0) {
5905 const STRLEN real_len = utf8_length(s, send);
5907 if (found && PL_utf8cache < 0) {
5908 if (len != real_len) {
5909 /* Need to turn the assertions off otherwise we may recurse
5910 infinitely while printing error messages. */
5911 SAVEI8(PL_utf8cache);
5913 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5914 " real %"UVuf" for %"SVf,
5915 (UV) len, (UV) real_len, SVfARG(sv));
5922 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5928 Returns a boolean indicating whether the strings in the two SVs are
5929 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5930 coerce its args to strings if necessary.
5936 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5945 SV* svrecode = NULL;
5952 /* if pv1 and pv2 are the same, second SvPV_const call may
5953 * invalidate pv1, so we may need to make a copy */
5954 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5955 pv1 = SvPV_const(sv1, cur1);
5956 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5957 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5959 pv1 = SvPV_const(sv1, cur1);
5967 pv2 = SvPV_const(sv2, cur2);
5969 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5970 /* Differing utf8ness.
5971 * Do not UTF8size the comparands as a side-effect. */
5974 svrecode = newSVpvn(pv2, cur2);
5975 sv_recode_to_utf8(svrecode, PL_encoding);
5976 pv2 = SvPV_const(svrecode, cur2);
5979 svrecode = newSVpvn(pv1, cur1);
5980 sv_recode_to_utf8(svrecode, PL_encoding);
5981 pv1 = SvPV_const(svrecode, cur1);
5983 /* Now both are in UTF-8. */
5985 SvREFCNT_dec(svrecode);
5990 bool is_utf8 = TRUE;
5993 /* sv1 is the UTF-8 one,
5994 * if is equal it must be downgrade-able */
5995 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6001 /* sv2 is the UTF-8 one,
6002 * if is equal it must be downgrade-able */
6003 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6009 /* Downgrade not possible - cannot be eq */
6017 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6019 SvREFCNT_dec(svrecode);
6029 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6030 string in C<sv1> is less than, equal to, or greater than the string in
6031 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6032 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6038 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6042 const char *pv1, *pv2;
6045 SV *svrecode = NULL;
6052 pv1 = SvPV_const(sv1, cur1);
6059 pv2 = SvPV_const(sv2, cur2);
6061 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6062 /* Differing utf8ness.
6063 * Do not UTF8size the comparands as a side-effect. */
6066 svrecode = newSVpvn(pv2, cur2);
6067 sv_recode_to_utf8(svrecode, PL_encoding);
6068 pv2 = SvPV_const(svrecode, cur2);
6071 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6076 svrecode = newSVpvn(pv1, cur1);
6077 sv_recode_to_utf8(svrecode, PL_encoding);
6078 pv1 = SvPV_const(svrecode, cur1);
6081 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6087 cmp = cur2 ? -1 : 0;
6091 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6094 cmp = retval < 0 ? -1 : 1;
6095 } else if (cur1 == cur2) {
6098 cmp = cur1 < cur2 ? -1 : 1;
6102 SvREFCNT_dec(svrecode);
6110 =for apidoc sv_cmp_locale
6112 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6113 'use bytes' aware, handles get magic, and will coerce its args to strings
6114 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6120 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6123 #ifdef USE_LOCALE_COLLATE
6129 if (PL_collation_standard)
6133 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6135 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6137 if (!pv1 || !len1) {
6148 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6151 return retval < 0 ? -1 : 1;
6154 * When the result of collation is equality, that doesn't mean
6155 * that there are no differences -- some locales exclude some
6156 * characters from consideration. So to avoid false equalities,
6157 * we use the raw string as a tiebreaker.
6163 #endif /* USE_LOCALE_COLLATE */
6165 return sv_cmp(sv1, sv2);
6169 #ifdef USE_LOCALE_COLLATE
6172 =for apidoc sv_collxfrm
6174 Add Collate Transform magic to an SV if it doesn't already have it.
6176 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6177 scalar data of the variable, but transformed to such a format that a normal
6178 memory comparison can be used to compare the data according to the locale
6185 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6190 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6191 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6197 Safefree(mg->mg_ptr);
6198 s = SvPV_const(sv, len);
6199 if ((xf = mem_collxfrm(s, len, &xlen))) {
6200 if (SvREADONLY(sv)) {
6203 return xf + sizeof(PL_collation_ix);
6206 #ifdef PERL_OLD_COPY_ON_WRITE
6208 sv_force_normal_flags(sv, 0);
6210 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6224 if (mg && mg->mg_ptr) {
6226 return mg->mg_ptr + sizeof(PL_collation_ix);
6234 #endif /* USE_LOCALE_COLLATE */
6239 Get a line from the filehandle and store it into the SV, optionally
6240 appending to the currently-stored string.
6246 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6251 register STDCHAR rslast;
6252 register STDCHAR *bp;
6257 if (SvTHINKFIRST(sv))
6258 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6259 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6261 However, perlbench says it's slower, because the existing swipe code
6262 is faster than copy on write.
6263 Swings and roundabouts. */
6264 SvUPGRADE(sv, SVt_PV);
6269 if (PerlIO_isutf8(fp)) {
6271 sv_utf8_upgrade_nomg(sv);
6272 sv_pos_u2b(sv,&append,0);
6274 } else if (SvUTF8(sv)) {
6275 SV * const tsv = newSV(0);
6276 sv_gets(tsv, fp, 0);
6277 sv_utf8_upgrade_nomg(tsv);
6278 SvCUR_set(sv,append);
6281 goto return_string_or_null;
6286 if (PerlIO_isutf8(fp))
6289 if (IN_PERL_COMPILETIME) {
6290 /* we always read code in line mode */
6294 else if (RsSNARF(PL_rs)) {
6295 /* If it is a regular disk file use size from stat() as estimate
6296 of amount we are going to read -- may result in mallocing
6297 more memory than we really need if the layers below reduce
6298 the size we read (e.g. CRLF or a gzip layer).
6301 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6302 const Off_t offset = PerlIO_tell(fp);
6303 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6304 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6310 else if (RsRECORD(PL_rs)) {
6315 /* Grab the size of the record we're getting */
6316 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6317 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6320 /* VMS wants read instead of fread, because fread doesn't respect */
6321 /* RMS record boundaries. This is not necessarily a good thing to be */
6322 /* doing, but we've got no other real choice - except avoid stdio
6323 as implementation - perhaps write a :vms layer ?
6325 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6327 bytesread = PerlIO_read(fp, buffer, recsize);
6331 SvCUR_set(sv, bytesread += append);
6332 buffer[bytesread] = '\0';
6333 goto return_string_or_null;
6335 else if (RsPARA(PL_rs)) {
6341 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6342 if (PerlIO_isutf8(fp)) {
6343 rsptr = SvPVutf8(PL_rs, rslen);
6346 if (SvUTF8(PL_rs)) {
6347 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6348 Perl_croak(aTHX_ "Wide character in $/");
6351 rsptr = SvPV_const(PL_rs, rslen);
6355 rslast = rslen ? rsptr[rslen - 1] : '\0';
6357 if (rspara) { /* have to do this both before and after */
6358 do { /* to make sure file boundaries work right */
6361 i = PerlIO_getc(fp);
6365 PerlIO_ungetc(fp,i);
6371 /* See if we know enough about I/O mechanism to cheat it ! */
6373 /* This used to be #ifdef test - it is made run-time test for ease
6374 of abstracting out stdio interface. One call should be cheap
6375 enough here - and may even be a macro allowing compile
6379 if (PerlIO_fast_gets(fp)) {
6382 * We're going to steal some values from the stdio struct
6383 * and put EVERYTHING in the innermost loop into registers.
6385 register STDCHAR *ptr;
6389 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6390 /* An ungetc()d char is handled separately from the regular
6391 * buffer, so we getc() it back out and stuff it in the buffer.
6393 i = PerlIO_getc(fp);
6394 if (i == EOF) return 0;
6395 *(--((*fp)->_ptr)) = (unsigned char) i;
6399 /* Here is some breathtakingly efficient cheating */
6401 cnt = PerlIO_get_cnt(fp); /* get count into register */
6402 /* make sure we have the room */
6403 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6404 /* Not room for all of it
6405 if we are looking for a separator and room for some
6407 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6408 /* just process what we have room for */
6409 shortbuffered = cnt - SvLEN(sv) + append + 1;
6410 cnt -= shortbuffered;
6414 /* remember that cnt can be negative */
6415 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6420 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6421 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6422 DEBUG_P(PerlIO_printf(Perl_debug_log,
6423 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6424 DEBUG_P(PerlIO_printf(Perl_debug_log,
6425 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6426 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6427 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6432 while (cnt > 0) { /* this | eat */
6434 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6435 goto thats_all_folks; /* screams | sed :-) */
6439 Copy(ptr, bp, cnt, char); /* this | eat */
6440 bp += cnt; /* screams | dust */
6441 ptr += cnt; /* louder | sed :-) */
6446 if (shortbuffered) { /* oh well, must extend */
6447 cnt = shortbuffered;
6449 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6451 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6452 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6456 DEBUG_P(PerlIO_printf(Perl_debug_log,
6457 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6458 PTR2UV(ptr),(long)cnt));
6459 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6461 DEBUG_P(PerlIO_printf(Perl_debug_log,
6462 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6463 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6464 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6466 /* This used to call 'filbuf' in stdio form, but as that behaves like
6467 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6468 another abstraction. */
6469 i = PerlIO_getc(fp); /* get more characters */
6471 DEBUG_P(PerlIO_printf(Perl_debug_log,
6472 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6473 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6474 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6476 cnt = PerlIO_get_cnt(fp);
6477 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6478 DEBUG_P(PerlIO_printf(Perl_debug_log,
6479 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6481 if (i == EOF) /* all done for ever? */
6482 goto thats_really_all_folks;
6484 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6486 SvGROW(sv, bpx + cnt + 2);
6487 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6489 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6491 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6492 goto thats_all_folks;
6496 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6497 memNE((char*)bp - rslen, rsptr, rslen))
6498 goto screamer; /* go back to the fray */
6499 thats_really_all_folks:
6501 cnt += shortbuffered;
6502 DEBUG_P(PerlIO_printf(Perl_debug_log,
6503 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6504 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6505 DEBUG_P(PerlIO_printf(Perl_debug_log,
6506 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6507 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6508 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6510 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6511 DEBUG_P(PerlIO_printf(Perl_debug_log,
6512 "Screamer: done, len=%ld, string=|%.*s|\n",
6513 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6517 /*The big, slow, and stupid way. */
6518 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6519 STDCHAR *buf = NULL;
6520 Newx(buf, 8192, STDCHAR);
6528 register const STDCHAR * const bpe = buf + sizeof(buf);
6530 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6531 ; /* keep reading */
6535 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6536 /* Accomodate broken VAXC compiler, which applies U8 cast to
6537 * both args of ?: operator, causing EOF to change into 255
6540 i = (U8)buf[cnt - 1];
6546 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6548 sv_catpvn(sv, (char *) buf, cnt);
6550 sv_setpvn(sv, (char *) buf, cnt);
6552 if (i != EOF && /* joy */
6554 SvCUR(sv) < rslen ||
6555 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6559 * If we're reading from a TTY and we get a short read,
6560 * indicating that the user hit his EOF character, we need
6561 * to notice it now, because if we try to read from the TTY
6562 * again, the EOF condition will disappear.
6564 * The comparison of cnt to sizeof(buf) is an optimization
6565 * that prevents unnecessary calls to feof().
6569 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6573 #ifdef USE_HEAP_INSTEAD_OF_STACK
6578 if (rspara) { /* have to do this both before and after */
6579 while (i != EOF) { /* to make sure file boundaries work right */
6580 i = PerlIO_getc(fp);
6582 PerlIO_ungetc(fp,i);
6588 return_string_or_null:
6589 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6595 Auto-increment of the value in the SV, doing string to numeric conversion
6596 if necessary. Handles 'get' magic.
6602 Perl_sv_inc(pTHX_ register SV *sv)
6611 if (SvTHINKFIRST(sv)) {
6613 sv_force_normal_flags(sv, 0);
6614 if (SvREADONLY(sv)) {
6615 if (IN_PERL_RUNTIME)
6616 Perl_croak(aTHX_ PL_no_modify);
6620 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6622 i = PTR2IV(SvRV(sv));
6627 flags = SvFLAGS(sv);
6628 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6629 /* It's (privately or publicly) a float, but not tested as an
6630 integer, so test it to see. */
6632 flags = SvFLAGS(sv);
6634 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6635 /* It's publicly an integer, or privately an integer-not-float */
6636 #ifdef PERL_PRESERVE_IVUV
6640 if (SvUVX(sv) == UV_MAX)
6641 sv_setnv(sv, UV_MAX_P1);
6643 (void)SvIOK_only_UV(sv);
6644 SvUV_set(sv, SvUVX(sv) + 1);
6646 if (SvIVX(sv) == IV_MAX)
6647 sv_setuv(sv, (UV)IV_MAX + 1);
6649 (void)SvIOK_only(sv);
6650 SvIV_set(sv, SvIVX(sv) + 1);
6655 if (flags & SVp_NOK) {
6656 (void)SvNOK_only(sv);
6657 SvNV_set(sv, SvNVX(sv) + 1.0);
6661 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6662 if ((flags & SVTYPEMASK) < SVt_PVIV)
6663 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6664 (void)SvIOK_only(sv);
6669 while (isALPHA(*d)) d++;
6670 while (isDIGIT(*d)) d++;
6672 #ifdef PERL_PRESERVE_IVUV
6673 /* Got to punt this as an integer if needs be, but we don't issue
6674 warnings. Probably ought to make the sv_iv_please() that does
6675 the conversion if possible, and silently. */
6676 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6677 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6678 /* Need to try really hard to see if it's an integer.
6679 9.22337203685478e+18 is an integer.
6680 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6681 so $a="9.22337203685478e+18"; $a+0; $a++
6682 needs to be the same as $a="9.22337203685478e+18"; $a++
6689 /* sv_2iv *should* have made this an NV */
6690 if (flags & SVp_NOK) {
6691 (void)SvNOK_only(sv);
6692 SvNV_set(sv, SvNVX(sv) + 1.0);
6695 /* I don't think we can get here. Maybe I should assert this
6696 And if we do get here I suspect that sv_setnv will croak. NWC
6698 #if defined(USE_LONG_DOUBLE)
6699 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",
6700 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6702 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6703 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6706 #endif /* PERL_PRESERVE_IVUV */
6707 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6711 while (d >= SvPVX_const(sv)) {
6719 /* MKS: The original code here died if letters weren't consecutive.
6720 * at least it didn't have to worry about non-C locales. The
6721 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6722 * arranged in order (although not consecutively) and that only
6723 * [A-Za-z] are accepted by isALPHA in the C locale.
6725 if (*d != 'z' && *d != 'Z') {
6726 do { ++*d; } while (!isALPHA(*d));
6729 *(d--) -= 'z' - 'a';
6734 *(d--) -= 'z' - 'a' + 1;
6738 /* oh,oh, the number grew */
6739 SvGROW(sv, SvCUR(sv) + 2);
6740 SvCUR_set(sv, SvCUR(sv) + 1);
6741 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6752 Auto-decrement of the value in the SV, doing string to numeric conversion
6753 if necessary. Handles 'get' magic.
6759 Perl_sv_dec(pTHX_ register SV *sv)
6767 if (SvTHINKFIRST(sv)) {
6769 sv_force_normal_flags(sv, 0);
6770 if (SvREADONLY(sv)) {
6771 if (IN_PERL_RUNTIME)
6772 Perl_croak(aTHX_ PL_no_modify);
6776 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6778 i = PTR2IV(SvRV(sv));
6783 /* Unlike sv_inc we don't have to worry about string-never-numbers
6784 and keeping them magic. But we mustn't warn on punting */
6785 flags = SvFLAGS(sv);
6786 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6787 /* It's publicly an integer, or privately an integer-not-float */
6788 #ifdef PERL_PRESERVE_IVUV
6792 if (SvUVX(sv) == 0) {
6793 (void)SvIOK_only(sv);
6797 (void)SvIOK_only_UV(sv);
6798 SvUV_set(sv, SvUVX(sv) - 1);
6801 if (SvIVX(sv) == IV_MIN)
6802 sv_setnv(sv, (NV)IV_MIN - 1.0);
6804 (void)SvIOK_only(sv);
6805 SvIV_set(sv, SvIVX(sv) - 1);
6810 if (flags & SVp_NOK) {
6811 SvNV_set(sv, SvNVX(sv) - 1.0);
6812 (void)SvNOK_only(sv);
6815 if (!(flags & SVp_POK)) {
6816 if ((flags & SVTYPEMASK) < SVt_PVIV)
6817 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6819 (void)SvIOK_only(sv);
6822 #ifdef PERL_PRESERVE_IVUV
6824 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6825 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6826 /* Need to try really hard to see if it's an integer.
6827 9.22337203685478e+18 is an integer.
6828 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6829 so $a="9.22337203685478e+18"; $a+0; $a--
6830 needs to be the same as $a="9.22337203685478e+18"; $a--
6837 /* sv_2iv *should* have made this an NV */
6838 if (flags & SVp_NOK) {
6839 (void)SvNOK_only(sv);
6840 SvNV_set(sv, SvNVX(sv) - 1.0);
6843 /* I don't think we can get here. Maybe I should assert this
6844 And if we do get here I suspect that sv_setnv will croak. NWC
6846 #if defined(USE_LONG_DOUBLE)
6847 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",
6848 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6850 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6851 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6855 #endif /* PERL_PRESERVE_IVUV */
6856 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6860 =for apidoc sv_mortalcopy
6862 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6863 The new SV is marked as mortal. It will be destroyed "soon", either by an
6864 explicit call to FREETMPS, or by an implicit call at places such as
6865 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6870 /* Make a string that will exist for the duration of the expression
6871 * evaluation. Actually, it may have to last longer than that, but
6872 * hopefully we won't free it until it has been assigned to a
6873 * permanent location. */
6876 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6882 sv_setsv(sv,oldstr);
6884 PL_tmps_stack[++PL_tmps_ix] = sv;
6890 =for apidoc sv_newmortal
6892 Creates a new null SV which is mortal. The reference count of the SV is
6893 set to 1. It will be destroyed "soon", either by an explicit call to
6894 FREETMPS, or by an implicit call at places such as statement boundaries.
6895 See also C<sv_mortalcopy> and C<sv_2mortal>.
6901 Perl_sv_newmortal(pTHX)
6907 SvFLAGS(sv) = SVs_TEMP;
6909 PL_tmps_stack[++PL_tmps_ix] = sv;
6914 =for apidoc sv_2mortal
6916 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6917 by an explicit call to FREETMPS, or by an implicit call at places such as
6918 statement boundaries. SvTEMP() is turned on which means that the SV's
6919 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6920 and C<sv_mortalcopy>.
6926 Perl_sv_2mortal(pTHX_ register SV *sv)
6931 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6934 PL_tmps_stack[++PL_tmps_ix] = sv;
6942 Creates a new SV and copies a string into it. The reference count for the
6943 SV is set to 1. If C<len> is zero, Perl will compute the length using
6944 strlen(). For efficiency, consider using C<newSVpvn> instead.
6950 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6956 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6961 =for apidoc newSVpvn
6963 Creates a new SV and copies a string into it. The reference count for the
6964 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6965 string. You are responsible for ensuring that the source string is at least
6966 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6972 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6978 sv_setpvn(sv,s,len);
6984 =for apidoc newSVhek
6986 Creates a new SV from the hash key structure. It will generate scalars that
6987 point to the shared string table where possible. Returns a new (undefined)
6988 SV if the hek is NULL.
6994 Perl_newSVhek(pTHX_ const HEK *hek)
7004 if (HEK_LEN(hek) == HEf_SVKEY) {
7005 return newSVsv(*(SV**)HEK_KEY(hek));
7007 const int flags = HEK_FLAGS(hek);
7008 if (flags & HVhek_WASUTF8) {
7010 Andreas would like keys he put in as utf8 to come back as utf8
7012 STRLEN utf8_len = HEK_LEN(hek);
7013 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7014 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7017 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7019 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7020 /* We don't have a pointer to the hv, so we have to replicate the
7021 flag into every HEK. This hv is using custom a hasing
7022 algorithm. Hence we can't return a shared string scalar, as
7023 that would contain the (wrong) hash value, and might get passed
7024 into an hv routine with a regular hash.
7025 Similarly, a hash that isn't using shared hash keys has to have
7026 the flag in every key so that we know not to try to call
7027 share_hek_kek on it. */
7029 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7034 /* This will be overwhelminly the most common case. */
7036 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7037 more efficient than sharepvn(). */
7041 sv_upgrade(sv, SVt_PV);
7042 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7043 SvCUR_set(sv, HEK_LEN(hek));
7056 =for apidoc newSVpvn_share
7058 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7059 table. If the string does not already exist in the table, it is created
7060 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7061 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7062 otherwise the hash is computed. The idea here is that as the string table
7063 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7064 hash lookup will avoid string compare.
7070 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7074 bool is_utf8 = FALSE;
7075 const char *const orig_src = src;
7078 STRLEN tmplen = -len;
7080 /* See the note in hv.c:hv_fetch() --jhi */
7081 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7085 PERL_HASH(hash, src, len);
7087 sv_upgrade(sv, SVt_PV);
7088 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7096 if (src != orig_src)
7102 #if defined(PERL_IMPLICIT_CONTEXT)
7104 /* pTHX_ magic can't cope with varargs, so this is a no-context
7105 * version of the main function, (which may itself be aliased to us).
7106 * Don't access this version directly.
7110 Perl_newSVpvf_nocontext(const char* pat, ...)
7115 va_start(args, pat);
7116 sv = vnewSVpvf(pat, &args);
7123 =for apidoc newSVpvf
7125 Creates a new SV and initializes it with the string formatted like
7132 Perl_newSVpvf(pTHX_ const char* pat, ...)
7136 va_start(args, pat);
7137 sv = vnewSVpvf(pat, &args);
7142 /* backend for newSVpvf() and newSVpvf_nocontext() */
7145 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7150 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7157 Creates a new SV and copies a floating point value into it.
7158 The reference count for the SV is set to 1.
7164 Perl_newSVnv(pTHX_ NV n)
7177 Creates a new SV and copies an integer into it. The reference count for the
7184 Perl_newSViv(pTHX_ IV i)
7197 Creates a new SV and copies an unsigned integer into it.
7198 The reference count for the SV is set to 1.
7204 Perl_newSVuv(pTHX_ UV u)
7215 =for apidoc newSV_type
7217 Creates a new SV, of the type specificied. The reference count for the new SV
7224 Perl_newSV_type(pTHX_ svtype type)
7229 sv_upgrade(sv, type);
7234 =for apidoc newRV_noinc
7236 Creates an RV wrapper for an SV. The reference count for the original
7237 SV is B<not> incremented.
7243 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7246 register SV *sv = newSV_type(SVt_RV);
7248 SvRV_set(sv, tmpRef);
7253 /* newRV_inc is the official function name to use now.
7254 * newRV_inc is in fact #defined to newRV in sv.h
7258 Perl_newRV(pTHX_ SV *sv)
7261 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7267 Creates a new SV which is an exact duplicate of the original SV.
7274 Perl_newSVsv(pTHX_ register SV *old)
7281 if (SvTYPE(old) == SVTYPEMASK) {
7282 if (ckWARN_d(WARN_INTERNAL))
7283 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7287 /* SV_GMAGIC is the default for sv_setv()
7288 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7289 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7290 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7295 =for apidoc sv_reset
7297 Underlying implementation for the C<reset> Perl function.
7298 Note that the perl-level function is vaguely deprecated.
7304 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7307 char todo[PERL_UCHAR_MAX+1];
7312 if (!*s) { /* reset ?? searches */
7313 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7315 const U32 count = mg->mg_len / sizeof(PMOP**);
7316 PMOP **pmp = (PMOP**) mg->mg_ptr;
7317 PMOP *const *const end = pmp + count;
7321 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7323 (*pmp)->op_pmflags &= ~PMf_USED;
7331 /* reset variables */
7333 if (!HvARRAY(stash))
7336 Zero(todo, 256, char);
7339 I32 i = (unsigned char)*s;
7343 max = (unsigned char)*s++;
7344 for ( ; i <= max; i++) {
7347 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7349 for (entry = HvARRAY(stash)[i];
7351 entry = HeNEXT(entry))
7356 if (!todo[(U8)*HeKEY(entry)])
7358 gv = (GV*)HeVAL(entry);
7361 if (SvTHINKFIRST(sv)) {
7362 if (!SvREADONLY(sv) && SvROK(sv))
7364 /* XXX Is this continue a bug? Why should THINKFIRST
7365 exempt us from resetting arrays and hashes? */
7369 if (SvTYPE(sv) >= SVt_PV) {
7371 if (SvPVX_const(sv) != NULL)
7379 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7381 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7384 # if defined(USE_ENVIRON_ARRAY)
7387 # endif /* USE_ENVIRON_ARRAY */
7398 Using various gambits, try to get an IO from an SV: the IO slot if its a
7399 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7400 named after the PV if we're a string.
7406 Perl_sv_2io(pTHX_ SV *sv)
7411 switch (SvTYPE(sv)) {
7419 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7423 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7425 return sv_2io(SvRV(sv));
7426 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7432 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7441 Using various gambits, try to get a CV from an SV; in addition, try if
7442 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7443 The flags in C<lref> are passed to sv_fetchsv.
7449 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7460 switch (SvTYPE(sv)) {
7479 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7480 tryAMAGICunDEREF(to_cv);
7483 if (SvTYPE(sv) == SVt_PVCV) {
7492 Perl_croak(aTHX_ "Not a subroutine reference");
7497 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7503 /* Some flags to gv_fetchsv mean don't really create the GV */
7504 if (SvTYPE(gv) != SVt_PVGV) {
7510 if (lref && !GvCVu(gv)) {
7514 gv_efullname3(tmpsv, gv, NULL);
7515 /* XXX this is probably not what they think they're getting.
7516 * It has the same effect as "sub name;", i.e. just a forward
7518 newSUB(start_subparse(FALSE, 0),
7519 newSVOP(OP_CONST, 0, tmpsv),
7523 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7533 Returns true if the SV has a true value by Perl's rules.
7534 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7535 instead use an in-line version.
7541 Perl_sv_true(pTHX_ register SV *sv)
7546 register const XPV* const tXpv = (XPV*)SvANY(sv);
7548 (tXpv->xpv_cur > 1 ||
7549 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7556 return SvIVX(sv) != 0;
7559 return SvNVX(sv) != 0.0;
7561 return sv_2bool(sv);
7567 =for apidoc sv_pvn_force
7569 Get a sensible string out of the SV somehow.
7570 A private implementation of the C<SvPV_force> macro for compilers which
7571 can't cope with complex macro expressions. Always use the macro instead.
7573 =for apidoc sv_pvn_force_flags
7575 Get a sensible string out of the SV somehow.
7576 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7577 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7578 implemented in terms of this function.
7579 You normally want to use the various wrapper macros instead: see
7580 C<SvPV_force> and C<SvPV_force_nomg>
7586 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7589 if (SvTHINKFIRST(sv) && !SvROK(sv))
7590 sv_force_normal_flags(sv, 0);
7600 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7601 const char * const ref = sv_reftype(sv,0);
7603 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7604 ref, OP_NAME(PL_op));
7606 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7608 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7609 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7611 s = sv_2pv_flags(sv, &len, flags);
7615 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7618 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7619 SvGROW(sv, len + 1);
7620 Move(s,SvPVX(sv),len,char);
7622 SvPVX(sv)[len] = '\0';
7625 SvPOK_on(sv); /* validate pointer */
7627 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7628 PTR2UV(sv),SvPVX_const(sv)));
7631 return SvPVX_mutable(sv);
7635 =for apidoc sv_pvbyten_force
7637 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7643 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7645 sv_pvn_force(sv,lp);
7646 sv_utf8_downgrade(sv,0);
7652 =for apidoc sv_pvutf8n_force
7654 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7660 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7662 sv_pvn_force(sv,lp);
7663 sv_utf8_upgrade(sv);
7669 =for apidoc sv_reftype
7671 Returns a string describing what the SV is a reference to.
7677 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7679 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7680 inside return suggests a const propagation bug in g++. */
7681 if (ob && SvOBJECT(sv)) {
7682 char * const name = HvNAME_get(SvSTASH(sv));
7683 return name ? name : (char *) "__ANON__";
7686 switch (SvTYPE(sv)) {
7702 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7703 /* tied lvalues should appear to be
7704 * scalars for backwards compatitbility */
7705 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7706 ? "SCALAR" : "LVALUE");
7707 case SVt_PVAV: return "ARRAY";
7708 case SVt_PVHV: return "HASH";
7709 case SVt_PVCV: return "CODE";
7710 case SVt_PVGV: return "GLOB";
7711 case SVt_PVFM: return "FORMAT";
7712 case SVt_PVIO: return "IO";
7713 case SVt_BIND: return "BIND";
7714 default: return "UNKNOWN";
7720 =for apidoc sv_isobject
7722 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7723 object. If the SV is not an RV, or if the object is not blessed, then this
7730 Perl_sv_isobject(pTHX_ SV *sv)
7746 Returns a boolean indicating whether the SV is blessed into the specified
7747 class. This does not check for subtypes; use C<sv_derived_from> to verify
7748 an inheritance relationship.
7754 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7765 hvname = HvNAME_get(SvSTASH(sv));
7769 return strEQ(hvname, name);
7775 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7776 it will be upgraded to one. If C<classname> is non-null then the new SV will
7777 be blessed in the specified package. The new SV is returned and its
7778 reference count is 1.
7784 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7791 SV_CHECK_THINKFIRST_COW_DROP(rv);
7792 (void)SvAMAGIC_off(rv);
7794 if (SvTYPE(rv) >= SVt_PVMG) {
7795 const U32 refcnt = SvREFCNT(rv);
7799 SvREFCNT(rv) = refcnt;
7801 sv_upgrade(rv, SVt_RV);
7802 } else if (SvROK(rv)) {
7803 SvREFCNT_dec(SvRV(rv));
7804 } else if (SvTYPE(rv) < SVt_RV)
7805 sv_upgrade(rv, SVt_RV);
7806 else if (SvTYPE(rv) > SVt_RV) {
7817 HV* const stash = gv_stashpv(classname, GV_ADD);
7818 (void)sv_bless(rv, stash);
7824 =for apidoc sv_setref_pv
7826 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7827 argument will be upgraded to an RV. That RV will be modified to point to
7828 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7829 into the SV. The C<classname> argument indicates the package for the
7830 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7831 will have a reference count of 1, and the RV will be returned.
7833 Do not use with other Perl types such as HV, AV, SV, CV, because those
7834 objects will become corrupted by the pointer copy process.
7836 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7842 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7846 sv_setsv(rv, &PL_sv_undef);
7850 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7855 =for apidoc sv_setref_iv
7857 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7858 argument will be upgraded to an RV. That RV will be modified to point to
7859 the new SV. The C<classname> argument indicates the package for the
7860 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7861 will have a reference count of 1, and the RV will be returned.
7867 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7869 sv_setiv(newSVrv(rv,classname), iv);
7874 =for apidoc sv_setref_uv
7876 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7877 argument will be upgraded to an RV. That RV will be modified to point to
7878 the new SV. The C<classname> argument indicates the package for the
7879 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7880 will have a reference count of 1, and the RV will be returned.
7886 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7888 sv_setuv(newSVrv(rv,classname), uv);
7893 =for apidoc sv_setref_nv
7895 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7896 argument will be upgraded to an RV. That RV will be modified to point to
7897 the new SV. The C<classname> argument indicates the package for the
7898 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7899 will have a reference count of 1, and the RV will be returned.
7905 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7907 sv_setnv(newSVrv(rv,classname), nv);
7912 =for apidoc sv_setref_pvn
7914 Copies a string into a new SV, optionally blessing the SV. The length of the
7915 string must be specified with C<n>. The C<rv> argument will be upgraded to
7916 an RV. That RV will be modified to point to the new SV. The C<classname>
7917 argument indicates the package for the blessing. Set C<classname> to
7918 C<NULL> to avoid the blessing. The new SV will have a reference count
7919 of 1, and the RV will be returned.
7921 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7927 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7929 sv_setpvn(newSVrv(rv,classname), pv, n);
7934 =for apidoc sv_bless
7936 Blesses an SV into a specified package. The SV must be an RV. The package
7937 must be designated by its stash (see C<gv_stashpv()>). The reference count
7938 of the SV is unaffected.
7944 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7949 Perl_croak(aTHX_ "Can't bless non-reference value");
7951 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7952 if (SvREADONLY(tmpRef))
7953 Perl_croak(aTHX_ PL_no_modify);
7954 if (SvOBJECT(tmpRef)) {
7955 if (SvTYPE(tmpRef) != SVt_PVIO)
7957 SvREFCNT_dec(SvSTASH(tmpRef));
7960 SvOBJECT_on(tmpRef);
7961 if (SvTYPE(tmpRef) != SVt_PVIO)
7963 SvUPGRADE(tmpRef, SVt_PVMG);
7964 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7969 (void)SvAMAGIC_off(sv);
7971 if(SvSMAGICAL(tmpRef))
7972 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7980 /* Downgrades a PVGV to a PVMG.
7984 S_sv_unglob(pTHX_ SV *sv)
7989 SV * const temp = sv_newmortal();
7991 assert(SvTYPE(sv) == SVt_PVGV);
7993 gv_efullname3(temp, (GV *) sv, "*");
7996 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
7997 mro_method_changed_in(stash);
8001 sv_del_backref((SV*)GvSTASH(sv), sv);
8005 if (GvNAME_HEK(sv)) {
8006 unshare_hek(GvNAME_HEK(sv));
8008 isGV_with_GP_off(sv);
8010 /* need to keep SvANY(sv) in the right arena */
8011 xpvmg = new_XPVMG();
8012 StructCopy(SvANY(sv), xpvmg, XPVMG);
8013 del_XPVGV(SvANY(sv));
8016 SvFLAGS(sv) &= ~SVTYPEMASK;
8017 SvFLAGS(sv) |= SVt_PVMG;
8019 /* Intentionally not calling any local SET magic, as this isn't so much a
8020 set operation as merely an internal storage change. */
8021 sv_setsv_flags(sv, temp, 0);
8025 =for apidoc sv_unref_flags
8027 Unsets the RV status of the SV, and decrements the reference count of
8028 whatever was being referenced by the RV. This can almost be thought of
8029 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8030 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8031 (otherwise the decrementing is conditional on the reference count being
8032 different from one or the reference being a readonly SV).
8039 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8041 SV* const target = SvRV(ref);
8043 if (SvWEAKREF(ref)) {
8044 sv_del_backref(target, ref);
8046 SvRV_set(ref, NULL);
8049 SvRV_set(ref, NULL);
8051 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8052 assigned to as BEGIN {$a = \"Foo"} will fail. */
8053 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8054 SvREFCNT_dec(target);
8055 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8056 sv_2mortal(target); /* Schedule for freeing later */
8060 =for apidoc sv_untaint
8062 Untaint an SV. Use C<SvTAINTED_off> instead.
8067 Perl_sv_untaint(pTHX_ SV *sv)
8069 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8070 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8077 =for apidoc sv_tainted
8079 Test an SV for taintedness. Use C<SvTAINTED> instead.
8084 Perl_sv_tainted(pTHX_ SV *sv)
8086 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8087 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8088 if (mg && (mg->mg_len & 1) )
8095 =for apidoc sv_setpviv
8097 Copies an integer into the given SV, also updating its string value.
8098 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8104 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8106 char buf[TYPE_CHARS(UV)];
8108 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8110 sv_setpvn(sv, ptr, ebuf - ptr);
8114 =for apidoc sv_setpviv_mg
8116 Like C<sv_setpviv>, but also handles 'set' magic.
8122 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8128 #if defined(PERL_IMPLICIT_CONTEXT)
8130 /* pTHX_ magic can't cope with varargs, so this is a no-context
8131 * version of the main function, (which may itself be aliased to us).
8132 * Don't access this version directly.
8136 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8140 va_start(args, pat);
8141 sv_vsetpvf(sv, pat, &args);
8145 /* pTHX_ magic can't cope with varargs, so this is a no-context
8146 * version of the main function, (which may itself be aliased to us).
8147 * Don't access this version directly.
8151 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8155 va_start(args, pat);
8156 sv_vsetpvf_mg(sv, pat, &args);
8162 =for apidoc sv_setpvf
8164 Works like C<sv_catpvf> but copies the text into the SV instead of
8165 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8171 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8174 va_start(args, pat);
8175 sv_vsetpvf(sv, pat, &args);
8180 =for apidoc sv_vsetpvf
8182 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8183 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8185 Usually used via its frontend C<sv_setpvf>.
8191 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8193 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8197 =for apidoc sv_setpvf_mg
8199 Like C<sv_setpvf>, but also handles 'set' magic.
8205 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8208 va_start(args, pat);
8209 sv_vsetpvf_mg(sv, pat, &args);
8214 =for apidoc sv_vsetpvf_mg
8216 Like C<sv_vsetpvf>, but also handles 'set' magic.
8218 Usually used via its frontend C<sv_setpvf_mg>.
8224 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8226 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8230 #if defined(PERL_IMPLICIT_CONTEXT)
8232 /* pTHX_ magic can't cope with varargs, so this is a no-context
8233 * version of the main function, (which may itself be aliased to us).
8234 * Don't access this version directly.
8238 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8242 va_start(args, pat);
8243 sv_vcatpvf(sv, pat, &args);
8247 /* pTHX_ magic can't cope with varargs, so this is a no-context
8248 * version of the main function, (which may itself be aliased to us).
8249 * Don't access this version directly.
8253 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8257 va_start(args, pat);
8258 sv_vcatpvf_mg(sv, pat, &args);
8264 =for apidoc sv_catpvf
8266 Processes its arguments like C<sprintf> and appends the formatted
8267 output to an SV. If the appended data contains "wide" characters
8268 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8269 and characters >255 formatted with %c), the original SV might get
8270 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8271 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8272 valid UTF-8; if the original SV was bytes, the pattern should be too.
8277 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8280 va_start(args, pat);
8281 sv_vcatpvf(sv, pat, &args);
8286 =for apidoc sv_vcatpvf
8288 Processes its arguments like C<vsprintf> and appends the formatted output
8289 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8291 Usually used via its frontend C<sv_catpvf>.
8297 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8299 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8303 =for apidoc sv_catpvf_mg
8305 Like C<sv_catpvf>, but also handles 'set' magic.
8311 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8314 va_start(args, pat);
8315 sv_vcatpvf_mg(sv, pat, &args);
8320 =for apidoc sv_vcatpvf_mg
8322 Like C<sv_vcatpvf>, but also handles 'set' magic.
8324 Usually used via its frontend C<sv_catpvf_mg>.
8330 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8332 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8337 =for apidoc sv_vsetpvfn
8339 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8342 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8348 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8350 sv_setpvn(sv, "", 0);
8351 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8355 S_expect_number(pTHX_ char** pattern)
8359 switch (**pattern) {
8360 case '1': case '2': case '3':
8361 case '4': case '5': case '6':
8362 case '7': case '8': case '9':
8363 var = *(*pattern)++ - '0';
8364 while (isDIGIT(**pattern)) {
8365 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8367 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8375 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8377 const int neg = nv < 0;
8386 if (uv & 1 && uv == nv)
8387 uv--; /* Round to even */
8389 const unsigned dig = uv % 10;
8402 =for apidoc sv_vcatpvfn
8404 Processes its arguments like C<vsprintf> and appends the formatted output
8405 to an SV. Uses an array of SVs if the C style variable argument list is
8406 missing (NULL). When running with taint checks enabled, indicates via
8407 C<maybe_tainted> if results are untrustworthy (often due to the use of
8410 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8416 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8417 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8418 vec_utf8 = DO_UTF8(vecsv);
8420 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8423 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8431 static const char nullstr[] = "(null)";
8433 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8434 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8436 /* Times 4: a decimal digit takes more than 3 binary digits.
8437 * NV_DIG: mantissa takes than many decimal digits.
8438 * Plus 32: Playing safe. */
8439 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8440 /* large enough for "%#.#f" --chip */
8441 /* what about long double NVs? --jhi */
8443 PERL_UNUSED_ARG(maybe_tainted);
8445 /* no matter what, this is a string now */
8446 (void)SvPV_force(sv, origlen);
8448 /* special-case "", "%s", and "%-p" (SVf - see below) */
8451 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8453 const char * const s = va_arg(*args, char*);
8454 sv_catpv(sv, s ? s : nullstr);
8456 else if (svix < svmax) {
8457 sv_catsv(sv, *svargs);
8461 if (args && patlen == 3 && pat[0] == '%' &&
8462 pat[1] == '-' && pat[2] == 'p') {
8463 argsv = (SV*)va_arg(*args, void*);
8464 sv_catsv(sv, argsv);
8468 #ifndef USE_LONG_DOUBLE
8469 /* special-case "%.<number>[gf]" */
8470 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8471 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8472 unsigned digits = 0;
8476 while (*pp >= '0' && *pp <= '9')
8477 digits = 10 * digits + (*pp++ - '0');
8478 if (pp - pat == (int)patlen - 1) {
8486 /* Add check for digits != 0 because it seems that some
8487 gconverts are buggy in this case, and we don't yet have
8488 a Configure test for this. */
8489 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8490 /* 0, point, slack */
8491 Gconvert(nv, (int)digits, 0, ebuf);
8493 if (*ebuf) /* May return an empty string for digits==0 */
8496 } else if (!digits) {
8499 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8500 sv_catpvn(sv, p, l);
8506 #endif /* !USE_LONG_DOUBLE */
8508 if (!args && svix < svmax && DO_UTF8(*svargs))
8511 patend = (char*)pat + patlen;
8512 for (p = (char*)pat; p < patend; p = q) {
8515 bool vectorize = FALSE;
8516 bool vectorarg = FALSE;
8517 bool vec_utf8 = FALSE;
8523 bool has_precis = FALSE;
8525 const I32 osvix = svix;
8526 bool is_utf8 = FALSE; /* is this item utf8? */
8527 #ifdef HAS_LDBL_SPRINTF_BUG
8528 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8529 with sfio - Allen <allens@cpan.org> */
8530 bool fix_ldbl_sprintf_bug = FALSE;
8534 U8 utf8buf[UTF8_MAXBYTES+1];
8535 STRLEN esignlen = 0;
8537 const char *eptr = NULL;
8540 const U8 *vecstr = NULL;
8547 /* we need a long double target in case HAS_LONG_DOUBLE but
8550 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8558 const char *dotstr = ".";
8559 STRLEN dotstrlen = 1;
8560 I32 efix = 0; /* explicit format parameter index */
8561 I32 ewix = 0; /* explicit width index */
8562 I32 epix = 0; /* explicit precision index */
8563 I32 evix = 0; /* explicit vector index */
8564 bool asterisk = FALSE;
8566 /* echo everything up to the next format specification */
8567 for (q = p; q < patend && *q != '%'; ++q) ;
8569 if (has_utf8 && !pat_utf8)
8570 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8572 sv_catpvn(sv, p, q - p);
8579 We allow format specification elements in this order:
8580 \d+\$ explicit format parameter index
8582 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8583 0 flag (as above): repeated to allow "v02"
8584 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8585 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8587 [%bcdefginopsuxDFOUX] format (mandatory)
8592 As of perl5.9.3, printf format checking is on by default.
8593 Internally, perl uses %p formats to provide an escape to
8594 some extended formatting. This block deals with those
8595 extensions: if it does not match, (char*)q is reset and
8596 the normal format processing code is used.
8598 Currently defined extensions are:
8599 %p include pointer address (standard)
8600 %-p (SVf) include an SV (previously %_)
8601 %-<num>p include an SV with precision <num>
8602 %1p (VDf) include a v-string (as %vd)
8603 %<num>p reserved for future extensions
8605 Robin Barker 2005-07-14
8612 n = expect_number(&q);
8619 argsv = (SV*)va_arg(*args, void*);
8620 eptr = SvPV_const(argsv, elen);
8626 else if (n == vdNUMBER) { /* VDf */
8633 if (ckWARN_d(WARN_INTERNAL))
8634 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8635 "internal %%<num>p might conflict with future printf extensions");
8641 if ( (width = expect_number(&q)) ) {
8656 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8685 if ( (ewix = expect_number(&q)) )
8694 if ((vectorarg = asterisk)) {
8707 width = expect_number(&q);
8713 vecsv = va_arg(*args, SV*);
8715 vecsv = (evix > 0 && evix <= svmax)
8716 ? svargs[evix-1] : &PL_sv_undef;
8718 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8720 dotstr = SvPV_const(vecsv, dotstrlen);
8721 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8722 bad with tied or overloaded values that return UTF8. */
8725 else if (has_utf8) {
8726 vecsv = sv_mortalcopy(vecsv);
8727 sv_utf8_upgrade(vecsv);
8728 dotstr = SvPV_const(vecsv, dotstrlen);
8735 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8736 vecsv = svargs[efix ? efix-1 : svix++];
8737 vecstr = (U8*)SvPV_const(vecsv,veclen);
8738 vec_utf8 = DO_UTF8(vecsv);
8740 /* if this is a version object, we need to convert
8741 * back into v-string notation and then let the
8742 * vectorize happen normally
8744 if (sv_derived_from(vecsv, "version")) {
8745 char *version = savesvpv(vecsv);
8746 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8747 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8748 "vector argument not supported with alpha versions");
8751 vecsv = sv_newmortal();
8752 scan_vstring(version, version + veclen, vecsv);
8753 vecstr = (U8*)SvPV_const(vecsv, veclen);
8754 vec_utf8 = DO_UTF8(vecsv);
8766 i = va_arg(*args, int);
8768 i = (ewix ? ewix <= svmax : svix < svmax) ?
8769 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8771 width = (i < 0) ? -i : i;
8781 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8783 /* XXX: todo, support specified precision parameter */
8787 i = va_arg(*args, int);
8789 i = (ewix ? ewix <= svmax : svix < svmax)
8790 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8792 has_precis = !(i < 0);
8797 precis = precis * 10 + (*q++ - '0');
8806 case 'I': /* Ix, I32x, and I64x */
8808 if (q[1] == '6' && q[2] == '4') {
8814 if (q[1] == '3' && q[2] == '2') {
8824 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8835 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8836 if (*(q + 1) == 'l') { /* lld, llf */
8862 if (!vectorize && !args) {
8864 const I32 i = efix-1;
8865 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8867 argsv = (svix >= 0 && svix < svmax)
8868 ? svargs[svix++] : &PL_sv_undef;
8879 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8881 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8883 eptr = (char*)utf8buf;
8884 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8898 eptr = va_arg(*args, char*);
8900 #ifdef MACOS_TRADITIONAL
8901 /* On MacOS, %#s format is used for Pascal strings */
8906 elen = strlen(eptr);
8908 eptr = (char *)nullstr;
8909 elen = sizeof nullstr - 1;
8913 eptr = SvPV_const(argsv, elen);
8914 if (DO_UTF8(argsv)) {
8915 I32 old_precis = precis;
8916 if (has_precis && precis < elen) {
8918 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8921 if (width) { /* fudge width (can't fudge elen) */
8922 if (has_precis && precis < elen)
8923 width += precis - old_precis;
8925 width += elen - sv_len_utf8(argsv);
8932 if (has_precis && elen > precis)
8939 if (alt || vectorize)
8941 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8962 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8971 esignbuf[esignlen++] = plus;
8975 case 'h': iv = (short)va_arg(*args, int); break;
8976 case 'l': iv = va_arg(*args, long); break;
8977 case 'V': iv = va_arg(*args, IV); break;
8978 default: iv = va_arg(*args, int); break;
8980 case 'q': iv = va_arg(*args, Quad_t); break;
8985 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
8987 case 'h': iv = (short)tiv; break;
8988 case 'l': iv = (long)tiv; break;
8990 default: iv = tiv; break;
8992 case 'q': iv = (Quad_t)tiv; break;
8996 if ( !vectorize ) /* we already set uv above */
9001 esignbuf[esignlen++] = plus;
9005 esignbuf[esignlen++] = '-';
9049 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9060 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9061 case 'l': uv = va_arg(*args, unsigned long); break;
9062 case 'V': uv = va_arg(*args, UV); break;
9063 default: uv = va_arg(*args, unsigned); break;
9065 case 'q': uv = va_arg(*args, Uquad_t); break;
9070 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9072 case 'h': uv = (unsigned short)tuv; break;
9073 case 'l': uv = (unsigned long)tuv; break;
9075 default: uv = tuv; break;
9077 case 'q': uv = (Uquad_t)tuv; break;
9084 char *ptr = ebuf + sizeof ebuf;
9085 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9091 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9097 esignbuf[esignlen++] = '0';
9098 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9106 if (alt && *ptr != '0')
9115 esignbuf[esignlen++] = '0';
9116 esignbuf[esignlen++] = c;
9119 default: /* it had better be ten or less */
9123 } while (uv /= base);
9126 elen = (ebuf + sizeof ebuf) - ptr;
9130 zeros = precis - elen;
9131 else if (precis == 0 && elen == 1 && *eptr == '0'
9132 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9135 /* a precision nullifies the 0 flag. */
9142 /* FLOATING POINT */
9145 c = 'f'; /* maybe %F isn't supported here */
9153 /* This is evil, but floating point is even more evil */
9155 /* for SV-style calling, we can only get NV
9156 for C-style calling, we assume %f is double;
9157 for simplicity we allow any of %Lf, %llf, %qf for long double
9161 #if defined(USE_LONG_DOUBLE)
9165 /* [perl #20339] - we should accept and ignore %lf rather than die */
9169 #if defined(USE_LONG_DOUBLE)
9170 intsize = args ? 0 : 'q';
9174 #if defined(HAS_LONG_DOUBLE)
9183 /* now we need (long double) if intsize == 'q', else (double) */
9185 #if LONG_DOUBLESIZE > DOUBLESIZE
9187 va_arg(*args, long double) :
9188 va_arg(*args, double)
9190 va_arg(*args, double)
9195 if (c != 'e' && c != 'E') {
9197 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9198 will cast our (long double) to (double) */
9199 (void)Perl_frexp(nv, &i);
9200 if (i == PERL_INT_MIN)
9201 Perl_die(aTHX_ "panic: frexp");
9203 need = BIT_DIGITS(i);
9205 need += has_precis ? precis : 6; /* known default */
9210 #ifdef HAS_LDBL_SPRINTF_BUG
9211 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9212 with sfio - Allen <allens@cpan.org> */
9215 # define MY_DBL_MAX DBL_MAX
9216 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9217 # if DOUBLESIZE >= 8
9218 # define MY_DBL_MAX 1.7976931348623157E+308L
9220 # define MY_DBL_MAX 3.40282347E+38L
9224 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9225 # define MY_DBL_MAX_BUG 1L
9227 # define MY_DBL_MAX_BUG MY_DBL_MAX
9231 # define MY_DBL_MIN DBL_MIN
9232 # else /* XXX guessing! -Allen */
9233 # if DOUBLESIZE >= 8
9234 # define MY_DBL_MIN 2.2250738585072014E-308L
9236 # define MY_DBL_MIN 1.17549435E-38L
9240 if ((intsize == 'q') && (c == 'f') &&
9241 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9243 /* it's going to be short enough that
9244 * long double precision is not needed */
9246 if ((nv <= 0L) && (nv >= -0L))
9247 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9249 /* would use Perl_fp_class as a double-check but not
9250 * functional on IRIX - see perl.h comments */
9252 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9253 /* It's within the range that a double can represent */
9254 #if defined(DBL_MAX) && !defined(DBL_MIN)
9255 if ((nv >= ((long double)1/DBL_MAX)) ||
9256 (nv <= (-(long double)1/DBL_MAX)))
9258 fix_ldbl_sprintf_bug = TRUE;
9261 if (fix_ldbl_sprintf_bug == TRUE) {
9271 # undef MY_DBL_MAX_BUG
9274 #endif /* HAS_LDBL_SPRINTF_BUG */
9276 need += 20; /* fudge factor */
9277 if (PL_efloatsize < need) {
9278 Safefree(PL_efloatbuf);
9279 PL_efloatsize = need + 20; /* more fudge */
9280 Newx(PL_efloatbuf, PL_efloatsize, char);
9281 PL_efloatbuf[0] = '\0';
9284 if ( !(width || left || plus || alt) && fill != '0'
9285 && has_precis && intsize != 'q' ) { /* Shortcuts */
9286 /* See earlier comment about buggy Gconvert when digits,
9288 if ( c == 'g' && precis) {
9289 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9290 /* May return an empty string for digits==0 */
9291 if (*PL_efloatbuf) {
9292 elen = strlen(PL_efloatbuf);
9293 goto float_converted;
9295 } else if ( c == 'f' && !precis) {
9296 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9301 char *ptr = ebuf + sizeof ebuf;
9304 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9305 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9306 if (intsize == 'q') {
9307 /* Copy the one or more characters in a long double
9308 * format before the 'base' ([efgEFG]) character to
9309 * the format string. */
9310 static char const prifldbl[] = PERL_PRIfldbl;
9311 char const *p = prifldbl + sizeof(prifldbl) - 3;
9312 while (p >= prifldbl) { *--ptr = *p--; }
9317 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9322 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9334 /* No taint. Otherwise we are in the strange situation
9335 * where printf() taints but print($float) doesn't.
9337 #if defined(HAS_LONG_DOUBLE)
9338 elen = ((intsize == 'q')
9339 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9340 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9342 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9346 eptr = PL_efloatbuf;
9354 i = SvCUR(sv) - origlen;
9357 case 'h': *(va_arg(*args, short*)) = i; break;
9358 default: *(va_arg(*args, int*)) = i; break;
9359 case 'l': *(va_arg(*args, long*)) = i; break;
9360 case 'V': *(va_arg(*args, IV*)) = i; break;
9362 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9367 sv_setuv_mg(argsv, (UV)i);
9368 continue; /* not "break" */
9375 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9376 && ckWARN(WARN_PRINTF))
9378 SV * const msg = sv_newmortal();
9379 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9380 (PL_op->op_type == OP_PRTF) ? "" : "s");
9383 Perl_sv_catpvf(aTHX_ msg,
9384 "\"%%%c\"", c & 0xFF);
9386 Perl_sv_catpvf(aTHX_ msg,
9387 "\"%%\\%03"UVof"\"",
9390 sv_catpvs(msg, "end of string");
9391 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9394 /* output mangled stuff ... */
9400 /* ... right here, because formatting flags should not apply */
9401 SvGROW(sv, SvCUR(sv) + elen + 1);
9403 Copy(eptr, p, elen, char);
9406 SvCUR_set(sv, p - SvPVX_const(sv));
9408 continue; /* not "break" */
9411 if (is_utf8 != has_utf8) {
9414 sv_utf8_upgrade(sv);
9417 const STRLEN old_elen = elen;
9418 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9419 sv_utf8_upgrade(nsv);
9420 eptr = SvPVX_const(nsv);
9423 if (width) { /* fudge width (can't fudge elen) */
9424 width += elen - old_elen;
9430 have = esignlen + zeros + elen;
9432 Perl_croak_nocontext(PL_memory_wrap);
9434 need = (have > width ? have : width);
9437 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9438 Perl_croak_nocontext(PL_memory_wrap);
9439 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9441 if (esignlen && fill == '0') {
9443 for (i = 0; i < (int)esignlen; i++)
9447 memset(p, fill, gap);
9450 if (esignlen && fill != '0') {
9452 for (i = 0; i < (int)esignlen; i++)
9457 for (i = zeros; i; i--)
9461 Copy(eptr, p, elen, char);
9465 memset(p, ' ', gap);
9470 Copy(dotstr, p, dotstrlen, char);
9474 vectorize = FALSE; /* done iterating over vecstr */
9481 SvCUR_set(sv, p - SvPVX_const(sv));
9489 /* =========================================================================
9491 =head1 Cloning an interpreter
9493 All the macros and functions in this section are for the private use of
9494 the main function, perl_clone().
9496 The foo_dup() functions make an exact copy of an existing foo thinngy.
9497 During the course of a cloning, a hash table is used to map old addresses
9498 to new addresses. The table is created and manipulated with the
9499 ptr_table_* functions.
9503 ============================================================================*/
9506 #if defined(USE_ITHREADS)
9508 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9509 #ifndef GpREFCNT_inc
9510 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9514 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9515 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9516 If this changes, please unmerge ss_dup. */
9517 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9518 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9519 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9520 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9521 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9522 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9523 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9524 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9525 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9526 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9527 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9528 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9529 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9530 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9532 /* clone a parser */
9535 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9542 /* look for it in the table first */
9543 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9547 /* create anew and remember what it is */
9548 Newxz(parser, 1, yy_parser);
9549 ptr_table_store(PL_ptr_table, proto, parser);
9551 parser->yyerrstatus = 0;
9552 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9554 /* XXX these not yet duped */
9555 parser->old_parser = NULL;
9556 parser->stack = NULL;
9558 parser->stack_size = 0;
9559 /* XXX parser->stack->state = 0; */
9561 /* XXX eventually, just Copy() most of the parser struct ? */
9563 parser->lex_brackets = proto->lex_brackets;
9564 parser->lex_casemods = proto->lex_casemods;
9565 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9566 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9567 parser->lex_casestack = savepvn(proto->lex_casestack,
9568 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9569 parser->lex_defer = proto->lex_defer;
9570 parser->lex_dojoin = proto->lex_dojoin;
9571 parser->lex_expect = proto->lex_expect;
9572 parser->lex_formbrack = proto->lex_formbrack;
9573 parser->lex_inpat = proto->lex_inpat;
9574 parser->lex_inwhat = proto->lex_inwhat;
9575 parser->lex_op = proto->lex_op;
9576 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9577 parser->lex_starts = proto->lex_starts;
9578 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9579 parser->multi_close = proto->multi_close;
9580 parser->multi_open = proto->multi_open;
9581 parser->multi_start = proto->multi_start;
9582 parser->multi_end = proto->multi_end;
9583 parser->pending_ident = proto->pending_ident;
9584 parser->preambled = proto->preambled;
9585 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9586 parser->linestr = sv_dup_inc(proto->linestr, param);
9587 parser->expect = proto->expect;
9588 parser->copline = proto->copline;
9589 parser->last_lop_op = proto->last_lop_op;
9590 parser->lex_state = proto->lex_state;
9591 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9592 /* rsfp_filters entries have fake IoDIRP() */
9593 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9594 parser->in_my = proto->in_my;
9595 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9596 parser->error_count = proto->error_count;
9599 parser->linestr = sv_dup_inc(proto->linestr, param);
9602 char * const ols = SvPVX(proto->linestr);
9603 char * const ls = SvPVX(parser->linestr);
9605 parser->bufptr = ls + (proto->bufptr >= ols ?
9606 proto->bufptr - ols : 0);
9607 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9608 proto->oldbufptr - ols : 0);
9609 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9610 proto->oldoldbufptr - ols : 0);
9611 parser->linestart = ls + (proto->linestart >= ols ?
9612 proto->linestart - ols : 0);
9613 parser->last_uni = ls + (proto->last_uni >= ols ?
9614 proto->last_uni - ols : 0);
9615 parser->last_lop = ls + (proto->last_lop >= ols ?
9616 proto->last_lop - ols : 0);
9618 parser->bufend = ls + SvCUR(parser->linestr);
9621 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9625 parser->endwhite = proto->endwhite;
9626 parser->faketokens = proto->faketokens;
9627 parser->lasttoke = proto->lasttoke;
9628 parser->nextwhite = proto->nextwhite;
9629 parser->realtokenstart = proto->realtokenstart;
9630 parser->skipwhite = proto->skipwhite;
9631 parser->thisclose = proto->thisclose;
9632 parser->thismad = proto->thismad;
9633 parser->thisopen = proto->thisopen;
9634 parser->thisstuff = proto->thisstuff;
9635 parser->thistoken = proto->thistoken;
9636 parser->thiswhite = proto->thiswhite;
9638 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9639 parser->curforce = proto->curforce;
9641 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9642 Copy(proto->nexttype, parser->nexttype, 5, I32);
9643 parser->nexttoke = proto->nexttoke;
9649 /* duplicate a file handle */
9652 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9656 PERL_UNUSED_ARG(type);
9659 return (PerlIO*)NULL;
9661 /* look for it in the table first */
9662 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9666 /* create anew and remember what it is */
9667 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9668 ptr_table_store(PL_ptr_table, fp, ret);
9672 /* duplicate a directory handle */
9675 Perl_dirp_dup(pTHX_ DIR *dp)
9677 PERL_UNUSED_CONTEXT;
9684 /* duplicate a typeglob */
9687 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9693 /* look for it in the table first */
9694 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9698 /* create anew and remember what it is */
9700 ptr_table_store(PL_ptr_table, gp, ret);
9703 ret->gp_refcnt = 0; /* must be before any other dups! */
9704 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9705 ret->gp_io = io_dup_inc(gp->gp_io, param);
9706 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9707 ret->gp_av = av_dup_inc(gp->gp_av, param);
9708 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9709 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9710 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9711 ret->gp_cvgen = gp->gp_cvgen;
9712 ret->gp_line = gp->gp_line;
9713 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9717 /* duplicate a chain of magic */
9720 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9722 MAGIC *mgprev = (MAGIC*)NULL;
9725 return (MAGIC*)NULL;
9726 /* look for it in the table first */
9727 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9731 for (; mg; mg = mg->mg_moremagic) {
9733 Newxz(nmg, 1, MAGIC);
9735 mgprev->mg_moremagic = nmg;
9738 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9739 nmg->mg_private = mg->mg_private;
9740 nmg->mg_type = mg->mg_type;
9741 nmg->mg_flags = mg->mg_flags;
9742 if (mg->mg_type == PERL_MAGIC_qr) {
9743 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9745 else if(mg->mg_type == PERL_MAGIC_backref) {
9746 /* The backref AV has its reference count deliberately bumped by
9748 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9751 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9752 ? sv_dup_inc(mg->mg_obj, param)
9753 : sv_dup(mg->mg_obj, param);
9755 nmg->mg_len = mg->mg_len;
9756 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9757 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9758 if (mg->mg_len > 0) {
9759 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9760 if (mg->mg_type == PERL_MAGIC_overload_table &&
9761 AMT_AMAGIC((AMT*)mg->mg_ptr))
9763 const AMT * const amtp = (AMT*)mg->mg_ptr;
9764 AMT * const namtp = (AMT*)nmg->mg_ptr;
9766 for (i = 1; i < NofAMmeth; i++) {
9767 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9771 else if (mg->mg_len == HEf_SVKEY)
9772 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9774 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9775 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9782 #endif /* USE_ITHREADS */
9784 /* create a new pointer-mapping table */
9787 Perl_ptr_table_new(pTHX)
9790 PERL_UNUSED_CONTEXT;
9792 Newxz(tbl, 1, PTR_TBL_t);
9795 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9799 #define PTR_TABLE_HASH(ptr) \
9800 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9803 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9804 following define) and at call to new_body_inline made below in
9805 Perl_ptr_table_store()
9808 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9810 /* map an existing pointer using a table */
9812 STATIC PTR_TBL_ENT_t *
9813 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9814 PTR_TBL_ENT_t *tblent;
9815 const UV hash = PTR_TABLE_HASH(sv);
9817 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9818 for (; tblent; tblent = tblent->next) {
9819 if (tblent->oldval == sv)
9826 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9828 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9829 PERL_UNUSED_CONTEXT;
9830 return tblent ? tblent->newval : NULL;
9833 /* add a new entry to a pointer-mapping table */
9836 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9838 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9839 PERL_UNUSED_CONTEXT;
9842 tblent->newval = newsv;
9844 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9846 new_body_inline(tblent, PTE_SVSLOT);
9848 tblent->oldval = oldsv;
9849 tblent->newval = newsv;
9850 tblent->next = tbl->tbl_ary[entry];
9851 tbl->tbl_ary[entry] = tblent;
9853 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9854 ptr_table_split(tbl);
9858 /* double the hash bucket size of an existing ptr table */
9861 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9863 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9864 const UV oldsize = tbl->tbl_max + 1;
9865 UV newsize = oldsize * 2;
9867 PERL_UNUSED_CONTEXT;
9869 Renew(ary, newsize, PTR_TBL_ENT_t*);
9870 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9871 tbl->tbl_max = --newsize;
9873 for (i=0; i < oldsize; i++, ary++) {
9874 PTR_TBL_ENT_t **curentp, **entp, *ent;
9877 curentp = ary + oldsize;
9878 for (entp = ary, ent = *ary; ent; ent = *entp) {
9879 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9881 ent->next = *curentp;
9891 /* remove all the entries from a ptr table */
9894 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9896 if (tbl && tbl->tbl_items) {
9897 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9898 UV riter = tbl->tbl_max;
9901 PTR_TBL_ENT_t *entry = array[riter];
9904 PTR_TBL_ENT_t * const oentry = entry;
9905 entry = entry->next;
9914 /* clear and free a ptr table */
9917 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9922 ptr_table_clear(tbl);
9923 Safefree(tbl->tbl_ary);
9927 #if defined(USE_ITHREADS)
9930 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9933 SvRV_set(dstr, SvWEAKREF(sstr)
9934 ? sv_dup(SvRV(sstr), param)
9935 : sv_dup_inc(SvRV(sstr), param));
9938 else if (SvPVX_const(sstr)) {
9939 /* Has something there */
9941 /* Normal PV - clone whole allocated space */
9942 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9943 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9944 /* Not that normal - actually sstr is copy on write.
9945 But we are a true, independant SV, so: */
9946 SvREADONLY_off(dstr);
9951 /* Special case - not normally malloced for some reason */
9952 if (isGV_with_GP(sstr)) {
9953 /* Don't need to do anything here. */
9955 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9956 /* A "shared" PV - clone it as "shared" PV */
9958 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9962 /* Some other special case - random pointer */
9963 SvPV_set(dstr, SvPVX(sstr));
9969 if (SvTYPE(dstr) == SVt_RV)
9970 SvRV_set(dstr, NULL);
9972 SvPV_set(dstr, NULL);
9976 /* duplicate an SV of any type (including AV, HV etc) */
9979 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9984 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9986 /* look for it in the table first */
9987 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9991 if(param->flags & CLONEf_JOIN_IN) {
9992 /** We are joining here so we don't want do clone
9993 something that is bad **/
9994 if (SvTYPE(sstr) == SVt_PVHV) {
9995 const char * const hvname = HvNAME_get(sstr);
9997 /** don't clone stashes if they already exist **/
9998 return (SV*)gv_stashpv(hvname,0);
10002 /* create anew and remember what it is */
10005 #ifdef DEBUG_LEAKING_SCALARS
10006 dstr->sv_debug_optype = sstr->sv_debug_optype;
10007 dstr->sv_debug_line = sstr->sv_debug_line;
10008 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10009 dstr->sv_debug_cloned = 1;
10010 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10013 ptr_table_store(PL_ptr_table, sstr, dstr);
10016 SvFLAGS(dstr) = SvFLAGS(sstr);
10017 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10018 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10021 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10022 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10023 (void*)PL_watch_pvx, SvPVX_const(sstr));
10026 /* don't clone objects whose class has asked us not to */
10027 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10028 SvFLAGS(dstr) &= ~SVTYPEMASK;
10029 SvOBJECT_off(dstr);
10033 switch (SvTYPE(sstr)) {
10035 SvANY(dstr) = NULL;
10038 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10039 SvIV_set(dstr, SvIVX(sstr));
10042 SvANY(dstr) = new_XNV();
10043 SvNV_set(dstr, SvNVX(sstr));
10046 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10047 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10049 /* case SVt_BIND: */
10052 /* These are all the types that need complex bodies allocating. */
10054 const svtype sv_type = SvTYPE(sstr);
10055 const struct body_details *const sv_type_details
10056 = bodies_by_type + sv_type;
10060 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10064 if (GvUNIQUE((GV*)sstr)) {
10065 NOOP; /* Do sharing here, and fall through */
10077 assert(sv_type_details->body_size);
10078 if (sv_type_details->arena) {
10079 new_body_inline(new_body, sv_type);
10081 = (void*)((char*)new_body - sv_type_details->offset);
10083 new_body = new_NOARENA(sv_type_details);
10087 SvANY(dstr) = new_body;
10090 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10091 ((char*)SvANY(dstr)) + sv_type_details->offset,
10092 sv_type_details->copy, char);
10094 Copy(((char*)SvANY(sstr)),
10095 ((char*)SvANY(dstr)),
10096 sv_type_details->body_size + sv_type_details->offset, char);
10099 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10100 && !isGV_with_GP(dstr))
10101 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10103 /* The Copy above means that all the source (unduplicated) pointers
10104 are now in the destination. We can check the flags and the
10105 pointers in either, but it's possible that there's less cache
10106 missing by always going for the destination.
10107 FIXME - instrument and check that assumption */
10108 if (sv_type >= SVt_PVMG) {
10109 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10110 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10111 } else if (SvMAGIC(dstr))
10112 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10114 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10117 /* The cast silences a GCC warning about unhandled types. */
10118 switch ((int)sv_type) {
10128 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10129 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10130 LvTARG(dstr) = dstr;
10131 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10132 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10134 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10136 if(isGV_with_GP(sstr)) {
10137 if (GvNAME_HEK(dstr))
10138 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10139 /* Don't call sv_add_backref here as it's going to be
10140 created as part of the magic cloning of the symbol
10142 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10143 at the point of this comment. */
10144 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10145 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10146 (void)GpREFCNT_inc(GvGP(dstr));
10148 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10151 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10152 if (IoOFP(dstr) == IoIFP(sstr))
10153 IoOFP(dstr) = IoIFP(dstr);
10155 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10156 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10157 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10158 /* I have no idea why fake dirp (rsfps)
10159 should be treated differently but otherwise
10160 we end up with leaks -- sky*/
10161 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10162 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10163 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10165 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10166 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10167 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10168 if (IoDIRP(dstr)) {
10169 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10172 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10175 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10176 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10177 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10180 if (AvARRAY((AV*)sstr)) {
10181 SV **dst_ary, **src_ary;
10182 SSize_t items = AvFILLp((AV*)sstr) + 1;
10184 src_ary = AvARRAY((AV*)sstr);
10185 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10186 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10187 AvARRAY((AV*)dstr) = dst_ary;
10188 AvALLOC((AV*)dstr) = dst_ary;
10189 if (AvREAL((AV*)sstr)) {
10190 while (items-- > 0)
10191 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10194 while (items-- > 0)
10195 *dst_ary++ = sv_dup(*src_ary++, param);
10197 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10198 while (items-- > 0) {
10199 *dst_ary++ = &PL_sv_undef;
10203 AvARRAY((AV*)dstr) = NULL;
10204 AvALLOC((AV*)dstr) = (SV**)NULL;
10208 if (HvARRAY((HV*)sstr)) {
10210 const bool sharekeys = !!HvSHAREKEYS(sstr);
10211 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10212 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10214 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10215 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10217 HvARRAY(dstr) = (HE**)darray;
10218 while (i <= sxhv->xhv_max) {
10219 const HE * const source = HvARRAY(sstr)[i];
10220 HvARRAY(dstr)[i] = source
10221 ? he_dup(source, sharekeys, param) : 0;
10226 const struct xpvhv_aux * const saux = HvAUX(sstr);
10227 struct xpvhv_aux * const daux = HvAUX(dstr);
10228 /* This flag isn't copied. */
10229 /* SvOOK_on(hv) attacks the IV flags. */
10230 SvFLAGS(dstr) |= SVf_OOK;
10232 hvname = saux->xhv_name;
10233 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10235 daux->xhv_riter = saux->xhv_riter;
10236 daux->xhv_eiter = saux->xhv_eiter
10237 ? he_dup(saux->xhv_eiter,
10238 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10239 daux->xhv_backreferences =
10240 saux->xhv_backreferences
10241 ? (AV*) SvREFCNT_inc(
10242 sv_dup((SV*)saux->xhv_backreferences, param))
10245 daux->xhv_mro_meta = saux->xhv_mro_meta
10246 ? mro_meta_dup(saux->xhv_mro_meta, param)
10249 /* Record stashes for possible cloning in Perl_clone(). */
10251 av_push(param->stashes, dstr);
10255 HvARRAY((HV*)dstr) = NULL;
10258 if (!(param->flags & CLONEf_COPY_STACKS)) {
10262 /* NOTE: not refcounted */
10263 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10265 if (!CvISXSUB(dstr))
10266 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10268 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10269 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10270 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10271 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10273 /* don't dup if copying back - CvGV isn't refcounted, so the
10274 * duped GV may never be freed. A bit of a hack! DAPM */
10275 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10276 NULL : gv_dup(CvGV(dstr), param) ;
10277 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10279 CvWEAKOUTSIDE(sstr)
10280 ? cv_dup( CvOUTSIDE(dstr), param)
10281 : cv_dup_inc(CvOUTSIDE(dstr), param);
10282 if (!CvISXSUB(dstr))
10283 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10289 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10295 /* duplicate a context */
10298 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10300 PERL_CONTEXT *ncxs;
10303 return (PERL_CONTEXT*)NULL;
10305 /* look for it in the table first */
10306 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10310 /* create anew and remember what it is */
10311 Newxz(ncxs, max + 1, PERL_CONTEXT);
10312 ptr_table_store(PL_ptr_table, cxs, ncxs);
10315 PERL_CONTEXT * const cx = &cxs[ix];
10316 PERL_CONTEXT * const ncx = &ncxs[ix];
10317 ncx->cx_type = cx->cx_type;
10318 if (CxTYPE(cx) == CXt_SUBST) {
10319 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10322 ncx->blk_oldsp = cx->blk_oldsp;
10323 ncx->blk_oldcop = cx->blk_oldcop;
10324 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10325 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10326 ncx->blk_oldpm = cx->blk_oldpm;
10327 ncx->blk_gimme = cx->blk_gimme;
10328 switch (CxTYPE(cx)) {
10330 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10331 ? cv_dup_inc(cx->blk_sub.cv, param)
10332 : cv_dup(cx->blk_sub.cv,param));
10333 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10334 ? av_dup_inc(cx->blk_sub.argarray, param)
10336 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10337 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10338 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10339 ncx->blk_sub.lval = cx->blk_sub.lval;
10340 ncx->blk_sub.retop = cx->blk_sub.retop;
10341 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10342 cx->blk_sub.oldcomppad);
10345 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10346 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10347 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10348 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10349 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10350 ncx->blk_eval.retop = cx->blk_eval.retop;
10353 ncx->blk_loop.label = cx->blk_loop.label;
10354 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10355 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10356 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10357 ? cx->blk_loop.iterdata
10358 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10359 ncx->blk_loop.oldcomppad
10360 = (PAD*)ptr_table_fetch(PL_ptr_table,
10361 cx->blk_loop.oldcomppad);
10362 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10363 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10364 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10365 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10366 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10369 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10370 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10371 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10372 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10373 ncx->blk_sub.retop = cx->blk_sub.retop;
10385 /* duplicate a stack info structure */
10388 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10393 return (PERL_SI*)NULL;
10395 /* look for it in the table first */
10396 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10400 /* create anew and remember what it is */
10401 Newxz(nsi, 1, PERL_SI);
10402 ptr_table_store(PL_ptr_table, si, nsi);
10404 nsi->si_stack = av_dup_inc(si->si_stack, param);
10405 nsi->si_cxix = si->si_cxix;
10406 nsi->si_cxmax = si->si_cxmax;
10407 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10408 nsi->si_type = si->si_type;
10409 nsi->si_prev = si_dup(si->si_prev, param);
10410 nsi->si_next = si_dup(si->si_next, param);
10411 nsi->si_markoff = si->si_markoff;
10416 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10417 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10418 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10419 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10420 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10421 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10422 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10423 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10424 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10425 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10426 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10427 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10428 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10429 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10432 #define pv_dup_inc(p) SAVEPV(p)
10433 #define pv_dup(p) SAVEPV(p)
10434 #define svp_dup_inc(p,pp) any_dup(p,pp)
10436 /* map any object to the new equivent - either something in the
10437 * ptr table, or something in the interpreter structure
10441 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10446 return (void*)NULL;
10448 /* look for it in the table first */
10449 ret = ptr_table_fetch(PL_ptr_table, v);
10453 /* see if it is part of the interpreter structure */
10454 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10455 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10463 /* duplicate the save stack */
10466 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10469 ANY * const ss = proto_perl->Isavestack;
10470 const I32 max = proto_perl->Isavestack_max;
10471 I32 ix = proto_perl->Isavestack_ix;
10484 void (*dptr) (void*);
10485 void (*dxptr) (pTHX_ void*);
10487 Newxz(nss, max, ANY);
10490 const I32 type = POPINT(ss,ix);
10491 TOPINT(nss,ix) = type;
10493 case SAVEt_HELEM: /* hash element */
10494 sv = (SV*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10497 case SAVEt_ITEM: /* normal string */
10498 case SAVEt_SV: /* scalar reference */
10499 sv = (SV*)POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10503 case SAVEt_MORTALIZESV:
10504 sv = (SV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10507 case SAVEt_SHARED_PVREF: /* char* in shared space */
10508 c = (char*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = savesharedpv(c);
10510 ptr = POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10513 case SAVEt_GENERIC_SVREF: /* generic sv */
10514 case SAVEt_SVREF: /* scalar reference */
10515 sv = (SV*)POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10517 ptr = POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10520 case SAVEt_HV: /* hash reference */
10521 case SAVEt_AV: /* array reference */
10522 sv = (SV*) POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10525 case SAVEt_COMPPAD:
10527 sv = (SV*) POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = sv_dup(sv, param);
10530 case SAVEt_INT: /* int reference */
10531 ptr = POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10533 intval = (int)POPINT(ss,ix);
10534 TOPINT(nss,ix) = intval;
10536 case SAVEt_LONG: /* long reference */
10537 ptr = POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10540 case SAVEt_CLEARSV:
10541 longval = (long)POPLONG(ss,ix);
10542 TOPLONG(nss,ix) = longval;
10544 case SAVEt_I32: /* I32 reference */
10545 case SAVEt_I16: /* I16 reference */
10546 case SAVEt_I8: /* I8 reference */
10547 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10548 ptr = POPPTR(ss,ix);
10549 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10551 TOPINT(nss,ix) = i;
10553 case SAVEt_IV: /* IV reference */
10554 ptr = POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10557 TOPIV(nss,ix) = iv;
10559 case SAVEt_HPTR: /* HV* reference */
10560 case SAVEt_APTR: /* AV* reference */
10561 case SAVEt_SPTR: /* SV* reference */
10562 ptr = POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10564 sv = (SV*)POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = sv_dup(sv, param);
10567 case SAVEt_VPTR: /* random* reference */
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10570 ptr = POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10573 case SAVEt_GENERIC_PVREF: /* generic char* */
10574 case SAVEt_PPTR: /* char* reference */
10575 ptr = POPPTR(ss,ix);
10576 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10577 c = (char*)POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = pv_dup(c);
10580 case SAVEt_GP: /* scalar reference */
10581 gp = (GP*)POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10583 (void)GpREFCNT_inc(gp);
10584 gv = (GV*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10588 ptr = POPPTR(ss,ix);
10589 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10590 /* these are assumed to be refcounted properly */
10592 switch (((OP*)ptr)->op_type) {
10594 case OP_LEAVESUBLV:
10598 case OP_LEAVEWRITE:
10599 TOPPTR(nss,ix) = ptr;
10602 (void) OpREFCNT_inc(o);
10606 TOPPTR(nss,ix) = NULL;
10611 TOPPTR(nss,ix) = NULL;
10614 c = (char*)POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = pv_dup_inc(c);
10618 hv = (HV*)POPPTR(ss,ix);
10619 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10620 c = (char*)POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = pv_dup_inc(c);
10623 case SAVEt_STACK_POS: /* Position on Perl stack */
10625 TOPINT(nss,ix) = i;
10627 case SAVEt_DESTRUCTOR:
10628 ptr = POPPTR(ss,ix);
10629 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10630 dptr = POPDPTR(ss,ix);
10631 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10632 any_dup(FPTR2DPTR(void *, dptr),
10635 case SAVEt_DESTRUCTOR_X:
10636 ptr = POPPTR(ss,ix);
10637 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10638 dxptr = POPDXPTR(ss,ix);
10639 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10640 any_dup(FPTR2DPTR(void *, dxptr),
10643 case SAVEt_REGCONTEXT:
10646 TOPINT(nss,ix) = i;
10649 case SAVEt_AELEM: /* array element */
10650 sv = (SV*)POPPTR(ss,ix);
10651 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10653 TOPINT(nss,ix) = i;
10654 av = (AV*)POPPTR(ss,ix);
10655 TOPPTR(nss,ix) = av_dup_inc(av, param);
10658 ptr = POPPTR(ss,ix);
10659 TOPPTR(nss,ix) = ptr;
10663 TOPINT(nss,ix) = i;
10664 ptr = POPPTR(ss,ix);
10667 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10668 HINTS_REFCNT_UNLOCK;
10670 TOPPTR(nss,ix) = ptr;
10671 if (i & HINT_LOCALIZE_HH) {
10672 hv = (HV*)POPPTR(ss,ix);
10673 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10677 longval = (long)POPLONG(ss,ix);
10678 TOPLONG(nss,ix) = longval;
10679 ptr = POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10681 sv = (SV*)POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = sv_dup(sv, param);
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10687 longval = (long)POPBOOL(ss,ix);
10688 TOPBOOL(nss,ix) = (bool)longval;
10690 case SAVEt_SET_SVFLAGS:
10692 TOPINT(nss,ix) = i;
10694 TOPINT(nss,ix) = i;
10695 sv = (SV*)POPPTR(ss,ix);
10696 TOPPTR(nss,ix) = sv_dup(sv, param);
10698 case SAVEt_RE_STATE:
10700 const struct re_save_state *const old_state
10701 = (struct re_save_state *)
10702 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10703 struct re_save_state *const new_state
10704 = (struct re_save_state *)
10705 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10707 Copy(old_state, new_state, 1, struct re_save_state);
10708 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10710 new_state->re_state_bostr
10711 = pv_dup(old_state->re_state_bostr);
10712 new_state->re_state_reginput
10713 = pv_dup(old_state->re_state_reginput);
10714 new_state->re_state_regeol
10715 = pv_dup(old_state->re_state_regeol);
10716 new_state->re_state_regoffs
10717 = (regexp_paren_pair*)
10718 any_dup(old_state->re_state_regoffs, proto_perl);
10719 new_state->re_state_reglastparen
10720 = (U32*) any_dup(old_state->re_state_reglastparen,
10722 new_state->re_state_reglastcloseparen
10723 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10725 /* XXX This just has to be broken. The old save_re_context
10726 code did SAVEGENERICPV(PL_reg_start_tmp);
10727 PL_reg_start_tmp is char **.
10728 Look above to what the dup code does for
10729 SAVEt_GENERIC_PVREF
10730 It can never have worked.
10731 So this is merely a faithful copy of the exiting bug: */
10732 new_state->re_state_reg_start_tmp
10733 = (char **) pv_dup((char *)
10734 old_state->re_state_reg_start_tmp);
10735 /* I assume that it only ever "worked" because no-one called
10736 (pseudo)fork while the regexp engine had re-entered itself.
10738 #ifdef PERL_OLD_COPY_ON_WRITE
10739 new_state->re_state_nrs
10740 = sv_dup(old_state->re_state_nrs, param);
10742 new_state->re_state_reg_magic
10743 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10745 new_state->re_state_reg_oldcurpm
10746 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10748 new_state->re_state_reg_curpm
10749 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10751 new_state->re_state_reg_oldsaved
10752 = pv_dup(old_state->re_state_reg_oldsaved);
10753 new_state->re_state_reg_poscache
10754 = pv_dup(old_state->re_state_reg_poscache);
10755 new_state->re_state_reg_starttry
10756 = pv_dup(old_state->re_state_reg_starttry);
10759 case SAVEt_COMPILE_WARNINGS:
10760 ptr = POPPTR(ss,ix);
10761 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10764 ptr = POPPTR(ss,ix);
10765 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10769 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10777 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10778 * flag to the result. This is done for each stash before cloning starts,
10779 * so we know which stashes want their objects cloned */
10782 do_mark_cloneable_stash(pTHX_ SV *sv)
10784 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10786 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10787 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10788 if (cloner && GvCV(cloner)) {
10795 XPUSHs(sv_2mortal(newSVhek(hvname)));
10797 call_sv((SV*)GvCV(cloner), G_SCALAR);
10804 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10812 =for apidoc perl_clone
10814 Create and return a new interpreter by cloning the current one.
10816 perl_clone takes these flags as parameters:
10818 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10819 without it we only clone the data and zero the stacks,
10820 with it we copy the stacks and the new perl interpreter is
10821 ready to run at the exact same point as the previous one.
10822 The pseudo-fork code uses COPY_STACKS while the
10823 threads->create doesn't.
10825 CLONEf_KEEP_PTR_TABLE
10826 perl_clone keeps a ptr_table with the pointer of the old
10827 variable as a key and the new variable as a value,
10828 this allows it to check if something has been cloned and not
10829 clone it again but rather just use the value and increase the
10830 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10831 the ptr_table using the function
10832 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10833 reason to keep it around is if you want to dup some of your own
10834 variable who are outside the graph perl scans, example of this
10835 code is in threads.xs create
10838 This is a win32 thing, it is ignored on unix, it tells perls
10839 win32host code (which is c++) to clone itself, this is needed on
10840 win32 if you want to run two threads at the same time,
10841 if you just want to do some stuff in a separate perl interpreter
10842 and then throw it away and return to the original one,
10843 you don't need to do anything.
10848 /* XXX the above needs expanding by someone who actually understands it ! */
10849 EXTERN_C PerlInterpreter *
10850 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10853 perl_clone(PerlInterpreter *proto_perl, UV flags)
10856 #ifdef PERL_IMPLICIT_SYS
10858 /* perlhost.h so we need to call into it
10859 to clone the host, CPerlHost should have a c interface, sky */
10861 if (flags & CLONEf_CLONE_HOST) {
10862 return perl_clone_host(proto_perl,flags);
10864 return perl_clone_using(proto_perl, flags,
10866 proto_perl->IMemShared,
10867 proto_perl->IMemParse,
10869 proto_perl->IStdIO,
10873 proto_perl->IProc);
10877 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10878 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10879 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10880 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10881 struct IPerlDir* ipD, struct IPerlSock* ipS,
10882 struct IPerlProc* ipP)
10884 /* XXX many of the string copies here can be optimized if they're
10885 * constants; they need to be allocated as common memory and just
10886 * their pointers copied. */
10889 CLONE_PARAMS clone_params;
10890 CLONE_PARAMS* const param = &clone_params;
10892 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10893 /* for each stash, determine whether its objects should be cloned */
10894 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10895 PERL_SET_THX(my_perl);
10898 PoisonNew(my_perl, 1, PerlInterpreter);
10904 PL_savestack_ix = 0;
10905 PL_savestack_max = -1;
10906 PL_sig_pending = 0;
10907 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10908 # else /* !DEBUGGING */
10909 Zero(my_perl, 1, PerlInterpreter);
10910 # endif /* DEBUGGING */
10912 /* host pointers */
10914 PL_MemShared = ipMS;
10915 PL_MemParse = ipMP;
10922 #else /* !PERL_IMPLICIT_SYS */
10924 CLONE_PARAMS clone_params;
10925 CLONE_PARAMS* param = &clone_params;
10926 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10927 /* for each stash, determine whether its objects should be cloned */
10928 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10929 PERL_SET_THX(my_perl);
10932 PoisonNew(my_perl, 1, PerlInterpreter);
10938 PL_savestack_ix = 0;
10939 PL_savestack_max = -1;
10940 PL_sig_pending = 0;
10941 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10942 # else /* !DEBUGGING */
10943 Zero(my_perl, 1, PerlInterpreter);
10944 # endif /* DEBUGGING */
10945 #endif /* PERL_IMPLICIT_SYS */
10946 param->flags = flags;
10947 param->proto_perl = proto_perl;
10949 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10951 PL_body_arenas = NULL;
10952 Zero(&PL_body_roots, 1, PL_body_roots);
10954 PL_nice_chunk = NULL;
10955 PL_nice_chunk_size = 0;
10957 PL_sv_objcount = 0;
10959 PL_sv_arenaroot = NULL;
10961 PL_debug = proto_perl->Idebug;
10963 PL_hash_seed = proto_perl->Ihash_seed;
10964 PL_rehash_seed = proto_perl->Irehash_seed;
10966 #ifdef USE_REENTRANT_API
10967 /* XXX: things like -Dm will segfault here in perlio, but doing
10968 * PERL_SET_CONTEXT(proto_perl);
10969 * breaks too many other things
10971 Perl_reentrant_init(aTHX);
10974 /* create SV map for pointer relocation */
10975 PL_ptr_table = ptr_table_new();
10977 /* initialize these special pointers as early as possible */
10978 SvANY(&PL_sv_undef) = NULL;
10979 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10980 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10981 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10983 SvANY(&PL_sv_no) = new_XPVNV();
10984 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10985 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10986 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10987 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10988 SvCUR_set(&PL_sv_no, 0);
10989 SvLEN_set(&PL_sv_no, 1);
10990 SvIV_set(&PL_sv_no, 0);
10991 SvNV_set(&PL_sv_no, 0);
10992 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10994 SvANY(&PL_sv_yes) = new_XPVNV();
10995 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10996 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10997 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10998 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10999 SvCUR_set(&PL_sv_yes, 1);
11000 SvLEN_set(&PL_sv_yes, 2);
11001 SvIV_set(&PL_sv_yes, 1);
11002 SvNV_set(&PL_sv_yes, 1);
11003 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11005 /* create (a non-shared!) shared string table */
11006 PL_strtab = newHV();
11007 HvSHAREKEYS_off(PL_strtab);
11008 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11009 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11011 PL_compiling = proto_perl->Icompiling;
11013 /* These two PVs will be free'd special way so must set them same way op.c does */
11014 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11015 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11017 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11018 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11020 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11021 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11022 if (PL_compiling.cop_hints_hash) {
11024 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11025 HINTS_REFCNT_UNLOCK;
11027 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11028 #ifdef PERL_DEBUG_READONLY_OPS
11033 /* pseudo environmental stuff */
11034 PL_origargc = proto_perl->Iorigargc;
11035 PL_origargv = proto_perl->Iorigargv;
11037 param->stashes = newAV(); /* Setup array of objects to call clone on */
11039 /* Set tainting stuff before PerlIO_debug can possibly get called */
11040 PL_tainting = proto_perl->Itainting;
11041 PL_taint_warn = proto_perl->Itaint_warn;
11043 #ifdef PERLIO_LAYERS
11044 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11045 PerlIO_clone(aTHX_ proto_perl, param);
11048 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11049 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11050 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11051 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11052 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11053 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11056 PL_minus_c = proto_perl->Iminus_c;
11057 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11058 PL_localpatches = proto_perl->Ilocalpatches;
11059 PL_splitstr = proto_perl->Isplitstr;
11060 PL_preprocess = proto_perl->Ipreprocess;
11061 PL_minus_n = proto_perl->Iminus_n;
11062 PL_minus_p = proto_perl->Iminus_p;
11063 PL_minus_l = proto_perl->Iminus_l;
11064 PL_minus_a = proto_perl->Iminus_a;
11065 PL_minus_E = proto_perl->Iminus_E;
11066 PL_minus_F = proto_perl->Iminus_F;
11067 PL_doswitches = proto_perl->Idoswitches;
11068 PL_dowarn = proto_perl->Idowarn;
11069 PL_doextract = proto_perl->Idoextract;
11070 PL_sawampersand = proto_perl->Isawampersand;
11071 PL_unsafe = proto_perl->Iunsafe;
11072 PL_inplace = SAVEPV(proto_perl->Iinplace);
11073 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11074 PL_perldb = proto_perl->Iperldb;
11075 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11076 PL_exit_flags = proto_perl->Iexit_flags;
11078 /* magical thingies */
11079 /* XXX time(&PL_basetime) when asked for? */
11080 PL_basetime = proto_perl->Ibasetime;
11081 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11083 PL_maxsysfd = proto_perl->Imaxsysfd;
11084 PL_statusvalue = proto_perl->Istatusvalue;
11086 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11088 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11090 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11092 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11093 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11094 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11097 /* RE engine related */
11098 Zero(&PL_reg_state, 1, struct re_save_state);
11099 PL_reginterp_cnt = 0;
11100 PL_regmatch_slab = NULL;
11102 /* Clone the regex array */
11103 PL_regex_padav = newAV();
11105 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11106 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11108 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11109 for(i = 1; i <= len; i++) {
11110 const SV * const regex = regexen[i];
11113 ? sv_dup_inc(regex, param)
11115 newSViv(PTR2IV(CALLREGDUPE(
11116 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11118 if (SvFLAGS(regex) & SVf_BREAK)
11119 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11120 av_push(PL_regex_padav, sv);
11123 PL_regex_pad = AvARRAY(PL_regex_padav);
11125 /* shortcuts to various I/O objects */
11126 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11127 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11128 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11129 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11130 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11131 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11133 /* shortcuts to regexp stuff */
11134 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11136 /* shortcuts to misc objects */
11137 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11139 /* shortcuts to debugging objects */
11140 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11141 PL_DBline = gv_dup(proto_perl->IDBline, param);
11142 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11143 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11144 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11145 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11146 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11148 /* symbol tables */
11149 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11150 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11151 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11152 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11153 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11155 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11156 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11157 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11158 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11159 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11160 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11161 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11162 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11164 PL_sub_generation = proto_perl->Isub_generation;
11165 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11166 PL_delayedisa = hv_dup_inc(proto_perl->Idelayedisa, param);
11168 /* funky return mechanisms */
11169 PL_forkprocess = proto_perl->Iforkprocess;
11171 /* subprocess state */
11172 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11174 /* internal state */
11175 PL_maxo = proto_perl->Imaxo;
11176 if (proto_perl->Iop_mask)
11177 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11180 /* PL_asserting = proto_perl->Iasserting; */
11182 /* current interpreter roots */
11183 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11185 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11187 PL_main_start = proto_perl->Imain_start;
11188 PL_eval_root = proto_perl->Ieval_root;
11189 PL_eval_start = proto_perl->Ieval_start;
11191 /* runtime control stuff */
11192 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11194 PL_filemode = proto_perl->Ifilemode;
11195 PL_lastfd = proto_perl->Ilastfd;
11196 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11199 PL_gensym = proto_perl->Igensym;
11200 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11201 PL_laststatval = proto_perl->Ilaststatval;
11202 PL_laststype = proto_perl->Ilaststype;
11205 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11207 /* interpreter atexit processing */
11208 PL_exitlistlen = proto_perl->Iexitlistlen;
11209 if (PL_exitlistlen) {
11210 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11211 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11214 PL_exitlist = (PerlExitListEntry*)NULL;
11216 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11217 if (PL_my_cxt_size) {
11218 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11219 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11220 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11221 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11222 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11226 PL_my_cxt_list = (void**)NULL;
11227 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11228 PL_my_cxt_keys = (const char**)NULL;
11231 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11232 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11233 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11235 PL_profiledata = NULL;
11237 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11239 PAD_CLONE_VARS(proto_perl, param);
11241 #ifdef HAVE_INTERP_INTERN
11242 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11245 /* more statics moved here */
11246 PL_generation = proto_perl->Igeneration;
11247 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11249 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11250 PL_in_clean_all = proto_perl->Iin_clean_all;
11252 PL_uid = proto_perl->Iuid;
11253 PL_euid = proto_perl->Ieuid;
11254 PL_gid = proto_perl->Igid;
11255 PL_egid = proto_perl->Iegid;
11256 PL_nomemok = proto_perl->Inomemok;
11257 PL_an = proto_perl->Ian;
11258 PL_evalseq = proto_perl->Ievalseq;
11259 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11260 PL_origalen = proto_perl->Iorigalen;
11261 #ifdef PERL_USES_PL_PIDSTATUS
11262 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11264 PL_osname = SAVEPV(proto_perl->Iosname);
11265 PL_sighandlerp = proto_perl->Isighandlerp;
11267 PL_runops = proto_perl->Irunops;
11270 PL_cshlen = proto_perl->Icshlen;
11271 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11274 PL_parser = parser_dup(proto_perl->Iparser, param);
11276 PL_subline = proto_perl->Isubline;
11277 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11280 PL_cryptseen = proto_perl->Icryptseen;
11283 PL_hints = proto_perl->Ihints;
11285 PL_amagic_generation = proto_perl->Iamagic_generation;
11287 #ifdef USE_LOCALE_COLLATE
11288 PL_collation_ix = proto_perl->Icollation_ix;
11289 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11290 PL_collation_standard = proto_perl->Icollation_standard;
11291 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11292 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11293 #endif /* USE_LOCALE_COLLATE */
11295 #ifdef USE_LOCALE_NUMERIC
11296 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11297 PL_numeric_standard = proto_perl->Inumeric_standard;
11298 PL_numeric_local = proto_perl->Inumeric_local;
11299 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11300 #endif /* !USE_LOCALE_NUMERIC */
11302 /* utf8 character classes */
11303 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11304 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11305 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11306 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11307 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11308 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11309 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11310 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11311 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11312 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11313 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11314 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11315 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11316 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11317 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11318 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11319 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11320 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11321 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11322 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11324 /* Did the locale setup indicate UTF-8? */
11325 PL_utf8locale = proto_perl->Iutf8locale;
11326 /* Unicode features (see perlrun/-C) */
11327 PL_unicode = proto_perl->Iunicode;
11329 /* Pre-5.8 signals control */
11330 PL_signals = proto_perl->Isignals;
11332 /* times() ticks per second */
11333 PL_clocktick = proto_perl->Iclocktick;
11335 /* Recursion stopper for PerlIO_find_layer */
11336 PL_in_load_module = proto_perl->Iin_load_module;
11338 /* sort() routine */
11339 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11341 /* Not really needed/useful since the reenrant_retint is "volatile",
11342 * but do it for consistency's sake. */
11343 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11345 /* Hooks to shared SVs and locks. */
11346 PL_sharehook = proto_perl->Isharehook;
11347 PL_lockhook = proto_perl->Ilockhook;
11348 PL_unlockhook = proto_perl->Iunlockhook;
11349 PL_threadhook = proto_perl->Ithreadhook;
11351 #ifdef THREADS_HAVE_PIDS
11352 PL_ppid = proto_perl->Ippid;
11356 PL_last_swash_hv = NULL; /* reinits on demand */
11357 PL_last_swash_klen = 0;
11358 PL_last_swash_key[0]= '\0';
11359 PL_last_swash_tmps = (U8*)NULL;
11360 PL_last_swash_slen = 0;
11362 PL_glob_index = proto_perl->Iglob_index;
11363 PL_srand_called = proto_perl->Isrand_called;
11364 PL_bitcount = NULL; /* reinits on demand */
11366 if (proto_perl->Ipsig_pend) {
11367 Newxz(PL_psig_pend, SIG_SIZE, int);
11370 PL_psig_pend = (int*)NULL;
11373 if (proto_perl->Ipsig_ptr) {
11374 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11375 Newxz(PL_psig_name, SIG_SIZE, SV*);
11376 for (i = 1; i < SIG_SIZE; i++) {
11377 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11378 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11382 PL_psig_ptr = (SV**)NULL;
11383 PL_psig_name = (SV**)NULL;
11386 /* intrpvar.h stuff */
11388 if (flags & CLONEf_COPY_STACKS) {
11389 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11390 PL_tmps_ix = proto_perl->Itmps_ix;
11391 PL_tmps_max = proto_perl->Itmps_max;
11392 PL_tmps_floor = proto_perl->Itmps_floor;
11393 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11395 while (i <= PL_tmps_ix) {
11396 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11400 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11401 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11402 Newxz(PL_markstack, i, I32);
11403 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11404 - proto_perl->Imarkstack);
11405 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11406 - proto_perl->Imarkstack);
11407 Copy(proto_perl->Imarkstack, PL_markstack,
11408 PL_markstack_ptr - PL_markstack + 1, I32);
11410 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11411 * NOTE: unlike the others! */
11412 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11413 PL_scopestack_max = proto_perl->Iscopestack_max;
11414 Newxz(PL_scopestack, PL_scopestack_max, I32);
11415 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11417 /* NOTE: si_dup() looks at PL_markstack */
11418 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11420 /* PL_curstack = PL_curstackinfo->si_stack; */
11421 PL_curstack = av_dup(proto_perl->Icurstack, param);
11422 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11424 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11425 PL_stack_base = AvARRAY(PL_curstack);
11426 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11427 - proto_perl->Istack_base);
11428 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11430 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11431 * NOTE: unlike the others! */
11432 PL_savestack_ix = proto_perl->Isavestack_ix;
11433 PL_savestack_max = proto_perl->Isavestack_max;
11434 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11435 PL_savestack = ss_dup(proto_perl, param);
11439 ENTER; /* perl_destruct() wants to LEAVE; */
11441 /* although we're not duplicating the tmps stack, we should still
11442 * add entries for any SVs on the tmps stack that got cloned by a
11443 * non-refcount means (eg a temp in @_); otherwise they will be
11446 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11447 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11448 proto_perl->Itmps_stack[i]);
11449 if (nsv && !SvREFCNT(nsv)) {
11451 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11456 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11457 PL_top_env = &PL_start_env;
11459 PL_op = proto_perl->Iop;
11462 PL_Xpv = (XPV*)NULL;
11463 PL_na = proto_perl->Ina;
11465 PL_statbuf = proto_perl->Istatbuf;
11466 PL_statcache = proto_perl->Istatcache;
11467 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11468 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11470 PL_timesbuf = proto_perl->Itimesbuf;
11473 PL_tainted = proto_perl->Itainted;
11474 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11475 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11476 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11477 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11478 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11479 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11480 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11481 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11482 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11484 PL_restartop = proto_perl->Irestartop;
11485 PL_in_eval = proto_perl->Iin_eval;
11486 PL_delaymagic = proto_perl->Idelaymagic;
11487 PL_dirty = proto_perl->Idirty;
11488 PL_localizing = proto_perl->Ilocalizing;
11490 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11491 PL_hv_fetch_ent_mh = NULL;
11492 PL_modcount = proto_perl->Imodcount;
11493 PL_lastgotoprobe = NULL;
11494 PL_dumpindent = proto_perl->Idumpindent;
11496 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11497 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11498 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11499 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11500 PL_efloatbuf = NULL; /* reinits on demand */
11501 PL_efloatsize = 0; /* reinits on demand */
11505 PL_screamfirst = NULL;
11506 PL_screamnext = NULL;
11507 PL_maxscream = -1; /* reinits on demand */
11508 PL_lastscream = NULL;
11511 PL_regdummy = proto_perl->Iregdummy;
11512 PL_colorset = 0; /* reinits PL_colors[] */
11513 /*PL_colors[6] = {0,0,0,0,0,0};*/
11517 /* Pluggable optimizer */
11518 PL_peepp = proto_perl->Ipeepp;
11520 PL_stashcache = newHV();
11522 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11523 proto_perl->Iwatchaddr);
11524 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11525 if (PL_debug && PL_watchaddr) {
11526 PerlIO_printf(Perl_debug_log,
11527 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11528 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11529 PTR2UV(PL_watchok));
11532 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11533 ptr_table_free(PL_ptr_table);
11534 PL_ptr_table = NULL;
11537 /* Call the ->CLONE method, if it exists, for each of the stashes
11538 identified by sv_dup() above.
11540 while(av_len(param->stashes) != -1) {
11541 HV* const stash = (HV*) av_shift(param->stashes);
11542 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11543 if (cloner && GvCV(cloner)) {
11548 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11550 call_sv((SV*)GvCV(cloner), G_DISCARD);
11556 SvREFCNT_dec(param->stashes);
11558 /* orphaned? eg threads->new inside BEGIN or use */
11559 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11560 SvREFCNT_inc_simple_void(PL_compcv);
11561 SAVEFREESV(PL_compcv);
11567 #endif /* USE_ITHREADS */
11570 =head1 Unicode Support
11572 =for apidoc sv_recode_to_utf8
11574 The encoding is assumed to be an Encode object, on entry the PV
11575 of the sv is assumed to be octets in that encoding, and the sv
11576 will be converted into Unicode (and UTF-8).
11578 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11579 is not a reference, nothing is done to the sv. If the encoding is not
11580 an C<Encode::XS> Encoding object, bad things will happen.
11581 (See F<lib/encoding.pm> and L<Encode>).
11583 The PV of the sv is returned.
11588 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11591 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11605 Passing sv_yes is wrong - it needs to be or'ed set of constants
11606 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11607 remove converted chars from source.
11609 Both will default the value - let them.
11611 XPUSHs(&PL_sv_yes);
11614 call_method("decode", G_SCALAR);
11618 s = SvPV_const(uni, len);
11619 if (s != SvPVX_const(sv)) {
11620 SvGROW(sv, len + 1);
11621 Move(s, SvPVX(sv), len + 1, char);
11622 SvCUR_set(sv, len);
11629 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11633 =for apidoc sv_cat_decode
11635 The encoding is assumed to be an Encode object, the PV of the ssv is
11636 assumed to be octets in that encoding and decoding the input starts
11637 from the position which (PV + *offset) pointed to. The dsv will be
11638 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11639 when the string tstr appears in decoding output or the input ends on
11640 the PV of the ssv. The value which the offset points will be modified
11641 to the last input position on the ssv.
11643 Returns TRUE if the terminator was found, else returns FALSE.
11648 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11649 SV *ssv, int *offset, char *tstr, int tlen)
11653 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11664 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11665 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11667 call_method("cat_decode", G_SCALAR);
11669 ret = SvTRUE(TOPs);
11670 *offset = SvIV(offsv);
11676 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11681 /* ---------------------------------------------------------------------
11683 * support functions for report_uninit()
11686 /* the maxiumum size of array or hash where we will scan looking
11687 * for the undefined element that triggered the warning */
11689 #define FUV_MAX_SEARCH_SIZE 1000
11691 /* Look for an entry in the hash whose value has the same SV as val;
11692 * If so, return a mortal copy of the key. */
11695 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11698 register HE **array;
11701 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11702 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11705 array = HvARRAY(hv);
11707 for (i=HvMAX(hv); i>0; i--) {
11708 register HE *entry;
11709 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11710 if (HeVAL(entry) != val)
11712 if ( HeVAL(entry) == &PL_sv_undef ||
11713 HeVAL(entry) == &PL_sv_placeholder)
11717 if (HeKLEN(entry) == HEf_SVKEY)
11718 return sv_mortalcopy(HeKEY_sv(entry));
11719 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11725 /* Look for an entry in the array whose value has the same SV as val;
11726 * If so, return the index, otherwise return -1. */
11729 S_find_array_subscript(pTHX_ AV *av, SV* val)
11732 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11733 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11736 if (val != &PL_sv_undef) {
11737 SV ** const svp = AvARRAY(av);
11740 for (i=AvFILLp(av); i>=0; i--)
11747 /* S_varname(): return the name of a variable, optionally with a subscript.
11748 * If gv is non-zero, use the name of that global, along with gvtype (one
11749 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11750 * targ. Depending on the value of the subscript_type flag, return:
11753 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11754 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11755 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11756 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11759 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11760 SV* keyname, I32 aindex, int subscript_type)
11763 SV * const name = sv_newmortal();
11766 buffer[0] = gvtype;
11769 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11771 gv_fullname4(name, gv, buffer, 0);
11773 if ((unsigned int)SvPVX(name)[1] <= 26) {
11775 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11777 /* Swap the 1 unprintable control character for the 2 byte pretty
11778 version - ie substr($name, 1, 1) = $buffer; */
11779 sv_insert(name, 1, 1, buffer, 2);
11783 CV * const cv = find_runcv(NULL);
11787 if (!cv || !CvPADLIST(cv))
11789 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11790 sv = *av_fetch(av, targ, FALSE);
11791 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11794 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11795 SV * const sv = newSV(0);
11796 *SvPVX(name) = '$';
11797 Perl_sv_catpvf(aTHX_ name, "{%s}",
11798 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11801 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11802 *SvPVX(name) = '$';
11803 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11805 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11806 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11813 =for apidoc find_uninit_var
11815 Find the name of the undefined variable (if any) that caused the operator o
11816 to issue a "Use of uninitialized value" warning.
11817 If match is true, only return a name if it's value matches uninit_sv.
11818 So roughly speaking, if a unary operator (such as OP_COS) generates a
11819 warning, then following the direct child of the op may yield an
11820 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11821 other hand, with OP_ADD there are two branches to follow, so we only print
11822 the variable name if we get an exact match.
11824 The name is returned as a mortal SV.
11826 Assumes that PL_op is the op that originally triggered the error, and that
11827 PL_comppad/PL_curpad points to the currently executing pad.
11833 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11841 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11842 uninit_sv == &PL_sv_placeholder)))
11845 switch (obase->op_type) {
11852 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11853 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11856 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11858 if (pad) { /* @lex, %lex */
11859 sv = PAD_SVl(obase->op_targ);
11863 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11864 /* @global, %global */
11865 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11868 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11870 else /* @{expr}, %{expr} */
11871 return find_uninit_var(cUNOPx(obase)->op_first,
11875 /* attempt to find a match within the aggregate */
11877 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11879 subscript_type = FUV_SUBSCRIPT_HASH;
11882 index = find_array_subscript((AV*)sv, uninit_sv);
11884 subscript_type = FUV_SUBSCRIPT_ARRAY;
11887 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11890 return varname(gv, hash ? '%' : '@', obase->op_targ,
11891 keysv, index, subscript_type);
11895 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11897 return varname(NULL, '$', obase->op_targ,
11898 NULL, 0, FUV_SUBSCRIPT_NONE);
11901 gv = cGVOPx_gv(obase);
11902 if (!gv || (match && GvSV(gv) != uninit_sv))
11904 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11907 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11910 av = (AV*)PAD_SV(obase->op_targ);
11911 if (!av || SvRMAGICAL(av))
11913 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11914 if (!svp || *svp != uninit_sv)
11917 return varname(NULL, '$', obase->op_targ,
11918 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11921 gv = cGVOPx_gv(obase);
11927 if (!av || SvRMAGICAL(av))
11929 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11930 if (!svp || *svp != uninit_sv)
11933 return varname(gv, '$', 0,
11934 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11939 o = cUNOPx(obase)->op_first;
11940 if (!o || o->op_type != OP_NULL ||
11941 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11943 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11947 if (PL_op == obase)
11948 /* $a[uninit_expr] or $h{uninit_expr} */
11949 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11952 o = cBINOPx(obase)->op_first;
11953 kid = cBINOPx(obase)->op_last;
11955 /* get the av or hv, and optionally the gv */
11957 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11958 sv = PAD_SV(o->op_targ);
11960 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11961 && cUNOPo->op_first->op_type == OP_GV)
11963 gv = cGVOPx_gv(cUNOPo->op_first);
11966 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11971 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11972 /* index is constant */
11976 if (obase->op_type == OP_HELEM) {
11977 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11978 if (!he || HeVAL(he) != uninit_sv)
11982 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11983 if (!svp || *svp != uninit_sv)
11987 if (obase->op_type == OP_HELEM)
11988 return varname(gv, '%', o->op_targ,
11989 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11991 return varname(gv, '@', o->op_targ, NULL,
11992 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11995 /* index is an expression;
11996 * attempt to find a match within the aggregate */
11997 if (obase->op_type == OP_HELEM) {
11998 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12000 return varname(gv, '%', o->op_targ,
12001 keysv, 0, FUV_SUBSCRIPT_HASH);
12004 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12006 return varname(gv, '@', o->op_targ,
12007 NULL, index, FUV_SUBSCRIPT_ARRAY);
12012 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12014 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12019 /* only examine RHS */
12020 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12023 o = cUNOPx(obase)->op_first;
12024 if (o->op_type == OP_PUSHMARK)
12027 if (!o->op_sibling) {
12028 /* one-arg version of open is highly magical */
12030 if (o->op_type == OP_GV) { /* open FOO; */
12032 if (match && GvSV(gv) != uninit_sv)
12034 return varname(gv, '$', 0,
12035 NULL, 0, FUV_SUBSCRIPT_NONE);
12037 /* other possibilities not handled are:
12038 * open $x; or open my $x; should return '${*$x}'
12039 * open expr; should return '$'.expr ideally
12045 /* ops where $_ may be an implicit arg */
12049 if ( !(obase->op_flags & OPf_STACKED)) {
12050 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12051 ? PAD_SVl(obase->op_targ)
12054 sv = sv_newmortal();
12055 sv_setpvn(sv, "$_", 2);
12064 /* skip filehandle as it can't produce 'undef' warning */
12065 o = cUNOPx(obase)->op_first;
12066 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12067 o = o->op_sibling->op_sibling;
12074 match = 1; /* XS or custom code could trigger random warnings */
12079 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12080 return sv_2mortal(newSVpvs("${$/}"));
12085 if (!(obase->op_flags & OPf_KIDS))
12087 o = cUNOPx(obase)->op_first;
12093 /* if all except one arg are constant, or have no side-effects,
12094 * or are optimized away, then it's unambiguous */
12096 for (kid=o; kid; kid = kid->op_sibling) {
12098 const OPCODE type = kid->op_type;
12099 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12100 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12101 || (type == OP_PUSHMARK)
12105 if (o2) { /* more than one found */
12112 return find_uninit_var(o2, uninit_sv, match);
12114 /* scan all args */
12116 sv = find_uninit_var(o, uninit_sv, 1);
12128 =for apidoc report_uninit
12130 Print appropriate "Use of uninitialized variable" warning
12136 Perl_report_uninit(pTHX_ SV* uninit_sv)
12140 SV* varname = NULL;
12142 varname = find_uninit_var(PL_op, uninit_sv,0);
12144 sv_insert(varname, 0, 0, " ", 1);
12146 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12147 varname ? SvPV_nolen_const(varname) : "",
12148 " in ", OP_DESC(PL_op));
12151 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12157 * c-indentation-style: bsd
12158 * c-basic-offset: 4
12159 * indent-tabs-mode: t
12162 * ex: set ts=8 sts=4 sw=4 noet: