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 always 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]) {
2784 if (isGV_with_GP(sv))
2785 return glob_2pv((GV *)sv, lp);
2787 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2791 if (SvTYPE(sv) < SVt_PV)
2792 /* Typically the caller expects that sv_any is not NULL now. */
2793 sv_upgrade(sv, SVt_PV);
2797 const STRLEN len = s - SvPVX_const(sv);
2803 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2804 PTR2UV(sv),SvPVX_const(sv)));
2805 if (flags & SV_CONST_RETURN)
2806 return (char *)SvPVX_const(sv);
2807 if (flags & SV_MUTABLE_RETURN)
2808 return SvPVX_mutable(sv);
2813 =for apidoc sv_copypv
2815 Copies a stringified representation of the source SV into the
2816 destination SV. Automatically performs any necessary mg_get and
2817 coercion of numeric values into strings. Guaranteed to preserve
2818 UTF8 flag even from overloaded objects. Similar in nature to
2819 sv_2pv[_flags] but operates directly on an SV instead of just the
2820 string. Mostly uses sv_2pv_flags to do its work, except when that
2821 would lose the UTF-8'ness of the PV.
2827 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2830 const char * const s = SvPV_const(ssv,len);
2831 sv_setpvn(dsv,s,len);
2839 =for apidoc sv_2pvbyte
2841 Return a pointer to the byte-encoded representation of the SV, and set *lp
2842 to its length. May cause the SV to be downgraded from UTF-8 as a
2845 Usually accessed via the C<SvPVbyte> macro.
2851 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2853 sv_utf8_downgrade(sv,0);
2854 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2858 =for apidoc sv_2pvutf8
2860 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2861 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2863 Usually accessed via the C<SvPVutf8> macro.
2869 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2871 sv_utf8_upgrade(sv);
2872 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2877 =for apidoc sv_2bool
2879 This function is only called on magical items, and is only used by
2880 sv_true() or its macro equivalent.
2886 Perl_sv_2bool(pTHX_ register SV *sv)
2895 SV * const tmpsv = AMG_CALLun(sv,bool_);
2896 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2897 return (bool)SvTRUE(tmpsv);
2899 return SvRV(sv) != 0;
2902 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2904 (*sv->sv_u.svu_pv > '0' ||
2905 Xpvtmp->xpv_cur > 1 ||
2906 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2913 return SvIVX(sv) != 0;
2916 return SvNVX(sv) != 0.0;
2918 if (isGV_with_GP(sv))
2928 =for apidoc sv_utf8_upgrade
2930 Converts the PV of an SV to its UTF-8-encoded form.
2931 Forces the SV to string form if it is not already.
2932 Always sets the SvUTF8 flag to avoid future validity checks even
2933 if all the bytes have hibit clear.
2935 This is not as a general purpose byte encoding to Unicode interface:
2936 use the Encode extension for that.
2938 =for apidoc sv_utf8_upgrade_flags
2940 Converts the PV of an SV to its UTF-8-encoded form.
2941 Forces the SV to string form if it is not already.
2942 Always sets the SvUTF8 flag to avoid future validity checks even
2943 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2944 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2945 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2947 This is not as a general purpose byte encoding to Unicode interface:
2948 use the Encode extension for that.
2954 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2957 if (sv == &PL_sv_undef)
2961 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2962 (void) sv_2pv_flags(sv,&len, flags);
2966 (void) SvPV_force(sv,len);
2975 sv_force_normal_flags(sv, 0);
2978 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2979 sv_recode_to_utf8(sv, PL_encoding);
2980 else { /* Assume Latin-1/EBCDIC */
2981 /* This function could be much more efficient if we
2982 * had a FLAG in SVs to signal if there are any hibit
2983 * chars in the PV. Given that there isn't such a flag
2984 * make the loop as fast as possible. */
2985 const U8 * const s = (U8 *) SvPVX_const(sv);
2986 const U8 * const e = (U8 *) SvEND(sv);
2991 /* Check for hi bit */
2992 if (!NATIVE_IS_INVARIANT(ch)) {
2993 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2994 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2996 SvPV_free(sv); /* No longer using what was there before. */
2997 SvPV_set(sv, (char*)recoded);
2998 SvCUR_set(sv, len - 1);
2999 SvLEN_set(sv, len); /* No longer know the real size. */
3003 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3010 =for apidoc sv_utf8_downgrade
3012 Attempts to convert the PV of an SV from characters to bytes.
3013 If the PV contains a character beyond byte, this conversion will fail;
3014 in this case, either returns false or, if C<fail_ok> is not
3017 This is not as a general purpose Unicode to byte encoding interface:
3018 use the Encode extension for that.
3024 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3027 if (SvPOKp(sv) && SvUTF8(sv)) {
3033 sv_force_normal_flags(sv, 0);
3035 s = (U8 *) SvPV(sv, len);
3036 if (!utf8_to_bytes(s, &len)) {
3041 Perl_croak(aTHX_ "Wide character in %s",
3044 Perl_croak(aTHX_ "Wide character");
3055 =for apidoc sv_utf8_encode
3057 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3058 flag off so that it looks like octets again.
3064 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3067 sv_force_normal_flags(sv, 0);
3069 if (SvREADONLY(sv)) {
3070 Perl_croak(aTHX_ PL_no_modify);
3072 (void) sv_utf8_upgrade(sv);
3077 =for apidoc sv_utf8_decode
3079 If the PV of the SV is an octet sequence in UTF-8
3080 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3081 so that it looks like a character. If the PV contains only single-byte
3082 characters, the C<SvUTF8> flag stays being off.
3083 Scans PV for validity and returns false if the PV is invalid UTF-8.
3089 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3095 /* The octets may have got themselves encoded - get them back as
3098 if (!sv_utf8_downgrade(sv, TRUE))
3101 /* it is actually just a matter of turning the utf8 flag on, but
3102 * we want to make sure everything inside is valid utf8 first.
3104 c = (const U8 *) SvPVX_const(sv);
3105 if (!is_utf8_string(c, SvCUR(sv)+1))
3107 e = (const U8 *) SvEND(sv);
3110 if (!UTF8_IS_INVARIANT(ch)) {
3120 =for apidoc sv_setsv
3122 Copies the contents of the source SV C<ssv> into the destination SV
3123 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3124 function if the source SV needs to be reused. Does not handle 'set' magic.
3125 Loosely speaking, it performs a copy-by-value, obliterating any previous
3126 content of the destination.
3128 You probably want to use one of the assortment of wrappers, such as
3129 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3130 C<SvSetMagicSV_nosteal>.
3132 =for apidoc sv_setsv_flags
3134 Copies the contents of the source SV C<ssv> into the destination SV
3135 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3136 function if the source SV needs to be reused. Does not handle 'set' magic.
3137 Loosely speaking, it performs a copy-by-value, obliterating any previous
3138 content of the destination.
3139 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3140 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3141 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3142 and C<sv_setsv_nomg> are implemented in terms of this function.
3144 You probably want to use one of the assortment of wrappers, such as
3145 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3146 C<SvSetMagicSV_nosteal>.
3148 This is the primary function for copying scalars, and most other
3149 copy-ish functions and macros use this underneath.
3155 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3157 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3159 if (dtype != SVt_PVGV) {
3160 const char * const name = GvNAME(sstr);
3161 const STRLEN len = GvNAMELEN(sstr);
3163 if (dtype >= SVt_PV) {
3169 SvUPGRADE(dstr, SVt_PVGV);
3170 (void)SvOK_off(dstr);
3171 /* FIXME - why are we doing this, then turning it off and on again
3173 isGV_with_GP_on(dstr);
3175 GvSTASH(dstr) = GvSTASH(sstr);
3177 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3178 gv_name_set((GV *)dstr, name, len, GV_ADD);
3179 SvFAKE_on(dstr); /* can coerce to non-glob */
3182 #ifdef GV_UNIQUE_CHECK
3183 if (GvUNIQUE((GV*)dstr)) {
3184 Perl_croak(aTHX_ PL_no_modify);
3188 if(GvGP((GV*)sstr)) {
3189 /* If source has method cache entry, clear it */
3191 SvREFCNT_dec(GvCV(sstr));
3195 /* If source has a real method, then a method is
3197 else if(GvCV((GV*)sstr)) {
3202 /* If dest already had a real method, that's a change as well */
3203 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3207 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3211 isGV_with_GP_off(dstr);
3212 (void)SvOK_off(dstr);
3213 isGV_with_GP_on(dstr);
3214 GvINTRO_off(dstr); /* one-shot flag */
3215 GvGP(dstr) = gp_ref(GvGP(sstr));
3216 if (SvTAINTED(sstr))
3218 if (GvIMPORTED(dstr) != GVf_IMPORTED
3219 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3221 GvIMPORTED_on(dstr);
3224 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3225 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3230 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3231 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3233 const int intro = GvINTRO(dstr);
3236 const U32 stype = SvTYPE(sref);
3239 #ifdef GV_UNIQUE_CHECK
3240 if (GvUNIQUE((GV*)dstr)) {
3241 Perl_croak(aTHX_ PL_no_modify);
3246 GvINTRO_off(dstr); /* one-shot flag */
3247 GvLINE(dstr) = CopLINE(PL_curcop);
3248 GvEGV(dstr) = (GV*)dstr;
3253 location = (SV **) &GvCV(dstr);
3254 import_flag = GVf_IMPORTED_CV;
3257 location = (SV **) &GvHV(dstr);
3258 import_flag = GVf_IMPORTED_HV;
3261 location = (SV **) &GvAV(dstr);
3262 import_flag = GVf_IMPORTED_AV;
3265 location = (SV **) &GvIOp(dstr);
3268 location = (SV **) &GvFORM(dstr);
3270 location = &GvSV(dstr);
3271 import_flag = GVf_IMPORTED_SV;
3274 if (stype == SVt_PVCV) {
3275 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3276 if (GvCVGEN(dstr)) {
3277 SvREFCNT_dec(GvCV(dstr));
3279 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3282 SAVEGENERICSV(*location);
3286 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3287 CV* const cv = (CV*)*location;
3289 if (!GvCVGEN((GV*)dstr) &&
3290 (CvROOT(cv) || CvXSUB(cv)))
3292 /* Redefining a sub - warning is mandatory if
3293 it was a const and its value changed. */
3294 if (CvCONST(cv) && CvCONST((CV*)sref)
3295 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3297 /* They are 2 constant subroutines generated from
3298 the same constant. This probably means that
3299 they are really the "same" proxy subroutine
3300 instantiated in 2 places. Most likely this is
3301 when a constant is exported twice. Don't warn.
3304 else if (ckWARN(WARN_REDEFINE)
3306 && (!CvCONST((CV*)sref)
3307 || sv_cmp(cv_const_sv(cv),
3308 cv_const_sv((CV*)sref))))) {
3309 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3312 ? "Constant subroutine %s::%s redefined"
3313 : "Subroutine %s::%s redefined"),
3314 HvNAME_get(GvSTASH((GV*)dstr)),
3315 GvENAME((GV*)dstr));
3319 cv_ckproto_len(cv, (GV*)dstr,
3320 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3321 SvPOK(sref) ? SvCUR(sref) : 0);
3323 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3324 GvASSUMECV_on(dstr);
3325 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3328 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3329 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3330 GvFLAGS(dstr) |= import_flag;
3335 if (SvTAINTED(sstr))
3341 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3344 register U32 sflags;
3346 register svtype stype;
3351 if (SvIS_FREED(dstr)) {
3352 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3353 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3355 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3357 sstr = &PL_sv_undef;
3358 if (SvIS_FREED(sstr)) {
3359 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3360 (void*)sstr, (void*)dstr);
3362 stype = SvTYPE(sstr);
3363 dtype = SvTYPE(dstr);
3365 (void)SvAMAGIC_off(dstr);
3368 /* need to nuke the magic */
3370 SvRMAGICAL_off(dstr);
3373 /* There's a lot of redundancy below but we're going for speed here */
3378 if (dtype != SVt_PVGV) {
3379 (void)SvOK_off(dstr);
3387 sv_upgrade(dstr, SVt_IV);
3392 sv_upgrade(dstr, SVt_PVIV);
3395 goto end_of_first_switch;
3397 (void)SvIOK_only(dstr);
3398 SvIV_set(dstr, SvIVX(sstr));
3401 /* SvTAINTED can only be true if the SV has taint magic, which in
3402 turn means that the SV type is PVMG (or greater). This is the
3403 case statement for SVt_IV, so this cannot be true (whatever gcov
3405 assert(!SvTAINTED(sstr));
3415 sv_upgrade(dstr, SVt_NV);
3420 sv_upgrade(dstr, SVt_PVNV);
3423 goto end_of_first_switch;
3425 SvNV_set(dstr, SvNVX(sstr));
3426 (void)SvNOK_only(dstr);
3427 /* SvTAINTED can only be true if the SV has taint magic, which in
3428 turn means that the SV type is PVMG (or greater). This is the
3429 case statement for SVt_NV, so this cannot be true (whatever gcov
3431 assert(!SvTAINTED(sstr));
3438 sv_upgrade(dstr, SVt_RV);
3441 #ifdef PERL_OLD_COPY_ON_WRITE
3442 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3443 if (dtype < SVt_PVIV)
3444 sv_upgrade(dstr, SVt_PVIV);
3451 sv_upgrade(dstr, SVt_PV);
3454 if (dtype < SVt_PVIV)
3455 sv_upgrade(dstr, SVt_PVIV);
3458 if (dtype < SVt_PVNV)
3459 sv_upgrade(dstr, SVt_PVNV);
3463 const char * const type = sv_reftype(sstr,0);
3465 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3467 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3471 /* case SVt_BIND: */
3474 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3475 glob_assign_glob(dstr, sstr, dtype);
3478 /* SvVALID means that this PVGV is playing at being an FBM. */
3482 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3484 if (SvTYPE(sstr) != stype) {
3485 stype = SvTYPE(sstr);
3486 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3487 glob_assign_glob(dstr, sstr, dtype);
3492 if (stype == SVt_PVLV)
3493 SvUPGRADE(dstr, SVt_PVNV);
3495 SvUPGRADE(dstr, (svtype)stype);
3497 end_of_first_switch:
3499 /* dstr may have been upgraded. */
3500 dtype = SvTYPE(dstr);
3501 sflags = SvFLAGS(sstr);
3503 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3504 /* Assigning to a subroutine sets the prototype. */
3507 const char *const ptr = SvPV_const(sstr, len);
3509 SvGROW(dstr, len + 1);
3510 Copy(ptr, SvPVX(dstr), len + 1, char);
3511 SvCUR_set(dstr, len);
3513 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3517 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3518 const char * const type = sv_reftype(dstr,0);
3520 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3522 Perl_croak(aTHX_ "Cannot copy to %s", type);
3523 } else if (sflags & SVf_ROK) {
3524 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3525 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3528 if (GvIMPORTED(dstr) != GVf_IMPORTED
3529 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3531 GvIMPORTED_on(dstr);
3536 glob_assign_glob(dstr, sstr, dtype);
3540 if (dtype >= SVt_PV) {
3541 if (dtype == SVt_PVGV) {
3542 glob_assign_ref(dstr, sstr);
3545 if (SvPVX_const(dstr)) {
3551 (void)SvOK_off(dstr);
3552 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3553 SvFLAGS(dstr) |= sflags & SVf_ROK;
3554 assert(!(sflags & SVp_NOK));
3555 assert(!(sflags & SVp_IOK));
3556 assert(!(sflags & SVf_NOK));
3557 assert(!(sflags & SVf_IOK));
3559 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3560 if (!(sflags & SVf_OK)) {
3561 if (ckWARN(WARN_MISC))
3562 Perl_warner(aTHX_ packWARN(WARN_MISC),
3563 "Undefined value assigned to typeglob");
3566 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3567 if (dstr != (SV*)gv) {
3570 GvGP(dstr) = gp_ref(GvGP(gv));
3574 else if (sflags & SVp_POK) {
3578 * Check to see if we can just swipe the string. If so, it's a
3579 * possible small lose on short strings, but a big win on long ones.
3580 * It might even be a win on short strings if SvPVX_const(dstr)
3581 * has to be allocated and SvPVX_const(sstr) has to be freed.
3582 * Likewise if we can set up COW rather than doing an actual copy, we
3583 * drop to the else clause, as the swipe code and the COW setup code
3584 * have much in common.
3587 /* Whichever path we take through the next code, we want this true,
3588 and doing it now facilitates the COW check. */
3589 (void)SvPOK_only(dstr);
3592 /* If we're already COW then this clause is not true, and if COW
3593 is allowed then we drop down to the else and make dest COW
3594 with us. If caller hasn't said that we're allowed to COW
3595 shared hash keys then we don't do the COW setup, even if the
3596 source scalar is a shared hash key scalar. */
3597 (((flags & SV_COW_SHARED_HASH_KEYS)
3598 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3599 : 1 /* If making a COW copy is forbidden then the behaviour we
3600 desire is as if the source SV isn't actually already
3601 COW, even if it is. So we act as if the source flags
3602 are not COW, rather than actually testing them. */
3604 #ifndef PERL_OLD_COPY_ON_WRITE
3605 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3606 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3607 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3608 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3609 but in turn, it's somewhat dead code, never expected to go
3610 live, but more kept as a placeholder on how to do it better
3611 in a newer implementation. */
3612 /* If we are COW and dstr is a suitable target then we drop down
3613 into the else and make dest a COW of us. */
3614 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3619 (sflags & SVs_TEMP) && /* slated for free anyway? */
3620 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3621 (!(flags & SV_NOSTEAL)) &&
3622 /* and we're allowed to steal temps */
3623 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3624 SvLEN(sstr) && /* and really is a string */
3625 /* and won't be needed again, potentially */
3626 !(PL_op && PL_op->op_type == OP_AASSIGN))
3627 #ifdef PERL_OLD_COPY_ON_WRITE
3628 && ((flags & SV_COW_SHARED_HASH_KEYS)
3629 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3630 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3631 && SvTYPE(sstr) >= SVt_PVIV))
3635 /* Failed the swipe test, and it's not a shared hash key either.
3636 Have to copy the string. */
3637 STRLEN len = SvCUR(sstr);
3638 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3639 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3640 SvCUR_set(dstr, len);
3641 *SvEND(dstr) = '\0';
3643 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3645 /* Either it's a shared hash key, or it's suitable for
3646 copy-on-write or we can swipe the string. */
3648 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3652 #ifdef PERL_OLD_COPY_ON_WRITE
3654 /* I believe I should acquire a global SV mutex if
3655 it's a COW sv (not a shared hash key) to stop
3656 it going un copy-on-write.
3657 If the source SV has gone un copy on write between up there
3658 and down here, then (assert() that) it is of the correct
3659 form to make it copy on write again */
3660 if ((sflags & (SVf_FAKE | SVf_READONLY))
3661 != (SVf_FAKE | SVf_READONLY)) {
3662 SvREADONLY_on(sstr);
3664 /* Make the source SV into a loop of 1.
3665 (about to become 2) */
3666 SV_COW_NEXT_SV_SET(sstr, sstr);
3670 /* Initial code is common. */
3671 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3676 /* making another shared SV. */
3677 STRLEN cur = SvCUR(sstr);
3678 STRLEN len = SvLEN(sstr);
3679 #ifdef PERL_OLD_COPY_ON_WRITE
3681 assert (SvTYPE(dstr) >= SVt_PVIV);
3682 /* SvIsCOW_normal */
3683 /* splice us in between source and next-after-source. */
3684 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3685 SV_COW_NEXT_SV_SET(sstr, dstr);
3686 SvPV_set(dstr, SvPVX_mutable(sstr));
3690 /* SvIsCOW_shared_hash */
3691 DEBUG_C(PerlIO_printf(Perl_debug_log,
3692 "Copy on write: Sharing hash\n"));
3694 assert (SvTYPE(dstr) >= SVt_PV);
3696 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3698 SvLEN_set(dstr, len);
3699 SvCUR_set(dstr, cur);
3700 SvREADONLY_on(dstr);
3702 /* Relesase a global SV mutex. */
3705 { /* Passes the swipe test. */
3706 SvPV_set(dstr, SvPVX_mutable(sstr));
3707 SvLEN_set(dstr, SvLEN(sstr));
3708 SvCUR_set(dstr, SvCUR(sstr));
3711 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3712 SvPV_set(sstr, NULL);
3718 if (sflags & SVp_NOK) {
3719 SvNV_set(dstr, SvNVX(sstr));
3721 if (sflags & SVp_IOK) {
3723 SvIV_set(dstr, SvIVX(sstr));
3724 /* Must do this otherwise some other overloaded use of 0x80000000
3725 gets confused. I guess SVpbm_VALID */
3726 if (sflags & SVf_IVisUV)
3729 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3731 const MAGIC * const smg = SvVSTRING_mg(sstr);
3733 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3734 smg->mg_ptr, smg->mg_len);
3735 SvRMAGICAL_on(dstr);
3739 else if (sflags & (SVp_IOK|SVp_NOK)) {
3740 (void)SvOK_off(dstr);
3741 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3742 if (sflags & SVp_IOK) {
3743 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3744 SvIV_set(dstr, SvIVX(sstr));
3746 if (sflags & SVp_NOK) {
3747 SvNV_set(dstr, SvNVX(sstr));
3751 if (isGV_with_GP(sstr)) {
3752 /* This stringification rule for globs is spread in 3 places.
3753 This feels bad. FIXME. */
3754 const U32 wasfake = sflags & SVf_FAKE;
3756 /* FAKE globs can get coerced, so need to turn this off
3757 temporarily if it is on. */
3759 gv_efullname3(dstr, (GV *)sstr, "*");
3760 SvFLAGS(sstr) |= wasfake;
3763 (void)SvOK_off(dstr);
3765 if (SvTAINTED(sstr))
3770 =for apidoc sv_setsv_mg
3772 Like C<sv_setsv>, but also handles 'set' magic.
3778 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3780 sv_setsv(dstr,sstr);
3784 #ifdef PERL_OLD_COPY_ON_WRITE
3786 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3788 STRLEN cur = SvCUR(sstr);
3789 STRLEN len = SvLEN(sstr);
3790 register char *new_pv;
3793 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3794 (void*)sstr, (void*)dstr);
3801 if (SvTHINKFIRST(dstr))
3802 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3803 else if (SvPVX_const(dstr))
3804 Safefree(SvPVX_const(dstr));
3808 SvUPGRADE(dstr, SVt_PVIV);
3810 assert (SvPOK(sstr));
3811 assert (SvPOKp(sstr));
3812 assert (!SvIOK(sstr));
3813 assert (!SvIOKp(sstr));
3814 assert (!SvNOK(sstr));
3815 assert (!SvNOKp(sstr));
3817 if (SvIsCOW(sstr)) {
3819 if (SvLEN(sstr) == 0) {
3820 /* source is a COW shared hash key. */
3821 DEBUG_C(PerlIO_printf(Perl_debug_log,
3822 "Fast copy on write: Sharing hash\n"));
3823 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3826 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3828 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3829 SvUPGRADE(sstr, SVt_PVIV);
3830 SvREADONLY_on(sstr);
3832 DEBUG_C(PerlIO_printf(Perl_debug_log,
3833 "Fast copy on write: Converting sstr to COW\n"));
3834 SV_COW_NEXT_SV_SET(dstr, sstr);
3836 SV_COW_NEXT_SV_SET(sstr, dstr);
3837 new_pv = SvPVX_mutable(sstr);
3840 SvPV_set(dstr, new_pv);
3841 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3844 SvLEN_set(dstr, len);
3845 SvCUR_set(dstr, cur);
3854 =for apidoc sv_setpvn
3856 Copies a string into an SV. The C<len> parameter indicates the number of
3857 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3858 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3864 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3867 register char *dptr;
3869 SV_CHECK_THINKFIRST_COW_DROP(sv);
3875 /* len is STRLEN which is unsigned, need to copy to signed */
3878 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3880 SvUPGRADE(sv, SVt_PV);
3882 dptr = SvGROW(sv, len + 1);
3883 Move(ptr,dptr,len,char);
3886 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3891 =for apidoc sv_setpvn_mg
3893 Like C<sv_setpvn>, but also handles 'set' magic.
3899 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3901 sv_setpvn(sv,ptr,len);
3906 =for apidoc sv_setpv
3908 Copies a string into an SV. The string must be null-terminated. Does not
3909 handle 'set' magic. See C<sv_setpv_mg>.
3915 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3918 register STRLEN len;
3920 SV_CHECK_THINKFIRST_COW_DROP(sv);
3926 SvUPGRADE(sv, SVt_PV);
3928 SvGROW(sv, len + 1);
3929 Move(ptr,SvPVX(sv),len+1,char);
3931 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3936 =for apidoc sv_setpv_mg
3938 Like C<sv_setpv>, but also handles 'set' magic.
3944 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3951 =for apidoc sv_usepvn_flags
3953 Tells an SV to use C<ptr> to find its string value. Normally the
3954 string is stored inside the SV but sv_usepvn allows the SV to use an
3955 outside string. The C<ptr> should point to memory that was allocated
3956 by C<malloc>. The string length, C<len>, must be supplied. By default
3957 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3958 so that pointer should not be freed or used by the programmer after
3959 giving it to sv_usepvn, and neither should any pointers from "behind"
3960 that pointer (e.g. ptr + 1) be used.
3962 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3963 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3964 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3965 C<len>, and already meets the requirements for storing in C<SvPVX>)
3971 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3975 SV_CHECK_THINKFIRST_COW_DROP(sv);
3976 SvUPGRADE(sv, SVt_PV);
3979 if (flags & SV_SMAGIC)
3983 if (SvPVX_const(sv))
3987 if (flags & SV_HAS_TRAILING_NUL)
3988 assert(ptr[len] == '\0');
3991 allocate = (flags & SV_HAS_TRAILING_NUL)
3992 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3993 if (flags & SV_HAS_TRAILING_NUL) {
3994 /* It's long enough - do nothing.
3995 Specfically Perl_newCONSTSUB is relying on this. */
3998 /* Force a move to shake out bugs in callers. */
3999 char *new_ptr = (char*)safemalloc(allocate);
4000 Copy(ptr, new_ptr, len, char);
4001 PoisonFree(ptr,len,char);
4005 ptr = (char*) saferealloc (ptr, allocate);
4010 SvLEN_set(sv, allocate);
4011 if (!(flags & SV_HAS_TRAILING_NUL)) {
4014 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4016 if (flags & SV_SMAGIC)
4020 #ifdef PERL_OLD_COPY_ON_WRITE
4021 /* Need to do this *after* making the SV normal, as we need the buffer
4022 pointer to remain valid until after we've copied it. If we let go too early,
4023 another thread could invalidate it by unsharing last of the same hash key
4024 (which it can do by means other than releasing copy-on-write Svs)
4025 or by changing the other copy-on-write SVs in the loop. */
4027 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4029 { /* this SV was SvIsCOW_normal(sv) */
4030 /* we need to find the SV pointing to us. */
4031 SV *current = SV_COW_NEXT_SV(after);
4033 if (current == sv) {
4034 /* The SV we point to points back to us (there were only two of us
4036 Hence other SV is no longer copy on write either. */
4038 SvREADONLY_off(after);
4040 /* We need to follow the pointers around the loop. */
4042 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4045 /* don't loop forever if the structure is bust, and we have
4046 a pointer into a closed loop. */
4047 assert (current != after);
4048 assert (SvPVX_const(current) == pvx);
4050 /* Make the SV before us point to the SV after us. */
4051 SV_COW_NEXT_SV_SET(current, after);
4057 =for apidoc sv_force_normal_flags
4059 Undo various types of fakery on an SV: if the PV is a shared string, make
4060 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4061 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4062 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4063 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4064 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4065 set to some other value.) In addition, the C<flags> parameter gets passed to
4066 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4067 with flags set to 0.
4073 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4076 #ifdef PERL_OLD_COPY_ON_WRITE
4077 if (SvREADONLY(sv)) {
4078 /* At this point I believe I should acquire a global SV mutex. */
4080 const char * const pvx = SvPVX_const(sv);
4081 const STRLEN len = SvLEN(sv);
4082 const STRLEN cur = SvCUR(sv);
4083 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4084 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4085 we'll fail an assertion. */
4086 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4089 PerlIO_printf(Perl_debug_log,
4090 "Copy on write: Force normal %ld\n",
4096 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4099 if (flags & SV_COW_DROP_PV) {
4100 /* OK, so we don't need to copy our buffer. */
4103 SvGROW(sv, cur + 1);
4104 Move(pvx,SvPVX(sv),cur,char);
4109 sv_release_COW(sv, pvx, next);
4111 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4117 else if (IN_PERL_RUNTIME)
4118 Perl_croak(aTHX_ PL_no_modify);
4119 /* At this point I believe that I can drop the global SV mutex. */
4122 if (SvREADONLY(sv)) {
4124 const char * const pvx = SvPVX_const(sv);
4125 const STRLEN len = SvCUR(sv);
4130 SvGROW(sv, len + 1);
4131 Move(pvx,SvPVX(sv),len,char);
4133 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4135 else if (IN_PERL_RUNTIME)
4136 Perl_croak(aTHX_ PL_no_modify);
4140 sv_unref_flags(sv, flags);
4141 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4148 Efficient removal of characters from the beginning of the string buffer.
4149 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4150 the string buffer. The C<ptr> becomes the first character of the adjusted
4151 string. Uses the "OOK hack".
4152 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4153 refer to the same chunk of data.
4159 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4161 register STRLEN delta;
4162 if (!ptr || !SvPOKp(sv))
4164 delta = ptr - SvPVX_const(sv);
4165 SV_CHECK_THINKFIRST(sv);
4166 if (SvTYPE(sv) < SVt_PVIV)
4167 sv_upgrade(sv,SVt_PVIV);
4170 if (!SvLEN(sv)) { /* make copy of shared string */
4171 const char *pvx = SvPVX_const(sv);
4172 const STRLEN len = SvCUR(sv);
4173 SvGROW(sv, len + 1);
4174 Move(pvx,SvPVX(sv),len,char);
4178 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4179 and we do that anyway inside the SvNIOK_off
4181 SvFLAGS(sv) |= SVf_OOK;
4184 SvLEN_set(sv, SvLEN(sv) - delta);
4185 SvCUR_set(sv, SvCUR(sv) - delta);
4186 SvPV_set(sv, SvPVX(sv) + delta);
4187 SvIV_set(sv, SvIVX(sv) + delta);
4191 =for apidoc sv_catpvn
4193 Concatenates the string onto the end of the string which is in the SV. The
4194 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4195 status set, then the bytes appended should be valid UTF-8.
4196 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4198 =for apidoc sv_catpvn_flags
4200 Concatenates the string onto the end of the string which is in the SV. The
4201 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4202 status set, then the bytes appended should be valid UTF-8.
4203 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4204 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4205 in terms of this function.
4211 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4215 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4217 SvGROW(dsv, dlen + slen + 1);
4219 sstr = SvPVX_const(dsv);
4220 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4221 SvCUR_set(dsv, SvCUR(dsv) + slen);
4223 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4225 if (flags & SV_SMAGIC)
4230 =for apidoc sv_catsv
4232 Concatenates the string from SV C<ssv> onto the end of the string in
4233 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4234 not 'set' magic. See C<sv_catsv_mg>.
4236 =for apidoc sv_catsv_flags
4238 Concatenates the string from SV C<ssv> onto the end of the string in
4239 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4240 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4241 and C<sv_catsv_nomg> are implemented in terms of this function.
4246 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4251 const char *spv = SvPV_const(ssv, slen);
4253 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4254 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4255 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4256 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4257 dsv->sv_flags doesn't have that bit set.
4258 Andy Dougherty 12 Oct 2001
4260 const I32 sutf8 = DO_UTF8(ssv);
4263 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4265 dutf8 = DO_UTF8(dsv);
4267 if (dutf8 != sutf8) {
4269 /* Not modifying source SV, so taking a temporary copy. */
4270 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4272 sv_utf8_upgrade(csv);
4273 spv = SvPV_const(csv, slen);
4276 sv_utf8_upgrade_nomg(dsv);
4278 sv_catpvn_nomg(dsv, spv, slen);
4281 if (flags & SV_SMAGIC)
4286 =for apidoc sv_catpv
4288 Concatenates the string onto the end of the string which is in the SV.
4289 If the SV has the UTF-8 status set, then the bytes appended should be
4290 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4295 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4298 register STRLEN len;
4304 junk = SvPV_force(sv, tlen);
4306 SvGROW(sv, tlen + len + 1);
4308 ptr = SvPVX_const(sv);
4309 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4310 SvCUR_set(sv, SvCUR(sv) + len);
4311 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4316 =for apidoc sv_catpv_mg
4318 Like C<sv_catpv>, but also handles 'set' magic.
4324 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4333 Creates a new SV. A non-zero C<len> parameter indicates the number of
4334 bytes of preallocated string space the SV should have. An extra byte for a
4335 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4336 space is allocated.) The reference count for the new SV is set to 1.
4338 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4339 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4340 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4341 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4342 modules supporting older perls.
4348 Perl_newSV(pTHX_ STRLEN len)
4355 sv_upgrade(sv, SVt_PV);
4356 SvGROW(sv, len + 1);
4361 =for apidoc sv_magicext
4363 Adds magic to an SV, upgrading it if necessary. Applies the
4364 supplied vtable and returns a pointer to the magic added.
4366 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4367 In particular, you can add magic to SvREADONLY SVs, and add more than
4368 one instance of the same 'how'.
4370 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4371 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4372 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4373 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4375 (This is now used as a subroutine by C<sv_magic>.)
4380 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4381 const char* name, I32 namlen)
4386 SvUPGRADE(sv, SVt_PVMG);
4387 Newxz(mg, 1, MAGIC);
4388 mg->mg_moremagic = SvMAGIC(sv);
4389 SvMAGIC_set(sv, mg);
4391 /* Sometimes a magic contains a reference loop, where the sv and
4392 object refer to each other. To prevent a reference loop that
4393 would prevent such objects being freed, we look for such loops
4394 and if we find one we avoid incrementing the object refcount.
4396 Note we cannot do this to avoid self-tie loops as intervening RV must
4397 have its REFCNT incremented to keep it in existence.
4400 if (!obj || obj == sv ||
4401 how == PERL_MAGIC_arylen ||
4402 how == PERL_MAGIC_qr ||
4403 how == PERL_MAGIC_symtab ||
4404 (SvTYPE(obj) == SVt_PVGV &&
4405 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4406 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4407 GvFORM(obj) == (CV*)sv)))
4412 mg->mg_obj = SvREFCNT_inc_simple(obj);
4413 mg->mg_flags |= MGf_REFCOUNTED;
4416 /* Normal self-ties simply pass a null object, and instead of
4417 using mg_obj directly, use the SvTIED_obj macro to produce a
4418 new RV as needed. For glob "self-ties", we are tieing the PVIO
4419 with an RV obj pointing to the glob containing the PVIO. In
4420 this case, to avoid a reference loop, we need to weaken the
4424 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4425 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4431 mg->mg_len = namlen;
4434 mg->mg_ptr = savepvn(name, namlen);
4435 else if (namlen == HEf_SVKEY)
4436 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4438 mg->mg_ptr = (char *) name;
4440 mg->mg_virtual = (MGVTBL *) vtable;
4444 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4449 =for apidoc sv_magic
4451 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4452 then adds a new magic item of type C<how> to the head of the magic list.
4454 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4455 handling of the C<name> and C<namlen> arguments.
4457 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4458 to add more than one instance of the same 'how'.
4464 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4467 const MGVTBL *vtable;
4470 #ifdef PERL_OLD_COPY_ON_WRITE
4472 sv_force_normal_flags(sv, 0);
4474 if (SvREADONLY(sv)) {
4476 /* its okay to attach magic to shared strings; the subsequent
4477 * upgrade to PVMG will unshare the string */
4478 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4481 && how != PERL_MAGIC_regex_global
4482 && how != PERL_MAGIC_bm
4483 && how != PERL_MAGIC_fm
4484 && how != PERL_MAGIC_sv
4485 && how != PERL_MAGIC_backref
4488 Perl_croak(aTHX_ PL_no_modify);
4491 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4492 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4493 /* sv_magic() refuses to add a magic of the same 'how' as an
4496 if (how == PERL_MAGIC_taint) {
4498 /* Any scalar which already had taint magic on which someone
4499 (erroneously?) did SvIOK_on() or similar will now be
4500 incorrectly sporting public "OK" flags. */
4501 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4509 vtable = &PL_vtbl_sv;
4511 case PERL_MAGIC_overload:
4512 vtable = &PL_vtbl_amagic;
4514 case PERL_MAGIC_overload_elem:
4515 vtable = &PL_vtbl_amagicelem;
4517 case PERL_MAGIC_overload_table:
4518 vtable = &PL_vtbl_ovrld;
4521 vtable = &PL_vtbl_bm;
4523 case PERL_MAGIC_regdata:
4524 vtable = &PL_vtbl_regdata;
4526 case PERL_MAGIC_regdatum:
4527 vtable = &PL_vtbl_regdatum;
4529 case PERL_MAGIC_env:
4530 vtable = &PL_vtbl_env;
4533 vtable = &PL_vtbl_fm;
4535 case PERL_MAGIC_envelem:
4536 vtable = &PL_vtbl_envelem;
4538 case PERL_MAGIC_regex_global:
4539 vtable = &PL_vtbl_mglob;
4541 case PERL_MAGIC_isa:
4542 vtable = &PL_vtbl_isa;
4544 case PERL_MAGIC_isaelem:
4545 vtable = &PL_vtbl_isaelem;
4547 case PERL_MAGIC_nkeys:
4548 vtable = &PL_vtbl_nkeys;
4550 case PERL_MAGIC_dbfile:
4553 case PERL_MAGIC_dbline:
4554 vtable = &PL_vtbl_dbline;
4556 #ifdef USE_LOCALE_COLLATE
4557 case PERL_MAGIC_collxfrm:
4558 vtable = &PL_vtbl_collxfrm;
4560 #endif /* USE_LOCALE_COLLATE */
4561 case PERL_MAGIC_tied:
4562 vtable = &PL_vtbl_pack;
4564 case PERL_MAGIC_tiedelem:
4565 case PERL_MAGIC_tiedscalar:
4566 vtable = &PL_vtbl_packelem;
4569 vtable = &PL_vtbl_regexp;
4571 case PERL_MAGIC_hints:
4572 /* As this vtable is all NULL, we can reuse it. */
4573 case PERL_MAGIC_sig:
4574 vtable = &PL_vtbl_sig;
4576 case PERL_MAGIC_sigelem:
4577 vtable = &PL_vtbl_sigelem;
4579 case PERL_MAGIC_taint:
4580 vtable = &PL_vtbl_taint;
4582 case PERL_MAGIC_uvar:
4583 vtable = &PL_vtbl_uvar;
4585 case PERL_MAGIC_vec:
4586 vtable = &PL_vtbl_vec;
4588 case PERL_MAGIC_arylen_p:
4589 case PERL_MAGIC_rhash:
4590 case PERL_MAGIC_symtab:
4591 case PERL_MAGIC_vstring:
4594 case PERL_MAGIC_utf8:
4595 vtable = &PL_vtbl_utf8;
4597 case PERL_MAGIC_substr:
4598 vtable = &PL_vtbl_substr;
4600 case PERL_MAGIC_defelem:
4601 vtable = &PL_vtbl_defelem;
4603 case PERL_MAGIC_arylen:
4604 vtable = &PL_vtbl_arylen;
4606 case PERL_MAGIC_pos:
4607 vtable = &PL_vtbl_pos;
4609 case PERL_MAGIC_backref:
4610 vtable = &PL_vtbl_backref;
4612 case PERL_MAGIC_hintselem:
4613 vtable = &PL_vtbl_hintselem;
4615 case PERL_MAGIC_ext:
4616 /* Reserved for use by extensions not perl internals. */
4617 /* Useful for attaching extension internal data to perl vars. */
4618 /* Note that multiple extensions may clash if magical scalars */
4619 /* etc holding private data from one are passed to another. */
4623 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4626 /* Rest of work is done else where */
4627 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4630 case PERL_MAGIC_taint:
4633 case PERL_MAGIC_ext:
4634 case PERL_MAGIC_dbfile:
4641 =for apidoc sv_unmagic
4643 Removes all magic of type C<type> from an SV.
4649 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4653 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4655 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4656 for (mg = *mgp; mg; mg = *mgp) {
4657 if (mg->mg_type == type) {
4658 const MGVTBL* const vtbl = mg->mg_virtual;
4659 *mgp = mg->mg_moremagic;
4660 if (vtbl && vtbl->svt_free)
4661 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4662 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4664 Safefree(mg->mg_ptr);
4665 else if (mg->mg_len == HEf_SVKEY)
4666 SvREFCNT_dec((SV*)mg->mg_ptr);
4667 else if (mg->mg_type == PERL_MAGIC_utf8)
4668 Safefree(mg->mg_ptr);
4670 if (mg->mg_flags & MGf_REFCOUNTED)
4671 SvREFCNT_dec(mg->mg_obj);
4675 mgp = &mg->mg_moremagic;
4679 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4680 SvMAGIC_set(sv, NULL);
4687 =for apidoc sv_rvweaken
4689 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4690 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4691 push a back-reference to this RV onto the array of backreferences
4692 associated with that magic. If the RV is magical, set magic will be
4693 called after the RV is cleared.
4699 Perl_sv_rvweaken(pTHX_ SV *sv)
4702 if (!SvOK(sv)) /* let undefs pass */
4705 Perl_croak(aTHX_ "Can't weaken a nonreference");
4706 else if (SvWEAKREF(sv)) {
4707 if (ckWARN(WARN_MISC))
4708 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4712 Perl_sv_add_backref(aTHX_ tsv, sv);
4718 /* Give tsv backref magic if it hasn't already got it, then push a
4719 * back-reference to sv onto the array associated with the backref magic.
4723 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4728 if (SvTYPE(tsv) == SVt_PVHV) {
4729 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4733 /* There is no AV in the offical place - try a fixup. */
4734 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4737 /* Aha. They've got it stowed in magic. Bring it back. */
4738 av = (AV*)mg->mg_obj;
4739 /* Stop mg_free decreasing the refernce count. */
4741 /* Stop mg_free even calling the destructor, given that
4742 there's no AV to free up. */
4744 sv_unmagic(tsv, PERL_MAGIC_backref);
4748 SvREFCNT_inc_simple_void(av);
4753 const MAGIC *const mg
4754 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4756 av = (AV*)mg->mg_obj;
4760 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4761 /* av now has a refcnt of 2, which avoids it getting freed
4762 * before us during global cleanup. The extra ref is removed
4763 * by magic_killbackrefs() when tsv is being freed */
4766 if (AvFILLp(av) >= AvMAX(av)) {
4767 av_extend(av, AvFILLp(av)+1);
4769 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4772 /* delete a back-reference to ourselves from the backref magic associated
4773 * with the SV we point to.
4777 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4784 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4785 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4786 /* We mustn't attempt to "fix up" the hash here by moving the
4787 backreference array back to the hv_aux structure, as that is stored
4788 in the main HvARRAY(), and hfreentries assumes that no-one
4789 reallocates HvARRAY() while it is running. */
4792 const MAGIC *const mg
4793 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4795 av = (AV *)mg->mg_obj;
4798 if (PL_in_clean_all)
4800 Perl_croak(aTHX_ "panic: del_backref");
4807 /* We shouldn't be in here more than once, but for paranoia reasons lets
4809 for (i = AvFILLp(av); i >= 0; i--) {
4811 const SSize_t fill = AvFILLp(av);
4813 /* We weren't the last entry.
4814 An unordered list has this property that you can take the
4815 last element off the end to fill the hole, and it's still
4816 an unordered list :-)
4821 AvFILLp(av) = fill - 1;
4827 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4829 SV **svp = AvARRAY(av);
4831 PERL_UNUSED_ARG(sv);
4833 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4834 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4835 if (svp && !SvIS_FREED(av)) {
4836 SV *const *const last = svp + AvFILLp(av);
4838 while (svp <= last) {
4840 SV *const referrer = *svp;
4841 if (SvWEAKREF(referrer)) {
4842 /* XXX Should we check that it hasn't changed? */
4843 SvRV_set(referrer, 0);
4845 SvWEAKREF_off(referrer);
4846 SvSETMAGIC(referrer);
4847 } else if (SvTYPE(referrer) == SVt_PVGV ||
4848 SvTYPE(referrer) == SVt_PVLV) {
4849 /* You lookin' at me? */
4850 assert(GvSTASH(referrer));
4851 assert(GvSTASH(referrer) == (HV*)sv);
4852 GvSTASH(referrer) = 0;
4855 "panic: magic_killbackrefs (flags=%"UVxf")",
4856 (UV)SvFLAGS(referrer));
4864 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4869 =for apidoc sv_insert
4871 Inserts a string at the specified offset/length within the SV. Similar to
4872 the Perl substr() function.
4878 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4883 register char *midend;
4884 register char *bigend;
4890 Perl_croak(aTHX_ "Can't modify non-existent substring");
4891 SvPV_force(bigstr, curlen);
4892 (void)SvPOK_only_UTF8(bigstr);
4893 if (offset + len > curlen) {
4894 SvGROW(bigstr, offset+len+1);
4895 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4896 SvCUR_set(bigstr, offset+len);
4900 i = littlelen - len;
4901 if (i > 0) { /* string might grow */
4902 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4903 mid = big + offset + len;
4904 midend = bigend = big + SvCUR(bigstr);
4907 while (midend > mid) /* shove everything down */
4908 *--bigend = *--midend;
4909 Move(little,big+offset,littlelen,char);
4910 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4915 Move(little,SvPVX(bigstr)+offset,len,char);
4920 big = SvPVX(bigstr);
4923 bigend = big + SvCUR(bigstr);
4925 if (midend > bigend)
4926 Perl_croak(aTHX_ "panic: sv_insert");
4928 if (mid - big > bigend - midend) { /* faster to shorten from end */
4930 Move(little, mid, littlelen,char);
4933 i = bigend - midend;
4935 Move(midend, mid, i,char);
4939 SvCUR_set(bigstr, mid - big);
4941 else if ((i = mid - big)) { /* faster from front */
4942 midend -= littlelen;
4944 sv_chop(bigstr,midend-i);
4949 Move(little, mid, littlelen,char);
4951 else if (littlelen) {
4952 midend -= littlelen;
4953 sv_chop(bigstr,midend);
4954 Move(little,midend,littlelen,char);
4957 sv_chop(bigstr,midend);
4963 =for apidoc sv_replace
4965 Make the first argument a copy of the second, then delete the original.
4966 The target SV physically takes over ownership of the body of the source SV
4967 and inherits its flags; however, the target keeps any magic it owns,
4968 and any magic in the source is discarded.
4969 Note that this is a rather specialist SV copying operation; most of the
4970 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4976 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4979 const U32 refcnt = SvREFCNT(sv);
4980 SV_CHECK_THINKFIRST_COW_DROP(sv);
4981 if (SvREFCNT(nsv) != 1) {
4982 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4983 UVuf " != 1)", (UV) SvREFCNT(nsv));
4985 if (SvMAGICAL(sv)) {
4989 sv_upgrade(nsv, SVt_PVMG);
4990 SvMAGIC_set(nsv, SvMAGIC(sv));
4991 SvFLAGS(nsv) |= SvMAGICAL(sv);
4993 SvMAGIC_set(sv, NULL);
4997 assert(!SvREFCNT(sv));
4998 #ifdef DEBUG_LEAKING_SCALARS
4999 sv->sv_flags = nsv->sv_flags;
5000 sv->sv_any = nsv->sv_any;
5001 sv->sv_refcnt = nsv->sv_refcnt;
5002 sv->sv_u = nsv->sv_u;
5004 StructCopy(nsv,sv,SV);
5006 /* Currently could join these into one piece of pointer arithmetic, but
5007 it would be unclear. */
5008 if(SvTYPE(sv) == SVt_IV)
5010 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5011 else if (SvTYPE(sv) == SVt_RV) {
5012 SvANY(sv) = &sv->sv_u.svu_rv;
5016 #ifdef PERL_OLD_COPY_ON_WRITE
5017 if (SvIsCOW_normal(nsv)) {
5018 /* We need to follow the pointers around the loop to make the
5019 previous SV point to sv, rather than nsv. */
5022 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5025 assert(SvPVX_const(current) == SvPVX_const(nsv));
5027 /* Make the SV before us point to the SV after us. */
5029 PerlIO_printf(Perl_debug_log, "previous is\n");
5031 PerlIO_printf(Perl_debug_log,
5032 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5033 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5035 SV_COW_NEXT_SV_SET(current, sv);
5038 SvREFCNT(sv) = refcnt;
5039 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5045 =for apidoc sv_clear
5047 Clear an SV: call any destructors, free up any memory used by the body,
5048 and free the body itself. The SV's head is I<not> freed, although
5049 its type is set to all 1's so that it won't inadvertently be assumed
5050 to be live during global destruction etc.
5051 This function should only be called when REFCNT is zero. Most of the time
5052 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5059 Perl_sv_clear(pTHX_ register SV *sv)
5062 const U32 type = SvTYPE(sv);
5063 const struct body_details *const sv_type_details
5064 = bodies_by_type + type;
5068 assert(SvREFCNT(sv) == 0);
5070 if (type <= SVt_IV) {
5071 /* See the comment in sv.h about the collusion between this early
5072 return and the overloading of the NULL and IV slots in the size
5078 if (PL_defstash) { /* Still have a symbol table? */
5083 stash = SvSTASH(sv);
5084 destructor = StashHANDLER(stash,DESTROY);
5086 SV* const tmpref = newRV(sv);
5087 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5089 PUSHSTACKi(PERLSI_DESTROY);
5094 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5100 if(SvREFCNT(tmpref) < 2) {
5101 /* tmpref is not kept alive! */
5103 SvRV_set(tmpref, NULL);
5106 SvREFCNT_dec(tmpref);
5108 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5112 if (PL_in_clean_objs)
5113 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5115 /* DESTROY gave object new lease on life */
5121 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5122 SvOBJECT_off(sv); /* Curse the object. */
5123 if (type != SVt_PVIO)
5124 --PL_sv_objcount; /* XXX Might want something more general */
5127 if (type >= SVt_PVMG) {
5128 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5129 SvREFCNT_dec(SvOURSTASH(sv));
5130 } else if (SvMAGIC(sv))
5132 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5133 SvREFCNT_dec(SvSTASH(sv));
5136 /* case SVt_BIND: */
5139 IoIFP(sv) != PerlIO_stdin() &&
5140 IoIFP(sv) != PerlIO_stdout() &&
5141 IoIFP(sv) != PerlIO_stderr())
5143 io_close((IO*)sv, FALSE);
5145 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5146 PerlDir_close(IoDIRP(sv));
5147 IoDIRP(sv) = (DIR*)NULL;
5148 Safefree(IoTOP_NAME(sv));
5149 Safefree(IoFMT_NAME(sv));
5150 Safefree(IoBOTTOM_NAME(sv));
5157 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5161 if (PL_comppad == (AV*)sv) {
5168 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5169 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5170 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5171 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5173 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5174 SvREFCNT_dec(LvTARG(sv));
5176 if (isGV_with_GP(sv)) {
5177 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5178 mro_method_changed_in(stash);
5181 unshare_hek(GvNAME_HEK(sv));
5182 /* If we're in a stash, we don't own a reference to it. However it does
5183 have a back reference to us, which needs to be cleared. */
5184 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5185 sv_del_backref((SV*)stash, sv);
5187 /* FIXME. There are probably more unreferenced pointers to SVs in the
5188 interpreter struct that we should check and tidy in a similar
5190 if ((GV*)sv == PL_last_in_gv)
5191 PL_last_in_gv = NULL;
5196 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5198 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5199 /* Don't even bother with turning off the OOK flag. */
5204 SV * const target = SvRV(sv);
5206 sv_del_backref(target, sv);
5208 SvREFCNT_dec(target);
5210 #ifdef PERL_OLD_COPY_ON_WRITE
5211 else if (SvPVX_const(sv)) {
5213 /* I believe I need to grab the global SV mutex here and
5214 then recheck the COW status. */
5216 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5220 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5222 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5225 /* And drop it here. */
5227 } else if (SvLEN(sv)) {
5228 Safefree(SvPVX_const(sv));
5232 else if (SvPVX_const(sv) && SvLEN(sv))
5233 Safefree(SvPVX_mutable(sv));
5234 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5235 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5244 SvFLAGS(sv) &= SVf_BREAK;
5245 SvFLAGS(sv) |= SVTYPEMASK;
5247 if (sv_type_details->arena) {
5248 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5249 &PL_body_roots[type]);
5251 else if (sv_type_details->body_size) {
5252 my_safefree(SvANY(sv));
5257 =for apidoc sv_newref
5259 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5266 Perl_sv_newref(pTHX_ SV *sv)
5268 PERL_UNUSED_CONTEXT;
5277 Decrement an SV's reference count, and if it drops to zero, call
5278 C<sv_clear> to invoke destructors and free up any memory used by
5279 the body; finally, deallocate the SV's head itself.
5280 Normally called via a wrapper macro C<SvREFCNT_dec>.
5286 Perl_sv_free(pTHX_ SV *sv)
5291 if (SvREFCNT(sv) == 0) {
5292 if (SvFLAGS(sv) & SVf_BREAK)
5293 /* this SV's refcnt has been artificially decremented to
5294 * trigger cleanup */
5296 if (PL_in_clean_all) /* All is fair */
5298 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5299 /* make sure SvREFCNT(sv)==0 happens very seldom */
5300 SvREFCNT(sv) = (~(U32)0)/2;
5303 if (ckWARN_d(WARN_INTERNAL)) {
5304 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5305 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5306 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5307 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5308 Perl_dump_sv_child(aTHX_ sv);
5310 #ifdef DEBUG_LEAKING_SCALARS
5317 if (--(SvREFCNT(sv)) > 0)
5319 Perl_sv_free2(aTHX_ sv);
5323 Perl_sv_free2(pTHX_ SV *sv)
5328 if (ckWARN_d(WARN_DEBUGGING))
5329 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5330 "Attempt to free temp prematurely: SV 0x%"UVxf
5331 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5335 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5336 /* make sure SvREFCNT(sv)==0 happens very seldom */
5337 SvREFCNT(sv) = (~(U32)0)/2;
5348 Returns the length of the string in the SV. Handles magic and type
5349 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5355 Perl_sv_len(pTHX_ register SV *sv)
5363 len = mg_length(sv);
5365 (void)SvPV_const(sv, len);
5370 =for apidoc sv_len_utf8
5372 Returns the number of characters in the string in an SV, counting wide
5373 UTF-8 bytes as a single character. Handles magic and type coercion.
5379 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5380 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5381 * (Note that the mg_len is not the length of the mg_ptr field.
5382 * This allows the cache to store the character length of the string without
5383 * needing to malloc() extra storage to attach to the mg_ptr.)
5388 Perl_sv_len_utf8(pTHX_ register SV *sv)
5394 return mg_length(sv);
5398 const U8 *s = (U8*)SvPV_const(sv, len);
5402 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5404 if (mg && mg->mg_len != -1) {
5406 if (PL_utf8cache < 0) {
5407 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5409 /* Need to turn the assertions off otherwise we may
5410 recurse infinitely while printing error messages.
5412 SAVEI8(PL_utf8cache);
5414 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5415 " real %"UVuf" for %"SVf,
5416 (UV) ulen, (UV) real, SVfARG(sv));
5421 ulen = Perl_utf8_length(aTHX_ s, s + len);
5422 if (!SvREADONLY(sv)) {
5424 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5425 &PL_vtbl_utf8, 0, 0);
5433 return Perl_utf8_length(aTHX_ s, s + len);
5437 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5440 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5443 const U8 *s = start;
5445 while (s < send && uoffset--)
5448 /* This is the existing behaviour. Possibly it should be a croak, as
5449 it's actually a bounds error */
5455 /* Given the length of the string in both bytes and UTF-8 characters, decide
5456 whether to walk forwards or backwards to find the byte corresponding to
5457 the passed in UTF-8 offset. */
5459 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5460 STRLEN uoffset, STRLEN uend)
5462 STRLEN backw = uend - uoffset;
5463 if (uoffset < 2 * backw) {
5464 /* The assumption is that going forwards is twice the speed of going
5465 forward (that's where the 2 * backw comes from).
5466 (The real figure of course depends on the UTF-8 data.) */
5467 return sv_pos_u2b_forwards(start, send, uoffset);
5472 while (UTF8_IS_CONTINUATION(*send))
5475 return send - start;
5478 /* For the string representation of the given scalar, find the byte
5479 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5480 give another position in the string, *before* the sought offset, which
5481 (which is always true, as 0, 0 is a valid pair of positions), which should
5482 help reduce the amount of linear searching.
5483 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5484 will be used to reduce the amount of linear searching. The cache will be
5485 created if necessary, and the found value offered to it for update. */
5487 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5488 const U8 *const send, STRLEN uoffset,
5489 STRLEN uoffset0, STRLEN boffset0) {
5490 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5493 assert (uoffset >= uoffset0);
5495 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5496 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5497 if ((*mgp)->mg_ptr) {
5498 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5499 if (cache[0] == uoffset) {
5500 /* An exact match. */
5503 if (cache[2] == uoffset) {
5504 /* An exact match. */
5508 if (cache[0] < uoffset) {
5509 /* The cache already knows part of the way. */
5510 if (cache[0] > uoffset0) {
5511 /* The cache knows more than the passed in pair */
5512 uoffset0 = cache[0];
5513 boffset0 = cache[1];
5515 if ((*mgp)->mg_len != -1) {
5516 /* And we know the end too. */
5518 + sv_pos_u2b_midway(start + boffset0, send,
5520 (*mgp)->mg_len - uoffset0);
5523 + sv_pos_u2b_forwards(start + boffset0,
5524 send, uoffset - uoffset0);
5527 else if (cache[2] < uoffset) {
5528 /* We're between the two cache entries. */
5529 if (cache[2] > uoffset0) {
5530 /* and the cache knows more than the passed in pair */
5531 uoffset0 = cache[2];
5532 boffset0 = cache[3];
5536 + sv_pos_u2b_midway(start + boffset0,
5539 cache[0] - uoffset0);
5542 + sv_pos_u2b_midway(start + boffset0,
5545 cache[2] - uoffset0);
5549 else if ((*mgp)->mg_len != -1) {
5550 /* If we can take advantage of a passed in offset, do so. */
5551 /* In fact, offset0 is either 0, or less than offset, so don't
5552 need to worry about the other possibility. */
5554 + sv_pos_u2b_midway(start + boffset0, send,
5556 (*mgp)->mg_len - uoffset0);
5561 if (!found || PL_utf8cache < 0) {
5562 const STRLEN real_boffset
5563 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5564 send, uoffset - uoffset0);
5566 if (found && PL_utf8cache < 0) {
5567 if (real_boffset != boffset) {
5568 /* Need to turn the assertions off otherwise we may recurse
5569 infinitely while printing error messages. */
5570 SAVEI8(PL_utf8cache);
5572 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5573 " real %"UVuf" for %"SVf,
5574 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5577 boffset = real_boffset;
5580 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5586 =for apidoc sv_pos_u2b
5588 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5589 the start of the string, to a count of the equivalent number of bytes; if
5590 lenp is non-zero, it does the same to lenp, but this time starting from
5591 the offset, rather than from the start of the string. Handles magic and
5598 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5599 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5600 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5605 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5613 start = (U8*)SvPV_const(sv, len);
5615 STRLEN uoffset = (STRLEN) *offsetp;
5616 const U8 * const send = start + len;
5618 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5621 *offsetp = (I32) boffset;
5624 /* Convert the relative offset to absolute. */
5625 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5626 const STRLEN boffset2
5627 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5628 uoffset, boffset) - boffset;
5642 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5643 byte length pairing. The (byte) length of the total SV is passed in too,
5644 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5645 may not have updated SvCUR, so we can't rely on reading it directly.
5647 The proffered utf8/byte length pairing isn't used if the cache already has
5648 two pairs, and swapping either for the proffered pair would increase the
5649 RMS of the intervals between known byte offsets.
5651 The cache itself consists of 4 STRLEN values
5652 0: larger UTF-8 offset
5653 1: corresponding byte offset
5654 2: smaller UTF-8 offset
5655 3: corresponding byte offset
5657 Unused cache pairs have the value 0, 0.
5658 Keeping the cache "backwards" means that the invariant of
5659 cache[0] >= cache[2] is maintained even with empty slots, which means that
5660 the code that uses it doesn't need to worry if only 1 entry has actually
5661 been set to non-zero. It also makes the "position beyond the end of the
5662 cache" logic much simpler, as the first slot is always the one to start
5666 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5674 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5676 (*mgp)->mg_len = -1;
5680 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5681 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5682 (*mgp)->mg_ptr = (char *) cache;
5686 if (PL_utf8cache < 0) {
5687 const U8 *start = (const U8 *) SvPVX_const(sv);
5688 const STRLEN realutf8 = utf8_length(start, start + byte);
5690 if (realutf8 != utf8) {
5691 /* Need to turn the assertions off otherwise we may recurse
5692 infinitely while printing error messages. */
5693 SAVEI8(PL_utf8cache);
5695 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5696 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5700 /* Cache is held with the later position first, to simplify the code
5701 that deals with unbounded ends. */
5703 ASSERT_UTF8_CACHE(cache);
5704 if (cache[1] == 0) {
5705 /* Cache is totally empty */
5708 } else if (cache[3] == 0) {
5709 if (byte > cache[1]) {
5710 /* New one is larger, so goes first. */
5711 cache[2] = cache[0];
5712 cache[3] = cache[1];
5720 #define THREEWAY_SQUARE(a,b,c,d) \
5721 ((float)((d) - (c))) * ((float)((d) - (c))) \
5722 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5723 + ((float)((b) - (a))) * ((float)((b) - (a)))
5725 /* Cache has 2 slots in use, and we know three potential pairs.
5726 Keep the two that give the lowest RMS distance. Do the
5727 calcualation in bytes simply because we always know the byte
5728 length. squareroot has the same ordering as the positive value,
5729 so don't bother with the actual square root. */
5730 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5731 if (byte > cache[1]) {
5732 /* New position is after the existing pair of pairs. */
5733 const float keep_earlier
5734 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5735 const float keep_later
5736 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5738 if (keep_later < keep_earlier) {
5739 if (keep_later < existing) {
5740 cache[2] = cache[0];
5741 cache[3] = cache[1];
5747 if (keep_earlier < existing) {
5753 else if (byte > cache[3]) {
5754 /* New position is between the existing pair of pairs. */
5755 const float keep_earlier
5756 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5757 const float keep_later
5758 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5760 if (keep_later < keep_earlier) {
5761 if (keep_later < existing) {
5767 if (keep_earlier < existing) {
5774 /* New position is before the existing pair of pairs. */
5775 const float keep_earlier
5776 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5777 const float keep_later
5778 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5780 if (keep_later < keep_earlier) {
5781 if (keep_later < existing) {
5787 if (keep_earlier < existing) {
5788 cache[0] = cache[2];
5789 cache[1] = cache[3];
5796 ASSERT_UTF8_CACHE(cache);
5799 /* We already know all of the way, now we may be able to walk back. The same
5800 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5801 backward is half the speed of walking forward. */
5803 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5806 const STRLEN forw = target - s;
5807 STRLEN backw = end - target;
5809 if (forw < 2 * backw) {
5810 return utf8_length(s, target);
5813 while (end > target) {
5815 while (UTF8_IS_CONTINUATION(*end)) {
5824 =for apidoc sv_pos_b2u
5826 Converts the value pointed to by offsetp from a count of bytes from the
5827 start of the string, to a count of the equivalent number of UTF-8 chars.
5828 Handles magic and type coercion.
5834 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5835 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5840 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5843 const STRLEN byte = *offsetp;
5844 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5853 s = (const U8*)SvPV_const(sv, blen);
5856 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5860 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5861 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5863 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5864 if (cache[1] == byte) {
5865 /* An exact match. */
5866 *offsetp = cache[0];
5869 if (cache[3] == byte) {
5870 /* An exact match. */
5871 *offsetp = cache[2];
5875 if (cache[1] < byte) {
5876 /* We already know part of the way. */
5877 if (mg->mg_len != -1) {
5878 /* Actually, we know the end too. */
5880 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5881 s + blen, mg->mg_len - cache[0]);
5883 len = cache[0] + utf8_length(s + cache[1], send);
5886 else if (cache[3] < byte) {
5887 /* We're between the two cached pairs, so we do the calculation
5888 offset by the byte/utf-8 positions for the earlier pair,
5889 then add the utf-8 characters from the string start to
5891 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5892 s + cache[1], cache[0] - cache[2])
5896 else { /* cache[3] > byte */
5897 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5901 ASSERT_UTF8_CACHE(cache);
5903 } else if (mg->mg_len != -1) {
5904 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5908 if (!found || PL_utf8cache < 0) {
5909 const STRLEN real_len = utf8_length(s, send);
5911 if (found && PL_utf8cache < 0) {
5912 if (len != real_len) {
5913 /* Need to turn the assertions off otherwise we may recurse
5914 infinitely while printing error messages. */
5915 SAVEI8(PL_utf8cache);
5917 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5918 " real %"UVuf" for %"SVf,
5919 (UV) len, (UV) real_len, SVfARG(sv));
5926 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5932 Returns a boolean indicating whether the strings in the two SVs are
5933 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5934 coerce its args to strings if necessary.
5940 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5949 SV* svrecode = NULL;
5956 /* if pv1 and pv2 are the same, second SvPV_const call may
5957 * invalidate pv1, so we may need to make a copy */
5958 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5959 pv1 = SvPV_const(sv1, cur1);
5960 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5961 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5963 pv1 = SvPV_const(sv1, cur1);
5971 pv2 = SvPV_const(sv2, cur2);
5973 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5974 /* Differing utf8ness.
5975 * Do not UTF8size the comparands as a side-effect. */
5978 svrecode = newSVpvn(pv2, cur2);
5979 sv_recode_to_utf8(svrecode, PL_encoding);
5980 pv2 = SvPV_const(svrecode, cur2);
5983 svrecode = newSVpvn(pv1, cur1);
5984 sv_recode_to_utf8(svrecode, PL_encoding);
5985 pv1 = SvPV_const(svrecode, cur1);
5987 /* Now both are in UTF-8. */
5989 SvREFCNT_dec(svrecode);
5994 bool is_utf8 = TRUE;
5997 /* sv1 is the UTF-8 one,
5998 * if is equal it must be downgrade-able */
5999 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6005 /* sv2 is the UTF-8 one,
6006 * if is equal it must be downgrade-able */
6007 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6013 /* Downgrade not possible - cannot be eq */
6021 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6023 SvREFCNT_dec(svrecode);
6033 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6034 string in C<sv1> is less than, equal to, or greater than the string in
6035 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6036 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6042 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6046 const char *pv1, *pv2;
6049 SV *svrecode = NULL;
6056 pv1 = SvPV_const(sv1, cur1);
6063 pv2 = SvPV_const(sv2, cur2);
6065 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6066 /* Differing utf8ness.
6067 * Do not UTF8size the comparands as a side-effect. */
6070 svrecode = newSVpvn(pv2, cur2);
6071 sv_recode_to_utf8(svrecode, PL_encoding);
6072 pv2 = SvPV_const(svrecode, cur2);
6075 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6080 svrecode = newSVpvn(pv1, cur1);
6081 sv_recode_to_utf8(svrecode, PL_encoding);
6082 pv1 = SvPV_const(svrecode, cur1);
6085 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6091 cmp = cur2 ? -1 : 0;
6095 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6098 cmp = retval < 0 ? -1 : 1;
6099 } else if (cur1 == cur2) {
6102 cmp = cur1 < cur2 ? -1 : 1;
6106 SvREFCNT_dec(svrecode);
6114 =for apidoc sv_cmp_locale
6116 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6117 'use bytes' aware, handles get magic, and will coerce its args to strings
6118 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6124 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6127 #ifdef USE_LOCALE_COLLATE
6133 if (PL_collation_standard)
6137 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6139 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6141 if (!pv1 || !len1) {
6152 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6155 return retval < 0 ? -1 : 1;
6158 * When the result of collation is equality, that doesn't mean
6159 * that there are no differences -- some locales exclude some
6160 * characters from consideration. So to avoid false equalities,
6161 * we use the raw string as a tiebreaker.
6167 #endif /* USE_LOCALE_COLLATE */
6169 return sv_cmp(sv1, sv2);
6173 #ifdef USE_LOCALE_COLLATE
6176 =for apidoc sv_collxfrm
6178 Add Collate Transform magic to an SV if it doesn't already have it.
6180 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6181 scalar data of the variable, but transformed to such a format that a normal
6182 memory comparison can be used to compare the data according to the locale
6189 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6194 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6195 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6201 Safefree(mg->mg_ptr);
6202 s = SvPV_const(sv, len);
6203 if ((xf = mem_collxfrm(s, len, &xlen))) {
6204 if (SvREADONLY(sv)) {
6207 return xf + sizeof(PL_collation_ix);
6210 #ifdef PERL_OLD_COPY_ON_WRITE
6212 sv_force_normal_flags(sv, 0);
6214 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6228 if (mg && mg->mg_ptr) {
6230 return mg->mg_ptr + sizeof(PL_collation_ix);
6238 #endif /* USE_LOCALE_COLLATE */
6243 Get a line from the filehandle and store it into the SV, optionally
6244 appending to the currently-stored string.
6250 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6255 register STDCHAR rslast;
6256 register STDCHAR *bp;
6261 if (SvTHINKFIRST(sv))
6262 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6263 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6265 However, perlbench says it's slower, because the existing swipe code
6266 is faster than copy on write.
6267 Swings and roundabouts. */
6268 SvUPGRADE(sv, SVt_PV);
6273 if (PerlIO_isutf8(fp)) {
6275 sv_utf8_upgrade_nomg(sv);
6276 sv_pos_u2b(sv,&append,0);
6278 } else if (SvUTF8(sv)) {
6279 SV * const tsv = newSV(0);
6280 sv_gets(tsv, fp, 0);
6281 sv_utf8_upgrade_nomg(tsv);
6282 SvCUR_set(sv,append);
6285 goto return_string_or_null;
6290 if (PerlIO_isutf8(fp))
6293 if (IN_PERL_COMPILETIME) {
6294 /* we always read code in line mode */
6298 else if (RsSNARF(PL_rs)) {
6299 /* If it is a regular disk file use size from stat() as estimate
6300 of amount we are going to read -- may result in mallocing
6301 more memory than we really need if the layers below reduce
6302 the size we read (e.g. CRLF or a gzip layer).
6305 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6306 const Off_t offset = PerlIO_tell(fp);
6307 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6308 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6314 else if (RsRECORD(PL_rs)) {
6319 /* Grab the size of the record we're getting */
6320 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6321 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6324 /* VMS wants read instead of fread, because fread doesn't respect */
6325 /* RMS record boundaries. This is not necessarily a good thing to be */
6326 /* doing, but we've got no other real choice - except avoid stdio
6327 as implementation - perhaps write a :vms layer ?
6329 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6331 bytesread = PerlIO_read(fp, buffer, recsize);
6335 SvCUR_set(sv, bytesread += append);
6336 buffer[bytesread] = '\0';
6337 goto return_string_or_null;
6339 else if (RsPARA(PL_rs)) {
6345 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6346 if (PerlIO_isutf8(fp)) {
6347 rsptr = SvPVutf8(PL_rs, rslen);
6350 if (SvUTF8(PL_rs)) {
6351 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6352 Perl_croak(aTHX_ "Wide character in $/");
6355 rsptr = SvPV_const(PL_rs, rslen);
6359 rslast = rslen ? rsptr[rslen - 1] : '\0';
6361 if (rspara) { /* have to do this both before and after */
6362 do { /* to make sure file boundaries work right */
6365 i = PerlIO_getc(fp);
6369 PerlIO_ungetc(fp,i);
6375 /* See if we know enough about I/O mechanism to cheat it ! */
6377 /* This used to be #ifdef test - it is made run-time test for ease
6378 of abstracting out stdio interface. One call should be cheap
6379 enough here - and may even be a macro allowing compile
6383 if (PerlIO_fast_gets(fp)) {
6386 * We're going to steal some values from the stdio struct
6387 * and put EVERYTHING in the innermost loop into registers.
6389 register STDCHAR *ptr;
6393 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6394 /* An ungetc()d char is handled separately from the regular
6395 * buffer, so we getc() it back out and stuff it in the buffer.
6397 i = PerlIO_getc(fp);
6398 if (i == EOF) return 0;
6399 *(--((*fp)->_ptr)) = (unsigned char) i;
6403 /* Here is some breathtakingly efficient cheating */
6405 cnt = PerlIO_get_cnt(fp); /* get count into register */
6406 /* make sure we have the room */
6407 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6408 /* Not room for all of it
6409 if we are looking for a separator and room for some
6411 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6412 /* just process what we have room for */
6413 shortbuffered = cnt - SvLEN(sv) + append + 1;
6414 cnt -= shortbuffered;
6418 /* remember that cnt can be negative */
6419 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6424 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6425 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6426 DEBUG_P(PerlIO_printf(Perl_debug_log,
6427 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6428 DEBUG_P(PerlIO_printf(Perl_debug_log,
6429 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6430 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6431 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6436 while (cnt > 0) { /* this | eat */
6438 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6439 goto thats_all_folks; /* screams | sed :-) */
6443 Copy(ptr, bp, cnt, char); /* this | eat */
6444 bp += cnt; /* screams | dust */
6445 ptr += cnt; /* louder | sed :-) */
6450 if (shortbuffered) { /* oh well, must extend */
6451 cnt = shortbuffered;
6453 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6455 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6456 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6460 DEBUG_P(PerlIO_printf(Perl_debug_log,
6461 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6462 PTR2UV(ptr),(long)cnt));
6463 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6467 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6468 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6470 /* This used to call 'filbuf' in stdio form, but as that behaves like
6471 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6472 another abstraction. */
6473 i = PerlIO_getc(fp); /* get more characters */
6475 DEBUG_P(PerlIO_printf(Perl_debug_log,
6476 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6477 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6478 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6480 cnt = PerlIO_get_cnt(fp);
6481 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6482 DEBUG_P(PerlIO_printf(Perl_debug_log,
6483 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6485 if (i == EOF) /* all done for ever? */
6486 goto thats_really_all_folks;
6488 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6490 SvGROW(sv, bpx + cnt + 2);
6491 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6493 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6495 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6496 goto thats_all_folks;
6500 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6501 memNE((char*)bp - rslen, rsptr, rslen))
6502 goto screamer; /* go back to the fray */
6503 thats_really_all_folks:
6505 cnt += shortbuffered;
6506 DEBUG_P(PerlIO_printf(Perl_debug_log,
6507 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6508 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6509 DEBUG_P(PerlIO_printf(Perl_debug_log,
6510 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6511 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6512 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6514 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6515 DEBUG_P(PerlIO_printf(Perl_debug_log,
6516 "Screamer: done, len=%ld, string=|%.*s|\n",
6517 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6521 /*The big, slow, and stupid way. */
6522 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6523 STDCHAR *buf = NULL;
6524 Newx(buf, 8192, STDCHAR);
6532 register const STDCHAR * const bpe = buf + sizeof(buf);
6534 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6535 ; /* keep reading */
6539 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6540 /* Accomodate broken VAXC compiler, which applies U8 cast to
6541 * both args of ?: operator, causing EOF to change into 255
6544 i = (U8)buf[cnt - 1];
6550 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6552 sv_catpvn(sv, (char *) buf, cnt);
6554 sv_setpvn(sv, (char *) buf, cnt);
6556 if (i != EOF && /* joy */
6558 SvCUR(sv) < rslen ||
6559 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6563 * If we're reading from a TTY and we get a short read,
6564 * indicating that the user hit his EOF character, we need
6565 * to notice it now, because if we try to read from the TTY
6566 * again, the EOF condition will disappear.
6568 * The comparison of cnt to sizeof(buf) is an optimization
6569 * that prevents unnecessary calls to feof().
6573 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6577 #ifdef USE_HEAP_INSTEAD_OF_STACK
6582 if (rspara) { /* have to do this both before and after */
6583 while (i != EOF) { /* to make sure file boundaries work right */
6584 i = PerlIO_getc(fp);
6586 PerlIO_ungetc(fp,i);
6592 return_string_or_null:
6593 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6599 Auto-increment of the value in the SV, doing string to numeric conversion
6600 if necessary. Handles 'get' magic.
6606 Perl_sv_inc(pTHX_ register SV *sv)
6615 if (SvTHINKFIRST(sv)) {
6617 sv_force_normal_flags(sv, 0);
6618 if (SvREADONLY(sv)) {
6619 if (IN_PERL_RUNTIME)
6620 Perl_croak(aTHX_ PL_no_modify);
6624 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6626 i = PTR2IV(SvRV(sv));
6631 flags = SvFLAGS(sv);
6632 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6633 /* It's (privately or publicly) a float, but not tested as an
6634 integer, so test it to see. */
6636 flags = SvFLAGS(sv);
6638 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6639 /* It's publicly an integer, or privately an integer-not-float */
6640 #ifdef PERL_PRESERVE_IVUV
6644 if (SvUVX(sv) == UV_MAX)
6645 sv_setnv(sv, UV_MAX_P1);
6647 (void)SvIOK_only_UV(sv);
6648 SvUV_set(sv, SvUVX(sv) + 1);
6650 if (SvIVX(sv) == IV_MAX)
6651 sv_setuv(sv, (UV)IV_MAX + 1);
6653 (void)SvIOK_only(sv);
6654 SvIV_set(sv, SvIVX(sv) + 1);
6659 if (flags & SVp_NOK) {
6660 (void)SvNOK_only(sv);
6661 SvNV_set(sv, SvNVX(sv) + 1.0);
6665 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6666 if ((flags & SVTYPEMASK) < SVt_PVIV)
6667 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6668 (void)SvIOK_only(sv);
6673 while (isALPHA(*d)) d++;
6674 while (isDIGIT(*d)) d++;
6676 #ifdef PERL_PRESERVE_IVUV
6677 /* Got to punt this as an integer if needs be, but we don't issue
6678 warnings. Probably ought to make the sv_iv_please() that does
6679 the conversion if possible, and silently. */
6680 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6681 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6682 /* Need to try really hard to see if it's an integer.
6683 9.22337203685478e+18 is an integer.
6684 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6685 so $a="9.22337203685478e+18"; $a+0; $a++
6686 needs to be the same as $a="9.22337203685478e+18"; $a++
6693 /* sv_2iv *should* have made this an NV */
6694 if (flags & SVp_NOK) {
6695 (void)SvNOK_only(sv);
6696 SvNV_set(sv, SvNVX(sv) + 1.0);
6699 /* I don't think we can get here. Maybe I should assert this
6700 And if we do get here I suspect that sv_setnv will croak. NWC
6702 #if defined(USE_LONG_DOUBLE)
6703 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",
6704 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6706 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6707 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6710 #endif /* PERL_PRESERVE_IVUV */
6711 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6715 while (d >= SvPVX_const(sv)) {
6723 /* MKS: The original code here died if letters weren't consecutive.
6724 * at least it didn't have to worry about non-C locales. The
6725 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6726 * arranged in order (although not consecutively) and that only
6727 * [A-Za-z] are accepted by isALPHA in the C locale.
6729 if (*d != 'z' && *d != 'Z') {
6730 do { ++*d; } while (!isALPHA(*d));
6733 *(d--) -= 'z' - 'a';
6738 *(d--) -= 'z' - 'a' + 1;
6742 /* oh,oh, the number grew */
6743 SvGROW(sv, SvCUR(sv) + 2);
6744 SvCUR_set(sv, SvCUR(sv) + 1);
6745 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6756 Auto-decrement of the value in the SV, doing string to numeric conversion
6757 if necessary. Handles 'get' magic.
6763 Perl_sv_dec(pTHX_ register SV *sv)
6771 if (SvTHINKFIRST(sv)) {
6773 sv_force_normal_flags(sv, 0);
6774 if (SvREADONLY(sv)) {
6775 if (IN_PERL_RUNTIME)
6776 Perl_croak(aTHX_ PL_no_modify);
6780 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6782 i = PTR2IV(SvRV(sv));
6787 /* Unlike sv_inc we don't have to worry about string-never-numbers
6788 and keeping them magic. But we mustn't warn on punting */
6789 flags = SvFLAGS(sv);
6790 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6791 /* It's publicly an integer, or privately an integer-not-float */
6792 #ifdef PERL_PRESERVE_IVUV
6796 if (SvUVX(sv) == 0) {
6797 (void)SvIOK_only(sv);
6801 (void)SvIOK_only_UV(sv);
6802 SvUV_set(sv, SvUVX(sv) - 1);
6805 if (SvIVX(sv) == IV_MIN)
6806 sv_setnv(sv, (NV)IV_MIN - 1.0);
6808 (void)SvIOK_only(sv);
6809 SvIV_set(sv, SvIVX(sv) - 1);
6814 if (flags & SVp_NOK) {
6815 SvNV_set(sv, SvNVX(sv) - 1.0);
6816 (void)SvNOK_only(sv);
6819 if (!(flags & SVp_POK)) {
6820 if ((flags & SVTYPEMASK) < SVt_PVIV)
6821 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6823 (void)SvIOK_only(sv);
6826 #ifdef PERL_PRESERVE_IVUV
6828 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6829 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6830 /* Need to try really hard to see if it's an integer.
6831 9.22337203685478e+18 is an integer.
6832 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6833 so $a="9.22337203685478e+18"; $a+0; $a--
6834 needs to be the same as $a="9.22337203685478e+18"; $a--
6841 /* sv_2iv *should* have made this an NV */
6842 if (flags & SVp_NOK) {
6843 (void)SvNOK_only(sv);
6844 SvNV_set(sv, SvNVX(sv) - 1.0);
6847 /* I don't think we can get here. Maybe I should assert this
6848 And if we do get here I suspect that sv_setnv will croak. NWC
6850 #if defined(USE_LONG_DOUBLE)
6851 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",
6852 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6854 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6855 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6859 #endif /* PERL_PRESERVE_IVUV */
6860 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6864 =for apidoc sv_mortalcopy
6866 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6867 The new SV is marked as mortal. It will be destroyed "soon", either by an
6868 explicit call to FREETMPS, or by an implicit call at places such as
6869 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6874 /* Make a string that will exist for the duration of the expression
6875 * evaluation. Actually, it may have to last longer than that, but
6876 * hopefully we won't free it until it has been assigned to a
6877 * permanent location. */
6880 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6886 sv_setsv(sv,oldstr);
6888 PL_tmps_stack[++PL_tmps_ix] = sv;
6894 =for apidoc sv_newmortal
6896 Creates a new null SV which is mortal. The reference count of the SV is
6897 set to 1. It will be destroyed "soon", either by an explicit call to
6898 FREETMPS, or by an implicit call at places such as statement boundaries.
6899 See also C<sv_mortalcopy> and C<sv_2mortal>.
6905 Perl_sv_newmortal(pTHX)
6911 SvFLAGS(sv) = SVs_TEMP;
6913 PL_tmps_stack[++PL_tmps_ix] = sv;
6918 =for apidoc sv_2mortal
6920 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6921 by an explicit call to FREETMPS, or by an implicit call at places such as
6922 statement boundaries. SvTEMP() is turned on which means that the SV's
6923 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6924 and C<sv_mortalcopy>.
6930 Perl_sv_2mortal(pTHX_ register SV *sv)
6935 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6938 PL_tmps_stack[++PL_tmps_ix] = sv;
6946 Creates a new SV and copies a string into it. The reference count for the
6947 SV is set to 1. If C<len> is zero, Perl will compute the length using
6948 strlen(). For efficiency, consider using C<newSVpvn> instead.
6954 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6960 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6965 =for apidoc newSVpvn
6967 Creates a new SV and copies a string into it. The reference count for the
6968 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6969 string. You are responsible for ensuring that the source string is at least
6970 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6976 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6982 sv_setpvn(sv,s,len);
6988 =for apidoc newSVhek
6990 Creates a new SV from the hash key structure. It will generate scalars that
6991 point to the shared string table where possible. Returns a new (undefined)
6992 SV if the hek is NULL.
6998 Perl_newSVhek(pTHX_ const HEK *hek)
7008 if (HEK_LEN(hek) == HEf_SVKEY) {
7009 return newSVsv(*(SV**)HEK_KEY(hek));
7011 const int flags = HEK_FLAGS(hek);
7012 if (flags & HVhek_WASUTF8) {
7014 Andreas would like keys he put in as utf8 to come back as utf8
7016 STRLEN utf8_len = HEK_LEN(hek);
7017 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7018 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7021 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7023 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7024 /* We don't have a pointer to the hv, so we have to replicate the
7025 flag into every HEK. This hv is using custom a hasing
7026 algorithm. Hence we can't return a shared string scalar, as
7027 that would contain the (wrong) hash value, and might get passed
7028 into an hv routine with a regular hash.
7029 Similarly, a hash that isn't using shared hash keys has to have
7030 the flag in every key so that we know not to try to call
7031 share_hek_kek on it. */
7033 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7038 /* This will be overwhelminly the most common case. */
7040 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7041 more efficient than sharepvn(). */
7045 sv_upgrade(sv, SVt_PV);
7046 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7047 SvCUR_set(sv, HEK_LEN(hek));
7060 =for apidoc newSVpvn_share
7062 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7063 table. If the string does not already exist in the table, it is created
7064 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7065 value is used; otherwise the hash is computed. The string's hash can be later
7066 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7067 that as the string table is used for shared hash keys these strings will have
7068 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7074 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7078 bool is_utf8 = FALSE;
7079 const char *const orig_src = src;
7082 STRLEN tmplen = -len;
7084 /* See the note in hv.c:hv_fetch() --jhi */
7085 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7089 PERL_HASH(hash, src, len);
7091 sv_upgrade(sv, SVt_PV);
7092 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7100 if (src != orig_src)
7106 #if defined(PERL_IMPLICIT_CONTEXT)
7108 /* pTHX_ magic can't cope with varargs, so this is a no-context
7109 * version of the main function, (which may itself be aliased to us).
7110 * Don't access this version directly.
7114 Perl_newSVpvf_nocontext(const char* pat, ...)
7119 va_start(args, pat);
7120 sv = vnewSVpvf(pat, &args);
7127 =for apidoc newSVpvf
7129 Creates a new SV and initializes it with the string formatted like
7136 Perl_newSVpvf(pTHX_ const char* pat, ...)
7140 va_start(args, pat);
7141 sv = vnewSVpvf(pat, &args);
7146 /* backend for newSVpvf() and newSVpvf_nocontext() */
7149 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7154 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7161 Creates a new SV and copies a floating point value into it.
7162 The reference count for the SV is set to 1.
7168 Perl_newSVnv(pTHX_ NV n)
7181 Creates a new SV and copies an integer into it. The reference count for the
7188 Perl_newSViv(pTHX_ IV i)
7201 Creates a new SV and copies an unsigned integer into it.
7202 The reference count for the SV is set to 1.
7208 Perl_newSVuv(pTHX_ UV u)
7219 =for apidoc newSV_type
7221 Creates a new SV, of the type specified. The reference count for the new SV
7228 Perl_newSV_type(pTHX_ svtype type)
7233 sv_upgrade(sv, type);
7238 =for apidoc newRV_noinc
7240 Creates an RV wrapper for an SV. The reference count for the original
7241 SV is B<not> incremented.
7247 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7250 register SV *sv = newSV_type(SVt_RV);
7252 SvRV_set(sv, tmpRef);
7257 /* newRV_inc is the official function name to use now.
7258 * newRV_inc is in fact #defined to newRV in sv.h
7262 Perl_newRV(pTHX_ SV *sv)
7265 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7271 Creates a new SV which is an exact duplicate of the original SV.
7278 Perl_newSVsv(pTHX_ register SV *old)
7285 if (SvTYPE(old) == SVTYPEMASK) {
7286 if (ckWARN_d(WARN_INTERNAL))
7287 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7291 /* SV_GMAGIC is the default for sv_setv()
7292 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7293 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7294 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7299 =for apidoc sv_reset
7301 Underlying implementation for the C<reset> Perl function.
7302 Note that the perl-level function is vaguely deprecated.
7308 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7311 char todo[PERL_UCHAR_MAX+1];
7316 if (!*s) { /* reset ?? searches */
7317 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7319 const U32 count = mg->mg_len / sizeof(PMOP**);
7320 PMOP **pmp = (PMOP**) mg->mg_ptr;
7321 PMOP *const *const end = pmp + count;
7325 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7327 (*pmp)->op_pmflags &= ~PMf_USED;
7335 /* reset variables */
7337 if (!HvARRAY(stash))
7340 Zero(todo, 256, char);
7343 I32 i = (unsigned char)*s;
7347 max = (unsigned char)*s++;
7348 for ( ; i <= max; i++) {
7351 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7353 for (entry = HvARRAY(stash)[i];
7355 entry = HeNEXT(entry))
7360 if (!todo[(U8)*HeKEY(entry)])
7362 gv = (GV*)HeVAL(entry);
7365 if (SvTHINKFIRST(sv)) {
7366 if (!SvREADONLY(sv) && SvROK(sv))
7368 /* XXX Is this continue a bug? Why should THINKFIRST
7369 exempt us from resetting arrays and hashes? */
7373 if (SvTYPE(sv) >= SVt_PV) {
7375 if (SvPVX_const(sv) != NULL)
7383 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7385 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7388 # if defined(USE_ENVIRON_ARRAY)
7391 # endif /* USE_ENVIRON_ARRAY */
7402 Using various gambits, try to get an IO from an SV: the IO slot if its a
7403 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7404 named after the PV if we're a string.
7410 Perl_sv_2io(pTHX_ SV *sv)
7415 switch (SvTYPE(sv)) {
7423 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7427 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7429 return sv_2io(SvRV(sv));
7430 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7436 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7445 Using various gambits, try to get a CV from an SV; in addition, try if
7446 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7447 The flags in C<lref> are passed to sv_fetchsv.
7453 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7464 switch (SvTYPE(sv)) {
7483 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7484 tryAMAGICunDEREF(to_cv);
7487 if (SvTYPE(sv) == SVt_PVCV) {
7496 Perl_croak(aTHX_ "Not a subroutine reference");
7501 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7507 /* Some flags to gv_fetchsv mean don't really create the GV */
7508 if (SvTYPE(gv) != SVt_PVGV) {
7514 if (lref && !GvCVu(gv)) {
7518 gv_efullname3(tmpsv, gv, NULL);
7519 /* XXX this is probably not what they think they're getting.
7520 * It has the same effect as "sub name;", i.e. just a forward
7522 newSUB(start_subparse(FALSE, 0),
7523 newSVOP(OP_CONST, 0, tmpsv),
7527 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7537 Returns true if the SV has a true value by Perl's rules.
7538 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7539 instead use an in-line version.
7545 Perl_sv_true(pTHX_ register SV *sv)
7550 register const XPV* const tXpv = (XPV*)SvANY(sv);
7552 (tXpv->xpv_cur > 1 ||
7553 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7560 return SvIVX(sv) != 0;
7563 return SvNVX(sv) != 0.0;
7565 return sv_2bool(sv);
7571 =for apidoc sv_pvn_force
7573 Get a sensible string out of the SV somehow.
7574 A private implementation of the C<SvPV_force> macro for compilers which
7575 can't cope with complex macro expressions. Always use the macro instead.
7577 =for apidoc sv_pvn_force_flags
7579 Get a sensible string out of the SV somehow.
7580 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7581 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7582 implemented in terms of this function.
7583 You normally want to use the various wrapper macros instead: see
7584 C<SvPV_force> and C<SvPV_force_nomg>
7590 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7593 if (SvTHINKFIRST(sv) && !SvROK(sv))
7594 sv_force_normal_flags(sv, 0);
7604 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7605 const char * const ref = sv_reftype(sv,0);
7607 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7608 ref, OP_NAME(PL_op));
7610 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7612 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7613 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7615 s = sv_2pv_flags(sv, &len, flags);
7619 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7622 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7623 SvGROW(sv, len + 1);
7624 Move(s,SvPVX(sv),len,char);
7626 SvPVX(sv)[len] = '\0';
7629 SvPOK_on(sv); /* validate pointer */
7631 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7632 PTR2UV(sv),SvPVX_const(sv)));
7635 return SvPVX_mutable(sv);
7639 =for apidoc sv_pvbyten_force
7641 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7647 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7649 sv_pvn_force(sv,lp);
7650 sv_utf8_downgrade(sv,0);
7656 =for apidoc sv_pvutf8n_force
7658 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7664 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7666 sv_pvn_force(sv,lp);
7667 sv_utf8_upgrade(sv);
7673 =for apidoc sv_reftype
7675 Returns a string describing what the SV is a reference to.
7681 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7683 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7684 inside return suggests a const propagation bug in g++. */
7685 if (ob && SvOBJECT(sv)) {
7686 char * const name = HvNAME_get(SvSTASH(sv));
7687 return name ? name : (char *) "__ANON__";
7690 switch (SvTYPE(sv)) {
7706 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7707 /* tied lvalues should appear to be
7708 * scalars for backwards compatitbility */
7709 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7710 ? "SCALAR" : "LVALUE");
7711 case SVt_PVAV: return "ARRAY";
7712 case SVt_PVHV: return "HASH";
7713 case SVt_PVCV: return "CODE";
7714 case SVt_PVGV: return "GLOB";
7715 case SVt_PVFM: return "FORMAT";
7716 case SVt_PVIO: return "IO";
7717 case SVt_BIND: return "BIND";
7718 default: return "UNKNOWN";
7724 =for apidoc sv_isobject
7726 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7727 object. If the SV is not an RV, or if the object is not blessed, then this
7734 Perl_sv_isobject(pTHX_ SV *sv)
7750 Returns a boolean indicating whether the SV is blessed into the specified
7751 class. This does not check for subtypes; use C<sv_derived_from> to verify
7752 an inheritance relationship.
7758 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7769 hvname = HvNAME_get(SvSTASH(sv));
7773 return strEQ(hvname, name);
7779 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7780 it will be upgraded to one. If C<classname> is non-null then the new SV will
7781 be blessed in the specified package. The new SV is returned and its
7782 reference count is 1.
7788 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7795 SV_CHECK_THINKFIRST_COW_DROP(rv);
7796 (void)SvAMAGIC_off(rv);
7798 if (SvTYPE(rv) >= SVt_PVMG) {
7799 const U32 refcnt = SvREFCNT(rv);
7803 SvREFCNT(rv) = refcnt;
7805 sv_upgrade(rv, SVt_RV);
7806 } else if (SvROK(rv)) {
7807 SvREFCNT_dec(SvRV(rv));
7808 } else if (SvTYPE(rv) < SVt_RV)
7809 sv_upgrade(rv, SVt_RV);
7810 else if (SvTYPE(rv) > SVt_RV) {
7821 HV* const stash = gv_stashpv(classname, GV_ADD);
7822 (void)sv_bless(rv, stash);
7828 =for apidoc sv_setref_pv
7830 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7831 argument will be upgraded to an RV. That RV will be modified to point to
7832 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7833 into the SV. The C<classname> argument indicates the package for the
7834 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7835 will have a reference count of 1, and the RV will be returned.
7837 Do not use with other Perl types such as HV, AV, SV, CV, because those
7838 objects will become corrupted by the pointer copy process.
7840 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7846 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7850 sv_setsv(rv, &PL_sv_undef);
7854 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7859 =for apidoc sv_setref_iv
7861 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7862 argument will be upgraded to an RV. That RV will be modified to point to
7863 the new SV. The C<classname> argument indicates the package for the
7864 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7865 will have a reference count of 1, and the RV will be returned.
7871 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7873 sv_setiv(newSVrv(rv,classname), iv);
7878 =for apidoc sv_setref_uv
7880 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7881 argument will be upgraded to an RV. That RV will be modified to point to
7882 the new SV. The C<classname> argument indicates the package for the
7883 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7884 will have a reference count of 1, and the RV will be returned.
7890 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7892 sv_setuv(newSVrv(rv,classname), uv);
7897 =for apidoc sv_setref_nv
7899 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7900 argument will be upgraded to an RV. That RV will be modified to point to
7901 the new SV. The C<classname> argument indicates the package for the
7902 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7903 will have a reference count of 1, and the RV will be returned.
7909 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7911 sv_setnv(newSVrv(rv,classname), nv);
7916 =for apidoc sv_setref_pvn
7918 Copies a string into a new SV, optionally blessing the SV. The length of the
7919 string must be specified with C<n>. The C<rv> argument will be upgraded to
7920 an RV. That RV will be modified to point to the new SV. The C<classname>
7921 argument indicates the package for the blessing. Set C<classname> to
7922 C<NULL> to avoid the blessing. The new SV will have a reference count
7923 of 1, and the RV will be returned.
7925 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7931 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7933 sv_setpvn(newSVrv(rv,classname), pv, n);
7938 =for apidoc sv_bless
7940 Blesses an SV into a specified package. The SV must be an RV. The package
7941 must be designated by its stash (see C<gv_stashpv()>). The reference count
7942 of the SV is unaffected.
7948 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7953 Perl_croak(aTHX_ "Can't bless non-reference value");
7955 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7956 if (SvREADONLY(tmpRef))
7957 Perl_croak(aTHX_ PL_no_modify);
7958 if (SvOBJECT(tmpRef)) {
7959 if (SvTYPE(tmpRef) != SVt_PVIO)
7961 SvREFCNT_dec(SvSTASH(tmpRef));
7964 SvOBJECT_on(tmpRef);
7965 if (SvTYPE(tmpRef) != SVt_PVIO)
7967 SvUPGRADE(tmpRef, SVt_PVMG);
7968 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7973 (void)SvAMAGIC_off(sv);
7975 if(SvSMAGICAL(tmpRef))
7976 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7984 /* Downgrades a PVGV to a PVMG.
7988 S_sv_unglob(pTHX_ SV *sv)
7993 SV * const temp = sv_newmortal();
7995 assert(SvTYPE(sv) == SVt_PVGV);
7997 gv_efullname3(temp, (GV *) sv, "*");
8000 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8001 mro_method_changed_in(stash);
8005 sv_del_backref((SV*)GvSTASH(sv), sv);
8009 if (GvNAME_HEK(sv)) {
8010 unshare_hek(GvNAME_HEK(sv));
8012 isGV_with_GP_off(sv);
8014 /* need to keep SvANY(sv) in the right arena */
8015 xpvmg = new_XPVMG();
8016 StructCopy(SvANY(sv), xpvmg, XPVMG);
8017 del_XPVGV(SvANY(sv));
8020 SvFLAGS(sv) &= ~SVTYPEMASK;
8021 SvFLAGS(sv) |= SVt_PVMG;
8023 /* Intentionally not calling any local SET magic, as this isn't so much a
8024 set operation as merely an internal storage change. */
8025 sv_setsv_flags(sv, temp, 0);
8029 =for apidoc sv_unref_flags
8031 Unsets the RV status of the SV, and decrements the reference count of
8032 whatever was being referenced by the RV. This can almost be thought of
8033 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8034 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8035 (otherwise the decrementing is conditional on the reference count being
8036 different from one or the reference being a readonly SV).
8043 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8045 SV* const target = SvRV(ref);
8047 if (SvWEAKREF(ref)) {
8048 sv_del_backref(target, ref);
8050 SvRV_set(ref, NULL);
8053 SvRV_set(ref, NULL);
8055 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8056 assigned to as BEGIN {$a = \"Foo"} will fail. */
8057 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8058 SvREFCNT_dec(target);
8059 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8060 sv_2mortal(target); /* Schedule for freeing later */
8064 =for apidoc sv_untaint
8066 Untaint an SV. Use C<SvTAINTED_off> instead.
8071 Perl_sv_untaint(pTHX_ SV *sv)
8073 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8074 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8081 =for apidoc sv_tainted
8083 Test an SV for taintedness. Use C<SvTAINTED> instead.
8088 Perl_sv_tainted(pTHX_ SV *sv)
8090 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8091 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8092 if (mg && (mg->mg_len & 1) )
8099 =for apidoc sv_setpviv
8101 Copies an integer into the given SV, also updating its string value.
8102 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8108 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8110 char buf[TYPE_CHARS(UV)];
8112 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8114 sv_setpvn(sv, ptr, ebuf - ptr);
8118 =for apidoc sv_setpviv_mg
8120 Like C<sv_setpviv>, but also handles 'set' magic.
8126 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8132 #if defined(PERL_IMPLICIT_CONTEXT)
8134 /* pTHX_ magic can't cope with varargs, so this is a no-context
8135 * version of the main function, (which may itself be aliased to us).
8136 * Don't access this version directly.
8140 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8144 va_start(args, pat);
8145 sv_vsetpvf(sv, pat, &args);
8149 /* pTHX_ magic can't cope with varargs, so this is a no-context
8150 * version of the main function, (which may itself be aliased to us).
8151 * Don't access this version directly.
8155 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8159 va_start(args, pat);
8160 sv_vsetpvf_mg(sv, pat, &args);
8166 =for apidoc sv_setpvf
8168 Works like C<sv_catpvf> but copies the text into the SV instead of
8169 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8175 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8178 va_start(args, pat);
8179 sv_vsetpvf(sv, pat, &args);
8184 =for apidoc sv_vsetpvf
8186 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8187 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8189 Usually used via its frontend C<sv_setpvf>.
8195 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8197 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8201 =for apidoc sv_setpvf_mg
8203 Like C<sv_setpvf>, but also handles 'set' magic.
8209 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8212 va_start(args, pat);
8213 sv_vsetpvf_mg(sv, pat, &args);
8218 =for apidoc sv_vsetpvf_mg
8220 Like C<sv_vsetpvf>, but also handles 'set' magic.
8222 Usually used via its frontend C<sv_setpvf_mg>.
8228 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8230 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8234 #if defined(PERL_IMPLICIT_CONTEXT)
8236 /* pTHX_ magic can't cope with varargs, so this is a no-context
8237 * version of the main function, (which may itself be aliased to us).
8238 * Don't access this version directly.
8242 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8246 va_start(args, pat);
8247 sv_vcatpvf(sv, pat, &args);
8251 /* pTHX_ magic can't cope with varargs, so this is a no-context
8252 * version of the main function, (which may itself be aliased to us).
8253 * Don't access this version directly.
8257 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8261 va_start(args, pat);
8262 sv_vcatpvf_mg(sv, pat, &args);
8268 =for apidoc sv_catpvf
8270 Processes its arguments like C<sprintf> and appends the formatted
8271 output to an SV. If the appended data contains "wide" characters
8272 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8273 and characters >255 formatted with %c), the original SV might get
8274 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8275 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8276 valid UTF-8; if the original SV was bytes, the pattern should be too.
8281 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8284 va_start(args, pat);
8285 sv_vcatpvf(sv, pat, &args);
8290 =for apidoc sv_vcatpvf
8292 Processes its arguments like C<vsprintf> and appends the formatted output
8293 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8295 Usually used via its frontend C<sv_catpvf>.
8301 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8303 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8307 =for apidoc sv_catpvf_mg
8309 Like C<sv_catpvf>, but also handles 'set' magic.
8315 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8318 va_start(args, pat);
8319 sv_vcatpvf_mg(sv, pat, &args);
8324 =for apidoc sv_vcatpvf_mg
8326 Like C<sv_vcatpvf>, but also handles 'set' magic.
8328 Usually used via its frontend C<sv_catpvf_mg>.
8334 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8336 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8341 =for apidoc sv_vsetpvfn
8343 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8346 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8352 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8354 sv_setpvn(sv, "", 0);
8355 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8359 S_expect_number(pTHX_ char** pattern)
8363 switch (**pattern) {
8364 case '1': case '2': case '3':
8365 case '4': case '5': case '6':
8366 case '7': case '8': case '9':
8367 var = *(*pattern)++ - '0';
8368 while (isDIGIT(**pattern)) {
8369 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8371 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8379 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8381 const int neg = nv < 0;
8390 if (uv & 1 && uv == nv)
8391 uv--; /* Round to even */
8393 const unsigned dig = uv % 10;
8406 =for apidoc sv_vcatpvfn
8408 Processes its arguments like C<vsprintf> and appends the formatted output
8409 to an SV. Uses an array of SVs if the C style variable argument list is
8410 missing (NULL). When running with taint checks enabled, indicates via
8411 C<maybe_tainted> if results are untrustworthy (often due to the use of
8414 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8420 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8421 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8422 vec_utf8 = DO_UTF8(vecsv);
8424 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8427 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8435 static const char nullstr[] = "(null)";
8437 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8438 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8440 /* Times 4: a decimal digit takes more than 3 binary digits.
8441 * NV_DIG: mantissa takes than many decimal digits.
8442 * Plus 32: Playing safe. */
8443 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8444 /* large enough for "%#.#f" --chip */
8445 /* what about long double NVs? --jhi */
8447 PERL_UNUSED_ARG(maybe_tainted);
8449 /* no matter what, this is a string now */
8450 (void)SvPV_force(sv, origlen);
8452 /* special-case "", "%s", and "%-p" (SVf - see below) */
8455 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8457 const char * const s = va_arg(*args, char*);
8458 sv_catpv(sv, s ? s : nullstr);
8460 else if (svix < svmax) {
8461 sv_catsv(sv, *svargs);
8465 if (args && patlen == 3 && pat[0] == '%' &&
8466 pat[1] == '-' && pat[2] == 'p') {
8467 argsv = (SV*)va_arg(*args, void*);
8468 sv_catsv(sv, argsv);
8472 #ifndef USE_LONG_DOUBLE
8473 /* special-case "%.<number>[gf]" */
8474 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8475 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8476 unsigned digits = 0;
8480 while (*pp >= '0' && *pp <= '9')
8481 digits = 10 * digits + (*pp++ - '0');
8482 if (pp - pat == (int)patlen - 1) {
8490 /* Add check for digits != 0 because it seems that some
8491 gconverts are buggy in this case, and we don't yet have
8492 a Configure test for this. */
8493 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8494 /* 0, point, slack */
8495 Gconvert(nv, (int)digits, 0, ebuf);
8497 if (*ebuf) /* May return an empty string for digits==0 */
8500 } else if (!digits) {
8503 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8504 sv_catpvn(sv, p, l);
8510 #endif /* !USE_LONG_DOUBLE */
8512 if (!args && svix < svmax && DO_UTF8(*svargs))
8515 patend = (char*)pat + patlen;
8516 for (p = (char*)pat; p < patend; p = q) {
8519 bool vectorize = FALSE;
8520 bool vectorarg = FALSE;
8521 bool vec_utf8 = FALSE;
8527 bool has_precis = FALSE;
8529 const I32 osvix = svix;
8530 bool is_utf8 = FALSE; /* is this item utf8? */
8531 #ifdef HAS_LDBL_SPRINTF_BUG
8532 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8533 with sfio - Allen <allens@cpan.org> */
8534 bool fix_ldbl_sprintf_bug = FALSE;
8538 U8 utf8buf[UTF8_MAXBYTES+1];
8539 STRLEN esignlen = 0;
8541 const char *eptr = NULL;
8544 const U8 *vecstr = NULL;
8551 /* we need a long double target in case HAS_LONG_DOUBLE but
8554 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8562 const char *dotstr = ".";
8563 STRLEN dotstrlen = 1;
8564 I32 efix = 0; /* explicit format parameter index */
8565 I32 ewix = 0; /* explicit width index */
8566 I32 epix = 0; /* explicit precision index */
8567 I32 evix = 0; /* explicit vector index */
8568 bool asterisk = FALSE;
8570 /* echo everything up to the next format specification */
8571 for (q = p; q < patend && *q != '%'; ++q) ;
8573 if (has_utf8 && !pat_utf8)
8574 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8576 sv_catpvn(sv, p, q - p);
8583 We allow format specification elements in this order:
8584 \d+\$ explicit format parameter index
8586 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8587 0 flag (as above): repeated to allow "v02"
8588 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8589 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8591 [%bcdefginopsuxDFOUX] format (mandatory)
8596 As of perl5.9.3, printf format checking is on by default.
8597 Internally, perl uses %p formats to provide an escape to
8598 some extended formatting. This block deals with those
8599 extensions: if it does not match, (char*)q is reset and
8600 the normal format processing code is used.
8602 Currently defined extensions are:
8603 %p include pointer address (standard)
8604 %-p (SVf) include an SV (previously %_)
8605 %-<num>p include an SV with precision <num>
8606 %1p (VDf) include a v-string (as %vd)
8607 %<num>p reserved for future extensions
8609 Robin Barker 2005-07-14
8616 n = expect_number(&q);
8623 argsv = (SV*)va_arg(*args, void*);
8624 eptr = SvPV_const(argsv, elen);
8630 else if (n == vdNUMBER) { /* VDf */
8637 if (ckWARN_d(WARN_INTERNAL))
8638 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8639 "internal %%<num>p might conflict with future printf extensions");
8645 if ( (width = expect_number(&q)) ) {
8660 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8689 if ( (ewix = expect_number(&q)) )
8698 if ((vectorarg = asterisk)) {
8711 width = expect_number(&q);
8717 vecsv = va_arg(*args, SV*);
8719 vecsv = (evix > 0 && evix <= svmax)
8720 ? svargs[evix-1] : &PL_sv_undef;
8722 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8724 dotstr = SvPV_const(vecsv, dotstrlen);
8725 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8726 bad with tied or overloaded values that return UTF8. */
8729 else if (has_utf8) {
8730 vecsv = sv_mortalcopy(vecsv);
8731 sv_utf8_upgrade(vecsv);
8732 dotstr = SvPV_const(vecsv, dotstrlen);
8739 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8740 vecsv = svargs[efix ? efix-1 : svix++];
8741 vecstr = (U8*)SvPV_const(vecsv,veclen);
8742 vec_utf8 = DO_UTF8(vecsv);
8744 /* if this is a version object, we need to convert
8745 * back into v-string notation and then let the
8746 * vectorize happen normally
8748 if (sv_derived_from(vecsv, "version")) {
8749 char *version = savesvpv(vecsv);
8750 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8751 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8752 "vector argument not supported with alpha versions");
8755 vecsv = sv_newmortal();
8756 scan_vstring(version, version + veclen, vecsv);
8757 vecstr = (U8*)SvPV_const(vecsv, veclen);
8758 vec_utf8 = DO_UTF8(vecsv);
8770 i = va_arg(*args, int);
8772 i = (ewix ? ewix <= svmax : svix < svmax) ?
8773 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8775 width = (i < 0) ? -i : i;
8785 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8787 /* XXX: todo, support specified precision parameter */
8791 i = va_arg(*args, int);
8793 i = (ewix ? ewix <= svmax : svix < svmax)
8794 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8796 has_precis = !(i < 0);
8801 precis = precis * 10 + (*q++ - '0');
8810 case 'I': /* Ix, I32x, and I64x */
8812 if (q[1] == '6' && q[2] == '4') {
8818 if (q[1] == '3' && q[2] == '2') {
8828 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8839 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8840 if (*(q + 1) == 'l') { /* lld, llf */
8866 if (!vectorize && !args) {
8868 const I32 i = efix-1;
8869 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8871 argsv = (svix >= 0 && svix < svmax)
8872 ? svargs[svix++] : &PL_sv_undef;
8883 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8885 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8887 eptr = (char*)utf8buf;
8888 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8902 eptr = va_arg(*args, char*);
8904 #ifdef MACOS_TRADITIONAL
8905 /* On MacOS, %#s format is used for Pascal strings */
8910 elen = strlen(eptr);
8912 eptr = (char *)nullstr;
8913 elen = sizeof nullstr - 1;
8917 eptr = SvPV_const(argsv, elen);
8918 if (DO_UTF8(argsv)) {
8919 I32 old_precis = precis;
8920 if (has_precis && precis < elen) {
8922 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8925 if (width) { /* fudge width (can't fudge elen) */
8926 if (has_precis && precis < elen)
8927 width += precis - old_precis;
8929 width += elen - sv_len_utf8(argsv);
8936 if (has_precis && elen > precis)
8943 if (alt || vectorize)
8945 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8966 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8975 esignbuf[esignlen++] = plus;
8979 case 'h': iv = (short)va_arg(*args, int); break;
8980 case 'l': iv = va_arg(*args, long); break;
8981 case 'V': iv = va_arg(*args, IV); break;
8982 default: iv = va_arg(*args, int); break;
8984 case 'q': iv = va_arg(*args, Quad_t); break;
8989 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
8991 case 'h': iv = (short)tiv; break;
8992 case 'l': iv = (long)tiv; break;
8994 default: iv = tiv; break;
8996 case 'q': iv = (Quad_t)tiv; break;
9000 if ( !vectorize ) /* we already set uv above */
9005 esignbuf[esignlen++] = plus;
9009 esignbuf[esignlen++] = '-';
9053 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9064 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9065 case 'l': uv = va_arg(*args, unsigned long); break;
9066 case 'V': uv = va_arg(*args, UV); break;
9067 default: uv = va_arg(*args, unsigned); break;
9069 case 'q': uv = va_arg(*args, Uquad_t); break;
9074 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9076 case 'h': uv = (unsigned short)tuv; break;
9077 case 'l': uv = (unsigned long)tuv; break;
9079 default: uv = tuv; break;
9081 case 'q': uv = (Uquad_t)tuv; break;
9088 char *ptr = ebuf + sizeof ebuf;
9089 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9095 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9101 esignbuf[esignlen++] = '0';
9102 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9110 if (alt && *ptr != '0')
9119 esignbuf[esignlen++] = '0';
9120 esignbuf[esignlen++] = c;
9123 default: /* it had better be ten or less */
9127 } while (uv /= base);
9130 elen = (ebuf + sizeof ebuf) - ptr;
9134 zeros = precis - elen;
9135 else if (precis == 0 && elen == 1 && *eptr == '0'
9136 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9139 /* a precision nullifies the 0 flag. */
9146 /* FLOATING POINT */
9149 c = 'f'; /* maybe %F isn't supported here */
9157 /* This is evil, but floating point is even more evil */
9159 /* for SV-style calling, we can only get NV
9160 for C-style calling, we assume %f is double;
9161 for simplicity we allow any of %Lf, %llf, %qf for long double
9165 #if defined(USE_LONG_DOUBLE)
9169 /* [perl #20339] - we should accept and ignore %lf rather than die */
9173 #if defined(USE_LONG_DOUBLE)
9174 intsize = args ? 0 : 'q';
9178 #if defined(HAS_LONG_DOUBLE)
9187 /* now we need (long double) if intsize == 'q', else (double) */
9189 #if LONG_DOUBLESIZE > DOUBLESIZE
9191 va_arg(*args, long double) :
9192 va_arg(*args, double)
9194 va_arg(*args, double)
9199 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9200 else. frexp() has some unspecified behaviour for those three */
9201 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9203 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9204 will cast our (long double) to (double) */
9205 (void)Perl_frexp(nv, &i);
9206 if (i == PERL_INT_MIN)
9207 Perl_die(aTHX_ "panic: frexp");
9209 need = BIT_DIGITS(i);
9211 need += has_precis ? precis : 6; /* known default */
9216 #ifdef HAS_LDBL_SPRINTF_BUG
9217 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9218 with sfio - Allen <allens@cpan.org> */
9221 # define MY_DBL_MAX DBL_MAX
9222 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9223 # if DOUBLESIZE >= 8
9224 # define MY_DBL_MAX 1.7976931348623157E+308L
9226 # define MY_DBL_MAX 3.40282347E+38L
9230 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9231 # define MY_DBL_MAX_BUG 1L
9233 # define MY_DBL_MAX_BUG MY_DBL_MAX
9237 # define MY_DBL_MIN DBL_MIN
9238 # else /* XXX guessing! -Allen */
9239 # if DOUBLESIZE >= 8
9240 # define MY_DBL_MIN 2.2250738585072014E-308L
9242 # define MY_DBL_MIN 1.17549435E-38L
9246 if ((intsize == 'q') && (c == 'f') &&
9247 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9249 /* it's going to be short enough that
9250 * long double precision is not needed */
9252 if ((nv <= 0L) && (nv >= -0L))
9253 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9255 /* would use Perl_fp_class as a double-check but not
9256 * functional on IRIX - see perl.h comments */
9258 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9259 /* It's within the range that a double can represent */
9260 #if defined(DBL_MAX) && !defined(DBL_MIN)
9261 if ((nv >= ((long double)1/DBL_MAX)) ||
9262 (nv <= (-(long double)1/DBL_MAX)))
9264 fix_ldbl_sprintf_bug = TRUE;
9267 if (fix_ldbl_sprintf_bug == TRUE) {
9277 # undef MY_DBL_MAX_BUG
9280 #endif /* HAS_LDBL_SPRINTF_BUG */
9282 need += 20; /* fudge factor */
9283 if (PL_efloatsize < need) {
9284 Safefree(PL_efloatbuf);
9285 PL_efloatsize = need + 20; /* more fudge */
9286 Newx(PL_efloatbuf, PL_efloatsize, char);
9287 PL_efloatbuf[0] = '\0';
9290 if ( !(width || left || plus || alt) && fill != '0'
9291 && has_precis && intsize != 'q' ) { /* Shortcuts */
9292 /* See earlier comment about buggy Gconvert when digits,
9294 if ( c == 'g' && precis) {
9295 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9296 /* May return an empty string for digits==0 */
9297 if (*PL_efloatbuf) {
9298 elen = strlen(PL_efloatbuf);
9299 goto float_converted;
9301 } else if ( c == 'f' && !precis) {
9302 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9307 char *ptr = ebuf + sizeof ebuf;
9310 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9311 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9312 if (intsize == 'q') {
9313 /* Copy the one or more characters in a long double
9314 * format before the 'base' ([efgEFG]) character to
9315 * the format string. */
9316 static char const prifldbl[] = PERL_PRIfldbl;
9317 char const *p = prifldbl + sizeof(prifldbl) - 3;
9318 while (p >= prifldbl) { *--ptr = *p--; }
9323 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9328 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9340 /* No taint. Otherwise we are in the strange situation
9341 * where printf() taints but print($float) doesn't.
9343 #if defined(HAS_LONG_DOUBLE)
9344 elen = ((intsize == 'q')
9345 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9346 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9348 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9352 eptr = PL_efloatbuf;
9360 i = SvCUR(sv) - origlen;
9363 case 'h': *(va_arg(*args, short*)) = i; break;
9364 default: *(va_arg(*args, int*)) = i; break;
9365 case 'l': *(va_arg(*args, long*)) = i; break;
9366 case 'V': *(va_arg(*args, IV*)) = i; break;
9368 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9373 sv_setuv_mg(argsv, (UV)i);
9374 continue; /* not "break" */
9381 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9382 && ckWARN(WARN_PRINTF))
9384 SV * const msg = sv_newmortal();
9385 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9386 (PL_op->op_type == OP_PRTF) ? "" : "s");
9389 Perl_sv_catpvf(aTHX_ msg,
9390 "\"%%%c\"", c & 0xFF);
9392 Perl_sv_catpvf(aTHX_ msg,
9393 "\"%%\\%03"UVof"\"",
9396 sv_catpvs(msg, "end of string");
9397 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9400 /* output mangled stuff ... */
9406 /* ... right here, because formatting flags should not apply */
9407 SvGROW(sv, SvCUR(sv) + elen + 1);
9409 Copy(eptr, p, elen, char);
9412 SvCUR_set(sv, p - SvPVX_const(sv));
9414 continue; /* not "break" */
9417 if (is_utf8 != has_utf8) {
9420 sv_utf8_upgrade(sv);
9423 const STRLEN old_elen = elen;
9424 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9425 sv_utf8_upgrade(nsv);
9426 eptr = SvPVX_const(nsv);
9429 if (width) { /* fudge width (can't fudge elen) */
9430 width += elen - old_elen;
9436 have = esignlen + zeros + elen;
9438 Perl_croak_nocontext(PL_memory_wrap);
9440 need = (have > width ? have : width);
9443 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9444 Perl_croak_nocontext(PL_memory_wrap);
9445 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9447 if (esignlen && fill == '0') {
9449 for (i = 0; i < (int)esignlen; i++)
9453 memset(p, fill, gap);
9456 if (esignlen && fill != '0') {
9458 for (i = 0; i < (int)esignlen; i++)
9463 for (i = zeros; i; i--)
9467 Copy(eptr, p, elen, char);
9471 memset(p, ' ', gap);
9476 Copy(dotstr, p, dotstrlen, char);
9480 vectorize = FALSE; /* done iterating over vecstr */
9487 SvCUR_set(sv, p - SvPVX_const(sv));
9495 /* =========================================================================
9497 =head1 Cloning an interpreter
9499 All the macros and functions in this section are for the private use of
9500 the main function, perl_clone().
9502 The foo_dup() functions make an exact copy of an existing foo thingy.
9503 During the course of a cloning, a hash table is used to map old addresses
9504 to new addresses. The table is created and manipulated with the
9505 ptr_table_* functions.
9509 ============================================================================*/
9512 #if defined(USE_ITHREADS)
9514 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9515 #ifndef GpREFCNT_inc
9516 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9520 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9521 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9522 If this changes, please unmerge ss_dup. */
9523 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9524 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9525 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9526 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9527 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9528 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9529 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9530 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9531 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9532 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9533 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9534 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9535 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9536 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9538 /* clone a parser */
9541 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9548 /* look for it in the table first */
9549 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9553 /* create anew and remember what it is */
9554 Newxz(parser, 1, yy_parser);
9555 ptr_table_store(PL_ptr_table, proto, parser);
9557 parser->yyerrstatus = 0;
9558 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9560 /* XXX these not yet duped */
9561 parser->old_parser = NULL;
9562 parser->stack = NULL;
9564 parser->stack_size = 0;
9565 /* XXX parser->stack->state = 0; */
9567 /* XXX eventually, just Copy() most of the parser struct ? */
9569 parser->lex_brackets = proto->lex_brackets;
9570 parser->lex_casemods = proto->lex_casemods;
9571 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9572 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9573 parser->lex_casestack = savepvn(proto->lex_casestack,
9574 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9575 parser->lex_defer = proto->lex_defer;
9576 parser->lex_dojoin = proto->lex_dojoin;
9577 parser->lex_expect = proto->lex_expect;
9578 parser->lex_formbrack = proto->lex_formbrack;
9579 parser->lex_inpat = proto->lex_inpat;
9580 parser->lex_inwhat = proto->lex_inwhat;
9581 parser->lex_op = proto->lex_op;
9582 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9583 parser->lex_starts = proto->lex_starts;
9584 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9585 parser->multi_close = proto->multi_close;
9586 parser->multi_open = proto->multi_open;
9587 parser->multi_start = proto->multi_start;
9588 parser->multi_end = proto->multi_end;
9589 parser->pending_ident = proto->pending_ident;
9590 parser->preambled = proto->preambled;
9591 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9592 parser->linestr = sv_dup_inc(proto->linestr, param);
9593 parser->expect = proto->expect;
9594 parser->copline = proto->copline;
9595 parser->last_lop_op = proto->last_lop_op;
9596 parser->lex_state = proto->lex_state;
9597 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9598 /* rsfp_filters entries have fake IoDIRP() */
9599 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9600 parser->in_my = proto->in_my;
9601 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9602 parser->error_count = proto->error_count;
9605 parser->linestr = sv_dup_inc(proto->linestr, param);
9608 char * const ols = SvPVX(proto->linestr);
9609 char * const ls = SvPVX(parser->linestr);
9611 parser->bufptr = ls + (proto->bufptr >= ols ?
9612 proto->bufptr - ols : 0);
9613 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9614 proto->oldbufptr - ols : 0);
9615 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9616 proto->oldoldbufptr - ols : 0);
9617 parser->linestart = ls + (proto->linestart >= ols ?
9618 proto->linestart - ols : 0);
9619 parser->last_uni = ls + (proto->last_uni >= ols ?
9620 proto->last_uni - ols : 0);
9621 parser->last_lop = ls + (proto->last_lop >= ols ?
9622 proto->last_lop - ols : 0);
9624 parser->bufend = ls + SvCUR(parser->linestr);
9627 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9631 parser->endwhite = proto->endwhite;
9632 parser->faketokens = proto->faketokens;
9633 parser->lasttoke = proto->lasttoke;
9634 parser->nextwhite = proto->nextwhite;
9635 parser->realtokenstart = proto->realtokenstart;
9636 parser->skipwhite = proto->skipwhite;
9637 parser->thisclose = proto->thisclose;
9638 parser->thismad = proto->thismad;
9639 parser->thisopen = proto->thisopen;
9640 parser->thisstuff = proto->thisstuff;
9641 parser->thistoken = proto->thistoken;
9642 parser->thiswhite = proto->thiswhite;
9644 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9645 parser->curforce = proto->curforce;
9647 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9648 Copy(proto->nexttype, parser->nexttype, 5, I32);
9649 parser->nexttoke = proto->nexttoke;
9655 /* duplicate a file handle */
9658 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9662 PERL_UNUSED_ARG(type);
9665 return (PerlIO*)NULL;
9667 /* look for it in the table first */
9668 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9672 /* create anew and remember what it is */
9673 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9674 ptr_table_store(PL_ptr_table, fp, ret);
9678 /* duplicate a directory handle */
9681 Perl_dirp_dup(pTHX_ DIR *dp)
9683 PERL_UNUSED_CONTEXT;
9690 /* duplicate a typeglob */
9693 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9699 /* look for it in the table first */
9700 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9704 /* create anew and remember what it is */
9706 ptr_table_store(PL_ptr_table, gp, ret);
9709 ret->gp_refcnt = 0; /* must be before any other dups! */
9710 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9711 ret->gp_io = io_dup_inc(gp->gp_io, param);
9712 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9713 ret->gp_av = av_dup_inc(gp->gp_av, param);
9714 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9715 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9716 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9717 ret->gp_cvgen = gp->gp_cvgen;
9718 ret->gp_line = gp->gp_line;
9719 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9723 /* duplicate a chain of magic */
9726 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9728 MAGIC *mgprev = (MAGIC*)NULL;
9731 return (MAGIC*)NULL;
9732 /* look for it in the table first */
9733 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9737 for (; mg; mg = mg->mg_moremagic) {
9739 Newxz(nmg, 1, MAGIC);
9741 mgprev->mg_moremagic = nmg;
9744 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9745 nmg->mg_private = mg->mg_private;
9746 nmg->mg_type = mg->mg_type;
9747 nmg->mg_flags = mg->mg_flags;
9748 if (mg->mg_type == PERL_MAGIC_qr) {
9749 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9751 else if(mg->mg_type == PERL_MAGIC_backref) {
9752 /* The backref AV has its reference count deliberately bumped by
9754 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9757 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9758 ? sv_dup_inc(mg->mg_obj, param)
9759 : sv_dup(mg->mg_obj, param);
9761 nmg->mg_len = mg->mg_len;
9762 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9763 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9764 if (mg->mg_len > 0) {
9765 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9766 if (mg->mg_type == PERL_MAGIC_overload_table &&
9767 AMT_AMAGIC((AMT*)mg->mg_ptr))
9769 const AMT * const amtp = (AMT*)mg->mg_ptr;
9770 AMT * const namtp = (AMT*)nmg->mg_ptr;
9772 for (i = 1; i < NofAMmeth; i++) {
9773 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9777 else if (mg->mg_len == HEf_SVKEY)
9778 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9780 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9781 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9788 #endif /* USE_ITHREADS */
9790 /* create a new pointer-mapping table */
9793 Perl_ptr_table_new(pTHX)
9796 PERL_UNUSED_CONTEXT;
9798 Newxz(tbl, 1, PTR_TBL_t);
9801 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9805 #define PTR_TABLE_HASH(ptr) \
9806 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9809 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9810 following define) and at call to new_body_inline made below in
9811 Perl_ptr_table_store()
9814 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9816 /* map an existing pointer using a table */
9818 STATIC PTR_TBL_ENT_t *
9819 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9820 PTR_TBL_ENT_t *tblent;
9821 const UV hash = PTR_TABLE_HASH(sv);
9823 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9824 for (; tblent; tblent = tblent->next) {
9825 if (tblent->oldval == sv)
9832 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9834 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9835 PERL_UNUSED_CONTEXT;
9836 return tblent ? tblent->newval : NULL;
9839 /* add a new entry to a pointer-mapping table */
9842 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9844 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9845 PERL_UNUSED_CONTEXT;
9848 tblent->newval = newsv;
9850 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9852 new_body_inline(tblent, PTE_SVSLOT);
9854 tblent->oldval = oldsv;
9855 tblent->newval = newsv;
9856 tblent->next = tbl->tbl_ary[entry];
9857 tbl->tbl_ary[entry] = tblent;
9859 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9860 ptr_table_split(tbl);
9864 /* double the hash bucket size of an existing ptr table */
9867 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9869 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9870 const UV oldsize = tbl->tbl_max + 1;
9871 UV newsize = oldsize * 2;
9873 PERL_UNUSED_CONTEXT;
9875 Renew(ary, newsize, PTR_TBL_ENT_t*);
9876 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9877 tbl->tbl_max = --newsize;
9879 for (i=0; i < oldsize; i++, ary++) {
9880 PTR_TBL_ENT_t **curentp, **entp, *ent;
9883 curentp = ary + oldsize;
9884 for (entp = ary, ent = *ary; ent; ent = *entp) {
9885 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9887 ent->next = *curentp;
9897 /* remove all the entries from a ptr table */
9900 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9902 if (tbl && tbl->tbl_items) {
9903 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9904 UV riter = tbl->tbl_max;
9907 PTR_TBL_ENT_t *entry = array[riter];
9910 PTR_TBL_ENT_t * const oentry = entry;
9911 entry = entry->next;
9920 /* clear and free a ptr table */
9923 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9928 ptr_table_clear(tbl);
9929 Safefree(tbl->tbl_ary);
9933 #if defined(USE_ITHREADS)
9936 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9939 SvRV_set(dstr, SvWEAKREF(sstr)
9940 ? sv_dup(SvRV(sstr), param)
9941 : sv_dup_inc(SvRV(sstr), param));
9944 else if (SvPVX_const(sstr)) {
9945 /* Has something there */
9947 /* Normal PV - clone whole allocated space */
9948 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9949 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9950 /* Not that normal - actually sstr is copy on write.
9951 But we are a true, independant SV, so: */
9952 SvREADONLY_off(dstr);
9957 /* Special case - not normally malloced for some reason */
9958 if (isGV_with_GP(sstr)) {
9959 /* Don't need to do anything here. */
9961 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9962 /* A "shared" PV - clone it as "shared" PV */
9964 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9968 /* Some other special case - random pointer */
9969 SvPV_set(dstr, SvPVX(sstr));
9975 if (SvTYPE(dstr) == SVt_RV)
9976 SvRV_set(dstr, NULL);
9978 SvPV_set(dstr, NULL);
9982 /* duplicate an SV of any type (including AV, HV etc) */
9985 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9990 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9992 /* look for it in the table first */
9993 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9997 if(param->flags & CLONEf_JOIN_IN) {
9998 /** We are joining here so we don't want do clone
9999 something that is bad **/
10000 if (SvTYPE(sstr) == SVt_PVHV) {
10001 const char * const hvname = HvNAME_get(sstr);
10003 /** don't clone stashes if they already exist **/
10004 return (SV*)gv_stashpv(hvname,0);
10008 /* create anew and remember what it is */
10011 #ifdef DEBUG_LEAKING_SCALARS
10012 dstr->sv_debug_optype = sstr->sv_debug_optype;
10013 dstr->sv_debug_line = sstr->sv_debug_line;
10014 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10015 dstr->sv_debug_cloned = 1;
10016 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10019 ptr_table_store(PL_ptr_table, sstr, dstr);
10022 SvFLAGS(dstr) = SvFLAGS(sstr);
10023 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10024 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10027 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10028 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10029 (void*)PL_watch_pvx, SvPVX_const(sstr));
10032 /* don't clone objects whose class has asked us not to */
10033 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10034 SvFLAGS(dstr) &= ~SVTYPEMASK;
10035 SvOBJECT_off(dstr);
10039 switch (SvTYPE(sstr)) {
10041 SvANY(dstr) = NULL;
10044 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10045 SvIV_set(dstr, SvIVX(sstr));
10048 SvANY(dstr) = new_XNV();
10049 SvNV_set(dstr, SvNVX(sstr));
10052 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10053 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10055 /* case SVt_BIND: */
10058 /* These are all the types that need complex bodies allocating. */
10060 const svtype sv_type = SvTYPE(sstr);
10061 const struct body_details *const sv_type_details
10062 = bodies_by_type + sv_type;
10066 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10070 if (GvUNIQUE((GV*)sstr)) {
10071 NOOP; /* Do sharing here, and fall through */
10083 assert(sv_type_details->body_size);
10084 if (sv_type_details->arena) {
10085 new_body_inline(new_body, sv_type);
10087 = (void*)((char*)new_body - sv_type_details->offset);
10089 new_body = new_NOARENA(sv_type_details);
10093 SvANY(dstr) = new_body;
10096 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10097 ((char*)SvANY(dstr)) + sv_type_details->offset,
10098 sv_type_details->copy, char);
10100 Copy(((char*)SvANY(sstr)),
10101 ((char*)SvANY(dstr)),
10102 sv_type_details->body_size + sv_type_details->offset, char);
10105 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10106 && !isGV_with_GP(dstr))
10107 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10109 /* The Copy above means that all the source (unduplicated) pointers
10110 are now in the destination. We can check the flags and the
10111 pointers in either, but it's possible that there's less cache
10112 missing by always going for the destination.
10113 FIXME - instrument and check that assumption */
10114 if (sv_type >= SVt_PVMG) {
10115 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10116 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10117 } else if (SvMAGIC(dstr))
10118 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10120 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10123 /* The cast silences a GCC warning about unhandled types. */
10124 switch ((int)sv_type) {
10134 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10135 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10136 LvTARG(dstr) = dstr;
10137 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10138 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10140 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10142 if(isGV_with_GP(sstr)) {
10143 if (GvNAME_HEK(dstr))
10144 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10145 /* Don't call sv_add_backref here as it's going to be
10146 created as part of the magic cloning of the symbol
10148 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10149 at the point of this comment. */
10150 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10151 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10152 (void)GpREFCNT_inc(GvGP(dstr));
10154 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10157 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10158 if (IoOFP(dstr) == IoIFP(sstr))
10159 IoOFP(dstr) = IoIFP(dstr);
10161 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10162 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10163 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10164 /* I have no idea why fake dirp (rsfps)
10165 should be treated differently but otherwise
10166 we end up with leaks -- sky*/
10167 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10168 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10169 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10171 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10172 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10173 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10174 if (IoDIRP(dstr)) {
10175 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10178 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10181 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10182 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10183 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10186 if (AvARRAY((AV*)sstr)) {
10187 SV **dst_ary, **src_ary;
10188 SSize_t items = AvFILLp((AV*)sstr) + 1;
10190 src_ary = AvARRAY((AV*)sstr);
10191 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10192 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10193 AvARRAY((AV*)dstr) = dst_ary;
10194 AvALLOC((AV*)dstr) = dst_ary;
10195 if (AvREAL((AV*)sstr)) {
10196 while (items-- > 0)
10197 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10200 while (items-- > 0)
10201 *dst_ary++ = sv_dup(*src_ary++, param);
10203 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10204 while (items-- > 0) {
10205 *dst_ary++ = &PL_sv_undef;
10209 AvARRAY((AV*)dstr) = NULL;
10210 AvALLOC((AV*)dstr) = (SV**)NULL;
10214 if (HvARRAY((HV*)sstr)) {
10216 const bool sharekeys = !!HvSHAREKEYS(sstr);
10217 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10218 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10220 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10221 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10223 HvARRAY(dstr) = (HE**)darray;
10224 while (i <= sxhv->xhv_max) {
10225 const HE * const source = HvARRAY(sstr)[i];
10226 HvARRAY(dstr)[i] = source
10227 ? he_dup(source, sharekeys, param) : 0;
10232 const struct xpvhv_aux * const saux = HvAUX(sstr);
10233 struct xpvhv_aux * const daux = HvAUX(dstr);
10234 /* This flag isn't copied. */
10235 /* SvOOK_on(hv) attacks the IV flags. */
10236 SvFLAGS(dstr) |= SVf_OOK;
10238 hvname = saux->xhv_name;
10239 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10241 daux->xhv_riter = saux->xhv_riter;
10242 daux->xhv_eiter = saux->xhv_eiter
10243 ? he_dup(saux->xhv_eiter,
10244 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10245 daux->xhv_backreferences =
10246 saux->xhv_backreferences
10247 ? (AV*) SvREFCNT_inc(
10248 sv_dup((SV*)saux->xhv_backreferences, param))
10251 daux->xhv_mro_meta = saux->xhv_mro_meta
10252 ? mro_meta_dup(saux->xhv_mro_meta, param)
10255 /* Record stashes for possible cloning in Perl_clone(). */
10257 av_push(param->stashes, dstr);
10261 HvARRAY((HV*)dstr) = NULL;
10264 if (!(param->flags & CLONEf_COPY_STACKS)) {
10268 /* NOTE: not refcounted */
10269 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10271 if (!CvISXSUB(dstr))
10272 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10274 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10275 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10276 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10277 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10279 /* don't dup if copying back - CvGV isn't refcounted, so the
10280 * duped GV may never be freed. A bit of a hack! DAPM */
10281 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10282 NULL : gv_dup(CvGV(dstr), param) ;
10283 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10285 CvWEAKOUTSIDE(sstr)
10286 ? cv_dup( CvOUTSIDE(dstr), param)
10287 : cv_dup_inc(CvOUTSIDE(dstr), param);
10288 if (!CvISXSUB(dstr))
10289 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10295 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10301 /* duplicate a context */
10304 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10306 PERL_CONTEXT *ncxs;
10309 return (PERL_CONTEXT*)NULL;
10311 /* look for it in the table first */
10312 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10316 /* create anew and remember what it is */
10317 Newxz(ncxs, max + 1, PERL_CONTEXT);
10318 ptr_table_store(PL_ptr_table, cxs, ncxs);
10321 PERL_CONTEXT * const cx = &cxs[ix];
10322 PERL_CONTEXT * const ncx = &ncxs[ix];
10323 ncx->cx_type = cx->cx_type;
10324 if (CxTYPE(cx) == CXt_SUBST) {
10325 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10328 ncx->blk_oldsp = cx->blk_oldsp;
10329 ncx->blk_oldcop = cx->blk_oldcop;
10330 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10331 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10332 ncx->blk_oldpm = cx->blk_oldpm;
10333 ncx->blk_gimme = cx->blk_gimme;
10334 switch (CxTYPE(cx)) {
10336 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10337 ? cv_dup_inc(cx->blk_sub.cv, param)
10338 : cv_dup(cx->blk_sub.cv,param));
10339 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10340 ? av_dup_inc(cx->blk_sub.argarray, param)
10342 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10343 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10344 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10345 ncx->blk_sub.lval = cx->blk_sub.lval;
10346 ncx->blk_sub.retop = cx->blk_sub.retop;
10347 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10348 cx->blk_sub.oldcomppad);
10351 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10352 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10353 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10354 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10355 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10356 ncx->blk_eval.retop = cx->blk_eval.retop;
10359 ncx->blk_loop.label = cx->blk_loop.label;
10360 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10361 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10362 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10363 ? cx->blk_loop.iterdata
10364 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10365 ncx->blk_loop.oldcomppad
10366 = (PAD*)ptr_table_fetch(PL_ptr_table,
10367 cx->blk_loop.oldcomppad);
10368 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10369 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10370 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10371 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10372 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10375 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10376 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10377 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10378 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10379 ncx->blk_sub.retop = cx->blk_sub.retop;
10391 /* duplicate a stack info structure */
10394 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10399 return (PERL_SI*)NULL;
10401 /* look for it in the table first */
10402 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10406 /* create anew and remember what it is */
10407 Newxz(nsi, 1, PERL_SI);
10408 ptr_table_store(PL_ptr_table, si, nsi);
10410 nsi->si_stack = av_dup_inc(si->si_stack, param);
10411 nsi->si_cxix = si->si_cxix;
10412 nsi->si_cxmax = si->si_cxmax;
10413 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10414 nsi->si_type = si->si_type;
10415 nsi->si_prev = si_dup(si->si_prev, param);
10416 nsi->si_next = si_dup(si->si_next, param);
10417 nsi->si_markoff = si->si_markoff;
10422 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10423 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10424 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10425 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10426 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10427 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10428 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10429 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10430 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10431 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10432 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10433 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10434 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10435 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10438 #define pv_dup_inc(p) SAVEPV(p)
10439 #define pv_dup(p) SAVEPV(p)
10440 #define svp_dup_inc(p,pp) any_dup(p,pp)
10442 /* map any object to the new equivent - either something in the
10443 * ptr table, or something in the interpreter structure
10447 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10452 return (void*)NULL;
10454 /* look for it in the table first */
10455 ret = ptr_table_fetch(PL_ptr_table, v);
10459 /* see if it is part of the interpreter structure */
10460 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10461 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10469 /* duplicate the save stack */
10472 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10475 ANY * const ss = proto_perl->Isavestack;
10476 const I32 max = proto_perl->Isavestack_max;
10477 I32 ix = proto_perl->Isavestack_ix;
10490 void (*dptr) (void*);
10491 void (*dxptr) (pTHX_ void*);
10493 Newxz(nss, max, ANY);
10496 const I32 type = POPINT(ss,ix);
10497 TOPINT(nss,ix) = type;
10499 case SAVEt_HELEM: /* hash element */
10500 sv = (SV*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10503 case SAVEt_ITEM: /* normal string */
10504 case SAVEt_SV: /* scalar reference */
10505 sv = (SV*)POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10509 case SAVEt_MORTALIZESV:
10510 sv = (SV*)POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10513 case SAVEt_SHARED_PVREF: /* char* in shared space */
10514 c = (char*)POPPTR(ss,ix);
10515 TOPPTR(nss,ix) = savesharedpv(c);
10516 ptr = POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10519 case SAVEt_GENERIC_SVREF: /* generic sv */
10520 case SAVEt_SVREF: /* scalar reference */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10523 ptr = POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10526 case SAVEt_HV: /* hash reference */
10527 case SAVEt_AV: /* array reference */
10528 sv = (SV*) POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10531 case SAVEt_COMPPAD:
10533 sv = (SV*) POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = sv_dup(sv, param);
10536 case SAVEt_INT: /* int reference */
10537 ptr = POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10539 intval = (int)POPINT(ss,ix);
10540 TOPINT(nss,ix) = intval;
10542 case SAVEt_LONG: /* long reference */
10543 ptr = POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10546 case SAVEt_CLEARSV:
10547 longval = (long)POPLONG(ss,ix);
10548 TOPLONG(nss,ix) = longval;
10550 case SAVEt_I32: /* I32 reference */
10551 case SAVEt_I16: /* I16 reference */
10552 case SAVEt_I8: /* I8 reference */
10553 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10554 ptr = POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10557 TOPINT(nss,ix) = i;
10559 case SAVEt_IV: /* IV reference */
10560 ptr = POPPTR(ss,ix);
10561 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10563 TOPIV(nss,ix) = iv;
10565 case SAVEt_HPTR: /* HV* reference */
10566 case SAVEt_APTR: /* AV* reference */
10567 case SAVEt_SPTR: /* SV* reference */
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10570 sv = (SV*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = sv_dup(sv, param);
10573 case SAVEt_VPTR: /* random* reference */
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10576 ptr = POPPTR(ss,ix);
10577 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10579 case SAVEt_GENERIC_PVREF: /* generic char* */
10580 case SAVEt_PPTR: /* char* reference */
10581 ptr = POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10583 c = (char*)POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = pv_dup(c);
10586 case SAVEt_GP: /* scalar reference */
10587 gp = (GP*)POPPTR(ss,ix);
10588 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10589 (void)GpREFCNT_inc(gp);
10590 gv = (GV*)POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10594 ptr = POPPTR(ss,ix);
10595 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10596 /* these are assumed to be refcounted properly */
10598 switch (((OP*)ptr)->op_type) {
10600 case OP_LEAVESUBLV:
10604 case OP_LEAVEWRITE:
10605 TOPPTR(nss,ix) = ptr;
10608 (void) OpREFCNT_inc(o);
10612 TOPPTR(nss,ix) = NULL;
10617 TOPPTR(nss,ix) = NULL;
10620 c = (char*)POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = pv_dup_inc(c);
10624 hv = (HV*)POPPTR(ss,ix);
10625 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10626 c = (char*)POPPTR(ss,ix);
10627 TOPPTR(nss,ix) = pv_dup_inc(c);
10629 case SAVEt_STACK_POS: /* Position on Perl stack */
10631 TOPINT(nss,ix) = i;
10633 case SAVEt_DESTRUCTOR:
10634 ptr = POPPTR(ss,ix);
10635 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10636 dptr = POPDPTR(ss,ix);
10637 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10638 any_dup(FPTR2DPTR(void *, dptr),
10641 case SAVEt_DESTRUCTOR_X:
10642 ptr = POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10644 dxptr = POPDXPTR(ss,ix);
10645 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10646 any_dup(FPTR2DPTR(void *, dxptr),
10649 case SAVEt_REGCONTEXT:
10652 TOPINT(nss,ix) = i;
10655 case SAVEt_AELEM: /* array element */
10656 sv = (SV*)POPPTR(ss,ix);
10657 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10659 TOPINT(nss,ix) = i;
10660 av = (AV*)POPPTR(ss,ix);
10661 TOPPTR(nss,ix) = av_dup_inc(av, param);
10664 ptr = POPPTR(ss,ix);
10665 TOPPTR(nss,ix) = ptr;
10669 TOPINT(nss,ix) = i;
10670 ptr = POPPTR(ss,ix);
10673 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10674 HINTS_REFCNT_UNLOCK;
10676 TOPPTR(nss,ix) = ptr;
10677 if (i & HINT_LOCALIZE_HH) {
10678 hv = (HV*)POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10683 longval = (long)POPLONG(ss,ix);
10684 TOPLONG(nss,ix) = longval;
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10687 sv = (SV*)POPPTR(ss,ix);
10688 TOPPTR(nss,ix) = sv_dup(sv, param);
10691 ptr = POPPTR(ss,ix);
10692 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10693 longval = (long)POPBOOL(ss,ix);
10694 TOPBOOL(nss,ix) = (bool)longval;
10696 case SAVEt_SET_SVFLAGS:
10698 TOPINT(nss,ix) = i;
10700 TOPINT(nss,ix) = i;
10701 sv = (SV*)POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = sv_dup(sv, param);
10704 case SAVEt_RE_STATE:
10706 const struct re_save_state *const old_state
10707 = (struct re_save_state *)
10708 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10709 struct re_save_state *const new_state
10710 = (struct re_save_state *)
10711 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10713 Copy(old_state, new_state, 1, struct re_save_state);
10714 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10716 new_state->re_state_bostr
10717 = pv_dup(old_state->re_state_bostr);
10718 new_state->re_state_reginput
10719 = pv_dup(old_state->re_state_reginput);
10720 new_state->re_state_regeol
10721 = pv_dup(old_state->re_state_regeol);
10722 new_state->re_state_regoffs
10723 = (regexp_paren_pair*)
10724 any_dup(old_state->re_state_regoffs, proto_perl);
10725 new_state->re_state_reglastparen
10726 = (U32*) any_dup(old_state->re_state_reglastparen,
10728 new_state->re_state_reglastcloseparen
10729 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10731 /* XXX This just has to be broken. The old save_re_context
10732 code did SAVEGENERICPV(PL_reg_start_tmp);
10733 PL_reg_start_tmp is char **.
10734 Look above to what the dup code does for
10735 SAVEt_GENERIC_PVREF
10736 It can never have worked.
10737 So this is merely a faithful copy of the exiting bug: */
10738 new_state->re_state_reg_start_tmp
10739 = (char **) pv_dup((char *)
10740 old_state->re_state_reg_start_tmp);
10741 /* I assume that it only ever "worked" because no-one called
10742 (pseudo)fork while the regexp engine had re-entered itself.
10744 #ifdef PERL_OLD_COPY_ON_WRITE
10745 new_state->re_state_nrs
10746 = sv_dup(old_state->re_state_nrs, param);
10748 new_state->re_state_reg_magic
10749 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10751 new_state->re_state_reg_oldcurpm
10752 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10754 new_state->re_state_reg_curpm
10755 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10757 new_state->re_state_reg_oldsaved
10758 = pv_dup(old_state->re_state_reg_oldsaved);
10759 new_state->re_state_reg_poscache
10760 = pv_dup(old_state->re_state_reg_poscache);
10761 new_state->re_state_reg_starttry
10762 = pv_dup(old_state->re_state_reg_starttry);
10765 case SAVEt_COMPILE_WARNINGS:
10766 ptr = POPPTR(ss,ix);
10767 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10770 ptr = POPPTR(ss,ix);
10771 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10775 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10783 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10784 * flag to the result. This is done for each stash before cloning starts,
10785 * so we know which stashes want their objects cloned */
10788 do_mark_cloneable_stash(pTHX_ SV *sv)
10790 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10792 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10793 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10794 if (cloner && GvCV(cloner)) {
10801 XPUSHs(sv_2mortal(newSVhek(hvname)));
10803 call_sv((SV*)GvCV(cloner), G_SCALAR);
10810 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10818 =for apidoc perl_clone
10820 Create and return a new interpreter by cloning the current one.
10822 perl_clone takes these flags as parameters:
10824 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10825 without it we only clone the data and zero the stacks,
10826 with it we copy the stacks and the new perl interpreter is
10827 ready to run at the exact same point as the previous one.
10828 The pseudo-fork code uses COPY_STACKS while the
10829 threads->create doesn't.
10831 CLONEf_KEEP_PTR_TABLE
10832 perl_clone keeps a ptr_table with the pointer of the old
10833 variable as a key and the new variable as a value,
10834 this allows it to check if something has been cloned and not
10835 clone it again but rather just use the value and increase the
10836 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10837 the ptr_table using the function
10838 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10839 reason to keep it around is if you want to dup some of your own
10840 variable who are outside the graph perl scans, example of this
10841 code is in threads.xs create
10844 This is a win32 thing, it is ignored on unix, it tells perls
10845 win32host code (which is c++) to clone itself, this is needed on
10846 win32 if you want to run two threads at the same time,
10847 if you just want to do some stuff in a separate perl interpreter
10848 and then throw it away and return to the original one,
10849 you don't need to do anything.
10854 /* XXX the above needs expanding by someone who actually understands it ! */
10855 EXTERN_C PerlInterpreter *
10856 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10859 perl_clone(PerlInterpreter *proto_perl, UV flags)
10862 #ifdef PERL_IMPLICIT_SYS
10864 /* perlhost.h so we need to call into it
10865 to clone the host, CPerlHost should have a c interface, sky */
10867 if (flags & CLONEf_CLONE_HOST) {
10868 return perl_clone_host(proto_perl,flags);
10870 return perl_clone_using(proto_perl, flags,
10872 proto_perl->IMemShared,
10873 proto_perl->IMemParse,
10875 proto_perl->IStdIO,
10879 proto_perl->IProc);
10883 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10884 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10885 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10886 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10887 struct IPerlDir* ipD, struct IPerlSock* ipS,
10888 struct IPerlProc* ipP)
10890 /* XXX many of the string copies here can be optimized if they're
10891 * constants; they need to be allocated as common memory and just
10892 * their pointers copied. */
10895 CLONE_PARAMS clone_params;
10896 CLONE_PARAMS* const param = &clone_params;
10898 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10899 /* for each stash, determine whether its objects should be cloned */
10900 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10901 PERL_SET_THX(my_perl);
10904 PoisonNew(my_perl, 1, PerlInterpreter);
10910 PL_savestack_ix = 0;
10911 PL_savestack_max = -1;
10912 PL_sig_pending = 0;
10914 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10915 # else /* !DEBUGGING */
10916 Zero(my_perl, 1, PerlInterpreter);
10917 # endif /* DEBUGGING */
10919 /* host pointers */
10921 PL_MemShared = ipMS;
10922 PL_MemParse = ipMP;
10929 #else /* !PERL_IMPLICIT_SYS */
10931 CLONE_PARAMS clone_params;
10932 CLONE_PARAMS* param = &clone_params;
10933 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10934 /* for each stash, determine whether its objects should be cloned */
10935 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10936 PERL_SET_THX(my_perl);
10939 PoisonNew(my_perl, 1, PerlInterpreter);
10945 PL_savestack_ix = 0;
10946 PL_savestack_max = -1;
10947 PL_sig_pending = 0;
10949 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10950 # else /* !DEBUGGING */
10951 Zero(my_perl, 1, PerlInterpreter);
10952 # endif /* DEBUGGING */
10953 #endif /* PERL_IMPLICIT_SYS */
10954 param->flags = flags;
10955 param->proto_perl = proto_perl;
10957 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10959 PL_body_arenas = NULL;
10960 Zero(&PL_body_roots, 1, PL_body_roots);
10962 PL_nice_chunk = NULL;
10963 PL_nice_chunk_size = 0;
10965 PL_sv_objcount = 0;
10967 PL_sv_arenaroot = NULL;
10969 PL_debug = proto_perl->Idebug;
10971 PL_hash_seed = proto_perl->Ihash_seed;
10972 PL_rehash_seed = proto_perl->Irehash_seed;
10974 #ifdef USE_REENTRANT_API
10975 /* XXX: things like -Dm will segfault here in perlio, but doing
10976 * PERL_SET_CONTEXT(proto_perl);
10977 * breaks too many other things
10979 Perl_reentrant_init(aTHX);
10982 /* create SV map for pointer relocation */
10983 PL_ptr_table = ptr_table_new();
10985 /* initialize these special pointers as early as possible */
10986 SvANY(&PL_sv_undef) = NULL;
10987 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10988 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10989 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10991 SvANY(&PL_sv_no) = new_XPVNV();
10992 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10993 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10994 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10995 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10996 SvCUR_set(&PL_sv_no, 0);
10997 SvLEN_set(&PL_sv_no, 1);
10998 SvIV_set(&PL_sv_no, 0);
10999 SvNV_set(&PL_sv_no, 0);
11000 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11002 SvANY(&PL_sv_yes) = new_XPVNV();
11003 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11004 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11005 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11006 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11007 SvCUR_set(&PL_sv_yes, 1);
11008 SvLEN_set(&PL_sv_yes, 2);
11009 SvIV_set(&PL_sv_yes, 1);
11010 SvNV_set(&PL_sv_yes, 1);
11011 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11013 /* create (a non-shared!) shared string table */
11014 PL_strtab = newHV();
11015 HvSHAREKEYS_off(PL_strtab);
11016 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11017 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11019 PL_compiling = proto_perl->Icompiling;
11021 /* These two PVs will be free'd special way so must set them same way op.c does */
11022 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11023 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11025 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11026 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11028 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11029 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11030 if (PL_compiling.cop_hints_hash) {
11032 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11033 HINTS_REFCNT_UNLOCK;
11035 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11036 #ifdef PERL_DEBUG_READONLY_OPS
11041 /* pseudo environmental stuff */
11042 PL_origargc = proto_perl->Iorigargc;
11043 PL_origargv = proto_perl->Iorigargv;
11045 param->stashes = newAV(); /* Setup array of objects to call clone on */
11047 /* Set tainting stuff before PerlIO_debug can possibly get called */
11048 PL_tainting = proto_perl->Itainting;
11049 PL_taint_warn = proto_perl->Itaint_warn;
11051 #ifdef PERLIO_LAYERS
11052 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11053 PerlIO_clone(aTHX_ proto_perl, param);
11056 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11057 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11058 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11059 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11060 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11061 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11064 PL_minus_c = proto_perl->Iminus_c;
11065 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11066 PL_localpatches = proto_perl->Ilocalpatches;
11067 PL_splitstr = proto_perl->Isplitstr;
11068 PL_preprocess = proto_perl->Ipreprocess;
11069 PL_minus_n = proto_perl->Iminus_n;
11070 PL_minus_p = proto_perl->Iminus_p;
11071 PL_minus_l = proto_perl->Iminus_l;
11072 PL_minus_a = proto_perl->Iminus_a;
11073 PL_minus_E = proto_perl->Iminus_E;
11074 PL_minus_F = proto_perl->Iminus_F;
11075 PL_doswitches = proto_perl->Idoswitches;
11076 PL_dowarn = proto_perl->Idowarn;
11077 PL_doextract = proto_perl->Idoextract;
11078 PL_sawampersand = proto_perl->Isawampersand;
11079 PL_unsafe = proto_perl->Iunsafe;
11080 PL_inplace = SAVEPV(proto_perl->Iinplace);
11081 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11082 PL_perldb = proto_perl->Iperldb;
11083 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11084 PL_exit_flags = proto_perl->Iexit_flags;
11086 /* magical thingies */
11087 /* XXX time(&PL_basetime) when asked for? */
11088 PL_basetime = proto_perl->Ibasetime;
11089 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11091 PL_maxsysfd = proto_perl->Imaxsysfd;
11092 PL_statusvalue = proto_perl->Istatusvalue;
11094 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11096 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11098 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11100 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11101 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11102 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11105 /* RE engine related */
11106 Zero(&PL_reg_state, 1, struct re_save_state);
11107 PL_reginterp_cnt = 0;
11108 PL_regmatch_slab = NULL;
11110 /* Clone the regex array */
11111 PL_regex_padav = newAV();
11113 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11114 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11116 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11117 for(i = 1; i <= len; i++) {
11118 const SV * const regex = regexen[i];
11121 ? sv_dup_inc(regex, param)
11123 newSViv(PTR2IV(CALLREGDUPE(
11124 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11126 if (SvFLAGS(regex) & SVf_BREAK)
11127 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11128 av_push(PL_regex_padav, sv);
11131 PL_regex_pad = AvARRAY(PL_regex_padav);
11133 /* shortcuts to various I/O objects */
11134 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11135 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11136 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11137 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11138 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11139 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11141 /* shortcuts to regexp stuff */
11142 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11144 /* shortcuts to misc objects */
11145 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11147 /* shortcuts to debugging objects */
11148 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11149 PL_DBline = gv_dup(proto_perl->IDBline, param);
11150 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11151 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11152 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11153 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11154 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11156 /* symbol tables */
11157 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11158 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11159 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11160 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11161 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11163 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11164 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11165 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11166 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11167 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11168 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11169 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11170 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11172 PL_sub_generation = proto_perl->Isub_generation;
11173 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11175 /* funky return mechanisms */
11176 PL_forkprocess = proto_perl->Iforkprocess;
11178 /* subprocess state */
11179 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11181 /* internal state */
11182 PL_maxo = proto_perl->Imaxo;
11183 if (proto_perl->Iop_mask)
11184 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11187 /* PL_asserting = proto_perl->Iasserting; */
11189 /* current interpreter roots */
11190 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11192 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11194 PL_main_start = proto_perl->Imain_start;
11195 PL_eval_root = proto_perl->Ieval_root;
11196 PL_eval_start = proto_perl->Ieval_start;
11198 /* runtime control stuff */
11199 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11201 PL_filemode = proto_perl->Ifilemode;
11202 PL_lastfd = proto_perl->Ilastfd;
11203 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11206 PL_gensym = proto_perl->Igensym;
11207 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11208 PL_laststatval = proto_perl->Ilaststatval;
11209 PL_laststype = proto_perl->Ilaststype;
11212 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11214 /* interpreter atexit processing */
11215 PL_exitlistlen = proto_perl->Iexitlistlen;
11216 if (PL_exitlistlen) {
11217 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11218 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11221 PL_exitlist = (PerlExitListEntry*)NULL;
11223 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11224 if (PL_my_cxt_size) {
11225 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11226 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11227 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11228 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11229 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11233 PL_my_cxt_list = (void**)NULL;
11234 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11235 PL_my_cxt_keys = (const char**)NULL;
11238 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11239 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11240 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11242 PL_profiledata = NULL;
11244 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11246 PAD_CLONE_VARS(proto_perl, param);
11248 #ifdef HAVE_INTERP_INTERN
11249 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11252 /* more statics moved here */
11253 PL_generation = proto_perl->Igeneration;
11254 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11256 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11257 PL_in_clean_all = proto_perl->Iin_clean_all;
11259 PL_uid = proto_perl->Iuid;
11260 PL_euid = proto_perl->Ieuid;
11261 PL_gid = proto_perl->Igid;
11262 PL_egid = proto_perl->Iegid;
11263 PL_nomemok = proto_perl->Inomemok;
11264 PL_an = proto_perl->Ian;
11265 PL_evalseq = proto_perl->Ievalseq;
11266 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11267 PL_origalen = proto_perl->Iorigalen;
11268 #ifdef PERL_USES_PL_PIDSTATUS
11269 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11271 PL_osname = SAVEPV(proto_perl->Iosname);
11272 PL_sighandlerp = proto_perl->Isighandlerp;
11274 PL_runops = proto_perl->Irunops;
11276 PL_parser = parser_dup(proto_perl->Iparser, param);
11278 PL_subline = proto_perl->Isubline;
11279 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11282 PL_cryptseen = proto_perl->Icryptseen;
11285 PL_hints = proto_perl->Ihints;
11287 PL_amagic_generation = proto_perl->Iamagic_generation;
11289 #ifdef USE_LOCALE_COLLATE
11290 PL_collation_ix = proto_perl->Icollation_ix;
11291 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11292 PL_collation_standard = proto_perl->Icollation_standard;
11293 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11294 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11295 #endif /* USE_LOCALE_COLLATE */
11297 #ifdef USE_LOCALE_NUMERIC
11298 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11299 PL_numeric_standard = proto_perl->Inumeric_standard;
11300 PL_numeric_local = proto_perl->Inumeric_local;
11301 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11302 #endif /* !USE_LOCALE_NUMERIC */
11304 /* utf8 character classes */
11305 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11306 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11307 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11308 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11309 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11310 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11311 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11312 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11313 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11314 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11315 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11316 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11317 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11318 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11319 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11320 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11321 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11322 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11323 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11324 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11326 /* Did the locale setup indicate UTF-8? */
11327 PL_utf8locale = proto_perl->Iutf8locale;
11328 /* Unicode features (see perlrun/-C) */
11329 PL_unicode = proto_perl->Iunicode;
11331 /* Pre-5.8 signals control */
11332 PL_signals = proto_perl->Isignals;
11334 /* times() ticks per second */
11335 PL_clocktick = proto_perl->Iclocktick;
11337 /* Recursion stopper for PerlIO_find_layer */
11338 PL_in_load_module = proto_perl->Iin_load_module;
11340 /* sort() routine */
11341 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11343 /* Not really needed/useful since the reenrant_retint is "volatile",
11344 * but do it for consistency's sake. */
11345 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11347 /* Hooks to shared SVs and locks. */
11348 PL_sharehook = proto_perl->Isharehook;
11349 PL_lockhook = proto_perl->Ilockhook;
11350 PL_unlockhook = proto_perl->Iunlockhook;
11351 PL_threadhook = proto_perl->Ithreadhook;
11353 #ifdef THREADS_HAVE_PIDS
11354 PL_ppid = proto_perl->Ippid;
11358 PL_last_swash_hv = NULL; /* reinits on demand */
11359 PL_last_swash_klen = 0;
11360 PL_last_swash_key[0]= '\0';
11361 PL_last_swash_tmps = (U8*)NULL;
11362 PL_last_swash_slen = 0;
11364 PL_glob_index = proto_perl->Iglob_index;
11365 PL_srand_called = proto_perl->Isrand_called;
11366 PL_bitcount = NULL; /* reinits on demand */
11368 if (proto_perl->Ipsig_pend) {
11369 Newxz(PL_psig_pend, SIG_SIZE, int);
11372 PL_psig_pend = (int*)NULL;
11375 if (proto_perl->Ipsig_ptr) {
11376 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11377 Newxz(PL_psig_name, SIG_SIZE, SV*);
11378 for (i = 1; i < SIG_SIZE; i++) {
11379 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11380 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11384 PL_psig_ptr = (SV**)NULL;
11385 PL_psig_name = (SV**)NULL;
11388 /* intrpvar.h stuff */
11390 if (flags & CLONEf_COPY_STACKS) {
11391 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11392 PL_tmps_ix = proto_perl->Itmps_ix;
11393 PL_tmps_max = proto_perl->Itmps_max;
11394 PL_tmps_floor = proto_perl->Itmps_floor;
11395 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11397 while (i <= PL_tmps_ix) {
11398 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11402 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11403 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11404 Newxz(PL_markstack, i, I32);
11405 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11406 - proto_perl->Imarkstack);
11407 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11408 - proto_perl->Imarkstack);
11409 Copy(proto_perl->Imarkstack, PL_markstack,
11410 PL_markstack_ptr - PL_markstack + 1, I32);
11412 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11413 * NOTE: unlike the others! */
11414 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11415 PL_scopestack_max = proto_perl->Iscopestack_max;
11416 Newxz(PL_scopestack, PL_scopestack_max, I32);
11417 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11419 /* NOTE: si_dup() looks at PL_markstack */
11420 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11422 /* PL_curstack = PL_curstackinfo->si_stack; */
11423 PL_curstack = av_dup(proto_perl->Icurstack, param);
11424 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11426 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11427 PL_stack_base = AvARRAY(PL_curstack);
11428 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11429 - proto_perl->Istack_base);
11430 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11432 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11433 * NOTE: unlike the others! */
11434 PL_savestack_ix = proto_perl->Isavestack_ix;
11435 PL_savestack_max = proto_perl->Isavestack_max;
11436 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11437 PL_savestack = ss_dup(proto_perl, param);
11441 ENTER; /* perl_destruct() wants to LEAVE; */
11443 /* although we're not duplicating the tmps stack, we should still
11444 * add entries for any SVs on the tmps stack that got cloned by a
11445 * non-refcount means (eg a temp in @_); otherwise they will be
11448 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11449 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11450 proto_perl->Itmps_stack[i]);
11451 if (nsv && !SvREFCNT(nsv)) {
11453 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11458 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11459 PL_top_env = &PL_start_env;
11461 PL_op = proto_perl->Iop;
11464 PL_Xpv = (XPV*)NULL;
11465 PL_na = proto_perl->Ina;
11467 PL_statbuf = proto_perl->Istatbuf;
11468 PL_statcache = proto_perl->Istatcache;
11469 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11470 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11472 PL_timesbuf = proto_perl->Itimesbuf;
11475 PL_tainted = proto_perl->Itainted;
11476 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11477 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11478 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11479 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11480 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11481 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11482 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11483 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11484 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11486 PL_restartop = proto_perl->Irestartop;
11487 PL_in_eval = proto_perl->Iin_eval;
11488 PL_delaymagic = proto_perl->Idelaymagic;
11489 PL_dirty = proto_perl->Idirty;
11490 PL_localizing = proto_perl->Ilocalizing;
11492 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11493 PL_hv_fetch_ent_mh = NULL;
11494 PL_modcount = proto_perl->Imodcount;
11495 PL_lastgotoprobe = NULL;
11496 PL_dumpindent = proto_perl->Idumpindent;
11498 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11499 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11500 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11501 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11502 PL_efloatbuf = NULL; /* reinits on demand */
11503 PL_efloatsize = 0; /* reinits on demand */
11507 PL_screamfirst = NULL;
11508 PL_screamnext = NULL;
11509 PL_maxscream = -1; /* reinits on demand */
11510 PL_lastscream = NULL;
11513 PL_regdummy = proto_perl->Iregdummy;
11514 PL_colorset = 0; /* reinits PL_colors[] */
11515 /*PL_colors[6] = {0,0,0,0,0,0};*/
11519 /* Pluggable optimizer */
11520 PL_peepp = proto_perl->Ipeepp;
11522 PL_stashcache = newHV();
11524 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11525 proto_perl->Iwatchaddr);
11526 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11527 if (PL_debug && PL_watchaddr) {
11528 PerlIO_printf(Perl_debug_log,
11529 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11530 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11531 PTR2UV(PL_watchok));
11534 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11535 ptr_table_free(PL_ptr_table);
11536 PL_ptr_table = NULL;
11539 /* Call the ->CLONE method, if it exists, for each of the stashes
11540 identified by sv_dup() above.
11542 while(av_len(param->stashes) != -1) {
11543 HV* const stash = (HV*) av_shift(param->stashes);
11544 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11545 if (cloner && GvCV(cloner)) {
11550 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11552 call_sv((SV*)GvCV(cloner), G_DISCARD);
11558 SvREFCNT_dec(param->stashes);
11560 /* orphaned? eg threads->new inside BEGIN or use */
11561 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11562 SvREFCNT_inc_simple_void(PL_compcv);
11563 SAVEFREESV(PL_compcv);
11569 #endif /* USE_ITHREADS */
11572 =head1 Unicode Support
11574 =for apidoc sv_recode_to_utf8
11576 The encoding is assumed to be an Encode object, on entry the PV
11577 of the sv is assumed to be octets in that encoding, and the sv
11578 will be converted into Unicode (and UTF-8).
11580 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11581 is not a reference, nothing is done to the sv. If the encoding is not
11582 an C<Encode::XS> Encoding object, bad things will happen.
11583 (See F<lib/encoding.pm> and L<Encode>).
11585 The PV of the sv is returned.
11590 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11593 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11607 Passing sv_yes is wrong - it needs to be or'ed set of constants
11608 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11609 remove converted chars from source.
11611 Both will default the value - let them.
11613 XPUSHs(&PL_sv_yes);
11616 call_method("decode", G_SCALAR);
11620 s = SvPV_const(uni, len);
11621 if (s != SvPVX_const(sv)) {
11622 SvGROW(sv, len + 1);
11623 Move(s, SvPVX(sv), len + 1, char);
11624 SvCUR_set(sv, len);
11631 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11635 =for apidoc sv_cat_decode
11637 The encoding is assumed to be an Encode object, the PV of the ssv is
11638 assumed to be octets in that encoding and decoding the input starts
11639 from the position which (PV + *offset) pointed to. The dsv will be
11640 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11641 when the string tstr appears in decoding output or the input ends on
11642 the PV of the ssv. The value which the offset points will be modified
11643 to the last input position on the ssv.
11645 Returns TRUE if the terminator was found, else returns FALSE.
11650 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11651 SV *ssv, int *offset, char *tstr, int tlen)
11655 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11666 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11667 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11669 call_method("cat_decode", G_SCALAR);
11671 ret = SvTRUE(TOPs);
11672 *offset = SvIV(offsv);
11678 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11683 /* ---------------------------------------------------------------------
11685 * support functions for report_uninit()
11688 /* the maxiumum size of array or hash where we will scan looking
11689 * for the undefined element that triggered the warning */
11691 #define FUV_MAX_SEARCH_SIZE 1000
11693 /* Look for an entry in the hash whose value has the same SV as val;
11694 * If so, return a mortal copy of the key. */
11697 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11700 register HE **array;
11703 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11704 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11707 array = HvARRAY(hv);
11709 for (i=HvMAX(hv); i>0; i--) {
11710 register HE *entry;
11711 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11712 if (HeVAL(entry) != val)
11714 if ( HeVAL(entry) == &PL_sv_undef ||
11715 HeVAL(entry) == &PL_sv_placeholder)
11719 if (HeKLEN(entry) == HEf_SVKEY)
11720 return sv_mortalcopy(HeKEY_sv(entry));
11721 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11727 /* Look for an entry in the array whose value has the same SV as val;
11728 * If so, return the index, otherwise return -1. */
11731 S_find_array_subscript(pTHX_ AV *av, SV* val)
11734 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11735 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11738 if (val != &PL_sv_undef) {
11739 SV ** const svp = AvARRAY(av);
11742 for (i=AvFILLp(av); i>=0; i--)
11749 /* S_varname(): return the name of a variable, optionally with a subscript.
11750 * If gv is non-zero, use the name of that global, along with gvtype (one
11751 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11752 * targ. Depending on the value of the subscript_type flag, return:
11755 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11756 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11757 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11758 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11761 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11762 SV* keyname, I32 aindex, int subscript_type)
11765 SV * const name = sv_newmortal();
11768 buffer[0] = gvtype;
11771 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11773 gv_fullname4(name, gv, buffer, 0);
11775 if ((unsigned int)SvPVX(name)[1] <= 26) {
11777 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11779 /* Swap the 1 unprintable control character for the 2 byte pretty
11780 version - ie substr($name, 1, 1) = $buffer; */
11781 sv_insert(name, 1, 1, buffer, 2);
11785 CV * const cv = find_runcv(NULL);
11789 if (!cv || !CvPADLIST(cv))
11791 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11792 sv = *av_fetch(av, targ, FALSE);
11793 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11796 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11797 SV * const sv = newSV(0);
11798 *SvPVX(name) = '$';
11799 Perl_sv_catpvf(aTHX_ name, "{%s}",
11800 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11803 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11804 *SvPVX(name) = '$';
11805 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11807 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11808 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11815 =for apidoc find_uninit_var
11817 Find the name of the undefined variable (if any) that caused the operator o
11818 to issue a "Use of uninitialized value" warning.
11819 If match is true, only return a name if it's value matches uninit_sv.
11820 So roughly speaking, if a unary operator (such as OP_COS) generates a
11821 warning, then following the direct child of the op may yield an
11822 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11823 other hand, with OP_ADD there are two branches to follow, so we only print
11824 the variable name if we get an exact match.
11826 The name is returned as a mortal SV.
11828 Assumes that PL_op is the op that originally triggered the error, and that
11829 PL_comppad/PL_curpad points to the currently executing pad.
11835 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11843 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11844 uninit_sv == &PL_sv_placeholder)))
11847 switch (obase->op_type) {
11854 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11855 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11858 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11860 if (pad) { /* @lex, %lex */
11861 sv = PAD_SVl(obase->op_targ);
11865 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11866 /* @global, %global */
11867 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11870 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11872 else /* @{expr}, %{expr} */
11873 return find_uninit_var(cUNOPx(obase)->op_first,
11877 /* attempt to find a match within the aggregate */
11879 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11881 subscript_type = FUV_SUBSCRIPT_HASH;
11884 index = find_array_subscript((AV*)sv, uninit_sv);
11886 subscript_type = FUV_SUBSCRIPT_ARRAY;
11889 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11892 return varname(gv, hash ? '%' : '@', obase->op_targ,
11893 keysv, index, subscript_type);
11897 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11899 return varname(NULL, '$', obase->op_targ,
11900 NULL, 0, FUV_SUBSCRIPT_NONE);
11903 gv = cGVOPx_gv(obase);
11904 if (!gv || (match && GvSV(gv) != uninit_sv))
11906 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11909 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11912 av = (AV*)PAD_SV(obase->op_targ);
11913 if (!av || SvRMAGICAL(av))
11915 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11916 if (!svp || *svp != uninit_sv)
11919 return varname(NULL, '$', obase->op_targ,
11920 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11923 gv = cGVOPx_gv(obase);
11929 if (!av || SvRMAGICAL(av))
11931 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11932 if (!svp || *svp != uninit_sv)
11935 return varname(gv, '$', 0,
11936 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11941 o = cUNOPx(obase)->op_first;
11942 if (!o || o->op_type != OP_NULL ||
11943 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11945 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11949 if (PL_op == obase)
11950 /* $a[uninit_expr] or $h{uninit_expr} */
11951 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11954 o = cBINOPx(obase)->op_first;
11955 kid = cBINOPx(obase)->op_last;
11957 /* get the av or hv, and optionally the gv */
11959 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11960 sv = PAD_SV(o->op_targ);
11962 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11963 && cUNOPo->op_first->op_type == OP_GV)
11965 gv = cGVOPx_gv(cUNOPo->op_first);
11968 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11973 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11974 /* index is constant */
11978 if (obase->op_type == OP_HELEM) {
11979 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11980 if (!he || HeVAL(he) != uninit_sv)
11984 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11985 if (!svp || *svp != uninit_sv)
11989 if (obase->op_type == OP_HELEM)
11990 return varname(gv, '%', o->op_targ,
11991 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11993 return varname(gv, '@', o->op_targ, NULL,
11994 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11997 /* index is an expression;
11998 * attempt to find a match within the aggregate */
11999 if (obase->op_type == OP_HELEM) {
12000 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12002 return varname(gv, '%', o->op_targ,
12003 keysv, 0, FUV_SUBSCRIPT_HASH);
12006 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12008 return varname(gv, '@', o->op_targ,
12009 NULL, index, FUV_SUBSCRIPT_ARRAY);
12014 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12016 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12021 /* only examine RHS */
12022 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12025 o = cUNOPx(obase)->op_first;
12026 if (o->op_type == OP_PUSHMARK)
12029 if (!o->op_sibling) {
12030 /* one-arg version of open is highly magical */
12032 if (o->op_type == OP_GV) { /* open FOO; */
12034 if (match && GvSV(gv) != uninit_sv)
12036 return varname(gv, '$', 0,
12037 NULL, 0, FUV_SUBSCRIPT_NONE);
12039 /* other possibilities not handled are:
12040 * open $x; or open my $x; should return '${*$x}'
12041 * open expr; should return '$'.expr ideally
12047 /* ops where $_ may be an implicit arg */
12051 if ( !(obase->op_flags & OPf_STACKED)) {
12052 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12053 ? PAD_SVl(obase->op_targ)
12056 sv = sv_newmortal();
12057 sv_setpvn(sv, "$_", 2);
12066 /* skip filehandle as it can't produce 'undef' warning */
12067 o = cUNOPx(obase)->op_first;
12068 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12069 o = o->op_sibling->op_sibling;
12076 match = 1; /* XS or custom code could trigger random warnings */
12080 /* def-ness of rval pos() is independent of the def-ness of its arg */
12081 if ( !(obase->op_flags & OPf_MOD))
12086 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12087 return sv_2mortal(newSVpvs("${$/}"));
12092 if (!(obase->op_flags & OPf_KIDS))
12094 o = cUNOPx(obase)->op_first;
12100 /* if all except one arg are constant, or have no side-effects,
12101 * or are optimized away, then it's unambiguous */
12103 for (kid=o; kid; kid = kid->op_sibling) {
12105 const OPCODE type = kid->op_type;
12106 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12107 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12108 || (type == OP_PUSHMARK)
12112 if (o2) { /* more than one found */
12119 return find_uninit_var(o2, uninit_sv, match);
12121 /* scan all args */
12123 sv = find_uninit_var(o, uninit_sv, 1);
12135 =for apidoc report_uninit
12137 Print appropriate "Use of uninitialized variable" warning
12143 Perl_report_uninit(pTHX_ SV* uninit_sv)
12147 SV* varname = NULL;
12149 varname = find_uninit_var(PL_op, uninit_sv,0);
12151 sv_insert(varname, 0, 0, " ", 1);
12153 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12154 varname ? SvPV_nolen_const(varname) : "",
12155 " in ", OP_DESC(PL_op));
12158 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12164 * c-indentation-style: bsd
12165 * c-basic-offset: 4
12166 * indent-tabs-mode: t
12169 * ex: set ts=8 sts=4 sw=4 noet: